API

List bulk search results

get
https://{hostname}/papi/v1/bulk/rules-search-requests/

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.

Path Params
integer
required

Identifies each bulk search job.

Query Params
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.

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.

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
string
enum
required

Enum Sets whether to represent ID prefixes in response data. Set to false when exchanging PAPI data with other APIs.

Allowed:
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 4 months ago

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json

Updated 4 months ago