Create Data Disclosure Agreement Template
POST/config/data-disclosure-agreement
Creates a Data Disclosure Agreement Template.
Request
- application/json
Body
dataDisclosureAgreementTemplate objectrequired
Required fields to create a Data Disclosure Agreement Template
ISO 639-1 language code (e.g. 'en' or 'sv')
dataController objectrequired
An organisation constituted as a legally defined entity in any jurisdiction
Data controller public key
Possible values: <= 50 characters
Data controller name
Data controller legal identifier
Data controller URL
Possible values: <= 50 characters
Data controller industry sector
Possible values: >= 1
Days for which the agreement is valid
dataSharingRestrictions objectrequired
Restrictions on how the data is shared. OBS! Object should be 'dataSharingRestrictions'
Where to find the policy
Jurisdiction where the data sharing restrictions apply
Possible values: >= 1
How many days the data can be kept
Where the data can be shared to
Where the data is stored
Possible values: <= 100 characters
Required if active=true, unless present already from the draft version
Possible values: <= 500 characters
Required if active=true, unless present already from the draft version
Possible values: [contract]
Required if active=true, unless present already from the draft version
URL to code of conduct
ID of the connected Data Agreement
ID of the connected Data Agreement Revision
Hash of the connected Data Agreement Revision
ID of the connected Presentation Definition
Publish immediately if true
Responses
- 200
Data Disclosure Agreement Template created
Response Headers
Content-Type json
Content-Type header
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
dataDisclosureAgreementTemplate objectrequired
A template outlines an agreement between a Data Source and Data Using Service that can be signed by both.
Array of URIs of JSON-LD contexts
Unique Data Disclosure Agreement Template identifier
The Data Disclosure Agreement type from context
ISO 639-1 language code (e.g. 'en' or 'sv')
The version of this Data Disclosure Agreement Template
Unique Data Disclosure Agreement Template identifier (derived from 'id')
The version of this Data Disclosure Agreement Template (derived from 'version')
dataController objectrequired
An organisation constituted as a legally defined entity in any jurisdiction
Data controller public key
Possible values: <= 50 characters
Data controller name
Data controller legal identifier
Data controller URL
Possible values: <= 50 characters
Data controller industry sector
Days for which agreement is valid
dataSharingRestrictions objectrequired
Restrictions on how the data is shared. OBS! Object should be 'dataSharingRestrictions'
Where to find the policy
Jurisdiction where the data sharing restrictions apply
Possible values: >= 1
How many days the data can be kept
Where the data can be shared to
Where the data is stored
Purpose of the Data Disclosure Agreement
Description of the Data Disclosure Agreement
Possible values: [contract]
Lawful basis for the Data Disclosure Agreement
dataAttributes object[]required
Data attribute ID
Name of the attribute, for instance "name" or "age"
Description of the attribute
Sensitivity of data attribute
Category of data attribute
Scope required for data attribute
URL to code of conduct
ID of the connected Data Agreement
ID of the connected Data Agreement Revision
Hash of the connected Data Agreement Revision
Whether the Data Disclosure Agreement is published or not
ID of the connected Presentation Definition
OpenAPI specification of the Data Agreement, defining available APIs for Data Using Services
revision 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.
Revision ID
Possible values: [dataAgreement, policy, dataAgreementRecord]
Previously "schema" but for technical reasons should be called "schemaName"
The PK of the object that was serialised
The object that is serialised
Indicates that objectId was left blank in serizalizedSnapshot when calculating serializedHash. objectId may subsequently be filled in.
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.
Hash of serizalizedSnapshot (SHA-1)
Timestamp of when revisioning happened. It should be ISO 8601 UTC date time
Individual ID
Reference to an admin user that has created this revision
If this revision is no longer the latest revision, refer to its successor
Tamper-resistent artifact from previous record, copied from serializedHash
Tamper-resistent artifact from previous record (we don't know if the previous record was signed or not)
{
"dataDisclosureAgreementTemplate": {
"context": [
"string"
],
"id": "string",
"type": [
"DataDisclosureAgreement"
],
"language": "string",
"version": "string",
"templateId": "string",
"templateVersion": "string",
"dataController": {
"publicKey": "string",
"name": "string",
"legalId": "string",
"url": "string",
"industrySector": "string"
},
"agreementPeriod": 0,
"dataSharingRestrictions": {
"policyUrl": "string",
"jurisdiction": "string",
"dataRetentionPeriod": 0,
"geographicRestriction": "string",
"storageLocation": "string"
},
"purpose": "string",
"purposeDescription": "string",
"lawfulBasis": "contract",
"dataAttributes": [
{
"id": "",
"name": "",
"description": "",
"sensitivity": "",
"category": "",
"scope": ""
}
],
"codeOfConduct": "string",
"dataAgreementId": "string",
"dataAgreementRevisionId": "string",
"dataAgreementRevisionHash": "string",
"active": true,
"presentationDefinitionId": "string",
"openApiSpecification": {}
},
"revision": {
"id": "",
"schemaName": "",
"objectId": "",
"objectData": "",
"signedWithoutObjectId": "",
"serizalizedSnapshot": "",
"serializedHash": "",
"timestamp": "",
"authorizedByIndividualId": "string",
"authorizedByOtherId": "",
"successorId": "string",
"predecessorHash": "",
"predecessorSignature": ""
}
}