List all revisions for all Data Disclosure Agreement Records

GET 
/config/data-disclosure-agreement/records/revisions

Lists all revisions of Data Disclosure Agreement Records, optionally filtered by organisation role and/or DDA Template Revision.

Request

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.

organisationRole stringrequired

Filter by Organisation Role for the Data Disclosure Record, "data_source" or "data_using_service"

dataDisclosureAgreementTemplateRevisionId stringrequired

Unique ID of a Data Disclosure Template Revision

Responses

200

Data Disclosure Agreement Record Revision List

Response Headers

• Content-Type json

  Content-Type header

application/json

Schema

Schema

revisions object[]required
Array [
id stringrequired
Revision ID
schemaName stringrequired
Possible values: [dataAgreement, policy, dataAgreementRecord]
Previously "schema" but for technical reasons should be called "schemaName"
objectId stringrequired
The PK of the object that was serialised
objectData stringrequired
The object that is serialised
signedWithoutObjectId boolean
Indicates that objectId was left blank in serizalizedSnapshot when calculating serializedHash. objectId may subsequently be filled in.
serizalizedSnapshot stringrequired
Revisioned data (sed 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)
]
pagination objectrequired

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

Example (from schema)

{
  "revisions": [
    {
      "id": "",
      "schemaName": "",
      "objectId": "",
      "objectData": "",
      "signedWithoutObjectId": "",
      "serizalizedSnapshot": "",
      "serializedHash": "",
      "timestamp": "",
      "authorizedByIndividualId": "string",
      "authorizedByOtherId": "",
      "successorId": "string",
      "predecessorHash": "",
      "predecessorSignature": ""
    }
  ],
  "pagination": {
    "currentPage": 0,
    "totalItems": 0,
    "totalPages": 0,
    "limit": 0,
    "hasPrevious": true,
    "hasNext": true
  }
}

Loading...