API
Start typing to search…

List available criteria for an include

get
https://{hostname}/papi/v1/includes//versions//available-criteria

Limited availability Lists the set of criteria you may apply within an include version's rules. The available set depends on the product under which you created the property and any additional modules enabled under your account.

Path Params
string
required

Unique identifier for the include. See ID prefixes for details on omitting the value's inc_ prefix.

integer
required

Include's incremental version number.

Query Params
string

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.

string

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.

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 about 1 month ago

Language
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json
Updated about 1 month ago