List bulk-activated properties

get https://{hostname}/papi/v1/bulk/activations/{bulkActivationId}

List all activations that result from a bulk activation request. Once the overall bulkActivationStatus is COMPLETE, check each activation's activationStatus to confirm it's ACTIVATED. See Bulk Search and Update for overall guidance on this feature.

Path Params

bulkActivationId

integer

required

Identifies each bulk activation job.

Query Params

contractId

string

Optionally filters bulk searches to properties created under the specified contract. For bulk operations, you can specify contractId and groupId independently from each other.

groupId

string

Optionally filters bulk searches to properties created under the specified group. For bulk operations, you can specify contractId and groupId independently from each other.

accountSwitchKey

string

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

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.

Responses

`bulkActivationStatus` is `COMPLETE`.

Response body

object

activatePropertyVersions

array of objects

Specifies each property version to include in the bulk activation. Following bulk activation, this reflects the activation state for each property.

activatePropertyVersions

object

acknowledgeAllWarnings

boolean

required

Indicates whether you specified acknowledgeAllWarnings as part of the bulk activation request's defaultActivationSettings. This allows properties to activate despite any warnings.

acknowledgeWarnings

array of strings

length ≥ 0

String IDs prefixed with msg_ to acknowledge any warnings noted in responses to previous activation requests.

acknowledgeWarnings

activationErrors

array of objects

length ≥ 0

Validation errors that prevented a bulk activation.

activationErrors

object

detail

string

Provides context for the problem that triggered the error.

type

string

A URI that identifies each error case. See the Errors section for details on each.

activationStatus

string

required

This property's initial activation status usually NEW. Values are the same as for individual activations: ACTIVE, INACTIVE, NEW, PENDING, ZONE_1, ZONE_2, ZONE_3, ABORTED, FAILED, PENDING_DEACTIVATION or DEACTIVATED.

ACTIVE INACTIVE PENDING ZONE_1 ZONE_2 ZONE_3 ABORTED FAILED DEACTIVATED PENDING_DEACTIVATION NEW

activationSubmitDate

string

required

An ISO 8601 timestamp indicating when activation initiated for this property.

activationUpdateDate

string

required

An ISO 8601 timestamp indicating when this property's activationStatus last changed.

activationWarnings

array of objects

length ≥ 0

Validation warnings resulting from the bulk activation. You need to acknowledge them when bulk-activating property versions.

activationWarnings

object

detail

string

Provides context for the problem that triggered the warning.

messageId

string

Identifies the validation warnings. You may need it to acknowledge when bulk-activating property versions. Specifying acknowledgeAllWarnings avoids the need to acknowledge specific warnings.

type

string

A URI that identifies each warning case. See the Errors section for details on each.

fastPush

boolean

required

Whether you specified fastPush as part of the bulk activation request's defaultActivationSettings. This allows properties to rely on fast metadata push.

fatalError

string

Indicates an error that prevented this property version from activating.

network

string

required

The network on which to activate this property, either STAGING or PRODUCTION.

STAGING PRODUCTION

note

string

An optional log message for this property's activation.

notifyEmails

array of strings

length ≥ 0

Email addresses to notify when this property's activationStatus changes. Note that these may supplement the set of notifyEmails specified within the bulk activation request's defaultActivationSettings.

notifyEmails

numberOfWarningsFromActivation

integer

≥ 0

This counts the number of non-blocking warnings present in the activated rule tree.

propertyActivationLink

string

Provides an API hypermedia link to each activation within the bulk activation job.

propertyId

string

required

Identifies each property targeted for activation within the bulk activation job. See ID prefixes for details on how to omit the ID's prp_ prefix. Don't use this value if you want to exchange data with the Identity and Access Manager API. See Manage properties and includes.

propertyName

string

Identifies the property name targeted for activation within the bulk activation job.

propertyVersion

integer

required

≥ 1

Identifies the property version targeted for activation within the bulk activation job. Once activated, you can no longer modify that version of the property.

taskStatus

string

This property's initial task status. Values are the same as for individual activations: PENDING, IN_PROGRESS, SUBMITTED, INTERRUPTED, SUBMISSION_ERROR, and COMPLETE.

PENDING IN_PROGRESS SUBMITTED INTERRUPTED SUBMISSION_ERROR COMPLETE

useFastFallback

boolean

required

Indicates whether you sepcified useFastFallback as part of the bulk activation request's defaultActivationSettings. This allows properties to quickly fall back to the previous activation.

bulkActivationId

integer

required

≥ 1

Unique identifier for each bulk activation request.

bulkActivationStatus

string

required

Reflects the status of the entire bulk update request, either PENDING, IN_PROGRESS, or COMPLETE.

PENDING COMPLETE IN_PROGRESS

bulkActivationSubmitDate

string

required

An ISO 8601 timestamp indicating when the bulk activation process initiated.

bulkActivationUpdateDate

string

required

An ISO 8601 timestamp indicating when the bulkActivationStatus last changed.

defaultActivationSettings

object

Common settings to apply to all activations in the batch.

acknowledgeAllWarnings

boolean

Indicates whether you specified acknowledgeAllWarnings as part of the bulk activation request's defaultActivationSettings. This allows properties to activate despite any warnings.

acknowledgeWarnings

array of strings

length ≥ 0

String IDs prefixed with msg_ to acknowledge any warnings noted in responses to previous activation requests.

acknowledgeWarnings

fastPush

boolean

Indicates whether you specified fastPush as part of the bulk activation request's defaultActivationSettings. This allows properties to rely on fast metadata push.

notifyEmails

array of strings

length ≥ 0

Email addresses to notify when the activation status changes for any property within the bulk activation. Note that you can supplement additional email addresses for each property you activate.

notifyEmails

useFastFallback

boolean

Indicates whether you specified useFastFallback as part of the bulk activation request's defaultActivationSettings. This allows properties to quickly fall back to the previous activation.

message

string

A notification in case the bulk request repeatedly fails to process.

Headers

object

X-RateLimit-Limit

integer

Maximum sustainable number of request allowed each minute per account. This rate limit protects PAPI resources from being exhausted by single users. Once you exceed the limit, you receive the 429 error. If you call PAPI using multiple API clients within the same account, the rate limit applies globally to all API clients.

This API also provides a burst limit that specifies how many requests you can make in excess of the imposed rate limit. The one-time burst limit is 1000 requests. Once you consume all available resources, the burst capacity increases steadily by 100 requests every minute, until it reaches its initial maximum limit of 1000.

X-RateLimit-Remaining

integer

Remianing number of requests allowed each minute per account. See Rate and resource limiting for details.

Language

Authentication

Remember to add your authentication credentials to run this code.

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://hostname/papi/v1/bulk/activations/bulkActivationId \
3
     --header 'PAPI-Use-Prefixes: true' \
4
     --header 'accept: application/json'


xxxxxxxxxx
74
}
1
{
2
  "activatePropertyVersions": [
3
    {
4
      "acknowledgeAllWarnings": false,
5
      "acknowledgeWarnings": [
6
        "msg_123",
7
        "msg_234"
8
      ],
9
      "activationStatus": "NEW",
10
      "activationSubmitDate": "2023-11-22T09:50:18Z",
11
      "activationUpdateDate": "2023-11-22T09:50:25Z",
12
      "fastPush": true,
13
      "fatalError": "property id is bad or not accessible",
14
      "network": "PRODUCTION",
15
      "note": "created by xyz",
16
      "notifyEmails": [
17
        "you@example.com",
18
        "them@example.com"
19
      ],
20
      "propertyId": "prp_3",
21
      "propertyVersion": 11,
22
      "taskStatus": "SUBMISSION_ERROR",
23
      "useFastFallback": false
24
    },
25
    {

200The response shows the bulk activation job, which proceeds until the bulkActivationStatus is COMPLETE.

400Bad request.

401Unauthorized.

403Forbidden.

404Not found.

405Method not allowed.

406Not acceptable.

429Too many requests.

500Internal server error.

`bulkActivationStatus` is `COMPLETE`.