Delete data policy

DELETE 
/config/policy/:policyId

This endpoint is used to delete an existing data policy.

Request

Path Parameters

policyId stringrequired

Unique ID of an object

Responses

200

Response Headers

application/json

Schema

Schema

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)

Example (from schema)

{
  "id": "",
  "schemaName": "",
  "objectId": "",
  "objectData": "",
  "signedWithoutObjectId": "",
  "serizalizedSnapshot": "",
  "serializedHash": "",
  "timestamp": "",
  "authorizedByIndividualId": "string",
  "authorizedByOtherId": "",
  "successorId": "string",
  "predecessorHash": "",
  "predecessorSignature": ""
}

400

bad input parameter

Response Headers

Loading...