List data policy revisions

GET 
/config/policy/:policyId/revisions

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

Request

Path Parameters

policyId stringrequired

Unique ID of an object

Query Parameters

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

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

policy object

A policy governs data and DataAgreement in the realm of an organisation that is refered to as "data controller" (GDPR) and owner of referencing Agreements.

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

revisions object[]
Array [
id stringrequired
Revision Id
schemaName stringrequired
Possible values: [dataAgreement, policy, dataAgreementRecord]
This was previously called "schema" but for technical reasons should be called "schemaName"
objectId stringrequired
The PK of the object that was serialized.
objectData stringrequired
The object that is serialised.
signedWithoutObjectId boolean
Indicates that objectId was left blank in serizalizedSnapshot when calculating serializedHash. objectId may be subsequently filled in.
serizalizedSnapshot stringrequired
Revisioned data (serialized as JSON) as a dict. Apply JSON Canonicalization Scheme as per IETF RFC 8785. It contains all the fields of the schema except sucessorId, serializedHash, serializedSnapshot.
serializedHash stringrequired
Hash of serizalizedSnapshot (SHA-1)
timestamp stringrequired
Timestamp of when revisioning happened. It should be ISO 8601 UTC date time
authorizedByIndividualId string
Individual Id
authorizedByOtherId string
Reference to an admin user that has created this revision
successorId string
If this revision is no longer the latest revision, refer to its successor.
predecessorHash string
Tamper-resistent artifact from previous record, copied from serializedHash
predecessorSignature string
Tamper-resistent artifact from previous record (we don't know if the previous record was signed or not)
]

Example (from schema)

{
  "pagination": {
    "currentPage": 0,
    "totalItems": 0,
    "totalPages": 0,
    "limit": 0,
    "hasPrevious": true,
    "hasNext": true
  },
  "policy": {
    "id": "",
    "name": "",
    "version": "",
    "url": "",
    "jurisdiction": "",
    "industrySector": "",
    "dataRetentionPeriodDays": "",
    "geographicRestriction": "",
    "storageLocation": "",
    "thirdPartyDataSharing": true
  },
  "revisions": [
    {
      "id": "",
      "schemaName": "",
      "objectId": "",
      "objectData": "",
      "signedWithoutObjectId": "",
      "serizalizedSnapshot": "",
      "serializedHash": "",
      "timestamp": "",
      "authorizedByIndividualId": "string",
      "authorizedByOtherId": "",
      "successorId": "string",
      "predecessorHash": "",
      "predecessorSignature": ""
    }
  ]
}

400

bad input parameter

Response Headers

Loading...