Validate an update to treatment definition

put/commons/validations/definitions/{definitionId}
Internal-Use Only

Determines whether an update to treatment definition is valid.

Request Samples

1

Response Samples

1{
2 "valid": true,
3 "version": 1
4}

Path Parameters

NameTypeRequiredDescription
definitionId
string
true

The unique identifier for the treatment definition.

Examples:
"625e99fd-4d8a-4ee2-b201-4fd3c062169f"

Header Parameters

NameTypeRequiredDescription
If-Match
string
true

Etag value from when the originating object was retrieved.

Examples:
"\"kknyjgku\""

Request Body

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"}}]}
NameTypeRequiredDescription
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.

Responses

StatusMeaningDescription
200OKThe request succeeded.HeadersSchema