List bulk search results

GET https://{{host}}/papi/v1/bulk/rules-search-requests/:bulkSearchId

List all property or include versions that result from a bulk search request. Run this operation to poll the asynchronous process's status. Once the searchTargetStatus is COMPLETE, you can feed the results into a bulk versioning operation. Also use the JSON path matchLocations to run a bulk patch operation over the rule trees. See Bulk Search and Update for guidance.

Request Params

KeyDatatypeRequiredDescription
contractIdstring(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.
groupIdstring(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.
accountSwitchKeystring(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

KeyDatatypeRequiredDescription
PAPI-Use-Prefixesstring(Required) Enum Sets whether to represent ID prefixes in response data. Set to false when exchanging PAPI data with other APIs.
Acceptstring

RESPONSES

status: OK

{"bulkSearchId":5,"bulkSearchQuery":{"bulkSearchQualifiers":["$.options[?(@.secure==\"true\")]","$..features[?(@.name==\"origin\")].options[?(@.hostname==\"old.origin.example.com\")]"],"match":"$..conditions[?(@.name == \"ext\" \u0026\u0026 \"mp3\" in @.options.value \u0026\u0026 \"mp4\" nin @.options.value)].options.value[?(@ == \"mp3\")]","syntax":"JSONPATH"},"results":[{"accountId":"act_A-CCT3456","isLatest":true,"isLocked":true,"isSecure":true,"lastModifiedTime":"2018-01-18T00:00:00Z","matchLocations":["/rules/children/1/features/0","/rules/children/1/features/3"],"productionStatus":"INACTIVE","propertyId":"prp_1","propertyName":"example1.example.com","propertyVersion":1,"stagingStatus":"ACTIVE"},{"accountId":"act_A-CCT3456","isLatest":false,"isLocked":false,"isSecure":true,"lastModifiedTime":"2018-01-18T00:00:00Z","matchLocations":["/rules/children/1/children/0/features/1"],"productionStatus":"INACTIVE","propertyId":"prp_15","propertyName":"example2.example.com","propertyVersion":2,"stagingStatus":"INACTIVE"},{"accountId":"A-CCT9012","isLatest":true,"isLocked":true,"isSecure":true,"lastModifiedTime":"2018-01-18T00:00:00Z","matchLocations":["/rules/children/0/children/1/children/2/features/1"],"productionStatus":"ACTIVE","propertyId":"prp_3","propertyName":"example3.example.com","propertyVersion":10,"stagingStatus":"INACTIVE"}],"searchSubmitDate":"2018-01-18T00:00:00Z","searchTargetStatus":"COMPLETE","searchUpdateDate":"2018-01-18T00:01:00Z"}