Validate a new treatment definition
post/commons/validations/definitions
Determines whether a new treatment definition is valid.
The treatment definition
The representation of a treatment definition.
Example:
{"name":"My Treatment Definition","checkout":false,"locked":false,"sourceRevisionUri":"/treatmentDefinitions/definitions/6b53e248-1afb-4147-b17a-13e75b8c759b/revisions/0340f630-3ee6-4058-ad36-744619c141d5","copyTimeStamp":"2020-06-17T13:37:01.750Z","attributes":[{"name":"Discount","valueConstraints":{"dataType":"number","format":"decimal"},"defaultValue":30},{"name":"Product","valueConstraints":{"dataType":"string","enum":["iPhone","Samsung"]},"defaultValue":"iPhone"},{"name":"Offertext","valueConstraints":{"dataType":"string"},"defaultValue":"Get a new iPhone now and get 30% off iPad"},{"name":"Budget","valueConstraints":{"dataType":"number","format":"decimal","readOnly":true},"defaultValue":500},{"name":"Goal","valueConstraints":{"dataType":"string","format":"date"},"defaultValue":"2018-07-13"},{"name":"TimesClicked","valueConstraints":{"dataType":"number","format":"integer"}}]}
Name | Type | Required | Description |
---|---|---|---|
name | string | true | The treatment definition name. |
description | string | false | The treatment definition description. |
status | string<enumeration> | false | The status of the treatment definition. Allowed values: validerror |
eligibility | Treatment Definition Eligibility | false | Represents the eligibility details for a treatment definition. This does not represent any of the top-level media types. |
attributes | array [Treatment Definition Attribute] | false | An array of treatment definition attributes. |
folderType | string | false | Indicates the type of folder where the treatment definition is stored. |
links | array [Link] | false | Zero or more links to related resources or operations. |
version | integer | false | This media type's schema version number. This representation is version 4. |
Status | Meaning | Description | ||
---|---|---|---|---|
200 | OK | The request succeeded. | Headers | Schema |