Get an include activation
GET https://{{host}}/papi/v1/includes/:includeId/activations/:activationId
Limited availability Gets details about an activation. The response also shows the results of a validation against the rule trees of active parent properties that reference the include. While you can ignore any warnings that indicate non-blocking, logical inconsistencies, you need to resolve all errors to activate an include.
You typically get a single activation from an activationLink when launching a new activation, and you follow up to poll its status. For activations whose status is PENDING, a Retry-After header provides an estimate for when it's likely to go live.
Note: To reduce errors, avoid calling PAPI with separate clients on the same data. Avoid frequently polling status values. Instead, progressively increase the delay between calls.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
contractId | string | (Optional) Unique identifier for the contract. The parameter is optional if a property belongs to only one contract. Otherwise you need to specify it along with the groupId. In other operations that don't specify a propertyId URL parameter, this parameter is always required. See ID prefixes for details on omitting the value's ctr_ prefix. | |
groupId | string | (Optional) Unique identifier for the group. The parameter is optional if a property belongs to only one group. Otherwise you need to specify it along with the contractId. In other operations that don't specify a propertyId URL parameter, this parameter is always required. See ID prefixes for details on omitting the value's grp_ prefix. | |
accountSwitchKey | string | (Optional) For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
PAPI-Use-Prefixes | string | (Required) Enum Sets whether to represent ID prefixes in response data. Set to false when exchanging PAPI data with other APIs. | |
Accept | string |
RESPONSES
status: OK
{"accountId":"act_A-CCT7890","activations":{"items":[{"activationType":"ACTIVATE","fmaActivationState":"received","includeActivationId":"5e597860-1107-461e-8dbe-4e7526e8dd02","includeId":"inc_173036","includeName":"example.inc.com","includeVersion":1,"network":"STAGING","note":"Sample activation","notifyEmails":["you@example.com","them@example.com"],"status":"PENDING","submitDate":"2022-03-02T02:22:12Z","updateDate":"2022-03-01T21:12:57Z"}]},"contractId":"ctr_K-0N7RAK71","groupId":"grp_32145","validations":{"network":"STAGING","validationErrorsItemList":{"items":[{"hasValidationError":true,"hasValidationWarning":true,"propertyName":"ng-parent5-for-inc7.com","validationResultsLink":"/papi-backend/v0/includes/validation-results/489e0b99-e80a-4cf0-bc44-f29f810c68c0/properties/747628/versions/1?groupId=15225\u0026contractId=ctr_C-0N7RAC7","versionId":185102232,"versionNumber":1},{"hasValidationError":true,"hasValidationWarning":false,"propertyName":"ng-include.common7","validationResultsLink":"/papi-backend/v0/includes/validation-results/489e0b99-e80a-4cf0-bc44-f29f810c68c0/properties/747209/versions/6?groupId=15225\u0026contractId=ctr_K-0N7RAK71","versionId":185107315,"versionNumber":6}]},"validationSummary":{"completePercent":100,"hasClientError":false,"hasSystemError":false,"hasValidationError":true,"hasValidationWarning":false,"messageState":"SUBMITTED_FOR_ACTIVATION"}}}