Update a treatment definition group

put/definitionGroups/{groupId}

Internal-Use Only

Updates the specified treatment definition group based on the representation in the request body.

Request Samples

application/json
default
1

Response Samples

200
application/json
default
1{
2  "name": "My Treatment Definition Group",
3  "checkout": false,
4  "locked": false,
5  "sourceRevisionUri": "/treatmentDefinitions/definitionGroups/6b53e248-1afb-4147-b17a-13e75b8c759b/revisions/0340f630-3ee6-4058-ad36-744619c141d5",
6  "copyTimeStamp": "2020-06-17T13:37:01.750Z",
7  "members": [
8    {
9      "definitionId": "60095dcd-b2ca-4705-8cf6-aa693fce1692"
10    },
11    {
12      "definitionId": "60095dcd-b2ca-4705-8cf6-aa693fce1692",
13      "definitionRevisionId": "f813702e-dff8-443e-a7af-727ab027fb7e",
14      "attributeValueMappings": [
15        {
16          "attributeId": "fdb1e22e-5358-4311-a914-eec901c2da5f",
17          "mappingType": "variable",
18          "value": "Discount"
19        },
20        {
21          "attributeId": "7c17cbaf-dd3d-4288-b6a9-54ae7c7c91c6",
22          "mappingType": "constant",
23          "value": "Samsung"
24        },
25        {
26          "attributeId": "a0a3b4d4-fc28-4194-84dd-fe2dc3286009",
27          "mappingType": "variable",
28          "value": "Clicked"
29        }
30      ],
31      "attributeNameAliases": [
32        {
33          "attributeId": "fdb1e22e-5358-4311-a914-eec901c2da5f",
34          "aliasName": "Discount ID"
35        }
36      ]
37    }
38  ]
39}

Path Parameters

Name	Type	Required	Description
groupId	string	true	The unique identifier for the treatment definition group.

Header Parameters

Name	Type	Required	Description
If-Match	string	true	Etag of content payload that was updated.

Request Body

The representation of a treatment definition group.

Name	Type	Required	Description
id	string	false	The system-assigned unique ID for this object
name	string	true	The treatment definition group name.
description	string	false	The treatment definition group description.
createdBy	string	false	The user who created the treatment definition group.
creationTimeStamp	string<date-time>	false	The date and time that the treatment definition group was created.
modifiedBy	string	false	The userId of the authenticated user who last updated the treatment definition group.
modifiedTimeStamp	string<date-time>	false	The date and time that the treatment definition group was last modified.
majorRevision	integer	false	Major version number of the revision being viewed of the treatment definition group. This value is assigned by the service, the user only has control on whether the major number or minor number is incremented when creating a new revision. This is a derived field which is generated on POST.
minorRevision	integer	false	Minor version number of the current revision of the treatment definition group. This value is assigned by the service, the user only has control on whether the major number or minor number is incremented when creating a new revision. This is a derived field which is generated on POST.
checkout	boolean	false	Flag which indicates that this treatment group is a user's working copy of another treatment group.
locked	boolean	false	Flag which indicates if the content of the revision being viewed is locked or editable.
activationStatus	string<enumeration>	false	Status of the activation. Allowed values: activeinactivependingrunningcancelledtimedOutfailed
activationError	Error	false	The representation of an error.
activatedTimeStamp	string<date-time>	false	The date and time that the treatment definition group revision was activated.
status	string<enumeration>	false	Status of the treatment definition. Allowed values: validerror
members	array [Treatment Definition Group Member]	false	The group of treatment definition members.
folderType	string	false	Indicates the kind of folder where the treatment definition group is housed.
sourceRevisionUri	string	false	The URI of the treatment definition group revision this treatment definition group is being created from.
copyTimeStamp	string<date-time>	false	The time stamp when the treatment definition group revision was copied.
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

Status	Meaning	Description
200	OK	The request succeeded.	Headers	Schema
400	Bad Request	The request was invalid.	Headers	Schema
404	Not Found	No treatment definition group exists at the requested path.	Headers	Schema
412	Precondition Failed	The `If-Match` request header did not match the resource's entity tag.	Headers	Schema
428	Precondition Required	The request headers did not include a `If-Match` precondition.	Headers	Schema