List bulk-versioned properties
GET https://{{host}}/papi/v1/bulk/property-version-creations/:bulkCreateId
List all new property versions that result from a bulk versioning request. This operation polls the asynchronous process's status. After the bulkCreateVersionsStatus
is COMPLETE
, use the new version numbers along with search paths from a bulk search operation to bulk patch them. See Bulk Search and Update for guidance.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
contractId | string | (Optional) 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 | (Optional) 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 | (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
{"bulkCreateId":9,"bulkCreateVersionSubmitDate":"2018-01-18T00:00:00Z","bulkCreateVersionUpdateDate":"2018-01-18T00:00:00Z","bulkCreateVersionsStatus":"IN_PROGRESS","createPropertyVersions":[{"createFromVersion":1,"createFromVersionEtag":"343410c585cf67fb","createVersionStatus":"PENDING","createVersionSubmitDate":"2018-01-18T00:00:00Z","createVersionUpdateDate":"2018-01-18T00:00:00Z","propertyId":"prp_1","propertyVersion":2,"propertyVersionLink":"/papi/v1/properties/prp_1/versions/2?contractId=ctr_C-0N7RAC7\u0026groupId=grp_15166"},{"createFromVersion":2,"createFromVersionEtag":"343410c585cf67fc","createVersionStatus":"IN_PROGRESS","createVersionSubmitDate":"2018-01-18T00:00:00Z","createVersionUpdateDate":"2018-01-18T00:00:00Z","propertyId":"prp_15","propertyVersion":3,"propertyVersionLink":"/papi/v1/properties/prp_2/versions/3?contractId=ctr_C-0N7RAC7\u0026groupId=grp_15166"},{"createFromVersion":10,"createFromVersionEtag":"6c7v5c65c6cvcv65","createVersionStatus":"SUBMISSION_ERROR","createVersionSubmitDate":"2023-11-22T09:57:39Z","createVersionUpdateDate":"2023-11-22T09:57:45Z","fatalError":"property id is bad or not accessible","propertyId":"prp_3"}]}