List all data policies

GET 
/config/policies

This endpoint reads all data policies defined in the consent building block.

Request

Query Parameters

revisionId stringrequired

An object with id revisionId

offset integerrequired

Requested index for start of resources to be provided in response requested by client

limit integerrequired

Default value: 10

Number of items returned per page. Requested number of resources to be provided in response requested by client

Responses

200

A list of Policy objects readable for the current session's credentials.

Response Headers

application/json

Schema

Schema

pagination object

currentPage integer

Current page number

totalItems integer

Total number of items available

totalPages integer

Total number of pages based on limit

limit integer

Number of items per page

hasPrevious boolean

Indicates if there's a previous page

hasNext boolean

Indicates if there's a next page

policies object[]
Array [
id string
name stringrequired
Name of the policy
version string
Version of the policy. It can follow semver format.
url stringrequired
Permanent URL at which this very version of the Policy can be read, should not be allowed to change over time.
jurisdiction string
Jurisdiction
industrySector string
Industry sector
dataRetentionPeriodDays integer
Data retention period in days
geographicRestriction string
Geographic restriction
storageLocation string
Storage location
thirdPartyDataSharing boolean
Third party data sharing
]

Example (from schema)

{
  "pagination": {
    "currentPage": 0,
    "totalItems": 0,
    "totalPages": 0,
    "limit": 0,
    "hasPrevious": true,
    "hasNext": true
  },
  "policies": [
    {
      "id": "",
      "name": "",
      "version": "",
      "url": "",
      "jurisdiction": "",
      "industrySector": "",
      "dataRetentionPeriodDays": "",
      "geographicRestriction": "",
      "storageLocation": "",
      "thirdPartyDataSharing": true
    }
  ]
}

400

bad input parameter

Response Headers

Loading...