Get a treatment definition

get/definitions/{definitionId}

Returns the representation of the specified treatment definition.

Request Samples

1

Response Samples

1{
2 "name": "My Treatment Definition",
3 "checkout": false,
4 "locked": false,
5 "sourceRevisionUri": "/treatmentDefinitions/definitions/6b53e248-1afb-4147-b17a-13e75b8c759b/revisions/0340f630-3ee6-4058-ad36-744619c141d5",
6 "copyTimeStamp": "2020-06-17T13:37:01.750Z",
7 "attributes": [
8 {
9 "name": "Discount",
10 "valueConstraints": {
11 "dataType": "number",
12 "format": "decimal"
13 },
14 "defaultValue": 30
15 },
16 {
17 "name": "Product",
18 "valueConstraints": {
19 "dataType": "string",
20 "enum": [
21 "iPhone",
22 "Samsung"
23 ]
24 },
25 "defaultValue": "iPhone"
26 },
27 {
28 "name": "Offertext",
29 "valueConstraints": {
30 "dataType": "string"
31 },
32 "defaultValue": "Get a new iPhone now and get 30% off iPad"
33 },
34 {
35 "name": "Budget",
36 "valueConstraints": {
37 "dataType": "number",
38 "format": "decimal",
39 "readOnly": true
40 },
41 "defaultValue": 500
42 },
43 {
44 "name": "Goal",
45 "valueConstraints": {
46 "dataType": "string",
47 "format": "date"
48 },
49 "defaultValue": "2018-07-13"
50 },
51 {
52 "name": "TimesClicked",
53 "valueConstraints": {
54 "dataType": "number",
55 "format": "integer"
56 }
57 }
58 ]
59}

Path Parameters

NameTypeRequiredDescription
definitionId
string
true

The unique identifier for the treatment definition.

Responses

StatusMeaningDescription
200OK

The request succeeded.

HeadersSchema
404Not Found

No treatment definition exists at the requested path.

HeadersSchema