Skip to main content

List Data Disclosure Agreement Templates

GET 
/v3/config/data-disclosure-agreements

Lists Data Disclosure Agreement Templates.

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.

    active booleanrequired

    Default value: false

    Filtering data disclosure agreement templates by draft/published status

Responses​

Data Disclosure Agreement Template List

Response Headers
  • Content-Type json

    Content-Type header

Schema
    dataDisclosureAgreementTemplates object[]
  • Array [
    • context string[]required

    Array of URIs of JSON-LD contexts

    id stringrequired

    Unique Data Disclosure Agreement Template identifier

    type string[]required

    The Data Disclosure Agreement type from context

    language stringrequired

    ISO 639-1 language code (e.g. 'en' or 'sv')

    version stringrequired

    The version of this Data Disclosure Agreement Template

    templateId stringrequired

    Unique Data Disclosure Agreement Template identifier (derived from 'id')

    templateVersion stringrequired

    The version of this Data Disclosure Agreement Template (derived from 'version')

    dataController objectrequired

    An organisation constituted as a legally defined entity in any jurisdiction

    publicKey string

    Data controller public key

    name stringrequired

    Possible values: <= 50 characters

    Data controller name

    legalId stringrequired

    Data controller legal identifier

    url urirequired

    Data controller URL

    industrySector stringrequired

    Possible values: <= 50 characters

    Data controller industry sector

    agreementPeriod integerrequired

    Days for which agreement is valid

    dataSharingRestrictions objectrequired

    Restrictions on how the data is shared. OBS! Object should be 'dataSharingRestrictions'

    policyUrl urirequired

    Where to find the policy

    jurisdiction stringrequired

    Jurisdiction where the data sharing restrictions apply

    dataRetentionPeriod integerrequired

    Possible values: >= 1

    How many days the data can be kept

    geographicRestriction stringrequired

    Where the data can be shared to

    storageLocation stringrequired

    Where the data is stored

    purpose stringrequired

    Purpose of the Data Disclosure Agreement

    purposeDescription stringrequired

    Description of the Data Disclosure Agreement

    lawfulBasis stringrequired

    Possible values: [contract]

    Lawful basis for the Data Disclosure Agreement

    dataAttributes object[]required
  • Array [
    • id string

    Data attribute ID

    name stringrequired

    Name of the attribute, for instance "name" or "age"

    description stringrequired

    Description of the attribute

    sensitivity boolean

    Sensitivity of data attribute

    category string

    Category of data attribute

    scope string

    Scope required for data attribute

  • ]
    • codeOfConduct stringrequired

    URL to code of conduct

    dataAgreementId stringrequired

    ID of the connected Data Agreement

    dataAgreementRevisionId stringrequired

    ID of the connected Data Agreement Revision

    dataAgreementRevisionHash stringrequired

    Hash of the connected Data Agreement Revision

    active booleanrequired

    Whether the Data Disclosure Agreement is published or not

    presentationDefinitionId stringrequired

    ID of the connected Presentation Definition

    openApiSpecification object

    OpenAPI specification of the Data Agreement, defining available APIs for Data Using Services

    revisions object[]

    List of revisions for this Data Disclosure Agreement Template

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

Loading...
Last updated on