Treatment Definitions

Loading...
The Treatment Definitions API is used for creating and maintaining treatment definitions and treatment definition groups.

Treatment Definitions

Contains operations to create, read, update, and delete treatment definitions.
get
Get a list of all treatment definitions
Internal-Use OnlyReturns a resource collection of all treatment definitions.
/definitions
post
Create a new treatment definition
Internal-Use OnlyCreates a new treatment definition based on the provided content
/definitions
get
Get treatment definition summary
Internal-Use OnlyReturns the summary representation of the specified treatment definition.
/definitions/{definitionId}
get
Get a treatment definition revision summary
Internal-Use OnlyReturns the revision summary representation of the specified treatment definition.
/definitions/{definitionId}
get
Get a treatment definition
Internal-Use OnlyReturns the representation of the specified treatment definition.
/definitions/{definitionId}
put
Update a treatment definition
Internal-Use OnlyUpdates the specified treatment definition based on the representation in the request body.
/definitions/{definitionId}
delete
Delete a treatment definition
Internal-Use OnlyDeletes the specified treatment definition.
/definitions/{definitionId}
get
Get direct dependencies of a treatment definition
Internal-Use OnlyReturns the representation of the transfer dependencies of treatment definition.
/definitions/{definitionId}/dependencies
post
Validate a new treatment definition
Internal-Use OnlyDetermines whether a new treatment definition is valid.
/commons/validations/definitions
put
Validate an update to treatment definition
Internal-Use OnlyDetermines whether an update to treatment definition is valid.
/commons/validations/definitions/{definitionId}
delete
Validate delete of treatment definition
Internal-Use OnlyDetermines whether a treatment definition can be deleted.
/commons/validations/definitions/{definitionId}

Treatment Definition Revisions

Contains operations to create and read treatment definition revisions.
get
Get all revisions for a treatment definition
Internal-Use OnlyRetrieves a list of all revisions that exist for a treatment definition.
/definitions/{definitionId}/revisions
post
Create revision of a treatment definition
Internal-Use OnlyCreates a new revision of a treatment definition based on the representation in the request body.
/definitions/{definitionId}/revisions
get
Get revision of treatment definition
Internal-Use OnlyReturns the summary representation of the revision of the specified treatment definition.
/definitions/{definitionId}/revisions/{revisionId}
get
Get treatment definition revision summary content
Internal-Use OnlyReturns the revision summary representation for the specified treatment definition.
/definitions/{definitionId}/revisions/{revisionId}
get
Get a list of checkouts for a treatment definition revision
Internal-Use OnlyReturns the complete list of checkouts for a treatment definition revision. Note: This endpoint does not support paging.
/definitions/{definitionId}/revisions/{revisionId}/checkOuts
get
Get revision of specified treatment definition
Internal-Use OnlyReturns the representation of the specified treatment definition revision.
/definitions/{definitionId}/revisions/{revisionId}
delete
Delete a treatment definition revision
Internal-Use OnlyDeletes the specified treatment definition revision.
/definitions/{definitionId}/revisions/{revisionId}

Treatment Definition Groups

Contains operations to create, read, update, and delete treatment definition groups.
get
Get a list of treatment definition groups
Internal-Use OnlyReturns a list of all the treatment definition groups.
/definitionGroups
post
Create a new treatment definition group
Internal-Use OnlyCreates a new treatment definition group based on the representation in the request body.
/definitionGroups
get
Get treatment definition group summary
Internal-Use OnlyReturns the summary representation of the specified treatment definition group.
/definitionGroups/{groupId}
get
Get a treatment definition group revision summary
Internal-Use OnlyReturns the revision summary representation of the specified treatment definition group.
/definitionGroups/{groupId}
get
Get a treatment definition group
Internal-Use OnlyReturns the representation of the specified treatment definition group.
/definitionGroups/{groupId}
put
Update a treatment definition group
Internal-Use OnlyUpdates the specified treatment definition group based on the representation in the request body.
/definitionGroups/{groupId}
delete
Delete a treatment definition group
Internal-Use OnlyDeletes the specified treatment definition group.
/definitionGroups/{groupId}
get
Get direct dependencies of a treatment definition group
Internal-Use OnlyReturns the representation of the transfer dependencies of treatment definition group.
/definitionGroups/{groupId}/dependencies

Treatment Definition Group Revisions

Contains operations to create and read treatment definition group revisions.
post
Get revisions across treatment definitions
Internal-Use OnlyReturns a list of the treatment definition revisions based on the list of resource IDs.
/definitionRevisions
get
Get revisions for a treatment definition group
Internal-Use OnlyRetrieves a list of all revisions that exist for a treatment definition group.
/definitionGroups/{groupId}/revisions
post
Create a revision of a treatment definition group
Internal-Use OnlyCreates a new revision of a treatment definition group based on the representation in the request body.
/definitionGroups/{groupId}/revisions
post
Get revisions across treatment definition groups
Internal-Use OnlyReturns a list of the treatment definition group revisions based on the list of resource IDs.
/definitionGroupRevisions
get
Get a revision of a treatment definition group
Internal-Use OnlyReturns the summary representation of the revision for the specified treatment definition group.
/definitionGroups/{groupId}/revisions/{revisionId}
get
Get treatment definition group revision summary content
Internal-Use OnlyReturns the treatment definition group revision summary representation
/definitionGroups/{groupId}/revisions/{revisionId}
get
Get a list of checkouts for a treatment definition group revision
Internal-Use OnlyReturns the complete list of checkouts for a treatment definition group revision. Note: This endpoint does not support paging.
/definitionGroups/{groupId}/revisions/{revisionId}/checkOuts
get
Get revision of treatment definition group
Internal-Use OnlyReturns the representation of the specified treatment definition group revision.
/definitionGroups/{groupId}/revisions/{revisionId}
delete
Delete a treatment definition group version
Internal-Use OnlyDeletes the specified treatment definition group version.
/definitionGroups/{groupId}/revisions/{revisionId}
put
Activate revision of a treatment definition group
Internal-Use OnlyActivates a locked revision of the specified treatment definition group.
/definitionGroups/{groupId}/active

Code

Contains operations for generating code.
get
Get treatment definition group code
Internal-Use OnlyReturns the DS2 code for the specified treatment definition group.
/definitionGroups/{groupId}/ds2Code
get
Get treatment definition group decision step code
Internal-Use OnlyReturns the decision step code for the specified treatment definition group.
/definitionGroups/{groupId}/decisionStepCode
get
Get treatment definition group revision code
Internal-Use OnlyReturns the DS2 code for the specified treatment definition group revision.
/definitionGroups/{groupId}/revisions/{revisionId}/ds2Code
get
Get treatment definition group revision decision step code
Internal-Use OnlyReturns the decision step code for the specified treatment definition group revision.
/definitionGroups/{groupId}/revisions/{revisionId}/decisionStepCode