API

Get a digest for an include's rule tree

head
https://{hostname}/papi/v1/includes//versions//rules

Limited availability Gets the rule tree's ETag without the rule tree object. Ordinarily when you get a rule tree, the response includes a large rule tree object. As discussed in Concurrency control, it includes a top-level etag data digest to use when writing back the data. Use this operation if you simply want to get the ETag as a header without the data.

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
required

A custom JSON type that validates against a dated rule format. When examining metadata from a property version or include, the content type is text/xml. See API versioning for guidance.

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/problem+json

Updated 4 months ago