Skip to main content

List Data Disclosure Agreement Records by Template Revision

GET 
/config/data-disclosure-agreement/:dataDisclosureAgreementTemplateRevisionId/records

Lists Data Disclosure Agreement Records for a Data Disclosure Agreement Template Revision depending on the role of the organisation for the record, "data_source" or "data_using_service".

Request​

Path Parameters

    dataDisclosureAgreementTemplateRevisionId stringrequired

    Unique ID of a Data Disclosure Template Revision

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"

Responses​

Data Disclosure Agreement Record List

Response Headers
  • Content-Type json

    Content-Type header

Schema
    dataDisclosureAgreementRecords object[]required
  • Array [
    • id stringrequired

    Unique Data Disclosure Agreement Record identifier.

    canonicalId stringrequired

    The cross-organisational identifier for the record.

    dataDisclosureAgreementTemplateRevision objectrequired

    A generic revision model captures the serialised contents of any schema's single row. This is then subject to 1) cryptographic signature and 2) auditing.

    Aside from the "successor" column, a revision should be considered locked.

    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)

    dataSourceSignature objectrequired

    The signature provided by the Data Source.

    id stringrequired

    Unique signature identifier

    payload stringrequired

    The Data Disclosure Agreement Record (as a stringified JSON object)

    signature stringrequired

    JWT signature

    signatureDecoded objectrequired

    Decoded signature, containing claims used from the signature JWT

    verificationMethod stringrequired

    A well-known string denoting which method is used. Valid values: 'keybinding_jwt'

    verificationPayload stringrequired

    The keybinding JWT payload that was signed to produce the signature

    verificationPayloadHash stringrequired

    Internally generated cryptographic hash of the value to be signed, i.e. the value of verificationPayload

    verificationSignedBy stringrequired

    Because an identifier's information may change over time, there is a need to store that information at the time of signing. In the case of a cryptographic signature, this field should contain some identifier for looking up or verifying the public key of the signing party.

    verificationSignedAs stringrequired

    Possible values: [data_source, data_using_service]

    Either signed as a "data_source" or as a "data_using_service"

    verificationJwsHeader stringrequired

    Alternative to the verificationMethod, verificationHash and verificationSignature, give a JWS serialised object (RFC7515)

    timestamp stringrequired

    Timestamp of signature

    signedWithoutObjectReference booleanrequired

    Indicates that objectReference was left blank in the serialised version that was signed, always false for Data Disclosure Agreement Record signatures

    objectType stringrequired

    Possible values: [data_disclosure_agreement_record]

    Name of the schema model that objectReference points to, in this case "data_disclosure_agreement_record"

    objectReference stringrequired

    In the case of a data_disclosure_agreement_record, this is the ID of the record that was signed

    dataUsingServiceSignature objectrequired

    The signature provided by the Data Using Service.

    id stringrequired

    Unique signature identifier

    payload stringrequired

    The Data Disclosure Agreement Record (as a stringified JSON object)

    signature stringrequired

    JWT signature

    signatureDecoded objectrequired

    Decoded signature, containing claims used from the signature JWT

    verificationMethod stringrequired

    A well-known string denoting which method is used. Valid values: 'keybinding_jwt'

    verificationPayload stringrequired

    The keybinding JWT payload that was signed to produce the signature

    verificationPayloadHash stringrequired

    Internally generated cryptographic hash of the value to be signed, i.e. the value of verificationPayload

    verificationSignedBy stringrequired

    Because an identifier's information may change over time, there is a need to store that information at the time of signing. In the case of a cryptographic signature, this field should contain some identifier for looking up or verifying the public key of the signing party.

    verificationSignedAs stringrequired

    Possible values: [data_source, data_using_service]

    Either signed as a "data_source" or as a "data_using_service"

    verificationJwsHeader stringrequired

    Alternative to the verificationMethod, verificationHash and verificationSignature, give a JWS serialised object (RFC7515)

    timestamp stringrequired

    Timestamp of signature

    signedWithoutObjectReference booleanrequired

    Indicates that objectReference was left blank in the serialised version that was signed, always false for Data Disclosure Agreement Record signatures

    objectType stringrequired

    Possible values: [data_disclosure_agreement_record]

    Name of the schema model that objectReference points to, in this case "data_disclosure_agreement_record"

    objectReference stringrequired

    In the case of a data_disclosure_agreement_record, this is the ID of the record that was signed

    optIn booleanrequired

    Whether the record is active and data can be shared to the Data Using Service.

    timestamp stringrequired

    The timestamp of when the latest signature was added.

    organisationId stringrequired

    The ID of the organisation this record belongs to (both organisation keep a copy).

    organisationRole stringrequired

    Possible values: [data_source, data_using_service]

    The role of the organisation in this agreement (e.g., data_source).

    isDeleted booleanrequired

    If the record is deleted.

  • ]
    • 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

Loading...
Last updated on