/histories/{ownerCompositeKey}
This resource is available only to principals with these entitlements: "ROLE_READ_OWN_CONSENTHISTORY" "ROLE_READ_OTHER_CONSENTHISTORY" "ROLE_BROKER_ADMIN"
Mount Point: /privacy/v1/histories/{ownerCompositeKey}/
GET
This operation is available only to principals with these entitlements: "ROLE_READ_OWN_CONSENTHISTORY" "ROLE_READ_OTHER_CONSENTHISTORY" "ROLE_BROKER_ADMIN"
Retrieves consent history.
Parameters
| name | description | type | default |
|---|---|---|---|
| ownerCompositeKey | The key to use to retrieve the owner. | path | |
| startIndex | The index number of the first item to be provided in the results. A null value is equivalent to 0. | query | 0 |
| count | The maximum number of items to be provided in the results. A null value signifies no maximum. | query | |
| sortBy | Specifies how the results should be sorted. Allowed values are defined by com.unboundid.policy.models.ConsentHistory#getSortsByEnumValues(). A null value returns items in an unspecified order. | query | |
| filter | Optional user-supplied input used for filtering. If null or empty, no items are filtered. | query | |
| actionType | Optional for filtering by action type. If null no items are filtered. | query | |
| applicationId | Optional for filtering by application id. If null no items are filtered. | query | |
| resourceId | Optional for filtering by resource id. If null no items are filtered. | query | |
| startTime |
Optional start time for the requested data. This value may be in a relative form which will be calculated relative to the time of the request, or it may be in an absolute form using ISO8601 format. Relative form uses the syntax: -N[mhdwMy] which is interpreted to mean N time-units before now. Absolute form uses the ISO8601 syntax of YYYY-MM-DDThh:mm:ss where you can specify a partial date by omitting fields on the right (without skipping any fields). For example, 2013-01-01 is a valid timestamp that mean midnight on January 1st 2013 If no timezone is specified the server timezone is used.. |
query | |
| endTime |
Optional end time for the requested data. This value may be in a relative form which will be calculated relative to startTime, or it may be in an absolute form using ISO8601 format. Relative form uses the syntax: N[mhdwMy] which is interpreted to mean N time-units after startTime. Absolute form uses the ISO8601 syntax of YYYY-MM-DDThh:mm:ss where you can specify a partial date by omitting fields on the right (without skipping any fields). For example, 2013-01-01 is a valid timestamp that mean midnight on January 1st 2013. If no timezone is specified the server timezone is used. |
query |
Response Body
| element: | (custom) |
| media types: | application/json |
Paged list of consent history associated with the given owner.
Status Codes
| code | description |
|---|---|
| 200 | Success |