Delete Data Disclosure Agreement Template

DELETE 
/v3/config/data-disclosure-agreement/:dataDisclosureAgreementTemplateId

Deletes a Data Disclosure Agreement Template.

Request

Path Parameters

dataDisclosureAgreementTemplateId stringrequired

Unique ID of a Data Disclosure Template

Responses

200

Data Disclosure Agreement Template Deleted

Response Headers

• Content-Type json

  Content-Type header

application/json

Schema

Schema

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.

id string

Revision ID

schemaName string

Possible values: [dataAgreement, policy, dataAgreementRecord]

Previously "schema" but for technical reasons should be called "schemaName"

objectId string

The PK of the object that was serialised

objectData string

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 string

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 string

Hash of serizalizedSnapshot (SHA-1)

timestamp string

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)

{
  "revision": {
    "id": "65471222e8c7c3bb3c2c6601",
    "schemaName": "dataAgreement",
    "objectId": "65471222e8c7c3bb3c2c8492",
    "objectData": "{...}",
    "signedWithoutObjectId": false,
    "serizalizedSnapshot": "{...}",
    "serializedHash": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2",
    "timestamp": "2024-01-15T10:30:00Z",
    "authorizedByIndividualId": "string",
    "authorizedByOtherId": "64541a2e6e7569000145ab00",
    "successorId": "string",
    "predecessorHash": "b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3",
    "predecessorSignature": "c3d4e5f6a1b2..."
  }
}

401

Unauthorized

Response Headers

application/json

Schema

Schema

errorCode integer
errorDescription string

Example (from schema)

{
  "errorCode": 400,
  "errorDescription": "Bad input parameter"
}

404

Resource not found

Response Headers

application/json

Schema

Schema

errorCode integer
errorDescription string

Example (from schema)

{
  "errorCode": 400,
  "errorDescription": "Bad input parameter"
}

500

Internal server error

Response Headers

application/json

Schema

Schema

errorCode integer
errorDescription string

Example (from schema)

{
  "errorCode": 400,
  "errorDescription": "Bad input parameter"
}

Loading...