Read data policy
GET/service/policy/:policyId
This endpoint is used to read latest version of data policy defined in the organisation in the consent building block.
Request
Path Parameters
Unique ID of an object
Query Parameters
An object with id revisionId
Responses
- 200
- 400
Response Headers
- application/json
- Schema
- Example (from schema)
Schema
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.
Name of the policy
Version of the policy. It can follow semver format.
Permanent URL at which this very version of the Policy can be read, should not be allowed to change over time.
Jurisdiction
Industry sector
Data retention period in days
Geographic restriction
Storage location
Third party data sharing
revision object
A generic revision model captures the serialized contents of any schema's single row. This is then subject to 1) cryptographic signature and 2) auditing.
Aside from "successor" column, a revision should be considered locked.
Revision Id
Possible values: [dataAgreement
, policy
, dataAgreementRecord
]
This was previously called "schema" but for technical reasons should be called "schemaName"
The PK of the object that was serialized.
The object that is serialised.
Indicates that objectId was left blank in serizalizedSnapshot when calculating serializedHash. objectId may be subsequently filled in.
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.
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)
{
"policy": {
"id": "",
"name": "",
"version": "",
"url": "",
"jurisdiction": "",
"industrySector": "",
"dataRetentionPeriodDays": "",
"geographicRestriction": "",
"storageLocation": "",
"thirdPartyDataSharing": true
},
"revision": {
"id": "",
"schemaName": "",
"objectId": "",
"objectData": "",
"signedWithoutObjectId": "",
"serizalizedSnapshot": "",
"serializedHash": "",
"timestamp": "",
"authorizedByIndividualId": "string",
"authorizedByOtherId": "",
"successorId": "string",
"predecessorHash": "",
"predecessorSignature": ""
}
}
bad input parameter