8 Service APIs

This section provides a reference for APIs that should be implemented by this Building Block.

8 Service APIs

This section provides a reference for APIs that should be implemented by this Building Block. The APIs defined here establish a blueprint for how the Building Block will interact with other Building Blocks. Additional APIs may be implemented by the Building Block, but the listed APIs define a minimal set of functionality that should be provided by any implementation of this Building Block.

The GovStack non-functional requirements document provides additional information on how 'adaptors' may be used to translate an existing API to the patterns described here. This section also provides guidance on how candidate products are tested and how GovStack validates a product's API against the API specifications defined here.

The tests for the Consent Building Block can be found in this GitHub repository.

8.1 API specification

The following is an automated rendition of the OpenAPI YAML specification contained in this release.

You can see the latest unreleased version of the OpenAPI specification in the main branch of our GitHub repository.

8.1.1 Config APIs

CREATE - Creates a new Policy object and returns the new object and a PolicyRevision

post

CREATE - Creates a new Policy object and returns the new object and a PolicyRevision

Authorizations

Body

policyobjectRequired

An object of type Policy

Responses

application/json

objectOptional

post

HTTPcURLJavaScriptPython

POST /apis/GovStack/consent-management-bb//config/policy/ HTTP/1.1
Host: app.swaggerhub.com
Content-Type: application/json
Accept: */*
Content-Length: 167

{
  "policy": {
    "id": "",
    "name": "",
    "version": "",
    "url": "",
    "jurisdiction": "",
    "industrySector": "",
    "dataRetentionPeriodDays": "",
    "geographicRestriction": "",
    "storageLocation": ""
  }
}

{
  "policy": {
    "id": "",
    "name": "",
    "version": "",
    "url": "",
    "jurisdiction": "",
    "industrySector": "",
    "dataRetentionPeriodDays": "",
    "geographicRestriction": "",
    "storageLocation": ""
  },
  "revision": {
    "id": "",
    "schemaName": "",
    "objectId": "",
    "signedWithoutObjectId": "",
    "serializedSnapshot": "",
    "serializedHash": "",
    "timestamp": "",
    "authorizedByIndividual": {
      "id": "",
      "externalId": "",
      "externalIdType": "",
      "identityProviderId": ""
    },
    "authorizedByOther": "",
    "successor": {
      "id": "",
      "schemaName": "",
      "objectId": "",
      "signedWithoutObjectId": "",
      "serializedSnapshot": "",
      "serializedHash": "",
      "timestamp": "",
      "authorizedByIndividual": {
        "id": "",
        "externalId": "",
        "externalIdType": "",
        "identityProviderId": ""
      },
      "authorizedByOther": "",
      "successor": {
        "id": "",
        "schemaName": "",
        "objectId": "",
        "signedWithoutObjectId": "",
        "serializedSnapshot": "",
        "serializedHash": "",
        "timestamp": "",
        "authorizedByIndividual": {
          "id": "",
          "externalId": "",
          "externalIdType": "",
          "identityProviderId": ""
        },
        "authorizedByOther": "",
        "successor": {
          "id": "",
          "schemaName": "",
          "objectId": "",
          "signedWithoutObjectId": "",
          "serializedSnapshot": "",
          "serializedHash": "",
          "timestamp": "",
          "authorizedByIndividual": {
            "id": "",
            "externalId": "",
            "externalIdType": "",
            "identityProviderId": ""
          },
          "authorizedByOther": "",
          "successor": {
            "id": "",
            "schemaName": "",
            "objectId": "",
            "signedWithoutObjectId": "",
            "serializedSnapshot": "",
            "serializedHash": "",
            "timestamp": "",
            "authorizedByIndividual": {
              "id": "",
              "externalId": "",
              "externalIdType": "",
              "identityProviderId": ""
            },
            "authorizedByOther": "",
            "successor": "[Circular Reference]",
            "predecessorHash": "",
            "predecessorSignature": ""
          },
          "predecessorHash": "",
          "predecessorSignature": ""
        },
        "predecessorHash": "",
        "predecessorSignature": ""
      },
      "predecessorHash": "",
      "predecessorSignature": ""
    },
    "predecessorHash": "",
    "predecessorSignature": ""
  }
}

READ - get a Policy object + latest Revisio

get

READ - get a Policy object + latest Revisio

Authorizations

Path parameters

policyIdstringRequired

Unique ID of an object

Query parameters

revisionIdstringOptional

An object with id revisionId

Responses

application/json

objectOptional

get

HTTPcURLJavaScriptPython

GET /apis/GovStack/consent-management-bb//config/policy/{policyId}/ HTTP/1.1
Host: app.swaggerhub.com
Accept: */*

{
  "policy": {
    "id": "",
    "name": "",
    "version": "",
    "url": "",
    "jurisdiction": "",
    "industrySector": "",
    "dataRetentionPeriodDays": "",
    "geographicRestriction": "",
    "storageLocation": ""
  },
  "revision": {
    "id": "",
    "schemaName": "",
    "objectId": "",
    "signedWithoutObjectId": "",
    "serializedSnapshot": "",
    "serializedHash": "",
    "timestamp": "",
    "authorizedByIndividual": {
      "id": "",
      "externalId": "",
      "externalIdType": "",
      "identityProviderId": ""
    },
    "authorizedByOther": "",
    "successor": {
      "id": "",
      "schemaName": "",
      "objectId": "",
      "signedWithoutObjectId": "",
      "serializedSnapshot": "",
      "serializedHash": "",
      "timestamp": "",
      "authorizedByIndividual": {
        "id": "",
        "externalId": "",
        "externalIdType": "",
        "identityProviderId": ""
      },
      "authorizedByOther": "",
      "successor": {
        "id": "",
        "schemaName": "",
        "objectId": "",
        "signedWithoutObjectId": "",
        "serializedSnapshot": "",
        "serializedHash": "",
        "timestamp": "",
        "authorizedByIndividual": {
          "id": "",
          "externalId": "",
          "externalIdType": "",
          "identityProviderId": ""
        },
        "authorizedByOther": "",
        "successor": {
          "id": "",
          "schemaName": "",
          "objectId": "",
          "signedWithoutObjectId": "",
          "serializedSnapshot": "",
          "serializedHash": "",
          "timestamp": "",
          "authorizedByIndividual": {
            "id": "",
            "externalId": "",
            "externalIdType": "",
            "identityProviderId": ""
          },
          "authorizedByOther": "",
          "successor": {
            "id": "",
            "schemaName": "",
            "objectId": "",
            "signedWithoutObjectId": "",
            "serializedSnapshot": "",
            "serializedHash": "",
            "timestamp": "",
            "authorizedByIndividual": {
              "id": "",
              "externalId": "",
              "externalIdType": "",
              "identityProviderId": ""
            },
            "authorizedByOther": "",
            "successor": "[Circular Reference]",
            "predecessorHash": "",
            "predecessorSignature": ""
          },
          "predecessorHash": "",
          "predecessorSignature": ""
        },
        "predecessorHash": "",
        "predecessorSignature": ""
      },
      "predecessorHash": "",
      "predecessorSignature": ""
    },
    "predecessorHash": "",
    "predecessorSignature": ""
  }
}

UPDATE - Updates an existing Policy object, returning the updated version and a new revision. Updating a Policy must not affect existing active references in DataAgreement, the new Revision should be specified for Agreement.

put

UPDATE - Updates an existing Policy object, returning the updated version and a new revision. Updating a Policy must not affect existing active references in DataAgreement, the new Revision should be specified for Agreement.

Authorizations

Path parameters

policyIdstringRequired

Unique ID of an object

Body

policyobjectRequired

An object of type Policy

Responses

application/json

objectOptional

put

HTTPcURLJavaScriptPython

PUT /apis/GovStack/consent-management-bb//config/policy/{policyId}/ HTTP/1.1
Host: app.swaggerhub.com
Content-Type: application/json
Accept: */*
Content-Length: 167

{
  "policy": {
    "id": "",
    "name": "",
    "version": "",
    "url": "",
    "jurisdiction": "",
    "industrySector": "",
    "dataRetentionPeriodDays": "",
    "geographicRestriction": "",
    "storageLocation": ""
  }
}

{
  "policy": {
    "id": "",
    "name": "",
    "version": "",
    "url": "",
    "jurisdiction": "",
    "industrySector": "",
    "dataRetentionPeriodDays": "",
    "geographicRestriction": "",
    "storageLocation": ""
  },
  "revision": {
    "id": "",
    "schemaName": "",
    "objectId": "",
    "signedWithoutObjectId": "",
    "serializedSnapshot": "",
    "serializedHash": "",
    "timestamp": "",
    "authorizedByIndividual": {
      "id": "",
      "externalId": "",
      "externalIdType": "",
      "identityProviderId": ""
    },
    "authorizedByOther": "",
    "successor": {
      "id": "",
      "schemaName": "",
      "objectId": "",
      "signedWithoutObjectId": "",
      "serializedSnapshot": "",
      "serializedHash": "",
      "timestamp": "",
      "authorizedByIndividual": {
        "id": "",
        "externalId": "",
        "externalIdType": "",
        "identityProviderId": ""
      },
      "authorizedByOther": "",
      "successor": {
        "id": "",
        "schemaName": "",
        "objectId": "",
        "signedWithoutObjectId": "",
        "serializedSnapshot": "",
        "serializedHash": "",
        "timestamp": "",
        "authorizedByIndividual": {
          "id": "",
          "externalId": "",
          "externalIdType": "",
          "identityProviderId": ""
        },
        "authorizedByOther": "",
        "successor": {
          "id": "",
          "schemaName": "",
          "objectId": "",
          "signedWithoutObjectId": "",
          "serializedSnapshot": "",
          "serializedHash": "",
          "timestamp": "",
          "authorizedByIndividual": {
            "id": "",
            "externalId": "",
            "externalIdType": "",
            "identityProviderId": ""
          },
          "authorizedByOther": "",
          "successor": {
            "id": "",
            "schemaName": "",
            "objectId": "",
            "signedWithoutObjectId": "",
            "serializedSnapshot": "",
            "serializedHash": "",
            "timestamp": "",
            "authorizedByIndividual": {
              "id": "",
              "externalId": "",
              "externalIdType": "",
              "identityProviderId": ""
            },
            "authorizedByOther": "",
            "successor": "[Circular Reference]",
            "predecessorHash": "",
            "predecessorSignature": ""
          },
          "predecessorHash": "",
          "predecessorSignature": ""
        },
        "predecessorHash": "",
        "predecessorSignature": ""
      },
      "predecessorHash": "",
      "predecessorSignature": ""
    },
    "predecessorHash": "",
    "predecessorSignature": ""
  }
}

DELETE - Deletes an existing Policy object, returning a new revision. Deleting a Policy is not possible if it's associated with active DataAgreement.

delete

DELETE - Deletes an existing Policy object, returning a new revision. Deleting a Policy is not possible if it's associated with active DataAgreement.

Authorizations

Path parameters

policyIdstringRequired

Unique ID of an object

Responses

application/json

objectOptional

delete

HTTPcURLJavaScriptPython

DELETE /apis/GovStack/consent-management-bb//config/policy/{policyId}/ HTTP/1.1
Host: app.swaggerhub.com
Accept: */*

{
  "revision": {
    "id": "",
    "schemaName": "",
    "objectId": "",
    "signedWithoutObjectId": "",
    "serializedSnapshot": "",
    "serializedHash": "",
    "timestamp": "",
    "authorizedByIndividual": {
      "id": "",
      "externalId": "",
      "externalIdType": "",
      "identityProviderId": ""
    },
    "authorizedByOther": "",
    "successor": {
      "id": "",
      "schemaName": "",
      "objectId": "",
      "signedWithoutObjectId": "",
      "serializedSnapshot": "",
      "serializedHash": "",
      "timestamp": "",
      "authorizedByIndividual": {
        "id": "",
        "externalId": "",
        "externalIdType": "",
        "identityProviderId": ""
      },
      "authorizedByOther": "",
      "successor": {
        "id": "",
        "schemaName": "",
        "objectId": "",
        "signedWithoutObjectId": "",
        "serializedSnapshot": "",
        "serializedHash": "",
        "timestamp": "",
        "authorizedByIndividual": {
          "id": "",
          "externalId": "",
          "externalIdType": "",
          "identityProviderId": ""
        },
        "authorizedByOther": "",
        "successor": {
          "id": "",
          "schemaName": "",
          "objectId": "",
          "signedWithoutObjectId": "",
          "serializedSnapshot": "",
          "serializedHash": "",
          "timestamp": "",
          "authorizedByIndividual": {
            "id": "",
            "externalId": "",
            "externalIdType": "",
            "identityProviderId": ""
          },
          "authorizedByOther": "",
          "successor": {
            "id": "",
            "schemaName": "",
            "objectId": "",
            "signedWithoutObjectId": "",
            "serializedSnapshot": "",
            "serializedHash": "",
            "timestamp": "",
            "authorizedByIndividual": {
              "id": "",
              "externalId": "",
              "externalIdType": "",
              "identityProviderId": ""
            },
            "authorizedByOther": "",
            "successor": "[Circular Reference]",
            "predecessorHash": "",
            "predecessorSignature": ""
          },
          "predecessorHash": "",
          "predecessorSignature": ""
        },
        "predecessorHash": "",
        "predecessorSignature": ""
      },
      "predecessorHash": "",
      "predecessorSignature": ""
    },
    "predecessorHash": "",
    "predecessorSignature": ""
  }
}

LIST - returns the current Policy

get

LIST - returns the current Policy

Authorizations

Path parameters

policyIdstringRequired

Unique ID of an object

Query parameters

offsetintegerOptional

Requested index for start of resources to be provided in response requested by client

limitintegerOptional

Requested number of resources to be provided in response requested by client

Responses

application/json

objectOptional

get

HTTPcURLJavaScriptPython

GET /apis/GovStack/consent-management-bb//config/policy/{policyId}/revisions/ HTTP/1.1
Host: app.swaggerhub.com
Accept: */*

{
  "policy": {
    "id": "",
    "name": "",
    "version": "",
    "url": "",
    "jurisdiction": "",
    "industrySector": "",
    "dataRetentionPeriodDays": "",
    "geographicRestriction": "",
    "storageLocation": ""
  }
}

Returns a list of readable Policy objects

get

LIST - Fetches list of readable Policy objects

Authorizations

Query parameters

revisionIdstringOptional

An object with id revisionId

offsetintegerOptional

Requested index for start of resources to be provided in response requested by client

limitintegerOptional

Requested number of resources to be provided in response requested by client

Responses

application/json

objectOptional

get

HTTPcURLJavaScriptPython

GET /apis/GovStack/consent-management-bb//config/policies/ HTTP/1.1
Host: app.swaggerhub.com
Accept: */*

{
  "policies": [
    {
      "id": "",
      "name": "",
      "version": "",
      "url": "",
      "jurisdiction": "",
      "industrySector": "",
      "dataRetentionPeriodDays": "",
      "geographicRestriction": "",
      "storageLocation": ""
    }
  ]
}

READ - fetches the latest version of an Agreement

get

READ - fetches the latest version of an Agreement

Authorizations

Path parameters

dataAgreementIdstringRequired

Unique ID of an object

Responses

application/json

objectOptional

get

HTTPcURLJavaScriptPython

GET /apis/GovStack/consent-management-bb//config/data-agreement/{dataAgreementId}/ HTTP/1.1
Host: app.swaggerhub.com
Accept: */*

{
  "dataAgreement": {
    "id": "",
    "version": "",
    "controller": {
      "id": "",
      "name": "",
      "url": ""
    },
    "policy": {
      "id": "",
      "name": "",
      "version": "",
      "url": "",
      "jurisdiction": "",
      "industrySector": "",
      "dataRetentionPeriodDays": "",
      "geographicRestriction": "",
      "storageLocation": ""
    },
    "purpose": "",
    "lawfulBasis": "",
    "dataUse": "",
    "dpia": "",
    "active": "",
    "forgettable": "",
    "compatibleWithVersion": {
      "id": "",
      "version": "",
      "controller": {
        "id": "",
        "name": "",
        "url": ""
      },
      "policy": {
        "id": "",
        "name": "",
        "version": "",
        "url": "",
        "jurisdiction": "",
        "industrySector": "",
        "dataRetentionPeriodDays": "",
        "geographicRestriction": "",
        "storageLocation": ""
      },
      "purpose": "",
      "lawfulBasis": "",
      "dataUse": "",
      "dpia": "",
      "active": "",
      "forgettable": "",
      "compatibleWithVersion": {
        "id": "",
        "version": "",
        "controller": {
          "id": "",
          "name": "",
          "url": ""
        },
        "policy": {
          "id": "",
          "name": "",
          "version": "",
          "url": "",
          "jurisdiction": "",
          "industrySector": "",
          "dataRetentionPeriodDays": "",
          "geographicRestriction": "",
          "storageLocation": ""
        },
        "purpose": "",
        "lawfulBasis": "",
        "dataUse": "",
        "dpia": "",
        "active": "",
        "forgettable": "",
        "compatibleWithVersion": {
          "id": "",
          "version": "",
          "controller": {
            "id": "",
            "name": "",
            "url": ""
          },
          "policy": {
            "id": "",
            "name": "",
            "version": "",
            "url": "",
            "jurisdiction": "",
            "industrySector": "",
            "dataRetentionPeriodDays": "",
            "geographicRestriction": "",
            "storageLocation": ""
          },
          "purpose": "",
          "lawfulBasis": "",
          "dataUse": "",
          "dpia": "",
          "active": "",
          "forgettable": "",
          "compatibleWithVersion": {
            "id": "",
            "version": "",
            "controller": {
              "id": "",
              "name": "",
              "url": ""
            },
            "policy": {
              "id": "",
              "name": "",
              "version": "",
              "url": "",
              "jurisdiction": "",
              "industrySector": "",
              "dataRetentionPeriodDays": "",
              "geographicRestriction": "",
              "storageLocation": ""
            },
            "purpose": "",
            "lawfulBasis": "",
            "dataUse": "",
            "dpia": "",
            "active": "",
            "forgettable": "",
            "compatibleWithVersion": "[Circular Reference]",
            "lifecycle": {
              "id": "",
              "name": ""
            },
            "signature": {
              "id": "",
              "payload": "",
              "signature": "",
              "verificationMethod": "",
              "verificationPayload": "",
              "verificationPayloadHash": "",
              "verificationArtifact": "",
              "verificationSignedBy": "",
              "verificationSignedAs": "",
              "verificationJwsHeader": "",
              "timestamp": "",
              "signedWithoutObjectReference": "",
              "objectType": "",
              "objectReference": ""
            }
          },
          "lifecycle": {
            "id": "",
            "name": ""
          },
          "signature": {
            "id": "",
            "payload": "",
            "signature": "",
            "verificationMethod": "",
            "verificationPayload": "",
            "verificationPayloadHash": "",
            "verificationArtifact": "",
            "verificationSignedBy": "",
            "verificationSignedAs": "",
            "verificationJwsHeader": "",
            "timestamp": "",
            "signedWithoutObjectReference": "",
            "objectType": "",
            "objectReference": ""
          }
        },
        "lifecycle": {
          "id": "",
          "name": ""
        },
        "signature": {
          "id": "",
          "payload": "",
          "signature": "",
          "verificationMethod": "",
          "verificationPayload": "",
          "verificationPayloadHash": "",
          "verificationArtifact": "",
          "verificationSignedBy": "",
          "verificationSignedAs": "",
          "verificationJwsHeader": "",
          "timestamp": "",
          "signedWithoutObjectReference": "",
          "objectType": "",
          "objectReference": ""
        }
      },
      "lifecycle": {
        "id": "",
        "name": ""
      },
      "signature": {
        "id": "",
        "payload": "",
        "signature": "",
        "verificationMethod": "",
        "verificationPayload": "",
        "verificationPayloadHash": "",
        "verificationArtifact": "",
        "verificationSignedBy": "",
        "verificationSignedAs": "",
        "verificationJwsHeader": "",
        "timestamp": "",
        "signedWithoutObjectReference": "",
        "objectType": "",
        "objectReference": ""
      }
    },
    "lifecycle": {
      "id": "",
      "name": ""
    },
    "signature": {
      "id": "",
      "payload": "",
      "signature": "",
      "verificationMethod": "",
      "verificationPayload": "",
      "verificationPayloadHash": "",
      "verificationArtifact": "",
      "verificationSignedBy": "",
      "verificationSignedAs": "",
      "verificationJwsHeader": "",
      "timestamp": "",
      "signedWithoutObjectReference": "",
      "objectType": "",
      "objectReference": ""
    }
  },
  "revision": {
    "id": "",
    "schemaName": "",
    "objectId": "",
    "signedWithoutObjectId": "",
    "serializedSnapshot": "",
    "serializedHash": "",
    "timestamp": "",
    "authorizedByIndividual": {
      "id": "",
      "externalId": "",
      "externalIdType": "",
      "identityProviderId": ""
    },
    "authorizedByOther": "",
    "successor": {
      "id": "",
      "schemaName": "",
      "objectId": "",
      "signedWithoutObjectId": "",
      "serializedSnapshot": "",
      "serializedHash": "",
      "timestamp": "",
      "authorizedByIndividual": {
        "id": "",
        "externalId": "",
        "externalIdType": "",
        "identityProviderId": ""
      },
      "authorizedByOther": "",
      "successor": {
        "id": "",
        "schemaName": "",
        "objectId": "",
        "signedWithoutObjectId": "",
        "serializedSnapshot": "",
        "serializedHash": "",
        "timestamp": "",
        "authorizedByIndividual": {
          "id": "",
          "externalId": "",
          "externalIdType": "",
          "identityProviderId": ""
        },
        "authorizedByOther": "",
        "successor": {
          "id": "",
          "schemaName": "",
          "objectId": "",
          "signedWithoutObjectId": "",
          "serializedSnapshot": "",
          "serializedHash": "",
          "timestamp": "",
          "authorizedByIndividual": {
            "id": "",
            "externalId": "",
            "externalIdType": "",
            "identityProviderId": ""
          },
          "authorizedByOther": "",
          "successor": {
            "id": "",
            "schemaName": "",
            "objectId": "",
            "signedWithoutObjectId": "",
            "serializedSnapshot": "",
            "serializedHash": "",
            "timestamp": "",
            "authorizedByIndividual": {
              "id": "",
              "externalId": "",
              "externalIdType": "",
              "identityProviderId": ""
            },
            "authorizedByOther": "",
            "successor": "[Circular Reference]",
            "predecessorHash": "",
            "predecessorSignature": ""
          },
          "predecessorHash": "",
          "predecessorSignature": ""
        },
        "predecessorHash": "",
        "predecessorSignature": ""
      },
      "predecessorHash": "",
      "predecessorSignature": ""
    },
    "predecessorHash": "",
    "predecessorSignature": ""
  }
}

UPDATE - An existing DataAgreement object is created and returned together with a new Revision

put

UPDATE - An existing DataAgreement object is created and returned together with a new Revision

Authorizations

Path parameters

dataAgreementIdstringRequired

Unique ID of an object

Body

dataAgreementobjectRequired

An object of type DataAgreement

Responses

application/json

objectOptional

put

HTTPcURLJavaScriptPython

PUT /apis/GovStack/consent-management-bb//config/data-agreement/{dataAgreementId}/ HTTP/1.1
Host: app.swaggerhub.com
Content-Type: application/json
Accept: */*
Content-Length: 3480

{
  "dataAgreement": {
    "id": "",
    "version": "",
    "controller": {
      "id": "",
      "name": "",
      "url": ""
    },
    "policy": {
      "id": "",
      "name": "",
      "version": "",
      "url": "",
      "jurisdiction": "",
      "industrySector": "",
      "dataRetentionPeriodDays": "",
      "geographicRestriction": "",
      "storageLocation": ""
    },
    "purpose": "",
    "lawfulBasis": "",
    "dataUse": "",
    "dpia": "",
    "active": "",
    "forgettable": "",
    "compatibleWithVersion": {
      "id": "",
      "version": "",
      "controller": {
        "id": "",
        "name": "",
        "url": ""
      },
      "policy": {
        "id": "",
        "name": "",
        "version": "",
        "url": "",
        "jurisdiction": "",
        "industrySector": "",
        "dataRetentionPeriodDays": "",
        "geographicRestriction": "",
        "storageLocation": ""
      },
      "purpose": "",
      "lawfulBasis": "",
      "dataUse": "",
      "dpia": "",
      "active": "",
      "forgettable": "",
      "compatibleWithVersion": {
        "id": "",
        "version": "",
        "controller": {
          "id": "",
          "name": "",
          "url": ""
        },
        "policy": {
          "id": "",
          "name": "",
          "version": "",
          "url": "",
          "jurisdiction": "",
          "industrySector": "",
          "dataRetentionPeriodDays": "",
          "geographicRestriction": "",
          "storageLocation": ""
        },
        "purpose": "",
        "lawfulBasis": "",
        "dataUse": "",
        "dpia": "",
        "active": "",
        "forgettable": "",
        "compatibleWithVersion": {
          "id": "",
          "version": "",
          "controller": {
            "id": "",
            "name": "",
            "url": ""
          },
          "policy": {
            "id": "",
            "name": "",
            "version": "",
            "url": "",
            "jurisdiction": "",
            "industrySector": "",
            "dataRetentionPeriodDays": "",
            "geographicRestriction": "",
            "storageLocation": ""
          },
          "purpose": "",
          "lawfulBasis": "",
          "dataUse": "",
          "dpia": "",
          "active": "",
          "forgettable": "",
          "compatibleWithVersion": {
            "id": "",
            "version": "",
            "controller": {
              "id": "",
              "name": "",
              "url": ""
            },
            "policy": {
              "id": "",
              "name": "",
              "version": "",
              "url": "",
              "jurisdiction": "",
              "industrySector": "",
              "dataRetentionPeriodDays": "",
              "geographicRestriction": "",
              "storageLocation": ""
            },
            "purpose": "",
            "lawfulBasis": "",
            "dataUse": "",
            "dpia": "",
            "active": "",
            "forgettable": "",
            "compatibleWithVersion": "[Circular Reference]",
            "lifecycle": {
              "id": "",
              "name": ""
            },
            "signature": {
              "id": "",
              "payload": "",
              "signature": "",
              "verificationMethod": "",
              "verificationPayload": "",
              "verificationPayloadHash": "",
              "verificationArtifact": "",
              "verificationSignedBy": "",
              "verificationSignedAs": "",
              "verificationJwsHeader": "",
              "timestamp": "",
              "signedWithoutObjectReference": "",
              "objectType": "",
              "objectReference": ""
            }
          },
          "lifecycle": {
            "id": "",
            "name": ""
          },
          "signature": {
            "id": "",
            "payload": "",
            "signature": "",
            "verificationMethod": "",
            "verificationPayload": "",
            "verificationPayloadHash": "",
            "verificationArtifact": "",
            "verificationSignedBy": "",
            "verificationSignedAs": "",
            "verificationJwsHeader": "",
            "timestamp": "",
            "signedWithoutObjectReference": "",
            "objectType": "",
            "objectReference": ""
          }
        },
        "lifecycle": {
          "id": "",
          "name": ""
        },
        "signature": {
          "id": "",
          "payload": "",
          "signature": "",
          "verificationMethod": "",
          "verificationPayload": "",
          "verificationPayloadHash": "",
          "verificationArtifact": "",
          "verificationSignedBy": "",
          "verificationSignedAs": "",
          "verificationJwsHeader": "",
          "timestamp": "",
          "signedWithoutObjectReference": "",
          "objectType": "",
          "objectReference": ""
        }
      },
      "lifecycle": {
        "id": "",
        "name": ""
      },
      "signature": {
        "id": "",
        "payload": "",
        "signature": "",
        "verificationMethod": "",
        "verificationPayload": "",
        "verificationPayloadHash": "",
        "verificationArtifact": "",
        "verificationSignedBy": "",
        "verificationSignedAs": "",
        "verificationJwsHeader": "",
        "timestamp": "",
        "signedWithoutObjectReference": "",
        "objectType": "",
        "objectReference": ""
      }
    },
    "lifecycle": {
      "id": "",
      "name": ""
    },
    "signature": {
      "id": "",
      "payload": "",
      "signature": "",
      "verificationMethod": "",
      "verificationPayload": "",
      "verificationPayloadHash": "",
      "verificationArtifact": "",
      "verificationSignedBy": "",
      "verificationSignedAs": "",
      "verificationJwsHeader": "",
      "timestamp": "",
      "signedWithoutObjectReference": "",
      "objectType": "",
      "objectReference": ""
    }
  }
}

{
  "dataAgreement": {
    "id": "",
    "version": "",
    "controller": {
      "id": "",
      "name": "",
      "url": ""
    },
    "policy": {
      "id": "",
      "name": "",
      "version": "",
      "url": "",
      "jurisdiction": "",
      "industrySector": "",
      "dataRetentionPeriodDays": "",
      "geographicRestriction": "",
      "storageLocation": ""
    },
    "purpose": "",
    "lawfulBasis": "",
    "dataUse": "",
    "dpia": "",
    "active": "",
    "forgettable": "",
    "compatibleWithVersion": {
      "id": "",
      "version": "",
      "controller": {
        "id": "",
        "name": "",
        "url": ""
      },
      "policy": {
        "id": "",
        "name": "",
        "version": "",
        "url": "",
        "jurisdiction": "",
        "industrySector": "",
        "dataRetentionPeriodDays": "",
        "geographicRestriction": "",
        "storageLocation": ""
      },
      "purpose": "",
      "lawfulBasis": "",
      "dataUse": "",
      "dpia": "",
      "active": "",
      "forgettable": "",
      "compatibleWithVersion": {
        "id": "",
        "version": "",
        "controller": {
          "id": "",
          "name": "",
          "url": ""
        },
        "policy": {
          "id": "",
          "name": "",
          "version": "",
          "url": "",
          "jurisdiction": "",
          "industrySector": "",
          "dataRetentionPeriodDays": "",
          "geographicRestriction": "",
          "storageLocation": ""
        },
        "purpose": "",
        "lawfulBasis": "",
        "dataUse": "",
        "dpia": "",
        "active": "",
        "forgettable": "",
        "compatibleWithVersion": {
          "id": "",
          "version": "",
          "controller": {
            "id": "",
            "name": "",
            "url": ""
          },
          "policy": {
            "id": "",
            "name": "",
            "version": "",
            "url": "",
            "jurisdiction": "",
            "industrySector": "",
            "dataRetentionPeriodDays": "",
            "geographicRestriction": "",
            "storageLocation": ""
          },
          "purpose": "",
          "lawfulBasis": "",
          "dataUse": "",
          "dpia": "",
          "active": "",
          "forgettable": "",
          "compatibleWithVersion": {
            "id": "",
            "version": "",
            "controller": {
              "id": "",
              "name": "",
              "url": ""
            },
            "policy": {
              "id": "",
              "name": "",
              "version": "",
              "url": "",
              "jurisdiction": "",
              "industrySector": "",
              "dataRetentionPeriodDays": "",
              "geographicRestriction": "",
              "storageLocation": ""
            },
            "purpose": "",
            "lawfulBasis": "",
            "dataUse": "",
            "dpia": "",
            "active": "",
            "forgettable": "",
            "compatibleWithVersion": "[Circular Reference]",
            "lifecycle": {
              "id": "",
              "name": ""
            },
            "signature": {
              "id": "",
              "payload": "",
              "signature": "",
              "verificationMethod": "",
              "verificationPayload": "",
              "verificationPayloadHash": "",
              "verificationArtifact": "",
              "verificationSignedBy": "",
              "verificationSignedAs": "",
              "verificationJwsHeader": "",
              "timestamp": "",
              "signedWithoutObjectReference": "",
              "objectType": "",
              "objectReference": ""
            }
          },
          "lifecycle": {
            "id": "",
            "name": ""
          },
          "signature": {
            "id": "",
            "payload": "",
            "signature": "",
            "verificationMethod": "",
            "verificationPayload": "",
            "verificationPayloadHash": "",
            "verificationArtifact": "",
            "verificationSignedBy": "",
            "verificationSignedAs": "",
            "verificationJwsHeader": "",
            "timestamp": "",
            "signedWithoutObjectReference": "",
            "objectType": "",
            "objectReference": ""
          }
        },
        "lifecycle": {
          "id": "",
          "name": ""
        },
        "signature": {
          "id": "",
          "payload": "",
          "signature": "",
          "verificationMethod": "",
          "verificationPayload": "",
          "verificationPayloadHash": "",
          "verificationArtifact": "",
          "verificationSignedBy": "",
          "verificationSignedAs": "",
          "verificationJwsHeader": "",
          "timestamp": "",
          "signedWithoutObjectReference": "",
          "objectType": "",
          "objectReference": ""
        }
      },
      "lifecycle": {
        "id": "",
        "name": ""
      },
      "signature": {
        "id": "",
        "payload": "",
        "signature": "",
        "verificationMethod": "",
        "verificationPayload": "",
        "verificationPayloadHash": "",
        "verificationArtifact": "",
        "verificationSignedBy": "",
        "verificationSignedAs": "",
        "verificationJwsHeader": "",
        "timestamp": "",
        "signedWithoutObjectReference": "",
        "objectType": "",
        "objectReference": ""
      }
    },
    "lifecycle": {
      "id": "",
      "name": ""
    },
    "signature": {
      "id": "",
      "payload": "",
      "signature": "",
      "verificationMethod": "",
      "verificationPayload": "",
      "verificationPayloadHash": "",
      "verificationArtifact": "",
      "verificationSignedBy": "",
      "verificationSignedAs": "",
      "verificationJwsHeader": "",
      "timestamp": "",
      "signedWithoutObjectReference": "",
      "objectType": "",
      "objectReference": ""
    }
  },
  "revision": {
    "id": "",
    "schemaName": "",
    "objectId": "",
    "signedWithoutObjectId": "",
    "serializedSnapshot": "",
    "serializedHash": "",
    "timestamp": "",
    "authorizedByIndividual": {
      "id": "",
      "externalId": "",
      "externalIdType": "",
      "identityProviderId": ""
    },
    "authorizedByOther": "",
    "successor": {
      "id": "",
      "schemaName": "",
      "objectId": "",
      "signedWithoutObjectId": "",
      "serializedSnapshot": "",
      "serializedHash": "",
      "timestamp": "",
      "authorizedByIndividual": {
        "id": "",
        "externalId": "",
        "externalIdType": "",
        "identityProviderId": ""
      },
      "authorizedByOther": "",
      "successor": {
        "id": "",
        "schemaName": "",
        "objectId": "",
        "signedWithoutObjectId": "",
        "serializedSnapshot": "",
        "serializedHash": "",
        "timestamp": "",
        "authorizedByIndividual": {
          "id": "",
          "externalId": "",
          "externalIdType": "",
          "identityProviderId": ""
        },
        "authorizedByOther": "",
        "successor": {
          "id": "",
          "schemaName": "",
          "objectId": "",
          "signedWithoutObjectId": "",
          "serializedSnapshot": "",
          "serializedHash": "",
          "timestamp": "",
          "authorizedByIndividual": {
            "id": "",
            "externalId": "",
            "externalIdType": "",
            "identityProviderId": ""
          },
          "authorizedByOther": "",
          "successor": {
            "id": "",
            "schemaName": "",
            "objectId": "",
            "signedWithoutObjectId": "",
            "serializedSnapshot": "",
            "serializedHash": "",
            "timestamp": "",
            "authorizedByIndividual": {
              "id": "",
              "externalId": "",
              "externalIdType": "",
              "identityProviderId": ""
            },
            "authorizedByOther": "",
            "successor": "[Circular Reference]",
            "predecessorHash": "",
            "predecessorSignature": ""
          },
          "predecessorHash": "",
          "predecessorSignature": ""
        },
        "predecessorHash": "",
        "predecessorSignature": ""
      },
      "predecessorHash": "",
      "predecessorSignature": ""
    },
    "predecessorHash": "",
    "predecessorSignature": ""
  }
}

delete

Authorizations

Path parameters

dataAgreementIdstringRequired

Unique ID of an object

Responses

application/json

objectOptional

delete

HTTPcURLJavaScriptPython

DELETE /apis/GovStack/consent-management-bb//config/data-agreement/{dataAgreementId}/ HTTP/1.1
Host: app.swaggerhub.com
Accept: */*

{
  "revision": {
    "id": "",
    "schemaName": "",
    "objectId": "",
    "signedWithoutObjectId": "",
    "serializedSnapshot": "",
    "serializedHash": "",
    "timestamp": "",
    "authorizedByIndividual": {
      "id": "",
      "externalId": "",
      "externalIdType": "",
      "identityProviderId": ""
    },
    "authorizedByOther": "",
    "successor": {
      "id": "",
      "schemaName": "",
      "objectId": "",
      "signedWithoutObjectId": "",
      "serializedSnapshot": "",
      "serializedHash": "",
      "timestamp": "",
      "authorizedByIndividual": {
        "id": "",
        "externalId": "",
        "externalIdType": "",
        "identityProviderId": ""
      },
      "authorizedByOther": "",
      "successor": {
        "id": "",
        "schemaName": "",
        "objectId": "",
        "signedWithoutObjectId": "",
        "serializedSnapshot": "",
        "serializedHash": "",
        "timestamp": "",
        "authorizedByIndividual": {
          "id": "",
          "externalId": "",
          "externalIdType": "",
          "identityProviderId": ""
        },
        "authorizedByOther": "",
        "successor": {
          "id": "",
          "schemaName": "",
          "objectId": "",
          "signedWithoutObjectId": "",
          "serializedSnapshot": "",
          "serializedHash": "",
          "timestamp": "",
          "authorizedByIndividual": {
            "id": "",
            "externalId": "",
            "externalIdType": "",
            "identityProviderId": ""
          },
          "authorizedByOther": "",
          "successor": {
            "id": "",
            "schemaName": "",
            "objectId": "",
            "signedWithoutObjectId": "",
            "serializedSnapshot": "",
            "serializedHash": "",
            "timestamp": "",
            "authorizedByIndividual": {
              "id": "",
              "externalId": "",
              "externalIdType": "",
              "identityProviderId": ""
            },
            "authorizedByOther": "",
            "successor": "[Circular Reference]",
            "predecessorHash": "",
            "predecessorSignature": ""
          },
          "predecessorHash": "",
          "predecessorSignature": ""
        },
        "predecessorHash": "",
        "predecessorSignature": ""
      },
      "predecessorHash": "",
      "predecessorSignature": ""
    },
    "predecessorHash": "",
    "predecessorSignature": ""
  }
}

CREATE - A new DataAgreement object is created and returned together with a Revision

post

CREATE - A new DataAgreement object is created and returned together with a Revision

Authorizations

Body

dataAgreementobjectRequired

An object of type DataAgreement

Responses

application/json

objectOptional

post

HTTPcURLJavaScriptPython

POST /apis/GovStack/consent-management-bb//config/data-agreement/ HTTP/1.1
Host: app.swaggerhub.com
Content-Type: application/json
Accept: */*
Content-Length: 3480

{
  "dataAgreement": {
    "id": "",
    "version": "",
    "controller": {
      "id": "",
      "name": "",
      "url": ""
    },
    "policy": {
      "id": "",
      "name": "",
      "version": "",
      "url": "",
      "jurisdiction": "",
      "industrySector": "",
      "dataRetentionPeriodDays": "",
      "geographicRestriction": "",
      "storageLocation": ""
    },
    "purpose": "",
    "lawfulBasis": "",
    "dataUse": "",
    "dpia": "",
    "active": "",
    "forgettable": "",
    "compatibleWithVersion": {
      "id": "",
      "version": "",
      "controller": {
        "id": "",
        "name": "",
        "url": ""
      },
      "policy": {
        "id": "",
        "name": "",
        "version": "",
        "url": "",
        "jurisdiction": "",
        "industrySector": "",
        "dataRetentionPeriodDays": "",
        "geographicRestriction": "",
        "storageLocation": ""
      },
      "purpose": "",
      "lawfulBasis": "",
      "dataUse": "",
      "dpia": "",
      "active": "",
      "forgettable": "",
      "compatibleWithVersion": {
        "id": "",
        "version": "",
        "controller": {
          "id": "",
          "name": "",
          "url": ""
        },
        "policy": {
          "id": "",
          "name": "",
          "version": "",
          "url": "",
          "jurisdiction": "",
          "industrySector": "",
          "dataRetentionPeriodDays": "",
          "geographicRestriction": "",
          "storageLocation": ""
        },
        "purpose": "",
        "lawfulBasis": "",
        "dataUse": "",
        "dpia": "",
        "active": "",
        "forgettable": "",
        "compatibleWithVersion": {
          "id": "",
          "version": "",
          "controller": {
            "id": "",
            "name": "",
            "url": ""
          },
          "policy": {
            "id": "",
            "name": "",
            "version": "",
            "url": "",
            "jurisdiction": "",
            "industrySector": "",
            "dataRetentionPeriodDays": "",
            "geographicRestriction": "",
            "storageLocation": ""
          },
          "purpose": "",
          "lawfulBasis": "",
          "dataUse": "",
          "dpia": "",
          "active": "",
          "forgettable": "",
          "compatibleWithVersion": {
            "id": "",
            "version": "",
            "controller": {
              "id": "",
              "name": "",
              "url": ""
            },
            "policy": {
              "id": "",
              "name": "",
              "version": "",
              "url": "",
              "jurisdiction": "",
              "industrySector": "",
              "dataRetentionPeriodDays": "",
              "geographicRestriction": "",
              "storageLocation": ""
            },
            "purpose": "",
            "lawfulBasis": "",
            "dataUse": "",
            "dpia": "",
            "active": "",
            "forgettable": "",
            "compatibleWithVersion": "[Circular Reference]",
            "lifecycle": {
              "id": "",
              "name": ""
            },
            "signature": {
              "id": "",
              "payload": "",
              "signature": "",
              "verificationMethod": "",
              "verificationPayload": "",
              "verificationPayloadHash": "",
              "verificationArtifact": "",
              "verificationSignedBy": "",
              "verificationSignedAs": "",
              "verificationJwsHeader": "",
              "timestamp": "",
              "signedWithoutObjectReference": "",
              "objectType": "",
              "objectReference": ""
            }
          },
          "lifecycle": {
            "id": "",
            "name": ""
          },
          "signature": {
            "id": "",
            "payload": "",
            "signature": "",
            "verificationMethod": "",
            "verificationPayload": "",
            "verificationPayloadHash": "",
            "verificationArtifact": "",
            "verificationSignedBy": "",
            "verificationSignedAs": "",
            "verificationJwsHeader": "",
            "timestamp": "",
            "signedWithoutObjectReference": "",
            "objectType": "",
            "objectReference": ""
          }
        },
        "lifecycle": {
          "id": "",
          "name": ""
        },
        "signature": {
          "id": "",
          "payload": "",
          "signature": "",
          "verificationMethod": "",
          "verificationPayload": "",
          "verificationPayloadHash": "",
          "verificationArtifact": "",
          "verificationSignedBy": "",
          "verificationSignedAs": "",
          "verificationJwsHeader": "",
          "timestamp": "",
          "signedWithoutObjectReference": "",
          "objectType": "",
          "objectReference": ""
        }
      },
      "lifecycle": {
        "id": "",
        "name": ""
      },
      "signature": {
        "id": "",
        "payload": "",
        "signature": "",
        "verificationMethod": "",
        "verificationPayload": "",
        "verificationPayloadHash": "",
        "verificationArtifact": "",
        "verificationSignedBy": "",
        "verificationSignedAs": "",
        "verificationJwsHeader": "",
        "timestamp": "",
        "signedWithoutObjectReference": "",
        "objectType": "",
        "objectReference": ""
      }
    },
    "lifecycle": {
      "id": "",
      "name": ""
    },
    "signature": {
      "id": "",
      "payload": "",
      "signature": "",
      "verificationMethod": "",
      "verificationPayload": "",
      "verificationPayloadHash": "",
      "verificationArtifact": "",
      "verificationSignedBy": "",
      "verificationSignedAs": "",
      "verificationJwsHeader": "",
      "timestamp": "",
      "signedWithoutObjectReference": "",
      "objectType": "",
      "objectReference": ""
    }
  }
}

{
  "dataAgreement": {
    "id": "",
    "version": "",
    "controller": {
      "id": "",
      "name": "",
      "url": ""
    },
    "policy": {
      "id": "",
      "name": "",
      "version": "",
      "url": "",
      "jurisdiction": "",
      "industrySector": "",
      "dataRetentionPeriodDays": "",
      "geographicRestriction": "",
      "storageLocation": ""
    },
    "purpose": "",
    "lawfulBasis": "",
    "dataUse": "",
    "dpia": "",
    "active": "",
    "forgettable": "",
    "compatibleWithVersion": {
      "id": "",
      "version": "",
      "controller": {
        "id": "",
        "name": "",
        "url": ""
      },
      "policy": {
        "id": "",
        "name": "",
        "version": "",
        "url": "",
        "jurisdiction": "",
        "industrySector": "",
        "dataRetentionPeriodDays": "",
        "geographicRestriction": "",
        "storageLocation": ""
      },
      "purpose": "",
      "lawfulBasis": "",
      "dataUse": "",
      "dpia": "",
      "active": "",
      "forgettable": "",
      "compatibleWithVersion": {
        "id": "",
        "version": "",
        "controller": {
          "id": "",
          "name": "",
          "url": ""
        },
        "policy": {
          "id": "",
          "name": "",
          "version": "",
          "url": "",
          "jurisdiction": "",
          "industrySector": "",
          "dataRetentionPeriodDays": "",
          "geographicRestriction": "",
          "storageLocation": ""
        },
        "purpose": "",
        "lawfulBasis": "",
        "dataUse": "",
        "dpia": "",
        "active": "",
        "forgettable": "",
        "compatibleWithVersion": {
          "id": "",
          "version": "",
          "controller": {
            "id": "",
            "name": "",
            "url": ""
          },
          "policy": {
            "id": "",
            "name": "",
            "version": "",
            "url": "",
            "jurisdiction": "",
            "industrySector": "",
            "dataRetentionPeriodDays": "",
            "geographicRestriction": "",
            "storageLocation": ""
          },
          "purpose": "",
          "lawfulBasis": "",
          "dataUse": "",
          "dpia": "",
          "active": "",
          "forgettable": "",
          "compatibleWithVersion": {
            "id": "",
            "version": "",
            "controller": {
              "id": "",
              "name": "",
              "url": ""
            },
            "policy": {
              "id": "",
              "name": "",
              "version": "",
              "url": "",
              "jurisdiction": "",
              "industrySector": "",
              "dataRetentionPeriodDays": "",
              "geographicRestriction": "",
              "storageLocation": ""
            },
            "purpose": "",
            "lawfulBasis": "",
            "dataUse": "",
            "dpia": "",
            "active": "",
            "forgettable": "",
            "compatibleWithVersion": "[Circular Reference]",
            "lifecycle": {
              "id": "",
              "name": ""
            },
            "signature": {
              "id": "",
              "payload": "",
              "signature": "",
              "verificationMethod": "",
              "verificationPayload": "",
              "verificationPayloadHash": "",
              "verificationArtifact": "",
              "verificationSignedBy": "",
              "verificationSignedAs": "",
              "verificationJwsHeader": "",
              "timestamp": "",
              "signedWithoutObjectReference": "",
              "objectType": "",
              "objectReference": ""
            }
          },
          "lifecycle": {
            "id": "",
            "name": ""
          },
          "signature": {
            "id": "",
            "payload": "",
            "signature": "",
            "verificationMethod": "",
            "verificationPayload": "",
            "verificationPayloadHash": "",
            "verificationArtifact": "",
            "verificationSignedBy": "",
            "verificationSignedAs": "",
            "verificationJwsHeader": "",
            "timestamp": "",
            "signedWithoutObjectReference": "",
            "objectType": "",
            "objectReference": ""
          }
        },
        "lifecycle": {
          "id": "",
          "name": ""
        },
        "signature": {
          "id": "",
          "payload": "",
          "signature": "",
          "verificationMethod": "",
          "verificationPayload": "",
          "verificationPayloadHash": "",
          "verificationArtifact": "",
          "verificationSignedBy": "",
          "verificationSignedAs": "",
          "verificationJwsHeader": "",
          "timestamp": "",
          "signedWithoutObjectReference": "",
          "objectType": "",
          "objectReference": ""
        }
      },
      "lifecycle": {
        "id": "",
        "name": ""
      },
      "signature": {
        "id": "",
        "payload": "",
        "signature": "",
        "verificationMethod": "",
        "verificationPayload": "",
        "verificationPayloadHash": "",
        "verificationArtifact": "",
        "verificationSignedBy": "",
        "verificationSignedAs": "",
        "verificationJwsHeader": "",
        "timestamp": "",
        "signedWithoutObjectReference": "",
        "objectType": "",
        "objectReference": ""
      }
    },
    "lifecycle": {
      "id": "",
      "name": ""
    },
    "signature": {
      "id": "",
      "payload": "",
      "signature": "",
      "verificationMethod": "",
      "verificationPayload": "",
      "verificationPayloadHash": "",
      "verificationArtifact": "",
      "verificationSignedBy": "",
      "verificationSignedAs": "",
      "verificationJwsHeader": "",
      "timestamp": "",
      "signedWithoutObjectReference": "",
      "objectType": "",
      "objectReference": ""
    }
  },
  "revision": {
    "id": "",
    "schemaName": "",
    "objectId": "",
    "signedWithoutObjectId": "",
    "serializedSnapshot": "",
    "serializedHash": "",
    "timestamp": "",
    "authorizedByIndividual": {
      "id": "",
      "externalId": "",
      "externalIdType": "",
      "identityProviderId": ""
    },
    "authorizedByOther": "",
    "successor": {
      "id": "",
      "schemaName": "",
      "objectId": "",
      "signedWithoutObjectId": "",
      "serializedSnapshot": "",
      "serializedHash": "",
      "timestamp": "",
      "authorizedByIndividual": {
        "id": "",
        "externalId": "",
        "externalIdType": "",
        "identityProviderId": ""
      },
      "authorizedByOther": "",
      "successor": {
        "id": "",
        "schemaName": "",
        "objectId": "",
        "signedWithoutObjectId": "",
        "serializedSnapshot": "",
        "serializedHash": "",
        "timestamp": "",
        "authorizedByIndividual": {
          "id": "",
          "externalId": "",
          "externalIdType": "",
          "identityProviderId": ""
        },
        "authorizedByOther": "",
        "successor": {
          "id": "",
          "schemaName": "",
          "objectId": "",
          "signedWithoutObjectId": "",
          "serializedSnapshot": "",
          "serializedHash": "",
          "timestamp": "",
          "authorizedByIndividual": {
            "id": "",
            "externalId": "",
            "externalIdType": "",
            "identityProviderId": ""
          },
          "authorizedByOther": "",
          "successor": {
            "id": "",
            "schemaName": "",
            "objectId": "",
            "signedWithoutObjectId": "",
            "serializedSnapshot": "",
            "serializedHash": "",
            "timestamp": "",
            "authorizedByIndividual": {
              "id": "",
              "externalId": "",
              "externalIdType": "",
              "identityProviderId": ""
            },
            "authorizedByOther": "",
            "successor": "[Circular Reference]",
            "predecessorHash": "",
            "predecessorSignature": ""
          },
          "predecessorHash": "",
          "predecessorSignature": ""
        },
        "predecessorHash": "",
        "predecessorSignature": ""
      },
      "predecessorHash": "",
      "predecessorSignature": ""
    },
    "predecessorHash": "",
    "predecessorSignature": ""
  }
}

LIST - fetch all DataAgreements

get

LIST - fetch all DataAgreements

Authorizations

Query parameters

offsetintegerOptional

Requested index for start of resources to be provided in response requested by client

limitintegerOptional

Requested number of resources to be provided in response requested by client

Responses

application/json

objectOptional

get

HTTPcURLJavaScriptPython

GET /apis/GovStack/consent-management-bb//config/data-agreements/ HTTP/1.1
Host: app.swaggerhub.com
Accept: */*

{
  "dataAgreement": [
    {
      "id": "",
      "version": "",
      "controller": {
        "id": "",
        "name": "",
        "url": ""
      },
      "policy": {
        "id": "",
        "name": "",
        "version": "",
        "url": "",
        "jurisdiction": "",
        "industrySector": "",
        "dataRetentionPeriodDays": "",
        "geographicRestriction": "",
        "storageLocation": ""
      },
      "purpose": "",
      "lawfulBasis": "",
      "dataUse": "",
      "dpia": "",
      "active": "",
      "forgettable": "",
      "compatibleWithVersion": {
        "id": "",
        "version": "",
        "controller": {
          "id": "",
          "name": "",
          "url": ""
        },
        "policy": {
          "id": "",
          "name": "",
          "version": "",
          "url": "",
          "jurisdiction": "",
          "industrySector": "",
          "dataRetentionPeriodDays": "",
          "geographicRestriction": "",
          "storageLocation": ""
        },
        "purpose": "",
        "lawfulBasis": "",
        "dataUse": "",
        "dpia": "",
        "active": "",
        "forgettable": "",
        "compatibleWithVersion": {
          "id": "",
          "version": "",
          "controller": {
            "id": "",
            "name": "",
            "url": ""
          },
          "policy": {
            "id": "",
            "name": "",
            "version": "",
            "url": "",
            "jurisdiction": "",
            "industrySector": "",
            "dataRetentionPeriodDays": "",
            "geographicRestriction": "",
            "storageLocation": ""
          },
          "purpose": "",
          "lawfulBasis": "",
          "dataUse": "",
          "dpia": "",
          "active": "",
          "forgettable": "",
          "compatibleWithVersion": {
            "id": "",
            "version": "",
            "controller": {
              "id": "",
              "name": "",
              "url": ""
            },
            "policy": {
              "id": "",
              "name": "",
              "version": "",
              "url": "",
              "jurisdiction": "",
              "industrySector": "",
              "dataRetentionPeriodDays": "",
              "geographicRestriction": "",
              "storageLocation": ""
            },
            "purpose": "",
            "lawfulBasis": "",
            "dataUse": "",
            "dpia": "",
            "active": "",
            "forgettable": "",
            "compatibleWithVersion": "[Circular Reference]",
            "lifecycle": {
              "id": "",
              "name": ""
            },
            "signature": {
              "id": "",
              "payload": "",
              "signature": "",
              "verificationMethod": "",
              "verificationPayload": "",
              "verificationPayloadHash": "",
              "verificationArtifact": "",
              "verificationSignedBy": "",
              "verificationSignedAs": "",
              "verificationJwsHeader": "",
              "timestamp": "",
              "signedWithoutObjectReference": "",
              "objectType": "",
              "objectReference": ""
            }
          },
          "lifecycle": {
            "id": "",
            "name": ""
          },
          "signature": {
            "id": "",
            "payload": "",
            "signature": "",
            "verificationMethod": "",
            "verificationPayload": "",
            "verificationPayloadHash": "",
            "verificationArtifact": "",
            "verificationSignedBy": "",
            "verificationSignedAs": "",
            "verificationJwsHeader": "",
            "timestamp": "",
            "signedWithoutObjectReference": "",
            "objectType": "",
            "objectReference": ""
          }
        },
        "lifecycle": {
          "id": "",
          "name": ""
        },
        "signature": {
          "id": "",
          "payload": "",
          "signature": "",
          "verificationMethod": "",
          "verificationPayload": "",
          "verificationPayloadHash": "",
          "verificationArtifact": "",
          "verificationSignedBy": "",
          "verificationSignedAs": "",
          "verificationJwsHeader": "",
          "timestamp": "",
          "signedWithoutObjectReference": "",
          "objectType": "",
          "objectReference": ""
        }
      },
      "lifecycle": {
        "id": "",
        "name": ""
      },
      "signature": {
        "id": "",
        "payload": "",
        "signature": "",
        "verificationMethod": "",
        "verificationPayload": "",
        "verificationPayloadHash": "",
        "verificationArtifact": "",
        "verificationSignedBy": "",
        "verificationSignedAs": "",
        "verificationJwsHeader": "",
        "timestamp": "",
        "signedWithoutObjectReference": "",
        "objectType": "",
        "objectReference": ""
      }
    }
  ]
}

CREATE - Creates an Individual in the Consent system

post

CREATE - Creates an Individual in the Consent system

Authorizations

Body

individualobjectRequired

An object of type Individual

Responses

application/json

objectOptional

post

HTTPcURLJavaScriptPython

POST /apis/GovStack/consent-management-bb//config/individual/ HTTP/1.1
Host: app.swaggerhub.com
Content-Type: application/json
Accept: */*
Content-Length: 84

{
  "individual": {
    "id": "",
    "externalId": "",
    "externalIdType": "",
    "identityProviderId": ""
  }
}

{
  "individual": {
    "id": "",
    "externalId": "",
    "externalIdType": "",
    "identityProviderId": ""
  }
}

READ - Fetch an Individual in the Consent system

get

READ - Fetch an Individual in the Consent system

Authorizations

Path parameters

individualIdstringRequired

Unique ID of an object

Responses

application/json

objectOptional

get

HTTPcURLJavaScriptPython

GET /apis/GovStack/consent-management-bb//config/individual/{individualId}/ HTTP/1.1
Host: app.swaggerhub.com
Accept: */*

{
  "individual": {
    "id": "",
    "externalId": "",
    "externalIdType": "",
    "identityProviderId": ""
  }
}

LIST - lists individuals in the system

get

LIST - lists individuals in the system

Authorizations

Query parameters

offsetintegerOptional

Requested index for start of resources to be provided in response requested by client

limitintegerOptional

Requested number of resources to be provided in response requested by client

Responses

application/json

objectOptional

get

HTTPcURLJavaScriptPython

GET /apis/GovStack/consent-management-bb//config/individuals/ HTTP/1.1
Host: app.swaggerhub.com
Accept: */*

{
  "individuals": [
    {
      "id": "",
      "externalId": "",
      "externalIdType": "",
      "identityProviderId": ""
    }
  ]
}

CREATE - Creates a new Webhook object and returns the new object

post

CREATE - Creates a new Webhook object and returns the new object

Authorizations

Body

webhookobjectRequired

An object of type Webhook

Responses

application/json

objectOptional

post

HTTPcURLJavaScriptPython

POST /apis/GovStack/consent-management-bb//config/webhook/ HTTP/1.1
Host: app.swaggerhub.com
Content-Type: application/json
Accept: */*
Content-Length: 83

{
  "webhook": {
    "id": "",
    "payloadUrl": "",
    "contentType": "",
    "disabled": "",
    "secretKey": ""
  }
}

{
  "webhook": {
    "id": "",
    "payloadUrl": "",
    "contentType": "",
    "disabled": "",
    "secretKey": ""
  }
}

READ - get a Webhook object.

get

READ - get a Webhook object.

Authorizations

Path parameters

webhookIdstringRequired

Unique ID of an object

Query parameters

revisionIdstringOptional

An object with id revisionId

Responses

application/json

objectOptional

get

HTTPcURLJavaScriptPython

GET /apis/GovStack/consent-management-bb//config/webhook/{webhookId}/ HTTP/1.1
Host: app.swaggerhub.com
Accept: */*

{
  "webhook": {
    "id": "",
    "payloadUrl": "",
    "contentType": "",
    "disabled": "",
    "secretKey": ""
  }
}

UPDATE - Updates an existing Webhook object, returning the updated version.

put

UPDATE - Updates an existing Webhook object, returning the updated version.

Authorizations

Path parameters

webhookIdstringRequired

Unique ID of an object

Body

webhookobjectRequired

An object of type Webhook

Responses

application/json

objectOptional

put

HTTPcURLJavaScriptPython

PUT /apis/GovStack/consent-management-bb//config/webhook/{webhookId}/ HTTP/1.1
Host: app.swaggerhub.com
Content-Type: application/json
Accept: */*
Content-Length: 83

{
  "webhook": {
    "id": "",
    "payloadUrl": "",
    "contentType": "",
    "disabled": "",
    "secretKey": ""
  }
}

{
  "webhook": {
    "id": "",
    "payloadUrl": "",
    "contentType": "",
    "disabled": "",
    "secretKey": ""
  }
}

DELETE - Deletes an existing Webhook object.

delete

DELETE - Deletes an existing Webhook object.

Authorizations

Path parameters

webhookIdstringRequired

Unique ID of an object

Responses

delete

HTTPcURLJavaScriptPython

DELETE /apis/GovStack/consent-management-bb//config/webhook/{webhookId}/ HTTP/1.1
Host: app.swaggerhub.com
Accept: */*

No content

Returns a list of readable Webhook objects

get

LIST - Fetches list of readable Webhook objects

Authorizations

Query parameters

revisionIdstringOptional

An object with id revisionId

offsetintegerOptional

Requested index for start of resources to be provided in response requested by client

limitintegerOptional

Requested number of resources to be provided in response requested by client

Responses

application/json

objectOptional

get

HTTPcURLJavaScriptPython

GET /apis/GovStack/consent-management-bb//config/webhooks/ HTTP/1.1
Host: app.swaggerhub.com
Accept: */*

{
  "webhooks": [
    {
      "id": "",
      "payloadUrl": "",
      "contentType": "",
      "disabled": "",
      "secretKey": ""
    }
  ]
}

8.1.2 Service APIs

CREATE - Creates an Individual in the Consent system

post

CREATE - Creates an Individual in the Consent system

Authorizations

Body

individualobjectRequired

An object of type Individual

Responses

application/json

objectOptional

post

HTTPcURLJavaScriptPython

POST /apis/GovStack/consent-management-bb//service/individual/ HTTP/1.1
Host: app.swaggerhub.com
Content-Type: application/json
Accept: */*
Content-Length: 84

{
  "individual": {
    "id": "",
    "externalId": "",
    "externalIdType": "",
    "identityProviderId": ""
  }
}

{
  "individual": {
    "id": "",
    "externalId": "",
    "externalIdType": "",
    "identityProviderId": ""
  }
}

READ - Fetch an Individual in the Consent system

get

READ - Fetch an Individual in the Consent system

Authorizations

Path parameters

individualIdstringRequired

Unique ID of an object

Responses

application/json

objectOptional

get

HTTPcURLJavaScriptPython

GET /apis/GovStack/consent-management-bb//service/individual/{individualId}/ HTTP/1.1
Host: app.swaggerhub.com
Accept: */*

{
  "individual": {
    "id": "",
    "externalId": "",
    "externalIdType": "",
    "identityProviderId": ""
  }
}

UPDATE - Updates an Individual in the Consent system

put

UPDATE - Updates an Individual in the Consent system

Authorizations

Path parameters

individualIdstringRequired

Unique ID of an object

Body

individualobjectRequired

An object of type Individual

Responses

application/json

objectOptional

put

HTTPcURLJavaScriptPython

PUT /apis/GovStack/consent-management-bb//service/individual/{individualId}/ HTTP/1.1
Host: app.swaggerhub.com
Content-Type: application/json
Accept: */*
Content-Length: 84

{
  "individual": {
    "id": "",
    "externalId": "",
    "externalIdType": "",
    "identityProviderId": ""
  }
}

{
  "individual": {
    "id": "",
    "externalId": "",
    "externalIdType": "",
    "identityProviderId": ""
  }
}

LIST - lists individuals in the system

get

LIST - lists individuals in the system

Authorizations

Query parameters

offsetintegerOptional

Requested index for start of resources to be provided in response requested by client

limitintegerOptional

Requested number of resources to be provided in response requested by client

Responses

application/json

objectOptional

get

HTTPcURLJavaScriptPython

GET /apis/GovStack/consent-management-bb//service/individuals/ HTTP/1.1
Host: app.swaggerhub.com
Accept: */*

{
  "individuals": [
    {
      "id": "",
      "externalId": "",
      "externalIdType": "",
      "identityProviderId": ""
    }
  ]
}

READ - fetches the latest version of an Agreement

get

READ - fetches the latest version of an Agreement

Authorizations

Path parameters

dataAgreementIdstringRequired

Unique ID of an object

Responses

application/json

objectOptional

get

HTTPcURLJavaScriptPython

GET /apis/GovStack/consent-management-bb//service/data-agreement/{dataAgreementId}/ HTTP/1.1
Host: app.swaggerhub.com
Accept: */*

{
  "dataAgreement": {
    "id": "",
    "version": "",
    "controller": {
      "id": "",
      "name": "",
      "url": ""
    },
    "policy": {
      "id": "",
      "name": "",
      "version": "",
      "url": "",
      "jurisdiction": "",
      "industrySector": "",
      "dataRetentionPeriodDays": "",
      "geographicRestriction": "",
      "storageLocation": ""
    },
    "purpose": "",
    "lawfulBasis": "",
    "dataUse": "",
    "dpia": "",
    "active": "",
    "forgettable": "",
    "compatibleWithVersion": {
      "id": "",
      "version": "",
      "controller": {
        "id": "",
        "name": "",
        "url": ""
      },
      "policy": {
        "id": "",
        "name": "",
        "version": "",
        "url": "",
        "jurisdiction": "",
        "industrySector": "",
        "dataRetentionPeriodDays": "",
        "geographicRestriction": "",
        "storageLocation": ""
      },
      "purpose": "",
      "lawfulBasis": "",
      "dataUse": "",
      "dpia": "",
      "active": "",
      "forgettable": "",
      "compatibleWithVersion": {
        "id": "",
        "version": "",
        "controller": {
          "id": "",
          "name": "",
          "url": ""
        },
        "policy": {
          "id": "",
          "name": "",
          "version": "",
          "url": "",
          "jurisdiction": "",
          "industrySector": "",
          "dataRetentionPeriodDays": "",
          "geographicRestriction": "",
          "storageLocation": ""
        },
        "purpose": "",
        "lawfulBasis": "",
        "dataUse": "",
        "dpia": "",
        "active": "",
        "forgettable": "",
        "compatibleWithVersion": {
          "id": "",
          "version": "",
          "controller": {
            "id": "",
            "name": "",
            "url": ""
          },
          "policy": {
            "id": "",
            "name": "",
            "version": "",
            "url": "",
            "jurisdiction": "",
            "industrySector": "",
            "dataRetentionPeriodDays": "",
            "geographicRestriction": "",
            "storageLocation": ""
          },
          "purpose": "",
          "lawfulBasis": "",
          "dataUse": "",
          "dpia": "",
          "active": "",
          "forgettable": "",
          "compatibleWithVersion": {
            "id": "",
            "version": "",
            "controller": {
              "id": "",
              "name": "",
              "url": ""
            },
            "policy": {
              "id": "",
              "name": "",
              "version": "",
              "url": "",
              "jurisdiction": "",
              "industrySector": "",
              "dataRetentionPeriodDays": "",
              "geographicRestriction": "",
              "storageLocation": ""
            },
            "purpose": "",
            "lawfulBasis": "",
            "dataUse": "",
            "dpia": "",
            "active": "",
            "forgettable": "",
            "compatibleWithVersion": "[Circular Reference]",
            "lifecycle": {
              "id": "",
              "name": ""
            },
            "signature": {
              "id": "",
              "payload": "",
              "signature": "",
              "verificationMethod": "",
              "verificationPayload": "",
              "verificationPayloadHash": "",
              "verificationArtifact": "",
              "verificationSignedBy": "",
              "verificationSignedAs": "",
              "verificationJwsHeader": "",
              "timestamp": "",
              "signedWithoutObjectReference": "",
              "objectType": "",
              "objectReference": ""
            }
          },
          "lifecycle": {
            "id": "",
            "name": ""
          },
          "signature": {
            "id": "",
            "payload": "",
            "signature": "",
            "verificationMethod": "",
            "verificationPayload": "",
            "verificationPayloadHash": "",
            "verificationArtifact": "",
            "verificationSignedBy": "",
            "verificationSignedAs": "",
            "verificationJwsHeader": "",
            "timestamp": "",
            "signedWithoutObjectReference": "",
            "objectType": "",
            "objectReference": ""
          }
        },
        "lifecycle": {
          "id": "",
          "name": ""
        },
        "signature": {
          "id": "",
          "payload": "",
          "signature": "",
          "verificationMethod": "",
          "verificationPayload": "",
          "verificationPayloadHash": "",
          "verificationArtifact": "",
          "verificationSignedBy": "",
          "verificationSignedAs": "",
          "verificationJwsHeader": "",
          "timestamp": "",
          "signedWithoutObjectReference": "",
          "objectType": "",
          "objectReference": ""
        }
      },
      "lifecycle": {
        "id": "",
        "name": ""
      },
      "signature": {
        "id": "",
        "payload": "",
        "signature": "",
        "verificationMethod": "",
        "verificationPayload": "",
        "verificationPayloadHash": "",
        "verificationArtifact": "",
        "verificationSignedBy": "",
        "verificationSignedAs": "",
        "verificationJwsHeader": "",
        "timestamp": "",
        "signedWithoutObjectReference": "",
        "objectType": "",
        "objectReference": ""
      }
    },
    "lifecycle": {
      "id": "",
      "name": ""
    },
    "signature": {
      "id": "",
      "payload": "",
      "signature": "",
      "verificationMethod": "",
      "verificationPayload": "",
      "verificationPayloadHash": "",
      "verificationArtifact": "",
      "verificationSignedBy": "",
      "verificationSignedAs": "",
      "verificationJwsHeader": "",
      "timestamp": "",
      "signedWithoutObjectReference": "",
      "objectType": "",
      "objectReference": ""
    }
  },
  "revision": {
    "id": "",
    "schemaName": "",
    "objectId": "",
    "signedWithoutObjectId": "",
    "serializedSnapshot": "",
    "serializedHash": "",
    "timestamp": "",
    "authorizedByIndividual": {
      "id": "",
      "externalId": "",
      "externalIdType": "",
      "identityProviderId": ""
    },
    "authorizedByOther": "",
    "successor": {
      "id": "",
      "schemaName": "",
      "objectId": "",
      "signedWithoutObjectId": "",
      "serializedSnapshot": "",
      "serializedHash": "",
      "timestamp": "",
      "authorizedByIndividual": {
        "id": "",
        "externalId": "",
        "externalIdType": "",
        "identityProviderId": ""
      },
      "authorizedByOther": "",
      "successor": {
        "id": "",
        "schemaName": "",
        "objectId": "",
        "signedWithoutObjectId": "",
        "serializedSnapshot": "",
        "serializedHash": "",
        "timestamp": "",
        "authorizedByIndividual": {
          "id": "",
          "externalId": "",
          "externalIdType": "",
          "identityProviderId": ""
        },
        "authorizedByOther": "",
        "successor": {
          "id": "",
          "schemaName": "",
          "objectId": "",
          "signedWithoutObjectId": "",
          "serializedSnapshot": "",
          "serializedHash": "",
          "timestamp": "",
          "authorizedByIndividual": {
            "id": "",
            "externalId": "",
            "externalIdType": "",
            "identityProviderId": ""
          },
          "authorizedByOther": "",
          "successor": {
            "id": "",
            "schemaName": "",
            "objectId": "",
            "signedWithoutObjectId": "",
            "serializedSnapshot": "",
            "serializedHash": "",
            "timestamp": "",
            "authorizedByIndividual": {
              "id": "",
              "externalId": "",
              "externalIdType": "",
              "identityProviderId": ""
            },
            "authorizedByOther": "",
            "successor": "[Circular Reference]",
            "predecessorHash": "",
            "predecessorSignature": ""
          },
          "predecessorHash": "",
          "predecessorSignature": ""
        },
        "predecessorHash": "",
        "predecessorSignature": ""
      },
      "predecessorHash": "",
      "predecessorSignature": ""
    },
    "predecessorHash": "",
    "predecessorSignature": ""
  }
}

READ - fetches the latest version of a Policy and the presented revisionId of an associated Agreement

get

READ - fetches the latest version of a Policy and the presented revisionId of an associated Agreement

Authorizations

Path parameters

policyIdstringRequired

Unique ID of an object

Query parameters

revisionIdstringOptional

An object with id revisionId

Responses

application/json

objectOptional

get

HTTPcURLJavaScriptPython

GET /apis/GovStack/consent-management-bb//service/policy/{policyId}/ HTTP/1.1
Host: app.swaggerhub.com
Accept: */*

{
  "policy": {
    "id": "",
    "name": "",
    "version": "",
    "url": "",
    "jurisdiction": "",
    "industrySector": "",
    "dataRetentionPeriodDays": "",
    "geographicRestriction": "",
    "storageLocation": ""
  },
  "revision": {
    "id": "",
    "schemaName": "",
    "objectId": "",
    "signedWithoutObjectId": "",
    "serializedSnapshot": "",
    "serializedHash": "",
    "timestamp": "",
    "authorizedByIndividual": {
      "id": "",
      "externalId": "",
      "externalIdType": "",
      "identityProviderId": ""
    },
    "authorizedByOther": "",
    "successor": {
      "id": "",
      "schemaName": "",
      "objectId": "",
      "signedWithoutObjectId": "",
      "serializedSnapshot": "",
      "serializedHash": "",
      "timestamp": "",
      "authorizedByIndividual": {
        "id": "",
        "externalId": "",
        "externalIdType": "",
        "identityProviderId": ""
      },
      "authorizedByOther": "",
      "successor": {
        "id": "",
        "schemaName": "",
        "objectId": "",
        "signedWithoutObjectId": "",
        "serializedSnapshot": "",
        "serializedHash": "",
        "timestamp": "",
        "authorizedByIndividual": {
          "id": "",
          "externalId": "",
          "externalIdType": "",
          "identityProviderId": ""
        },
        "authorizedByOther": "",
        "successor": {
          "id": "",
          "schemaName": "",
          "objectId": "",
          "signedWithoutObjectId": "",
          "serializedSnapshot": "",
          "serializedHash": "",
          "timestamp": "",
          "authorizedByIndividual": {
            "id": "",
            "externalId": "",
            "externalIdType": "",
            "identityProviderId": ""
          },
          "authorizedByOther": "",
          "successor": {
            "id": "",
            "schemaName": "",
            "objectId": "",
            "signedWithoutObjectId": "",
            "serializedSnapshot": "",
            "serializedHash": "",
            "timestamp": "",
            "authorizedByIndividual": {
              "id": "",
              "externalId": "",
              "externalIdType": "",
              "identityProviderId": ""
            },
            "authorizedByOther": "",
            "successor": "[Circular Reference]",
            "predecessorHash": "",
            "predecessorSignature": ""
          },
          "predecessorHash": "",
          "predecessorSignature": ""
        },
        "predecessorHash": "",
        "predecessorSignature": ""
      },
      "predecessorHash": "",
      "predecessorSignature": ""
    },
    "predecessorHash": "",
    "predecessorSignature": ""
  }
}

LIST - Fetch

get

LIST - Fetch

Authorizations

Query parameters

offsetintegerOptional

Requested index for start of resources to be provided in response requested by client

limitintegerOptional

Requested number of resources to be provided in response requested by client

Responses

application/json

objectOptional

get

HTTPcURLJavaScriptPython

GET /apis/GovStack/consent-management-bb//service/verification/data-agreements/ HTTP/1.1
Host: app.swaggerhub.com
Accept: */*

{
  "dataAgreements": [
    {
      "id": "",
      "version": "",
      "controller": {
        "id": "",
        "name": "",
        "url": ""
      },
      "policy": {
        "id": "",
        "name": "",
        "version": "",
        "url": "",
        "jurisdiction": "",
        "industrySector": "",
        "dataRetentionPeriodDays": "",
        "geographicRestriction": "",
        "storageLocation": ""
      },
      "purpose": "",
      "lawfulBasis": "",
      "dataUse": "",
      "dpia": "",
      "active": "",
      "forgettable": "",
      "compatibleWithVersion": {
        "id": "",
        "version": "",
        "controller": {
          "id": "",
          "name": "",
          "url": ""
        },
        "policy": {
          "id": "",
          "name": "",
          "version": "",
          "url": "",
          "jurisdiction": "",
          "industrySector": "",
          "dataRetentionPeriodDays": "",
          "geographicRestriction": "",
          "storageLocation": ""
        },
        "purpose": "",
        "lawfulBasis": "",
        "dataUse": "",
        "dpia": "",
        "active": "",
        "forgettable": "",
        "compatibleWithVersion": {
          "id": "",
          "version": "",
          "controller": {
            "id": "",
            "name": "",
            "url": ""
          },
          "policy": {
            "id": "",
            "name": "",
            "version": "",
            "url": "",
            "jurisdiction": "",
            "industrySector": "",
            "dataRetentionPeriodDays": "",
            "geographicRestriction": "",
            "storageLocation": ""
          },
          "purpose": "",
          "lawfulBasis": "",
          "dataUse": "",
          "dpia": "",
          "active": "",
          "forgettable": "",
          "compatibleWithVersion": {
            "id": "",
            "version": "",
            "controller": {
              "id": "",
              "name": "",
              "url": ""
            },
            "policy": {
              "id": "",
              "name": "",
              "version": "",
              "url": "",
              "jurisdiction": "",
              "industrySector": "",
              "dataRetentionPeriodDays": "",
              "geographicRestriction": "",
              "storageLocation": ""
            },
            "purpose": "",
            "lawfulBasis": "",
            "dataUse": "",
            "dpia": "",
            "active": "",
            "forgettable": "",
            "compatibleWithVersion": "[Circular Reference]",
            "lifecycle": {
              "id": "",
              "name": ""
            },
            "signature": {
              "id": "",
              "payload": "",
              "signature": "",
              "verificationMethod": "",
              "verificationPayload": "",
              "verificationPayloadHash": "",
              "verificationArtifact": "",
              "verificationSignedBy": "",
              "verificationSignedAs": "",
              "verificationJwsHeader": "",
              "timestamp": "",
              "signedWithoutObjectReference": "",
              "objectType": "",
              "objectReference": ""
            }
          },
          "lifecycle": {
            "id": "",
            "name": ""
          },
          "signature": {
            "id": "",
            "payload": "",
            "signature": "",
            "verificationMethod": "",
            "verificationPayload": "",
            "verificationPayloadHash": "",
            "verificationArtifact": "",
            "verificationSignedBy": "",
            "verificationSignedAs": "",
            "verificationJwsHeader": "",
            "timestamp": "",
            "signedWithoutObjectReference": "",
            "objectType": "",
            "objectReference": ""
          }
        },
        "lifecycle": {
          "id": "",
          "name": ""
        },
        "signature": {
          "id": "",
          "payload": "",
          "signature": "",
          "verificationMethod": "",
          "verificationPayload": "",
          "verificationPayloadHash": "",
          "verificationArtifact": "",
          "verificationSignedBy": "",
          "verificationSignedAs": "",
          "verificationJwsHeader": "",
          "timestamp": "",
          "signedWithoutObjectReference": "",
          "objectType": "",
          "objectReference": ""
        }
      },
      "lifecycle": {
        "id": "",
        "name": ""
      },
      "signature": {
        "id": "",
        "payload": "",
        "signature": "",
        "verificationMethod": "",
        "verificationPayload": "",
        "verificationPayloadHash": "",
        "verificationArtifact": "",
        "verificationSignedBy": "",
        "verificationSignedAs": "",
        "verificationJwsHeader": "",
        "timestamp": "",
        "signedWithoutObjectReference": "",
        "objectType": "",
        "objectReference": ""
      }
    }
  ]
}

LIST - Fetch consent records (latest revision). For a given ConsentRecordFilter, query if consent exists.

get

LIST - Fetch consent records (latest revision). For a given ConsentRecordFilter, query if consent exists.

Authorizations

Query parameters

offsetintegerOptional

Requested index for start of resources to be provided in response requested by client

limitintegerOptional

Requested number of resources to be provided in response requested by client

Responses

application/json

objectOptional

get

HTTPcURLJavaScriptPython

GET /apis/GovStack/consent-management-bb//service/verification/consent-records/ HTTP/1.1
Host: app.swaggerhub.com
Accept: */*

{
  "consentRecords": [
    {
      "id": "",
      "dataAgreement": {
        "id": "",
        "version": "",
        "controller": {
          "id": "",
          "name": "",
          "url": ""
        },
        "policy": {
          "id": "",
          "name": "",
          "version": "",
          "url": "",
          "jurisdiction": "",
          "industrySector": "",
          "dataRetentionPeriodDays": "",
          "geographicRestriction": "",
          "storageLocation": ""
        },
        "purpose": "",
        "lawfulBasis": "",
        "dataUse": "",
        "dpia": "",
        "active": "",
        "forgettable": "",
        "compatibleWithVersion": {
          "id": "",
          "version": "",
          "controller": {
            "id": "",
            "name": "",
            "url": ""
          },
          "policy": {
            "id": "",
            "name": "",
            "version": "",
            "url": "",
            "jurisdiction": "",
            "industrySector": "",
            "dataRetentionPeriodDays": "",
            "geographicRestriction": "",
            "storageLocation": ""
          },
          "purpose": "",
          "lawfulBasis": "",
          "dataUse": "",
          "dpia": "",
          "active": "",
          "forgettable": "",
          "compatibleWithVersion": {
            "id": "",
            "version": "",
            "controller": {
              "id": "",
              "name": "",
              "url": ""
            },
            "policy": {
              "id": "",
              "name": "",
              "version": "",
              "url": "",
              "jurisdiction": "",
              "industrySector": "",
              "dataRetentionPeriodDays": "",
              "geographicRestriction": "",
              "storageLocation": ""
            },
            "purpose": "",
            "lawfulBasis": "",
            "dataUse": "",
            "dpia": "",
            "active": "",
            "forgettable": "",
            "compatibleWithVersion": "[Circular Reference]",
            "lifecycle": {
              "id": "",
              "name": ""
            },
            "signature": {
              "id": "",
              "payload": "",
              "signature": "",
              "verificationMethod": "",
              "verificationPayload": "",
              "verificationPayloadHash": "",
              "verificationArtifact": "",
              "verificationSignedBy": "",
              "verificationSignedAs": "",
              "verificationJwsHeader": "",
              "timestamp": "",
              "signedWithoutObjectReference": "",
              "objectType": "",
              "objectReference": ""
            }
          },
          "lifecycle": {
            "id": "",
            "name": ""
          },
          "signature": {
            "id": "",
            "payload": "",
            "signature": "",
            "verificationMethod": "",
            "verificationPayload": "",
            "verificationPayloadHash": "",
            "verificationArtifact": "",
            "verificationSignedBy": "",
            "verificationSignedAs": "",
            "verificationJwsHeader": "",
            "timestamp": "",
            "signedWithoutObjectReference": "",
            "objectType": "",
            "objectReference": ""
          }
        },
        "lifecycle": {
          "id": "",
          "name": ""
        },
        "signature": {
          "id": "",
          "payload": "",
          "signature": "",
          "verificationMethod": "",
          "verificationPayload": "",
          "verificationPayloadHash": "",
          "verificationArtifact": "",
          "verificationSignedBy": "",
          "verificationSignedAs": "",
          "verificationJwsHeader": "",
          "timestamp": "",
          "signedWithoutObjectReference": "",
          "objectType": "",
          "objectReference": ""
        }
      },
      "dataAgreementRevision": {
        "id": "",
        "schemaName": "",
        "objectId": "",
        "signedWithoutObjectId": "",
        "serializedSnapshot": "",
        "serializedHash": "",
        "timestamp": "",
        "authorizedByIndividual": {
          "id": "",
          "externalId": "",
          "externalIdType": "",
          "identityProviderId": ""
        },
        "authorizedByOther": "",
        "successor": {
          "id": "",
          "schemaName": "",
          "objectId": "",
          "signedWithoutObjectId": "",
          "serializedSnapshot": "",
          "serializedHash": "",
          "timestamp": "",
          "authorizedByIndividual": {
            "id": "",
            "externalId": "",
            "externalIdType": "",
            "identityProviderId": ""
          },
          "authorizedByOther": "",
          "successor": {
            "id": "",
            "schemaName": "",
            "objectId": "",
            "signedWithoutObjectId": "",
            "serializedSnapshot": "",
            "serializedHash": "",
            "timestamp": "",
            "authorizedByIndividual": {
              "id": "",
              "externalId": "",
              "externalIdType": "",
              "identityProviderId": ""
            },
            "authorizedByOther": "",
            "successor": "[Circular Reference]",
            "predecessorHash": "",
            "predecessorSignature": ""
          },
          "predecessorHash": "",
          "predecessorSignature": ""
        },
        "predecessorHash": "",
        "predecessorSignature": ""
      },
      "dataAgreementRevisionHash": "",
      "individual": {
        "id": "",
        "externalId": "",
        "externalIdType": "",
        "identityProviderId": ""
      },
      "optIn": "",
      "state": "",
      "signature": {
        "id": "",
        "payload": "",
        "signature": "",
        "verificationMethod": "",
        "verificationPayload": "",
        "verificationPayloadHash": "",
        "verificationArtifact": "",
        "verificationSignedBy": "",
        "verificationSignedAs": "",
        "verificationJwsHeader": "",
        "timestamp": "",
        "signedWithoutObjectReference": "",
        "objectType": "",
        "objectReference": ""
      }
    }
  ]
}

READ - Reads a consent record by its ID.

get

READ - Reads a consent record by its ID.

Authorizations

Path parameters

consentRecordIdstringRequired

Unique ID of an object

Responses

application/json

objectOptional

get

HTTPcURLJavaScriptPython

GET /apis/GovStack/consent-management-bb//service/verification/consent-record/{consentRecordId}/ HTTP/1.1
Host: app.swaggerhub.com
Accept: */*

{
  "consentRecord": {
    "id": "",
    "dataAgreement": {
      "id": "",
      "version": "",
      "controller": {
        "id": "",
        "name": "",
        "url": ""
      },
      "policy": {
        "id": "",
        "name": "",
        "version": "",
        "url": "",
        "jurisdiction": "",
        "industrySector": "",
        "dataRetentionPeriodDays": "",
        "geographicRestriction": "",
        "storageLocation": ""
      },
      "purpose": "",
      "lawfulBasis": "",
      "dataUse": "",
      "dpia": "",
      "active": "",
      "forgettable": "",
      "compatibleWithVersion": {
        "id": "",
        "version": "",
        "controller": {
          "id": "",
          "name": "",
          "url": ""
        },
        "policy": {
          "id": "",
          "name": "",
          "version": "",
          "url": "",
          "jurisdiction": "",
          "industrySector": "",
          "dataRetentionPeriodDays": "",
          "geographicRestriction": "",
          "storageLocation": ""
        },
        "purpose": "",
        "lawfulBasis": "",
        "dataUse": "",
        "dpia": "",
        "active": "",
        "forgettable": "",
        "compatibleWithVersion": {
          "id": "",
          "version": "",
          "controller": {
            "id": "",
            "name": "",
            "url": ""
          },
          "policy": {
            "id": "",
            "name": "",
            "version": "",
            "url": "",
            "jurisdiction": "",
            "industrySector": "",
            "dataRetentionPeriodDays": "",
            "geographicRestriction": "",
            "storageLocation": ""
          },
          "purpose": "",
          "lawfulBasis": "",
          "dataUse": "",
          "dpia": "",
          "active": "",
          "forgettable": "",
          "compatibleWithVersion": {
            "id": "",
            "version": "",
            "controller": {
              "id": "",
              "name": "",
              "url": ""
            },
            "policy": {
              "id": "",
              "name": "",
              "version": "",
              "url": "",
              "jurisdiction": "",
              "industrySector": "",
              "dataRetentionPeriodDays": "",
              "geographicRestriction": "",
              "storageLocation": ""
            },
            "purpose": "",
            "lawfulBasis": "",
            "dataUse": "",
            "dpia": "",
            "active": "",
            "forgettable": "",
            "compatibleWithVersion": "[Circular Reference]",
            "lifecycle": {
              "id": "",
              "name": ""
            },
            "signature": {
              "id": "",
              "payload": "",
              "signature": "",
              "verificationMethod": "",
              "verificationPayload": "",
              "verificationPayloadHash": "",
              "verificationArtifact": "",
              "verificationSignedBy": "",
              "verificationSignedAs": "",
              "verificationJwsHeader": "",
              "timestamp": "",
              "signedWithoutObjectReference": "",
              "objectType": "",
              "objectReference": ""
            }
          },
          "lifecycle": {
            "id": "",
            "name": ""
          },
          "signature": {
            "id": "",
            "payload": "",
            "signature": "",
            "verificationMethod": "",
            "verificationPayload": "",
            "verificationPayloadHash": "",
            "verificationArtifact": "",
            "verificationSignedBy": "",
            "verificationSignedAs": "",
            "verificationJwsHeader": "",
            "timestamp": "",
            "signedWithoutObjectReference": "",
            "objectType": "",
            "objectReference": ""
          }
        },
        "lifecycle": {
          "id": "",
          "name": ""
        },
        "signature": {
          "id": "",
          "payload": "",
          "signature": "",
          "verificationMethod": "",
          "verificationPayload": "",
          "verificationPayloadHash": "",
          "verificationArtifact": "",
          "verificationSignedBy": "",
          "verificationSignedAs": "",
          "verificationJwsHeader": "",
          "timestamp": "",
          "signedWithoutObjectReference": "",
          "objectType": "",
          "objectReference": ""
        }
      },
      "lifecycle": {
        "id": "",
        "name": ""
      },
      "signature": {
        "id": "",
        "payload": "",
        "signature": "",
        "verificationMethod": "",
        "verificationPayload": "",
        "verificationPayloadHash": "",
        "verificationArtifact": "",
        "verificationSignedBy": "",
        "verificationSignedAs": "",
        "verificationJwsHeader": "",
        "timestamp": "",
        "signedWithoutObjectReference": "",
        "objectType": "",
        "objectReference": ""
      }
    },
    "dataAgreementRevision": {
      "id": "",
      "schemaName": "",
      "objectId": "",
      "signedWithoutObjectId": "",
      "serializedSnapshot": "",
      "serializedHash": "",
      "timestamp": "",
      "authorizedByIndividual": {
        "id": "",
        "externalId": "",
        "externalIdType": "",
        "identityProviderId": ""
      },
      "authorizedByOther": "",
      "successor": {
        "id": "",
        "schemaName": "",
        "objectId": "",
        "signedWithoutObjectId": "",
        "serializedSnapshot": "",
        "serializedHash": "",
        "timestamp": "",
        "authorizedByIndividual": {
          "id": "",
          "externalId": "",
          "externalIdType": "",
          "identityProviderId": ""
        },
        "authorizedByOther": "",
        "successor": {
          "id": "",
          "schemaName": "",
          "objectId": "",
          "signedWithoutObjectId": "",
          "serializedSnapshot": "",
          "serializedHash": "",
          "timestamp": "",
          "authorizedByIndividual": {
            "id": "",
            "externalId": "",
            "externalIdType": "",
            "identityProviderId": ""
          },
          "authorizedByOther": "",
          "successor": {
            "id": "",
            "schemaName": "",
            "objectId": "",
            "signedWithoutObjectId": "",
            "serializedSnapshot": "",
            "serializedHash": "",
            "timestamp": "",
            "authorizedByIndividual": {
              "id": "",
              "externalId": "",
              "externalIdType": "",
              "identityProviderId": ""
            },
            "authorizedByOther": "",
            "successor": "[Circular Reference]",
            "predecessorHash": "",
            "predecessorSignature": ""
          },
          "predecessorHash": "",
          "predecessorSignature": ""
        },
        "predecessorHash": "",
        "predecessorSignature": ""
      },
      "predecessorHash": "",
      "predecessorSignature": ""
    },
    "dataAgreementRevisionHash": "",
    "individual": {
      "id": "",
      "externalId": "",
      "externalIdType": "",
      "identityProviderId": ""
    },
    "optIn": "",
    "state": "",
    "signature": {
      "id": "",
      "payload": "",
      "signature": "",
      "verificationMethod": "",
      "verificationPayload": "",
      "verificationPayloadHash": "",
      "verificationArtifact": "",
      "verificationSignedBy": "",
      "verificationSignedAs": "",
      "verificationJwsHeader": "",
      "timestamp": "",
      "signedWithoutObjectReference": "",
      "objectType": "",
      "objectReference": ""
    }
  },
  "revision": {
    "id": "",
    "schemaName": "",
    "objectId": "",
    "signedWithoutObjectId": "",
    "serializedSnapshot": "",
    "serializedHash": "",
    "timestamp": "",
    "authorizedByIndividual": {
      "id": "",
      "externalId": "",
      "externalIdType": "",
      "identityProviderId": ""
    },
    "authorizedByOther": "",
    "successor": {
      "id": "",
      "schemaName": "",
      "objectId": "",
      "signedWithoutObjectId": "",
      "serializedSnapshot": "",
      "serializedHash": "",
      "timestamp": "",
      "authorizedByIndividual": {
        "id": "",
        "externalId": "",
        "externalIdType": "",
        "identityProviderId": ""
      },
      "authorizedByOther": "",
      "successor": {
        "id": "",
        "schemaName": "",
        "objectId": "",
        "signedWithoutObjectId": "",
        "serializedSnapshot": "",
        "serializedHash": "",
        "timestamp": "",
        "authorizedByIndividual": {
          "id": "",
          "externalId": "",
          "externalIdType": "",
          "identityProviderId": ""
        },
        "authorizedByOther": "",
        "successor": {
          "id": "",
          "schemaName": "",
          "objectId": "",
          "signedWithoutObjectId": "",
          "serializedSnapshot": "",
          "serializedHash": "",
          "timestamp": "",
          "authorizedByIndividual": {
            "id": "",
            "externalId": "",
            "externalIdType": "",
            "identityProviderId": ""
          },
          "authorizedByOther": "",
          "successor": "[Circular Reference]",
          "predecessorHash": "",
          "predecessorSignature": ""
        },
        "predecessorHash": "",
        "predecessorSignature": ""
      },
      "predecessorHash": "",
      "predecessorSignature": ""
    },
    "predecessorHash": "",
    "predecessorSignature": ""
  }
}

CREATE - For a particular Individual and a particular Agreement, create a new Consent Record pointing to the current Revision of a given Agreement. Individual ID supplied as HTTP header.

post

CREATE - For a particular Individual and a particular Agreement, create a new Consent Record pointing to the current Revision of a given Agreement. Individual ID supplied as HTTP header.

Authorizations

Path parameters

dataAgreementIdstringRequired

Unique ID of an object

Query parameters

individualIdstringRequired

An object with id individualId

revisionIdstringOptional

An object with id revisionId

Responses

application/json

objectOptional

post

HTTPcURLJavaScriptPython

POST /apis/GovStack/consent-management-bb//service/individual/record/data-agreement/{dataAgreementId}/ HTTP/1.1
Host: app.swaggerhub.com
Accept: */*

{
  "consentRecord": {
    "id": "",
    "dataAgreement": {
      "id": "",
      "version": "",
      "controller": {
        "id": "",
        "name": "",
        "url": ""
      },
      "policy": {
        "id": "",
        "name": "",
        "version": "",
        "url": "",
        "jurisdiction": "",
        "industrySector": "",
        "dataRetentionPeriodDays": "",
        "geographicRestriction": "",
        "storageLocation": ""
      },
      "purpose": "",
      "lawfulBasis": "",
      "dataUse": "",
      "dpia": "",
      "active": "",
      "forgettable": "",
      "compatibleWithVersion": {
        "id": "",
        "version": "",
        "controller": {
          "id": "",
          "name": "",
          "url": ""
        },
        "policy": {
          "id": "",
          "name": "",
          "version": "",
          "url": "",
          "jurisdiction": "",
          "industrySector": "",
          "dataRetentionPeriodDays": "",
          "geographicRestriction": "",
          "storageLocation": ""
        },
        "purpose": "",
        "lawfulBasis": "",
        "dataUse": "",
        "dpia": "",
        "active": "",
        "forgettable": "",
        "compatibleWithVersion": {
          "id": "",
          "version": "",
          "controller": {
            "id": "",
            "name": "",
            "url": ""
          },
          "policy": {
            "id": "",
            "name": "",
            "version": "",
            "url": "",
            "jurisdiction": "",
            "industrySector": "",
            "dataRetentionPeriodDays": "",
            "geographicRestriction": "",
            "storageLocation": ""
          },
          "purpose": "",
          "lawfulBasis": "",
          "dataUse": "",
          "dpia": "",
          "active": "",
          "forgettable": "",
          "compatibleWithVersion": {
            "id": "",
            "version": "",
            "controller": {
              "id": "",
              "name": "",
              "url": ""
            },
            "policy": {
              "id": "",
              "name": "",
              "version": "",
              "url": "",
              "jurisdiction": "",
              "industrySector": "",
              "dataRetentionPeriodDays": "",
              "geographicRestriction": "",
              "storageLocation": ""
            },
            "purpose": "",
            "lawfulBasis": "",
            "dataUse": "",
            "dpia": "",
            "active": "",
            "forgettable": "",
            "compatibleWithVersion": "[Circular Reference]",
            "lifecycle": {
              "id": "",
              "name": ""
            },
            "signature": {
              "id": "",
              "payload": "",
              "signature": "",
              "verificationMethod": "",
              "verificationPayload": "",
              "verificationPayloadHash": "",
              "verificationArtifact": "",
              "verificationSignedBy": "",
              "verificationSignedAs": "",
              "verificationJwsHeader": "",
              "timestamp": "",
              "signedWithoutObjectReference": "",
              "objectType": "",
              "objectReference": ""
            }
          },
          "lifecycle": {
            "id": "",
            "name": ""
          },
          "signature": {
            "id": "",
            "payload": "",
            "signature": "",
            "verificationMethod": "",
            "verificationPayload": "",
            "verificationPayloadHash": "",
            "verificationArtifact": "",
            "verificationSignedBy": "",
            "verificationSignedAs": "",
            "verificationJwsHeader": "",
            "timestamp": "",
            "signedWithoutObjectReference": "",
            "objectType": "",
            "objectReference": ""
          }
        },
        "lifecycle": {
          "id": "",
          "name": ""
        },
        "signature": {
          "id": "",
          "payload": "",
          "signature": "",
          "verificationMethod": "",
          "verificationPayload": "",
          "verificationPayloadHash": "",
          "verificationArtifact": "",
          "verificationSignedBy": "",
          "verificationSignedAs": "",
          "verificationJwsHeader": "",
          "timestamp": "",
          "signedWithoutObjectReference": "",
          "objectType": "",
          "objectReference": ""
        }
      },
      "lifecycle": {
        "id": "",
        "name": ""
      },
      "signature": {
        "id": "",
        "payload": "",
        "signature": "",
        "verificationMethod": "",
        "verificationPayload": "",
        "verificationPayloadHash": "",
        "verificationArtifact": "",
        "verificationSignedBy": "",
        "verificationSignedAs": "",
        "verificationJwsHeader": "",
        "timestamp": "",
        "signedWithoutObjectReference": "",
        "objectType": "",
        "objectReference": ""
      }
    },
    "dataAgreementRevision": {
      "id": "",
      "schemaName": "",
      "objectId": "",
      "signedWithoutObjectId": "",
      "serializedSnapshot": "",
      "serializedHash": "",
      "timestamp": "",
      "authorizedByIndividual": {
        "id": "",
        "externalId": "",
        "externalIdType": "",
        "identityProviderId": ""
      },
      "authorizedByOther": "",
      "successor": {
        "id": "",
        "schemaName": "",
        "objectId": "",
        "signedWithoutObjectId": "",
        "serializedSnapshot": "",
        "serializedHash": "",
        "timestamp": "",
        "authorizedByIndividual": {
          "id": "",
          "externalId": "",
          "externalIdType": "",
          "identityProviderId": ""
        },
        "authorizedByOther": "",
        "successor": {
          "id": "",
          "schemaName": "",
          "objectId": "",
          "signedWithoutObjectId": "",
          "serializedSnapshot": "",
          "serializedHash": "",
          "timestamp": "",
          "authorizedByIndividual": {
            "id": "",
            "externalId": "",
            "externalIdType": "",
            "identityProviderId": ""
          },
          "authorizedByOther": "",
          "successor": {
            "id": "",
            "schemaName": "",
            "objectId": "",
            "signedWithoutObjectId": "",
            "serializedSnapshot": "",
            "serializedHash": "",
            "timestamp": "",
            "authorizedByIndividual": {
              "id": "",
              "externalId": "",
              "externalIdType": "",
              "identityProviderId": ""
            },
            "authorizedByOther": "",
            "successor": "[Circular Reference]",
            "predecessorHash": "",
            "predecessorSignature": ""
          },
          "predecessorHash": "",
          "predecessorSignature": ""
        },
        "predecessorHash": "",
        "predecessorSignature": ""
      },
      "predecessorHash": "",
      "predecessorSignature": ""
    },
    "dataAgreementRevisionHash": "",
    "individual": {
      "id": "",
      "externalId": "",
      "externalIdType": "",
      "identityProviderId": ""
    },
    "optIn": "",
    "state": "",
    "signature": {
      "id": "",
      "payload": "",
      "signature": "",
      "verificationMethod": "",
      "verificationPayload": "",
      "verificationPayloadHash": "",
      "verificationArtifact": "",
      "verificationSignedBy": "",
      "verificationSignedAs": "",
      "verificationJwsHeader": "",
      "timestamp": "",
      "signedWithoutObjectReference": "",
      "objectType": "",
      "objectReference": ""
    }
  },
  "revision": {
    "id": "",
    "schemaName": "",
    "objectId": "",
    "signedWithoutObjectId": "",
    "serializedSnapshot": "",
    "serializedHash": "",
    "timestamp": "",
    "authorizedByIndividual": {
      "id": "",
      "externalId": "",
      "externalIdType": "",
      "identityProviderId": ""
    },
    "authorizedByOther": "",
    "successor": {
      "id": "",
      "schemaName": "",
      "objectId": "",
      "signedWithoutObjectId": "",
      "serializedSnapshot": "",
      "serializedHash": "",
      "timestamp": "",
      "authorizedByIndividual": {
        "id": "",
        "externalId": "",
        "externalIdType": "",
        "identityProviderId": ""
      },
      "authorizedByOther": "",
      "successor": {
        "id": "",
        "schemaName": "",
        "objectId": "",
        "signedWithoutObjectId": "",
        "serializedSnapshot": "",
        "serializedHash": "",
        "timestamp": "",
        "authorizedByIndividual": {
          "id": "",
          "externalId": "",
          "externalIdType": "",
          "identityProviderId": ""
        },
        "authorizedByOther": "",
        "successor": {
          "id": "",
          "schemaName": "",
          "objectId": "",
          "signedWithoutObjectId": "",
          "serializedSnapshot": "",
          "serializedHash": "",
          "timestamp": "",
          "authorizedByIndividual": {
            "id": "",
            "externalId": "",
            "externalIdType": "",
            "identityProviderId": ""
          },
          "authorizedByOther": "",
          "successor": "[Circular Reference]",
          "predecessorHash": "",
          "predecessorSignature": ""
        },
        "predecessorHash": "",
        "predecessorSignature": ""
      },
      "predecessorHash": "",
      "predecessorSignature": ""
    },
    "predecessorHash": "",
    "predecessorSignature": ""
  }
}

READ - Individual ID supplied as HTTP header. Fetches the current ConsentRecord for an Agreement. There should be one unambiguous ConsentRecord for an Individual and an Agreement.

get

READ - Individual ID supplied as HTTP header. Fetches the current ConsentRecord for an Agreement. There should be one unambiguous ConsentRecord for an Individual and an Agreement.

Authorizations

Path parameters

dataAgreementIdstringRequired

Unique ID of an object

Responses

application/json

objectOptional

get

HTTPcURLJavaScriptPython

GET /apis/GovStack/consent-management-bb//service/individual/record/data-agreement/{dataAgreementId}/ HTTP/1.1
Host: app.swaggerhub.com
Accept: */*

{
  "consentRecord": {
    "id": "",
    "dataAgreement": {
      "id": "",
      "version": "",
      "controller": {
        "id": "",
        "name": "",
        "url": ""
      },
      "policy": {
        "id": "",
        "name": "",
        "version": "",
        "url": "",
        "jurisdiction": "",
        "industrySector": "",
        "dataRetentionPeriodDays": "",
        "geographicRestriction": "",
        "storageLocation": ""
      },
      "purpose": "",
      "lawfulBasis": "",
      "dataUse": "",
      "dpia": "",
      "active": "",
      "forgettable": "",
      "compatibleWithVersion": {
        "id": "",
        "version": "",
        "controller": {
          "id": "",
          "name": "",
          "url": ""
        },
        "policy": {
          "id": "",
          "name": "",
          "version": "",
          "url": "",
          "jurisdiction": "",
          "industrySector": "",
          "dataRetentionPeriodDays": "",
          "geographicRestriction": "",
          "storageLocation": ""
        },
        "purpose": "",
        "lawfulBasis": "",
        "dataUse": "",
        "dpia": "",
        "active": "",
        "forgettable": "",
        "compatibleWithVersion": {
          "id": "",
          "version": "",
          "controller": {
            "id": "",
            "name": "",
            "url": ""
          },
          "policy": {
            "id": "",
            "name": "",
            "version": "",
            "url": "",
            "jurisdiction": "",
            "industrySector": "",
            "dataRetentionPeriodDays": "",
            "geographicRestriction": "",
            "storageLocation": ""
          },
          "purpose": "",
          "lawfulBasis": "",
          "dataUse": "",
          "dpia": "",
          "active": "",
          "forgettable": "",
          "compatibleWithVersion": {
            "id": "",
            "version": "",
            "controller": {
              "id": "",
              "name": "",
              "url": ""
            },
            "policy": {
              "id": "",
              "name": "",
              "version": "",
              "url": "",
              "jurisdiction": "",
              "industrySector": "",
              "dataRetentionPeriodDays": "",
              "geographicRestriction": "",
              "storageLocation": ""
            },
            "purpose": "",
            "lawfulBasis": "",
            "dataUse": "",
            "dpia": "",
            "active": "",
            "forgettable": "",
            "compatibleWithVersion": "[Circular Reference]",
            "lifecycle": {
              "id": "",
              "name": ""
            },
            "signature": {
              "id": "",
              "payload": "",
              "signature": "",
              "verificationMethod": "",
              "verificationPayload": "",
              "verificationPayloadHash": "",
              "verificationArtifact": "",
              "verificationSignedBy": "",
              "verificationSignedAs": "",
              "verificationJwsHeader": "",
              "timestamp": "",
              "signedWithoutObjectReference": "",
              "objectType": "",
              "objectReference": ""
            }
          },
          "lifecycle": {
            "id": "",
            "name": ""
          },
          "signature": {
            "id": "",
            "payload": "",
            "signature": "",
            "verificationMethod": "",
            "verificationPayload": "",
            "verificationPayloadHash": "",
            "verificationArtifact": "",
            "verificationSignedBy": "",
            "verificationSignedAs": "",
            "verificationJwsHeader": "",
            "timestamp": "",
            "signedWithoutObjectReference": "",
            "objectType": "",
            "objectReference": ""
          }
        },
        "lifecycle": {
          "id": "",
          "name": ""
        },
        "signature": {
          "id": "",
          "payload": "",
          "signature": "",
          "verificationMethod": "",
          "verificationPayload": "",
          "verificationPayloadHash": "",
          "verificationArtifact": "",
          "verificationSignedBy": "",
          "verificationSignedAs": "",
          "verificationJwsHeader": "",
          "timestamp": "",
          "signedWithoutObjectReference": "",
          "objectType": "",
          "objectReference": ""
        }
      },
      "lifecycle": {
        "id": "",
        "name": ""
      },
      "signature": {
        "id": "",
        "payload": "",
        "signature": "",
        "verificationMethod": "",
        "verificationPayload": "",
        "verificationPayloadHash": "",
        "verificationArtifact": "",
        "verificationSignedBy": "",
        "verificationSignedAs": "",
        "verificationJwsHeader": "",
        "timestamp": "",
        "signedWithoutObjectReference": "",
        "objectType": "",
        "objectReference": ""
      }
    },
    "dataAgreementRevision": {
      "id": "",
      "schemaName": "",
      "objectId": "",
      "signedWithoutObjectId": "",
      "serializedSnapshot": "",
      "serializedHash": "",
      "timestamp": "",
      "authorizedByIndividual": {
        "id": "",
        "externalId": "",
        "externalIdType": "",
        "identityProviderId": ""
      },
      "authorizedByOther": "",
      "successor": {
        "id": "",
        "schemaName": "",
        "objectId": "",
        "signedWithoutObjectId": "",
        "serializedSnapshot": "",
        "serializedHash": "",
        "timestamp": "",
        "authorizedByIndividual": {
          "id": "",
          "externalId": "",
          "externalIdType": "",
          "identityProviderId": ""
        },
        "authorizedByOther": "",
        "successor": {
          "id": "",
          "schemaName": "",
          "objectId": "",
          "signedWithoutObjectId": "",
          "serializedSnapshot": "",
          "serializedHash": "",
          "timestamp": "",
          "authorizedByIndividual": {
            "id": "",
            "externalId": "",
            "externalIdType": "",
            "identityProviderId": ""
          },
          "authorizedByOther": "",
          "successor": {
            "id": "",
            "schemaName": "",
            "objectId": "",
            "signedWithoutObjectId": "",
            "serializedSnapshot": "",
            "serializedHash": "",
            "timestamp": "",
            "authorizedByIndividual": {
              "id": "",
              "externalId": "",
              "externalIdType": "",
              "identityProviderId": ""
            },
            "authorizedByOther": "",
            "successor": "[Circular Reference]",
            "predecessorHash": "",
            "predecessorSignature": ""
          },
          "predecessorHash": "",
          "predecessorSignature": ""
        },
        "predecessorHash": "",
        "predecessorSignature": ""
      },
      "predecessorHash": "",
      "predecessorSignature": ""
    },
    "dataAgreementRevisionHash": "",
    "individual": {
      "id": "",
      "externalId": "",
      "externalIdType": "",
      "identityProviderId": ""
    },
    "optIn": "",
    "state": "",
    "signature": {
      "id": "",
      "payload": "",
      "signature": "",
      "verificationMethod": "",
      "verificationPayload": "",
      "verificationPayloadHash": "",
      "verificationArtifact": "",
      "verificationSignedBy": "",
      "verificationSignedAs": "",
      "verificationJwsHeader": "",
      "timestamp": "",
      "signedWithoutObjectReference": "",
      "objectType": "",
      "objectReference": ""
    }
  }
}

CREATE - Gets a DRAFT (unsaved) ConsentRecord and Signature objects (without a PK) for a given dataAgreementId.

post

CREATE - Gets a DRAFT (unsaved) ConsentRecord and Signature objects (without a PK) for a given dataAgreementId.

Authorizations

Query parameters

individualIdstringRequired

An object with id individualId

dataAgreementIdstringRequired

An object with id dataAgreementId

revisionIdstringOptional

An object with id revisionId

Responses

application/json

objectOptional

post

HTTPcURLJavaScriptPython

POST /apis/GovStack/consent-management-bb//service/individual/record/consent-record/draft/ HTTP/1.1
Host: app.swaggerhub.com
Accept: */*

{
  "consentRecord": {
    "id": "",
    "dataAgreement": {
      "id": "",
      "version": "",
      "controller": {
        "id": "",
        "name": "",
        "url": ""
      },
      "policy": {
        "id": "",
        "name": "",
        "version": "",
        "url": "",
        "jurisdiction": "",
        "industrySector": "",
        "dataRetentionPeriodDays": "",
        "geographicRestriction": "",
        "storageLocation": ""
      },
      "purpose": "",
      "lawfulBasis": "",
      "dataUse": "",
      "dpia": "",
      "active": "",
      "forgettable": "",
      "compatibleWithVersion": {
        "id": "",
        "version": "",
        "controller": {
          "id": "",
          "name": "",
          "url": ""
        },
        "policy": {
          "id": "",
          "name": "",
          "version": "",
          "url": "",
          "jurisdiction": "",
          "industrySector": "",
          "dataRetentionPeriodDays": "",
          "geographicRestriction": "",
          "storageLocation": ""
        },
        "purpose": "",
        "lawfulBasis": "",
        "dataUse": "",
        "dpia": "",
        "active": "",
        "forgettable": "",
        "compatibleWithVersion": {
          "id": "",
          "version": "",
          "controller": {
            "id": "",
            "name": "",
            "url": ""
          },
          "policy": {
            "id": "",
            "name": "",
            "version": "",
            "url": "",
            "jurisdiction": "",
            "industrySector": "",
            "dataRetentionPeriodDays": "",
            "geographicRestriction": "",
            "storageLocation": ""
          },
          "purpose": "",
          "lawfulBasis": "",
          "dataUse": "",
          "dpia": "",
          "active": "",
          "forgettable": "",
          "compatibleWithVersion": {
            "id": "",
            "version": "",
            "controller": {
              "id": "",
              "name": "",
              "url": ""
            },
            "policy": {
              "id": "",
              "name": "",
              "version": "",
              "url": "",
              "jurisdiction": "",
              "industrySector": "",
              "dataRetentionPeriodDays": "",
              "geographicRestriction": "",
              "storageLocation": ""
            },
            "purpose": "",
            "lawfulBasis": "",
            "dataUse": "",
            "dpia": "",
            "active": "",
            "forgettable": "",
            "compatibleWithVersion": "[Circular Reference]",
            "lifecycle": {
              "id": "",
              "name": ""
            },
            "signature": {
              "id": "",
              "payload": "",
              "signature": "",
              "verificationMethod": "",
              "verificationPayload": "",
              "verificationPayloadHash": "",
              "verificationArtifact": "",
              "verificationSignedBy": "",
              "verificationSignedAs": "",
              "verificationJwsHeader": "",
              "timestamp": "",
              "signedWithoutObjectReference": "",
              "objectType": "",
              "objectReference": ""
            }
          },
          "lifecycle": {
            "id": "",
            "name": ""
          },
          "signature": {
            "id": "",
            "payload": "",
            "signature": "",
            "verificationMethod": "",
            "verificationPayload": "",
            "verificationPayloadHash": "",
            "verificationArtifact": "",
            "verificationSignedBy": "",
            "verificationSignedAs": "",
            "verificationJwsHeader": "",
            "timestamp": "",
            "signedWithoutObjectReference": "",
            "objectType": "",
            "objectReference": ""
          }
        },
        "lifecycle": {
          "id": "",
          "name": ""
        },
        "signature": {
          "id": "",
          "payload": "",
          "signature": "",
          "verificationMethod": "",
          "verificationPayload": "",
          "verificationPayloadHash": "",
          "verificationArtifact": "",
          "verificationSignedBy": "",
          "verificationSignedAs": "",
          "verificationJwsHeader": "",
          "timestamp": "",
          "signedWithoutObjectReference": "",
          "objectType": "",
          "objectReference": ""
        }
      },
      "lifecycle": {
        "id": "",
        "name": ""
      },
      "signature": {
        "id": "",
        "payload": "",
        "signature": "",
        "verificationMethod": "",
        "verificationPayload": "",
        "verificationPayloadHash": "",
        "verificationArtifact": "",
        "verificationSignedBy": "",
        "verificationSignedAs": "",
        "verificationJwsHeader": "",
        "timestamp": "",
        "signedWithoutObjectReference": "",
        "objectType": "",
        "objectReference": ""
      }
    },
    "dataAgreementRevision": {
      "id": "",
      "schemaName": "",
      "objectId": "",
      "signedWithoutObjectId": "",
      "serializedSnapshot": "",
      "serializedHash": "",
      "timestamp": "",
      "authorizedByIndividual": {
        "id": "",
        "externalId": "",
        "externalIdType": "",
        "identityProviderId": ""
      },
      "authorizedByOther": "",
      "successor": {
        "id": "",
        "schemaName": "",
        "objectId": "",
        "signedWithoutObjectId": "",
        "serializedSnapshot": "",
        "serializedHash": "",
        "timestamp": "",
        "authorizedByIndividual": {
          "id": "",
          "externalId": "",
          "externalIdType": "",
          "identityProviderId": ""
        },
        "authorizedByOther": "",
        "successor": {
          "id": "",
          "schemaName": "",
          "objectId": "",
          "signedWithoutObjectId": "",
          "serializedSnapshot": "",
          "serializedHash": "",
          "timestamp": "",
          "authorizedByIndividual": {
            "id": "",
            "externalId": "",
            "externalIdType": "",
            "identityProviderId": ""
          },
          "authorizedByOther": "",
          "successor": {
            "id": "",
            "schemaName": "",
            "objectId": "",
            "signedWithoutObjectId": "",
            "serializedSnapshot": "",
            "serializedHash": "",
            "timestamp": "",
            "authorizedByIndividual": {
              "id": "",
              "externalId": "",
              "externalIdType": "",
              "identityProviderId": ""
            },
            "authorizedByOther": "",
            "successor": "[Circular Reference]",
            "predecessorHash": "",
            "predecessorSignature": ""
          },
          "predecessorHash": "",
          "predecessorSignature": ""
        },
        "predecessorHash": "",
        "predecessorSignature": ""
      },
      "predecessorHash": "",
      "predecessorSignature": ""
    },
    "dataAgreementRevisionHash": "",
    "individual": {
      "id": "",
      "externalId": "",
      "externalIdType": "",
      "identityProviderId": ""
    },
    "optIn": "",
    "state": "",
    "signature": {
      "id": "",
      "payload": "",
      "signature": "",
      "verificationMethod": "",
      "verificationPayload": "",
      "verificationPayloadHash": "",
      "verificationArtifact": "",
      "verificationSignedBy": "",
      "verificationSignedAs": "",
      "verificationJwsHeader": "",
      "timestamp": "",
      "signedWithoutObjectReference": "",
      "objectType": "",
      "objectReference": ""
    }
  },
  "signature": {
    "id": "",
    "payload": "",
    "signature": "",
    "verificationMethod": "",
    "verificationPayload": "",
    "verificationPayloadHash": "",
    "verificationArtifact": "",
    "verificationSignedBy": "",
    "verificationSignedAs": "",
    "verificationJwsHeader": "",
    "timestamp": "",
    "signedWithoutObjectReference": "",
    "objectType": "",
    "objectReference": ""
  }
}

CREATE - Creates a paired ConsentRecord and Signature object. Returns the same objects with the PK defined.

post

CREATE - Creates a paired ConsentRecord and Signature object. Returns the same objects with the PK defined.

Authorizations

Body

consentRecordobjectRequired

An object of type ConsentRecord

signatureobjectRequired

An object of type Signature

Responses

application/json

objectOptional

post

HTTPcURLJavaScriptPython

POST /apis/GovStack/consent-management-bb//service/individual/record/consent-record/ HTTP/1.1
Host: app.swaggerhub.com
Content-Type: application/json
Accept: */*
Content-Length: 4851

{
  "consentRecord": {
    "id": "",
    "dataAgreement": {
      "id": "",
      "version": "",
      "controller": {
        "id": "",
        "name": "",
        "url": ""
      },
      "policy": {
        "id": "",
        "name": "",
        "version": "",
        "url": "",
        "jurisdiction": "",
        "industrySector": "",
        "dataRetentionPeriodDays": "",
        "geographicRestriction": "",
        "storageLocation": ""
      },
      "purpose": "",
      "lawfulBasis": "",
      "dataUse": "",
      "dpia": "",
      "active": "",
      "forgettable": "",
      "compatibleWithVersion": {
        "id": "",
        "version": "",
        "controller": {
          "id": "",
          "name": "",
          "url": ""
        },
        "policy": {
          "id": "",
          "name": "",
          "version": "",
          "url": "",
          "jurisdiction": "",
          "industrySector": "",
          "dataRetentionPeriodDays": "",
          "geographicRestriction": "",
          "storageLocation": ""
        },
        "purpose": "",
        "lawfulBasis": "",
        "dataUse": "",
        "dpia": "",
        "active": "",
        "forgettable": "",
        "compatibleWithVersion": {
          "id": "",
          "version": "",
          "controller": {
            "id": "",
            "name": "",
            "url": ""
          },
          "policy": {
            "id": "",
            "name": "",
            "version": "",
            "url": "",
            "jurisdiction": "",
            "industrySector": "",
            "dataRetentionPeriodDays": "",
            "geographicRestriction": "",
            "storageLocation": ""
          },
          "purpose": "",
          "lawfulBasis": "",
          "dataUse": "",
          "dpia": "",
          "active": "",
          "forgettable": "",
          "compatibleWithVersion": {
            "id": "",
            "version": "",
            "controller": {
              "id": "",
              "name": "",
              "url": ""
            },
            "policy": {
              "id": "",
              "name": "",
              "version": "",
              "url": "",
              "jurisdiction": "",
              "industrySector": "",
              "dataRetentionPeriodDays": "",
              "geographicRestriction": "",
              "storageLocation": ""
            },
            "purpose": "",
            "lawfulBasis": "",
            "dataUse": "",
            "dpia": "",
            "active": "",
            "forgettable": "",
            "compatibleWithVersion": "[Circular Reference]",
            "lifecycle": {
              "id": "",
              "name": ""
            },
            "signature": {
              "id": "",
              "payload": "",
              "signature": "",
              "verificationMethod": "",
              "verificationPayload": "",
              "verificationPayloadHash": "",
              "verificationArtifact": "",
              "verificationSignedBy": "",
              "verificationSignedAs": "",
              "verificationJwsHeader": "",
              "timestamp": "",
              "signedWithoutObjectReference": "",
              "objectType": "",
              "objectReference": ""
            }
          },
          "lifecycle": {
            "id": "",
            "name": ""
          },
          "signature": {
            "id": "",
            "payload": "",
            "signature": "",
            "verificationMethod": "",
            "verificationPayload": "",
            "verificationPayloadHash": "",
            "verificationArtifact": "",
            "verificationSignedBy": "",
            "verificationSignedAs": "",
            "verificationJwsHeader": "",
            "timestamp": "",
            "signedWithoutObjectReference": "",
            "objectType": "",
            "objectReference": ""
          }
        },
        "lifecycle": {
          "id": "",
          "name": ""
        },
        "signature": {
          "id": "",
          "payload": "",
          "signature": "",
          "verificationMethod": "",
          "verificationPayload": "",
          "verificationPayloadHash": "",
          "verificationArtifact": "",
          "verificationSignedBy": "",
          "verificationSignedAs": "",
          "verificationJwsHeader": "",
          "timestamp": "",
          "signedWithoutObjectReference": "",
          "objectType": "",
          "objectReference": ""
        }
      },
      "lifecycle": {
        "id": "",
        "name": ""
      },
      "signature": {
        "id": "",
        "payload": "",
        "signature": "",
        "verificationMethod": "",
        "verificationPayload": "",
        "verificationPayloadHash": "",
        "verificationArtifact": "",
        "verificationSignedBy": "",
        "verificationSignedAs": "",
        "verificationJwsHeader": "",
        "timestamp": "",
        "signedWithoutObjectReference": "",
        "objectType": "",
        "objectReference": ""
      }
    },
    "dataAgreementRevision": {
      "id": "",
      "schemaName": "",
      "objectId": "",
      "signedWithoutObjectId": "",
      "serializedSnapshot": "",
      "serializedHash": "",
      "timestamp": "",
      "authorizedByIndividual": {
        "id": "",
        "externalId": "",
        "externalIdType": "",
        "identityProviderId": ""
      },
      "authorizedByOther": "",
      "successor": {
        "id": "",
        "schemaName": "",
        "objectId": "",
        "signedWithoutObjectId": "",
        "serializedSnapshot": "",
        "serializedHash": "",
        "timestamp": "",
        "authorizedByIndividual": {
          "id": "",
          "externalId": "",
          "externalIdType": "",
          "identityProviderId": ""
        },
        "authorizedByOther": "",
        "successor": {
          "id": "",
          "schemaName": "",
          "objectId": "",
          "signedWithoutObjectId": "",
          "serializedSnapshot": "",
          "serializedHash": "",
          "timestamp": "",
          "authorizedByIndividual": {
            "id": "",
            "externalId": "",
            "externalIdType": "",
            "identityProviderId": ""
          },
          "authorizedByOther": "",
          "successor": {
            "id": "",
            "schemaName": "",
            "objectId": "",
            "signedWithoutObjectId": "",
            "serializedSnapshot": "",
            "serializedHash": "",
            "timestamp": "",
            "authorizedByIndividual": {
              "id": "",
              "externalId": "",
              "externalIdType": "",
              "identityProviderId": ""
            },
            "authorizedByOther": "",
            "successor": "[Circular Reference]",
            "predecessorHash": "",
            "predecessorSignature": ""
          },
          "predecessorHash": "",
          "predecessorSignature": ""
        },
        "predecessorHash": "",
        "predecessorSignature": ""
      },
      "predecessorHash": "",
      "predecessorSignature": ""
    },
    "dataAgreementRevisionHash": "",
    "individual": {
      "id": "",
      "externalId": "",
      "externalIdType": "",
      "identityProviderId": ""
    },
    "optIn": "",
    "state": "",
    "signature": {
      "id": "",
      "payload": "",
      "signature": "",
      "verificationMethod": "",
      "verificationPayload": "",
      "verificationPayloadHash": "",
      "verificationArtifact": "",
      "verificationSignedBy": "",
      "verificationSignedAs": "",
      "verificationJwsHeader": "",
      "timestamp": "",
      "signedWithoutObjectReference": "",
      "objectType": "",
      "objectReference": ""
    }
  },
  "signature": {
    "id": "",
    "payload": "",
    "signature": "",
    "verificationMethod": "",
    "verificationPayload": "",
    "verificationPayloadHash": "",
    "verificationArtifact": "",
    "verificationSignedBy": "",
    "verificationSignedAs": "",
    "verificationJwsHeader": "",
    "timestamp": "",
    "signedWithoutObjectReference": "",
    "objectType": "",
    "objectReference": ""
  }
}

{
  "consentRecord": {
    "id": "",
    "dataAgreement": {
      "id": "",
      "version": "",
      "controller": {
        "id": "",
        "name": "",
        "url": ""
      },
      "policy": {
        "id": "",
        "name": "",
        "version": "",
        "url": "",
        "jurisdiction": "",
        "industrySector": "",
        "dataRetentionPeriodDays": "",
        "geographicRestriction": "",
        "storageLocation": ""
      },
      "purpose": "",
      "lawfulBasis": "",
      "dataUse": "",
      "dpia": "",
      "active": "",
      "forgettable": "",
      "compatibleWithVersion": {
        "id": "",
        "version": "",
        "controller": {
          "id": "",
          "name": "",
          "url": ""
        },
        "policy": {
          "id": "",
          "name": "",
          "version": "",
          "url": "",
          "jurisdiction": "",
          "industrySector": "",
          "dataRetentionPeriodDays": "",
          "geographicRestriction": "",
          "storageLocation": ""
        },
        "purpose": "",
        "lawfulBasis": "",
        "dataUse": "",
        "dpia": "",
        "active": "",
        "forgettable": "",
        "compatibleWithVersion": {
          "id": "",
          "version": "",
          "controller": {
            "id": "",
            "name": "",
            "url": ""
          },
          "policy": {
            "id": "",
            "name": "",
            "version": "",
            "url": "",
            "jurisdiction": "",
            "industrySector": "",
            "dataRetentionPeriodDays": "",
            "geographicRestriction": "",
            "storageLocation": ""
          },
          "purpose": "",
          "lawfulBasis": "",
          "dataUse": "",
          "dpia": "",
          "active": "",
          "forgettable": "",
          "compatibleWithVersion": {
            "id": "",
            "version": "",
            "controller": {
              "id": "",
              "name": "",
              "url": ""
            },
            "policy": {
              "id": "",
              "name": "",
              "version": "",
              "url": "",
              "jurisdiction": "",
              "industrySector": "",
              "dataRetentionPeriodDays": "",
              "geographicRestriction": "",
              "storageLocation": ""
            },
            "purpose": "",
            "lawfulBasis": "",
            "dataUse": "",
            "dpia": "",
            "active": "",
            "forgettable": "",
            "compatibleWithVersion": "[Circular Reference]",
            "lifecycle": {
              "id": "",
              "name": ""
            },
            "signature": {
              "id": "",
              "payload": "",
              "signature": "",
              "verificationMethod": "",
              "verificationPayload": "",
              "verificationPayloadHash": "",
              "verificationArtifact": "",
              "verificationSignedBy": "",
              "verificationSignedAs": "",
              "verificationJwsHeader": "",
              "timestamp": "",
              "signedWithoutObjectReference": "",
              "objectType": "",
              "objectReference": ""
            }
          },
          "lifecycle": {
            "id": "",
            "name": ""
          },
          "signature": {
            "id": "",
            "payload": "",
            "signature": "",
            "verificationMethod": "",
            "verificationPayload": "",
            "verificationPayloadHash": "",
            "verificationArtifact": "",
            "verificationSignedBy": "",
            "verificationSignedAs": "",
            "verificationJwsHeader": "",
            "timestamp": "",
            "signedWithoutObjectReference": "",
            "objectType": "",
            "objectReference": ""
          }
        },
        "lifecycle": {
          "id": "",
          "name": ""
        },
        "signature": {
          "id": "",
          "payload": "",
          "signature": "",
          "verificationMethod": "",
          "verificationPayload": "",
          "verificationPayloadHash": "",
          "verificationArtifact": "",
          "verificationSignedBy": "",
          "verificationSignedAs": "",
          "verificationJwsHeader": "",
          "timestamp": "",
          "signedWithoutObjectReference": "",
          "objectType": "",
          "objectReference": ""
        }
      },
      "lifecycle": {
        "id": "",
        "name": ""
      },
      "signature": {
        "id": "",
        "payload": "",
        "signature": "",
        "verificationMethod": "",
        "verificationPayload": "",
        "verificationPayloadHash": "",
        "verificationArtifact": "",
        "verificationSignedBy": "",
        "verificationSignedAs": "",
        "verificationJwsHeader": "",
        "timestamp": "",
        "signedWithoutObjectReference": "",
        "objectType": "",
        "objectReference": ""
      }
    },
    "dataAgreementRevision": {
      "id": "",
      "schemaName": "",
      "objectId": "",
      "signedWithoutObjectId": "",
      "serializedSnapshot": "",
      "serializedHash": "",
      "timestamp": "",
      "authorizedByIndividual": {
        "id": "",
        "externalId": "",
        "externalIdType": "",
        "identityProviderId": ""
      },
      "authorizedByOther": "",
      "successor": {
        "id": "",
        "schemaName": "",
        "objectId": "",
        "signedWithoutObjectId": "",
        "serializedSnapshot": "",
        "serializedHash": "",
        "timestamp": "",
        "authorizedByIndividual": {
          "id": "",
          "externalId": "",
          "externalIdType": "",
          "identityProviderId": ""
        },
        "authorizedByOther": "",
        "successor": {
          "id": "",
          "schemaName": "",
          "objectId": "",
          "signedWithoutObjectId": "",
          "serializedSnapshot": "",
          "serializedHash": "",
          "timestamp": "",
          "authorizedByIndividual": {
            "id": "",
            "externalId": "",
            "externalIdType": "",
            "identityProviderId": ""
          },
          "authorizedByOther": "",
          "successor": {
            "id": "",
            "schemaName": "",
            "objectId": "",
            "signedWithoutObjectId": "",
            "serializedSnapshot": "",
            "serializedHash": "",
            "timestamp": "",
            "authorizedByIndividual": {
              "id": "",
              "externalId": "",
              "externalIdType": "",
              "identityProviderId": ""
            },
            "authorizedByOther": "",
            "successor": "[Circular Reference]",
            "predecessorHash": "",
            "predecessorSignature": ""
          },
          "predecessorHash": "",
          "predecessorSignature": ""
        },
        "predecessorHash": "",
        "predecessorSignature": ""
      },
      "predecessorHash": "",
      "predecessorSignature": ""
    },
    "dataAgreementRevisionHash": "",
    "individual": {
      "id": "",
      "externalId": "",
      "externalIdType": "",
      "identityProviderId": ""
    },
    "optIn": "",
    "state": "",
    "signature": {
      "id": "",
      "payload": "",
      "signature": "",
      "verificationMethod": "",
      "verificationPayload": "",
      "verificationPayloadHash": "",
      "verificationArtifact": "",
      "verificationSignedBy": "",
      "verificationSignedAs": "",
      "verificationJwsHeader": "",
      "timestamp": "",
      "signedWithoutObjectReference": "",
      "objectType": "",
      "objectReference": ""
    }
  },
  "revision": {
    "id": "",
    "schemaName": "",
    "objectId": "",
    "signedWithoutObjectId": "",
    "serializedSnapshot": "",
    "serializedHash": "",
    "timestamp": "",
    "authorizedByIndividual": {
      "id": "",
      "externalId": "",
      "externalIdType": "",
      "identityProviderId": ""
    },
    "authorizedByOther": "",
    "successor": {
      "id": "",
      "schemaName": "",
      "objectId": "",
      "signedWithoutObjectId": "",
      "serializedSnapshot": "",
      "serializedHash": "",
      "timestamp": "",
      "authorizedByIndividual": {
        "id": "",
        "externalId": "",
        "externalIdType": "",
        "identityProviderId": ""
      },
      "authorizedByOther": "",
      "successor": {
        "id": "",
        "schemaName": "",
        "objectId": "",
        "signedWithoutObjectId": "",
        "serializedSnapshot": "",
        "serializedHash": "",
        "timestamp": "",
        "authorizedByIndividual": {
          "id": "",
          "externalId": "",
          "externalIdType": "",
          "identityProviderId": ""
        },
        "authorizedByOther": "",
        "successor": {
          "id": "",
          "schemaName": "",
          "objectId": "",
          "signedWithoutObjectId": "",
          "serializedSnapshot": "",
          "serializedHash": "",
          "timestamp": "",
          "authorizedByIndividual": {
            "id": "",
            "externalId": "",
            "externalIdType": "",
            "identityProviderId": ""
          },
          "authorizedByOther": "",
          "successor": "[Circular Reference]",
          "predecessorHash": "",
          "predecessorSignature": ""
        },
        "predecessorHash": "",
        "predecessorSignature": ""
      },
      "predecessorHash": "",
      "predecessorSignature": ""
    },
    "predecessorHash": "",
    "predecessorSignature": ""
  },
  "signature": {
    "id": "",
    "payload": "",
    "signature": "",
    "verificationMethod": "",
    "verificationPayload": "",
    "verificationPayloadHash": "",
    "verificationArtifact": "",
    "verificationSignedBy": "",
    "verificationSignedAs": "",
    "verificationJwsHeader": "",
    "timestamp": "",
    "signedWithoutObjectReference": "",
    "objectType": "",
    "objectReference": ""
  }
}

LIST - Fetches all current unambiguous consent records stored for Individual ID. Individual ID supplied as HTTP header.

get

LIST - Fetches all current unambiguous consent records stored for Individual ID. Individual ID supplied as HTTP header.

Authorizations

Query parameters

offsetintegerOptional

Requested index for start of resources to be provided in response requested by client

limitintegerOptional

Requested number of resources to be provided in response requested by client

Responses

application/json

objectOptional

get

HTTPcURLJavaScriptPython

GET /apis/GovStack/consent-management-bb//service/individual/record/consent-record/ HTTP/1.1
Host: app.swaggerhub.com
Accept: */*

{
  "consentRecords": [
    {
      "id": "",
      "dataAgreement": {
        "id": "",
        "version": "",
        "controller": {
          "id": "",
          "name": "",
          "url": ""
        },
        "policy": {
          "id": "",
          "name": "",
          "version": "",
          "url": "",
          "jurisdiction": "",
          "industrySector": "",
          "dataRetentionPeriodDays": "",
          "geographicRestriction": "",
          "storageLocation": ""
        },
        "purpose": "",
        "lawfulBasis": "",
        "dataUse": "",
        "dpia": "",
        "active": "",
        "forgettable": "",
        "compatibleWithVersion": {
          "id": "",
          "version": "",
          "controller": {
            "id": "",
            "name": "",
            "url": ""
          },
          "policy": {
            "id": "",
            "name": "",
            "version": "",
            "url": "",
            "jurisdiction": "",
            "industrySector": "",
            "dataRetentionPeriodDays": "",
            "geographicRestriction": "",
            "storageLocation": ""
          },
          "purpose": "",
          "lawfulBasis": "",
          "dataUse": "",
          "dpia": "",
          "active": "",
          "forgettable": "",
          "compatibleWithVersion": {
            "id": "",
            "version": "",
            "controller": {
              "id": "",
              "name": "",
              "url": ""
            },
            "policy": {
              "id": "",
              "name": "",
              "version": "",
              "url": "",
              "jurisdiction": "",
              "industrySector": "",
              "dataRetentionPeriodDays": "",
              "geographicRestriction": "",
              "storageLocation": ""
            },
            "purpose": "",
            "lawfulBasis": "",
            "dataUse": "",
            "dpia": "",
            "active": "",
            "forgettable": "",
            "compatibleWithVersion": "[Circular Reference]",
            "lifecycle": {
              "id": "",
              "name": ""
            },
            "signature": {
              "id": "",
              "payload": "",
              "signature": "",
              "verificationMethod": "",
              "verificationPayload": "",
              "verificationPayloadHash": "",
              "verificationArtifact": "",
              "verificationSignedBy": "",
              "verificationSignedAs": "",
              "verificationJwsHeader": "",
              "timestamp": "",
              "signedWithoutObjectReference": "",
              "objectType": "",
              "objectReference": ""
            }
          },
          "lifecycle": {
            "id": "",
            "name": ""
          },
          "signature": {
            "id": "",
            "payload": "",
            "signature": "",
            "verificationMethod": "",
            "verificationPayload": "",
            "verificationPayloadHash": "",
            "verificationArtifact": "",
            "verificationSignedBy": "",
            "verificationSignedAs": "",
            "verificationJwsHeader": "",
            "timestamp": "",
            "signedWithoutObjectReference": "",
            "objectType": "",
            "objectReference": ""
          }
        },
        "lifecycle": {
          "id": "",
          "name": ""
        },
        "signature": {
          "id": "",
          "payload": "",
          "signature": "",
          "verificationMethod": "",
          "verificationPayload": "",
          "verificationPayloadHash": "",
          "verificationArtifact": "",
          "verificationSignedBy": "",
          "verificationSignedAs": "",
          "verificationJwsHeader": "",
          "timestamp": "",
          "signedWithoutObjectReference": "",
          "objectType": "",
          "objectReference": ""
        }
      },
      "dataAgreementRevision": {
        "id": "",
        "schemaName": "",
        "objectId": "",
        "signedWithoutObjectId": "",
        "serializedSnapshot": "",
        "serializedHash": "",
        "timestamp": "",
        "authorizedByIndividual": {
          "id": "",
          "externalId": "",
          "externalIdType": "",
          "identityProviderId": ""
        },
        "authorizedByOther": "",
        "successor": {
          "id": "",
          "schemaName": "",
          "objectId": "",
          "signedWithoutObjectId": "",
          "serializedSnapshot": "",
          "serializedHash": "",
          "timestamp": "",
          "authorizedByIndividual": {
            "id": "",
            "externalId": "",
            "externalIdType": "",
            "identityProviderId": ""
          },
          "authorizedByOther": "",
          "successor": {
            "id": "",
            "schemaName": "",
            "objectId": "",
            "signedWithoutObjectId": "",
            "serializedSnapshot": "",
            "serializedHash": "",
            "timestamp": "",
            "authorizedByIndividual": {
              "id": "",
              "externalId": "",
              "externalIdType": "",
              "identityProviderId": ""
            },
            "authorizedByOther": "",
            "successor": "[Circular Reference]",
            "predecessorHash": "",
            "predecessorSignature": ""
          },
          "predecessorHash": "",
          "predecessorSignature": ""
        },
        "predecessorHash": "",
        "predecessorSignature": ""
      },
      "dataAgreementRevisionHash": "",
      "individual": {
        "id": "",
        "externalId": "",
        "externalIdType": "",
        "identityProviderId": ""
      },
      "optIn": "",
      "state": "",
      "signature": {
        "id": "",
        "payload": "",
        "signature": "",
        "verificationMethod": "",
        "verificationPayload": "",
        "verificationPayloadHash": "",
        "verificationArtifact": "",
        "verificationSignedBy": "",
        "verificationSignedAs": "",
        "verificationJwsHeader": "",
        "timestamp": "",
        "signedWithoutObjectReference": "",
        "objectType": "",
        "objectReference": ""
      }
    }
  ]
}

UPDATE* - Update a particular Consent Record, generating a new Revision object. Individual ID supplied as HTTP header. Note that updating a signed Consent Record invalidates its signature. Field set subject to update is restricted.

put

UPDATE* - Update a particular Consent Record, generating a new Revision object. Individual ID supplied as HTTP header. Note that updating a signed Consent Record invalidates its signature. Field set subject to update is restricted.

Authorizations

Path parameters

consentRecordIdstringRequired

Unique ID of an object

Body

consentRecordobjectRequired

An object of type ConsentRecord

Responses

application/json

objectOptional

put

HTTPcURLJavaScriptPython

PUT /apis/GovStack/consent-management-bb//service/individual/record/consent-record/{consentRecordId}/ HTTP/1.1
Host: app.swaggerhub.com
Content-Type: application/json
Accept: */*
Content-Length: 4532

{
  "consentRecord": {
    "id": "",
    "dataAgreement": {
      "id": "",
      "version": "",
      "controller": {
        "id": "",
        "name": "",
        "url": ""
      },
      "policy": {
        "id": "",
        "name": "",
        "version": "",
        "url": "",
        "jurisdiction": "",
        "industrySector": "",
        "dataRetentionPeriodDays": "",
        "geographicRestriction": "",
        "storageLocation": ""
      },
      "purpose": "",
      "lawfulBasis": "",
      "dataUse": "",
      "dpia": "",
      "active": "",
      "forgettable": "",
      "compatibleWithVersion": {
        "id": "",
        "version": "",
        "controller": {
          "id": "",
          "name": "",
          "url": ""
        },
        "policy": {
          "id": "",
          "name": "",
          "version": "",
          "url": "",
          "jurisdiction": "",
          "industrySector": "",
          "dataRetentionPeriodDays": "",
          "geographicRestriction": "",
          "storageLocation": ""
        },
        "purpose": "",
        "lawfulBasis": "",
        "dataUse": "",
        "dpia": "",
        "active": "",
        "forgettable": "",
        "compatibleWithVersion": {
          "id": "",
          "version": "",
          "controller": {
            "id": "",
            "name": "",
            "url": ""
          },
          "policy": {
            "id": "",
            "name": "",
            "version": "",
            "url": "",
            "jurisdiction": "",
            "industrySector": "",
            "dataRetentionPeriodDays": "",
            "geographicRestriction": "",
            "storageLocation": ""
          },
          "purpose": "",
          "lawfulBasis": "",
          "dataUse": "",
          "dpia": "",
          "active": "",
          "forgettable": "",
          "compatibleWithVersion": {
            "id": "",
            "version": "",
            "controller": {
              "id": "",
              "name": "",
              "url": ""
            },
            "policy": {
              "id": "",
              "name": "",
              "version": "",
              "url": "",
              "jurisdiction": "",
              "industrySector": "",
              "dataRetentionPeriodDays": "",
              "geographicRestriction": "",
              "storageLocation": ""
            },
            "purpose": "",
            "lawfulBasis": "",
            "dataUse": "",
            "dpia": "",
            "active": "",
            "forgettable": "",
            "compatibleWithVersion": "[Circular Reference]",
            "lifecycle": {
              "id": "",
              "name": ""
            },
            "signature": {
              "id": "",
              "payload": "",
              "signature": "",
              "verificationMethod": "",
              "verificationPayload": "",
              "verificationPayloadHash": "",
              "verificationArtifact": "",
              "verificationSignedBy": "",
              "verificationSignedAs": "",
              "verificationJwsHeader": "",
              "timestamp": "",
              "signedWithoutObjectReference": "",
              "objectType": "",
              "objectReference": ""
            }
          },
          "lifecycle": {
            "id": "",
            "name": ""
          },
          "signature": {
            "id": "",
            "payload": "",
            "signature": "",
            "verificationMethod": "",
            "verificationPayload": "",
            "verificationPayloadHash": "",
            "verificationArtifact": "",
            "verificationSignedBy": "",
            "verificationSignedAs": "",
            "verificationJwsHeader": "",
            "timestamp": "",
            "signedWithoutObjectReference": "",
            "objectType": "",
            "objectReference": ""
          }
        },
        "lifecycle": {
          "id": "",
          "name": ""
        },
        "signature": {
          "id": "",
          "payload": "",
          "signature": "",
          "verificationMethod": "",
          "verificationPayload": "",
          "verificationPayloadHash": "",
          "verificationArtifact": "",
          "verificationSignedBy": "",
          "verificationSignedAs": "",
          "verificationJwsHeader": "",
          "timestamp": "",
          "signedWithoutObjectReference": "",
          "objectType": "",
          "objectReference": ""
        }
      },
      "lifecycle": {
        "id": "",
        "name": ""
      },
      "signature": {
        "id": "",
        "payload": "",
        "signature": "",
        "verificationMethod": "",
        "verificationPayload": "",
        "verificationPayloadHash": "",
        "verificationArtifact": "",
        "verificationSignedBy": "",
        "verificationSignedAs": "",
        "verificationJwsHeader": "",
        "timestamp": "",
        "signedWithoutObjectReference": "",
        "objectType": "",
        "objectReference": ""
      }
    },
    "dataAgreementRevision": {
      "id": "",
      "schemaName": "",
      "objectId": "",
      "signedWithoutObjectId": "",
      "serializedSnapshot": "",
      "serializedHash": "",
      "timestamp": "",
      "authorizedByIndividual": {
        "id": "",
        "externalId": "",
        "externalIdType": "",
        "identityProviderId": ""
      },
      "authorizedByOther": "",
      "successor": {
        "id": "",
        "schemaName": "",
        "objectId": "",
        "signedWithoutObjectId": "",
        "serializedSnapshot": "",
        "serializedHash": "",
        "timestamp": "",
        "authorizedByIndividual": {
          "id": "",
          "externalId": "",
          "externalIdType": "",
          "identityProviderId": ""
        },
        "authorizedByOther": "",
        "successor": {
          "id": "",
          "schemaName": "",
          "objectId": "",
          "signedWithoutObjectId": "",
          "serializedSnapshot": "",
          "serializedHash": "",
          "timestamp": "",
          "authorizedByIndividual": {
            "id": "",
            "externalId": "",
            "externalIdType": "",
            "identityProviderId": ""
          },
          "authorizedByOther": "",
          "successor": {
            "id": "",
            "schemaName": "",
            "objectId": "",
            "signedWithoutObjectId": "",
            "serializedSnapshot": "",
            "serializedHash": "",
            "timestamp": "",
            "authorizedByIndividual": {
              "id": "",
              "externalId": "",
              "externalIdType": "",
              "identityProviderId": ""
            },
            "authorizedByOther": "",
            "successor": "[Circular Reference]",
            "predecessorHash": "",
            "predecessorSignature": ""
          },
          "predecessorHash": "",
          "predecessorSignature": ""
        },
        "predecessorHash": "",
        "predecessorSignature": ""
      },
      "predecessorHash": "",
      "predecessorSignature": ""
    },
    "dataAgreementRevisionHash": "",
    "individual": {
      "id": "",
      "externalId": "",
      "externalIdType": "",
      "identityProviderId": ""
    },
    "optIn": "",
    "state": "",
    "signature": {
      "id": "",
      "payload": "",
      "signature": "",
      "verificationMethod": "",
      "verificationPayload": "",
      "verificationPayloadHash": "",
      "verificationArtifact": "",
      "verificationSignedBy": "",
      "verificationSignedAs": "",
      "verificationJwsHeader": "",
      "timestamp": "",
      "signedWithoutObjectReference": "",
      "objectType": "",
      "objectReference": ""
    }
  }
}

{
  "consentRecord": {
    "id": "",
    "dataAgreement": {
      "id": "",
      "version": "",
      "controller": {
        "id": "",
        "name": "",
        "url": ""
      },
      "policy": {
        "id": "",
        "name": "",
        "version": "",
        "url": "",
        "jurisdiction": "",
        "industrySector": "",
        "dataRetentionPeriodDays": "",
        "geographicRestriction": "",
        "storageLocation": ""
      },
      "purpose": "",
      "lawfulBasis": "",
      "dataUse": "",
      "dpia": "",
      "active": "",
      "forgettable": "",
      "compatibleWithVersion": {
        "id": "",
        "version": "",
        "controller": {
          "id": "",
          "name": "",
          "url": ""
        },
        "policy": {
          "id": "",
          "name": "",
          "version": "",
          "url": "",
          "jurisdiction": "",
          "industrySector": "",
          "dataRetentionPeriodDays": "",
          "geographicRestriction": "",
          "storageLocation": ""
        },
        "purpose": "",
        "lawfulBasis": "",
        "dataUse": "",
        "dpia": "",
        "active": "",
        "forgettable": "",
        "compatibleWithVersion": {
          "id": "",
          "version": "",
          "controller": {
            "id": "",
            "name": "",
            "url": ""
          },
          "policy": {
            "id": "",
            "name": "",
            "version": "",
            "url": "",
            "jurisdiction": "",
            "industrySector": "",
            "dataRetentionPeriodDays": "",
            "geographicRestriction": "",
            "storageLocation": ""
          },
          "purpose": "",
          "lawfulBasis": "",
          "dataUse": "",
          "dpia": "",
          "active": "",
          "forgettable": "",
          "compatibleWithVersion": {
            "id": "",
            "version": "",
            "controller": {
              "id": "",
              "name": "",
              "url": ""
            },
            "policy": {
              "id": "",
              "name": "",
              "version": "",
              "url": "",
              "jurisdiction": "",
              "industrySector": "",
              "dataRetentionPeriodDays": "",
              "geographicRestriction": "",
              "storageLocation": ""
            },
            "purpose": "",
            "lawfulBasis": "",
            "dataUse": "",
            "dpia": "",
            "active": "",
            "forgettable": "",
            "compatibleWithVersion": "[Circular Reference]",
            "lifecycle": {
              "id": "",
              "name": ""
            },
            "signature": {
              "id": "",
              "payload": "",
              "signature": "",
              "verificationMethod": "",
              "verificationPayload": "",
              "verificationPayloadHash": "",
              "verificationArtifact": "",
              "verificationSignedBy": "",
              "verificationSignedAs": "",
              "verificationJwsHeader": "",
              "timestamp": "",
              "signedWithoutObjectReference": "",
              "objectType": "",
              "objectReference": ""
            }
          },
          "lifecycle": {
            "id": "",
            "name": ""
          },
          "signature": {
            "id": "",
            "payload": "",
            "signature": "",
            "verificationMethod": "",
            "verificationPayload": "",
            "verificationPayloadHash": "",
            "verificationArtifact": "",
            "verificationSignedBy": "",
            "verificationSignedAs": "",
            "verificationJwsHeader": "",
            "timestamp": "",
            "signedWithoutObjectReference": "",
            "objectType": "",
            "objectReference": ""
          }
        },
        "lifecycle": {
          "id": "",
          "name": ""
        },
        "signature": {
          "id": "",
          "payload": "",
          "signature": "",
          "verificationMethod": "",
          "verificationPayload": "",
          "verificationPayloadHash": "",
          "verificationArtifact": "",
          "verificationSignedBy": "",
          "verificationSignedAs": "",
          "verificationJwsHeader": "",
          "timestamp": "",
          "signedWithoutObjectReference": "",
          "objectType": "",
          "objectReference": ""
        }
      },
      "lifecycle": {
        "id": "",
        "name": ""
      },
      "signature": {
        "id": "",
        "payload": "",
        "signature": "",
        "verificationMethod": "",
        "verificationPayload": "",
        "verificationPayloadHash": "",
        "verificationArtifact": "",
        "verificationSignedBy": "",
        "verificationSignedAs": "",
        "verificationJwsHeader": "",
        "timestamp": "",
        "signedWithoutObjectReference": "",
        "objectType": "",
        "objectReference": ""
      }
    },
    "dataAgreementRevision": {
      "id": "",
      "schemaName": "",
      "objectId": "",
      "signedWithoutObjectId": "",
      "serializedSnapshot": "",
      "serializedHash": "",
      "timestamp": "",
      "authorizedByIndividual": {
        "id": "",
        "externalId": "",
        "externalIdType": "",
        "identityProviderId": ""
      },
      "authorizedByOther": "",
      "successor": {
        "id": "",
        "schemaName": "",
        "objectId": "",
        "signedWithoutObjectId": "",
        "serializedSnapshot": "",
        "serializedHash": "",
        "timestamp": "",
        "authorizedByIndividual": {
          "id": "",
          "externalId": "",
          "externalIdType": "",
          "identityProviderId": ""
        },
        "authorizedByOther": "",
        "successor": {
          "id": "",
          "schemaName": "",
          "objectId": "",
          "signedWithoutObjectId": "",
          "serializedSnapshot": "",
          "serializedHash": "",
          "timestamp": "",
          "authorizedByIndividual": {
            "id": "",
            "externalId": "",
            "externalIdType": "",
            "identityProviderId": ""
          },
          "authorizedByOther": "",
          "successor": {
            "id": "",
            "schemaName": "",
            "objectId": "",
            "signedWithoutObjectId": "",
            "serializedSnapshot": "",
            "serializedHash": "",
            "timestamp": "",
            "authorizedByIndividual": {
              "id": "",
              "externalId": "",
              "externalIdType": "",
              "identityProviderId": ""
            },
            "authorizedByOther": "",
            "successor": "[Circular Reference]",
            "predecessorHash": "",
            "predecessorSignature": ""
          },
          "predecessorHash": "",
          "predecessorSignature": ""
        },
        "predecessorHash": "",
        "predecessorSignature": ""
      },
      "predecessorHash": "",
      "predecessorSignature": ""
    },
    "dataAgreementRevisionHash": "",
    "individual": {
      "id": "",
      "externalId": "",
      "externalIdType": "",
      "identityProviderId": ""
    },
    "optIn": "",
    "state": "",
    "signature": {
      "id": "",
      "payload": "",
      "signature": "",
      "verificationMethod": "",
      "verificationPayload": "",
      "verificationPayloadHash": "",
      "verificationArtifact": "",
      "verificationSignedBy": "",
      "verificationSignedAs": "",
      "verificationJwsHeader": "",
      "timestamp": "",
      "signedWithoutObjectReference": "",
      "objectType": "",
      "objectReference": ""
    }
  },
  "revision": {
    "id": "",
    "schemaName": "",
    "objectId": "",
    "signedWithoutObjectId": "",
    "serializedSnapshot": "",
    "serializedHash": "",
    "timestamp": "",
    "authorizedByIndividual": {
      "id": "",
      "externalId": "",
      "externalIdType": "",
      "identityProviderId": ""
    },
    "authorizedByOther": "",
    "successor": {
      "id": "",
      "schemaName": "",
      "objectId": "",
      "signedWithoutObjectId": "",
      "serializedSnapshot": "",
      "serializedHash": "",
      "timestamp": "",
      "authorizedByIndividual": {
        "id": "",
        "externalId": "",
        "externalIdType": "",
        "identityProviderId": ""
      },
      "authorizedByOther": "",
      "successor": {
        "id": "",
        "schemaName": "",
        "objectId": "",
        "signedWithoutObjectId": "",
        "serializedSnapshot": "",
        "serializedHash": "",
        "timestamp": "",
        "authorizedByIndividual": {
          "id": "",
          "externalId": "",
          "externalIdType": "",
          "identityProviderId": ""
        },
        "authorizedByOther": "",
        "successor": {
          "id": "",
          "schemaName": "",
          "objectId": "",
          "signedWithoutObjectId": "",
          "serializedSnapshot": "",
          "serializedHash": "",
          "timestamp": "",
          "authorizedByIndividual": {
            "id": "",
            "externalId": "",
            "externalIdType": "",
            "identityProviderId": ""
          },
          "authorizedByOther": "",
          "successor": "[Circular Reference]",
          "predecessorHash": "",
          "predecessorSignature": ""
        },
        "predecessorHash": "",
        "predecessorSignature": ""
      },
      "predecessorHash": "",
      "predecessorSignature": ""
    },
    "predecessorHash": "",
    "predecessorSignature": ""
  }
}

CREATE - Creates and returns a Signature object for the Consent Record with a payload ready for signing. Signature object fieldset is restricted.

post

CREATE - Creates and returns a Signature object for the Consent Record with a payload ready for signing. Signature object fieldset is restricted.

Authorizations

Path parameters

consentRecordIdstringRequired

Unique ID of an object

Body

signatureobjectRequired

An object of type Signature

Responses

application/json

objectOptional

post

HTTPcURLJavaScriptPython

POST /apis/GovStack/consent-management-bb//service/individual/record/consent-record/{consentRecordId}/signature/ HTTP/1.1
Host: app.swaggerhub.com
Content-Type: application/json
Accept: */*
Content-Length: 320

{
  "signature": {
    "id": "",
    "payload": "",
    "signature": "",
    "verificationMethod": "",
    "verificationPayload": "",
    "verificationPayloadHash": "",
    "verificationArtifact": "",
    "verificationSignedBy": "",
    "verificationSignedAs": "",
    "verificationJwsHeader": "",
    "timestamp": "",
    "signedWithoutObjectReference": "",
    "objectType": "",
    "objectReference": ""
  }
}

{
  "signature": {
    "id": "",
    "payload": "",
    "signature": "",
    "verificationMethod": "",
    "verificationPayload": "",
    "verificationPayloadHash": "",
    "verificationArtifact": "",
    "verificationSignedBy": "",
    "verificationSignedAs": "",
    "verificationJwsHeader": "",
    "timestamp": "",
    "signedWithoutObjectReference": "",
    "objectType": "",
    "objectReference": ""
  }
}

UPDATE - Updates a Signature object for a Consent Record. This is used to add a signature to an existing unsigned Signature object. Consent BB is responsible for updating the Consent Record state. Signature object fieldset is restricted.

put

UPDATE - Updates a Signature object for a Consent Record. This is used to add a signature to an existing unsigned Signature object. Consent BB is responsible for updating the Consent Record state. Signature object fieldset is restricted.

Authorizations

Path parameters

consentRecordIdstringRequired

Unique ID of an object

Body

signatureobjectRequired

An object of type Signature

Responses

application/json

objectOptional

put

HTTPcURLJavaScriptPython

PUT /apis/GovStack/consent-management-bb//service/individual/record/consent-record/{consentRecordId}/signature/ HTTP/1.1
Host: app.swaggerhub.com
Content-Type: application/json
Accept: */*
Content-Length: 320

{
  "signature": {
    "id": "",
    "payload": "",
    "signature": "",
    "verificationMethod": "",
    "verificationPayload": "",
    "verificationPayloadHash": "",
    "verificationArtifact": "",
    "verificationSignedBy": "",
    "verificationSignedAs": "",
    "verificationJwsHeader": "",
    "timestamp": "",
    "signedWithoutObjectReference": "",
    "objectType": "",
    "objectReference": ""
  }
}

{
  "signature": {
    "id": "",
    "payload": "",
    "signature": "",
    "verificationMethod": "",
    "verificationPayload": "",
    "verificationPayloadHash": "",
    "verificationArtifact": "",
    "verificationSignedBy": "",
    "verificationSignedAs": "",
    "verificationJwsHeader": "",
    "timestamp": "",
    "signedWithoutObjectReference": "",
    "objectType": "",
    "objectReference": ""
  }
}

LIST - Fetches all consent records given to a particular agreement. Individual ID supplied as HTTP header.

get

LIST - Fetches all consent records given to a particular agreement. Individual ID supplied as HTTP header.

Authorizations

Path parameters

dataAgreementIdstringRequired

Unique ID of an object

Query parameters

offsetintegerOptional

Requested index for start of resources to be provided in response requested by client

limitintegerOptional

Requested number of resources to be provided in response requested by client

Responses

application/json

objectOptional

get

HTTPcURLJavaScriptPython

GET /apis/GovStack/consent-management-bb//service/individual/record/data-agreement/{dataAgreementId}/all/ HTTP/1.1
Host: app.swaggerhub.com
Accept: */*

{
  "consentRecords": [
    {
      "id": "",
      "dataAgreement": {
        "id": "",
        "version": "",
        "controller": {
          "id": "",
          "name": "",
          "url": ""
        },
        "policy": {
          "id": "",
          "name": "",
          "version": "",
          "url": "",
          "jurisdiction": "",
          "industrySector": "",
          "dataRetentionPeriodDays": "",
          "geographicRestriction": "",
          "storageLocation": ""
        },
        "purpose": "",
        "lawfulBasis": "",
        "dataUse": "",
        "dpia": "",
        "active": "",
        "forgettable": "",
        "compatibleWithVersion": {
          "id": "",
          "version": "",
          "controller": {
            "id": "",
            "name": "",
            "url": ""
          },
          "policy": {
            "id": "",
            "name": "",
            "version": "",
            "url": "",
            "jurisdiction": "",
            "industrySector": "",
            "dataRetentionPeriodDays": "",
            "geographicRestriction": "",
            "storageLocation": ""
          },
          "purpose": "",
          "lawfulBasis": "",
          "dataUse": "",
          "dpia": "",
          "active": "",
          "forgettable": "",
          "compatibleWithVersion": {
            "id": "",
            "version": "",
            "controller": {
              "id": "",
              "name": "",
              "url": ""
            },
            "policy": {
              "id": "",
              "name": "",
              "version": "",
              "url": "",
              "jurisdiction": "",
              "industrySector": "",
              "dataRetentionPeriodDays": "",
              "geographicRestriction": "",
              "storageLocation": ""
            },
            "purpose": "",
            "lawfulBasis": "",
            "dataUse": "",
            "dpia": "",
            "active": "",
            "forgettable": "",
            "compatibleWithVersion": "[Circular Reference]",
            "lifecycle": {
              "id": "",
              "name": ""
            },
            "signature": {
              "id": "",
              "payload": "",
              "signature": "",
              "verificationMethod": "",
              "verificationPayload": "",
              "verificationPayloadHash": "",
              "verificationArtifact": "",
              "verificationSignedBy": "",
              "verificationSignedAs": "",
              "verificationJwsHeader": "",
              "timestamp": "",
              "signedWithoutObjectReference": "",
              "objectType": "",
              "objectReference": ""
            }
          },
          "lifecycle": {
            "id": "",
            "name": ""
          },
          "signature": {
            "id": "",
            "payload": "",
            "signature": "",
            "verificationMethod": "",
            "verificationPayload": "",
            "verificationPayloadHash": "",
            "verificationArtifact": "",
            "verificationSignedBy": "",
            "verificationSignedAs": "",
            "verificationJwsHeader": "",
            "timestamp": "",
            "signedWithoutObjectReference": "",
            "objectType": "",
            "objectReference": ""
          }
        },
        "lifecycle": {
          "id": "",
          "name": ""
        },
        "signature": {
          "id": "",
          "payload": "",
          "signature": "",
          "verificationMethod": "",
          "verificationPayload": "",
          "verificationPayloadHash": "",
          "verificationArtifact": "",
          "verificationSignedBy": "",
          "verificationSignedAs": "",
          "verificationJwsHeader": "",
          "timestamp": "",
          "signedWithoutObjectReference": "",
          "objectType": "",
          "objectReference": ""
        }
      },
      "dataAgreementRevision": {
        "id": "",
        "schemaName": "",
        "objectId": "",
        "signedWithoutObjectId": "",
        "serializedSnapshot": "",
        "serializedHash": "",
        "timestamp": "",
        "authorizedByIndividual": {
          "id": "",
          "externalId": "",
          "externalIdType": "",
          "identityProviderId": ""
        },
        "authorizedByOther": "",
        "successor": {
          "id": "",
          "schemaName": "",
          "objectId": "",
          "signedWithoutObjectId": "",
          "serializedSnapshot": "",
          "serializedHash": "",
          "timestamp": "",
          "authorizedByIndividual": {
            "id": "",
            "externalId": "",
            "externalIdType": "",
            "identityProviderId": ""
          },
          "authorizedByOther": "",
          "successor": {
            "id": "",
            "schemaName": "",
            "objectId": "",
            "signedWithoutObjectId": "",
            "serializedSnapshot": "",
            "serializedHash": "",
            "timestamp": "",
            "authorizedByIndividual": {
              "id": "",
              "externalId": "",
              "externalIdType": "",
              "identityProviderId": ""
            },
            "authorizedByOther": "",
            "successor": "[Circular Reference]",
            "predecessorHash": "",
            "predecessorSignature": ""
          },
          "predecessorHash": "",
          "predecessorSignature": ""
        },
        "predecessorHash": "",
        "predecessorSignature": ""
      },
      "dataAgreementRevisionHash": "",
      "individual": {
        "id": "",
        "externalId": "",
        "externalIdType": "",
        "identityProviderId": ""
      },
      "optIn": "",
      "state": "",
      "signature": {
        "id": "",
        "payload": "",
        "signature": "",
        "verificationMethod": "",
        "verificationPayload": "",
        "verificationPayloadHash": "",
        "verificationArtifact": "",
        "verificationSignedBy": "",
        "verificationSignedAs": "",
        "verificationJwsHeader": "",
        "timestamp": "",
        "signedWithoutObjectReference": "",
        "objectType": "",
        "objectReference": ""
      }
    }
  ]
}

DELETE - Cascading delete operation for Right To Be Forgotten, deletes all Consent Records that shall not be retained and have a "forgettable" Agreement. May also delete an unsigned Consent Record, for instance in cases where the user exits the signing process. Individual ID supplied as HTTP header.

delete

DELETE - Cascading delete operation for Right To Be Forgotten, deletes all Consent Records that shall not be retained and have a "forgettable" Agreement. May also delete an unsigned Consent Record, for instance in cases where the user exits the signing process. Individual ID supplied as HTTP header.

Authorizations

Responses

delete

HTTPcURLJavaScriptPython

DELETE /apis/GovStack/consent-management-bb//service/individual/record/ HTTP/1.1
Host: app.swaggerhub.com
Accept: */*

No content

8.1.3 Audit APIs

LIST - fetch ConsentRecord objects

get

LIST - fetch ConsentRecord objects

Authorizations

Query parameters

offsetintegerOptional

Requested index for start of resources to be provided in response requested by client

limitintegerOptional

Requested number of resources to be provided in response requested by client

Responses

application/json

objectOptional

get

HTTPcURLJavaScriptPython

GET /apis/GovStack/consent-management-bb//audit/consent-records/ HTTP/1.1
Host: app.swaggerhub.com
Accept: */*

{
  "consentRecords": [
    {
      "id": "",
      "dataAgreement": {
        "id": "",
        "version": "",
        "controller": {
          "id": "",
          "name": "",
          "url": ""
        },
        "policy": {
          "id": "",
          "name": "",
          "version": "",
          "url": "",
          "jurisdiction": "",
          "industrySector": "",
          "dataRetentionPeriodDays": "",
          "geographicRestriction": "",
          "storageLocation": ""
        },
        "purpose": "",
        "lawfulBasis": "",
        "dataUse": "",
        "dpia": "",
        "active": "",
        "forgettable": "",
        "compatibleWithVersion": {
          "id": "",
          "version": "",
          "controller": {
            "id": "",
            "name": "",
            "url": ""
          },
          "policy": {
            "id": "",
            "name": "",
            "version": "",
            "url": "",
            "jurisdiction": "",
            "industrySector": "",
            "dataRetentionPeriodDays": "",
            "geographicRestriction": "",
            "storageLocation": ""
          },
          "purpose": "",
          "lawfulBasis": "",
          "dataUse": "",
          "dpia": "",
          "active": "",
          "forgettable": "",
          "compatibleWithVersion": {
            "id": "",
            "version": "",
            "controller": {
              "id": "",
              "name": "",
              "url": ""
            },
            "policy": {
              "id": "",
              "name": "",
              "version": "",
              "url": "",
              "jurisdiction": "",
              "industrySector": "",
              "dataRetentionPeriodDays": "",
              "geographicRestriction": "",
              "storageLocation": ""
            },
            "purpose": "",
            "lawfulBasis": "",
            "dataUse": "",
            "dpia": "",
            "active": "",
            "forgettable": "",
            "compatibleWithVersion": "[Circular Reference]",
            "lifecycle": {
              "id": "",
              "name": ""
            },
            "signature": {
              "id": "",
              "payload": "",
              "signature": "",
              "verificationMethod": "",
              "verificationPayload": "",
              "verificationPayloadHash": "",
              "verificationArtifact": "",
              "verificationSignedBy": "",
              "verificationSignedAs": "",
              "verificationJwsHeader": "",
              "timestamp": "",
              "signedWithoutObjectReference": "",
              "objectType": "",
              "objectReference": ""
            }
          },
          "lifecycle": {
            "id": "",
            "name": ""
          },
          "signature": {
            "id": "",
            "payload": "",
            "signature": "",
            "verificationMethod": "",
            "verificationPayload": "",
            "verificationPayloadHash": "",
            "verificationArtifact": "",
            "verificationSignedBy": "",
            "verificationSignedAs": "",
            "verificationJwsHeader": "",
            "timestamp": "",
            "signedWithoutObjectReference": "",
            "objectType": "",
            "objectReference": ""
          }
        },
        "lifecycle": {
          "id": "",
          "name": ""
        },
        "signature": {
          "id": "",
          "payload": "",
          "signature": "",
          "verificationMethod": "",
          "verificationPayload": "",
          "verificationPayloadHash": "",
          "verificationArtifact": "",
          "verificationSignedBy": "",
          "verificationSignedAs": "",
          "verificationJwsHeader": "",
          "timestamp": "",
          "signedWithoutObjectReference": "",
          "objectType": "",
          "objectReference": ""
        }
      },
      "dataAgreementRevision": {
        "id": "",
        "schemaName": "",
        "objectId": "",
        "signedWithoutObjectId": "",
        "serializedSnapshot": "",
        "serializedHash": "",
        "timestamp": "",
        "authorizedByIndividual": {
          "id": "",
          "externalId": "",
          "externalIdType": "",
          "identityProviderId": ""
        },
        "authorizedByOther": "",
        "successor": {
          "id": "",
          "schemaName": "",
          "objectId": "",
          "signedWithoutObjectId": "",
          "serializedSnapshot": "",
          "serializedHash": "",
          "timestamp": "",
          "authorizedByIndividual": {
            "id": "",
            "externalId": "",
            "externalIdType": "",
            "identityProviderId": ""
          },
          "authorizedByOther": "",
          "successor": {
            "id": "",
            "schemaName": "",
            "objectId": "",
            "signedWithoutObjectId": "",
            "serializedSnapshot": "",
            "serializedHash": "",
            "timestamp": "",
            "authorizedByIndividual": {
              "id": "",
              "externalId": "",
              "externalIdType": "",
              "identityProviderId": ""
            },
            "authorizedByOther": "",
            "successor": "[Circular Reference]",
            "predecessorHash": "",
            "predecessorSignature": ""
          },
          "predecessorHash": "",
          "predecessorSignature": ""
        },
        "predecessorHash": "",
        "predecessorSignature": ""
      },
      "dataAgreementRevisionHash": "",
      "individual": {
        "id": "",
        "externalId": "",
        "externalIdType": "",
        "identityProviderId": ""
      },
      "optIn": "",
      "state": "",
      "signature": {
        "id": "",
        "payload": "",
        "signature": "",
        "verificationMethod": "",
        "verificationPayload": "",
        "verificationPayloadHash": "",
        "verificationArtifact": "",
        "verificationSignedBy": "",
        "verificationSignedAs": "",
        "verificationJwsHeader": "",
        "timestamp": "",
        "signedWithoutObjectReference": "",
        "objectType": "",
        "objectReference": ""
      }
    }
  ]
}

READ

get

READ

Authorizations

Path parameters

consentRecordIdstringRequired

Unique ID of an object

Responses

application/json

objectOptional

get

HTTPcURLJavaScriptPython

GET /apis/GovStack/consent-management-bb//audit/consent-record/{consentRecordId}/ HTTP/1.1
Host: app.swaggerhub.com
Accept: */*

{
  "consentRecord": {
    "id": "",
    "dataAgreement": {
      "id": "",
      "version": "",
      "controller": {
        "id": "",
        "name": "",
        "url": ""
      },
      "policy": {
        "id": "",
        "name": "",
        "version": "",
        "url": "",
        "jurisdiction": "",
        "industrySector": "",
        "dataRetentionPeriodDays": "",
        "geographicRestriction": "",
        "storageLocation": ""
      },
      "purpose": "",
      "lawfulBasis": "",
      "dataUse": "",
      "dpia": "",
      "active": "",
      "forgettable": "",
      "compatibleWithVersion": {
        "id": "",
        "version": "",
        "controller": {
          "id": "",
          "name": "",
          "url": ""
        },
        "policy": {
          "id": "",
          "name": "",
          "version": "",
          "url": "",
          "jurisdiction": "",
          "industrySector": "",
          "dataRetentionPeriodDays": "",
          "geographicRestriction": "",
          "storageLocation": ""
        },
        "purpose": "",
        "lawfulBasis": "",
        "dataUse": "",
        "dpia": "",
        "active": "",
        "forgettable": "",
        "compatibleWithVersion": {
          "id": "",
          "version": "",
          "controller": {
            "id": "",
            "name": "",
            "url": ""
          },
          "policy": {
            "id": "",
            "name": "",
            "version": "",
            "url": "",
            "jurisdiction": "",
            "industrySector": "",
            "dataRetentionPeriodDays": "",
            "geographicRestriction": "",
            "storageLocation": ""
          },
          "purpose": "",
          "lawfulBasis": "",
          "dataUse": "",
          "dpia": "",
          "active": "",
          "forgettable": "",
          "compatibleWithVersion": {
            "id": "",
            "version": "",
            "controller": {
              "id": "",
              "name": "",
              "url": ""
            },
            "policy": {
              "id": "",
              "name": "",
              "version": "",
              "url": "",
              "jurisdiction": "",
              "industrySector": "",
              "dataRetentionPeriodDays": "",
              "geographicRestriction": "",
              "storageLocation": ""
            },
            "purpose": "",
            "lawfulBasis": "",
            "dataUse": "",
            "dpia": "",
            "active": "",
            "forgettable": "",
            "compatibleWithVersion": "[Circular Reference]",
            "lifecycle": {
              "id": "",
              "name": ""
            },
            "signature": {
              "id": "",
              "payload": "",
              "signature": "",
              "verificationMethod": "",
              "verificationPayload": "",
              "verificationPayloadHash": "",
              "verificationArtifact": "",
              "verificationSignedBy": "",
              "verificationSignedAs": "",
              "verificationJwsHeader": "",
              "timestamp": "",
              "signedWithoutObjectReference": "",
              "objectType": "",
              "objectReference": ""
            }
          },
          "lifecycle": {
            "id": "",
            "name": ""
          },
          "signature": {
            "id": "",
            "payload": "",
            "signature": "",
            "verificationMethod": "",
            "verificationPayload": "",
            "verificationPayloadHash": "",
            "verificationArtifact": "",
            "verificationSignedBy": "",
            "verificationSignedAs": "",
            "verificationJwsHeader": "",
            "timestamp": "",
            "signedWithoutObjectReference": "",
            "objectType": "",
            "objectReference": ""
          }
        },
        "lifecycle": {
          "id": "",
          "name": ""
        },
        "signature": {
          "id": "",
          "payload": "",
          "signature": "",
          "verificationMethod": "",
          "verificationPayload": "",
          "verificationPayloadHash": "",
          "verificationArtifact": "",
          "verificationSignedBy": "",
          "verificationSignedAs": "",
          "verificationJwsHeader": "",
          "timestamp": "",
          "signedWithoutObjectReference": "",
          "objectType": "",
          "objectReference": ""
        }
      },
      "lifecycle": {
        "id": "",
        "name": ""
      },
      "signature": {
        "id": "",
        "payload": "",
        "signature": "",
        "verificationMethod": "",
        "verificationPayload": "",
        "verificationPayloadHash": "",
        "verificationArtifact": "",
        "verificationSignedBy": "",
        "verificationSignedAs": "",
        "verificationJwsHeader": "",
        "timestamp": "",
        "signedWithoutObjectReference": "",
        "objectType": "",
        "objectReference": ""
      }
    },
    "dataAgreementRevision": {
      "id": "",
      "schemaName": "",
      "objectId": "",
      "signedWithoutObjectId": "",
      "serializedSnapshot": "",
      "serializedHash": "",
      "timestamp": "",
      "authorizedByIndividual": {
        "id": "",
        "externalId": "",
        "externalIdType": "",
        "identityProviderId": ""
      },
      "authorizedByOther": "",
      "successor": {
        "id": "",
        "schemaName": "",
        "objectId": "",
        "signedWithoutObjectId": "",
        "serializedSnapshot": "",
        "serializedHash": "",
        "timestamp": "",
        "authorizedByIndividual": {
          "id": "",
          "externalId": "",
          "externalIdType": "",
          "identityProviderId": ""
        },
        "authorizedByOther": "",
        "successor": {
          "id": "",
          "schemaName": "",
          "objectId": "",
          "signedWithoutObjectId": "",
          "serializedSnapshot": "",
          "serializedHash": "",
          "timestamp": "",
          "authorizedByIndividual": {
            "id": "",
            "externalId": "",
            "externalIdType": "",
            "identityProviderId": ""
          },
          "authorizedByOther": "",
          "successor": {
            "id": "",
            "schemaName": "",
            "objectId": "",
            "signedWithoutObjectId": "",
            "serializedSnapshot": "",
            "serializedHash": "",
            "timestamp": "",
            "authorizedByIndividual": {
              "id": "",
              "externalId": "",
              "externalIdType": "",
              "identityProviderId": ""
            },
            "authorizedByOther": "",
            "successor": "[Circular Reference]",
            "predecessorHash": "",
            "predecessorSignature": ""
          },
          "predecessorHash": "",
          "predecessorSignature": ""
        },
        "predecessorHash": "",
        "predecessorSignature": ""
      },
      "predecessorHash": "",
      "predecessorSignature": ""
    },
    "dataAgreementRevisionHash": "",
    "individual": {
      "id": "",
      "externalId": "",
      "externalIdType": "",
      "identityProviderId": ""
    },
    "optIn": "",
    "state": "",
    "signature": {
      "id": "",
      "payload": "",
      "signature": "",
      "verificationMethod": "",
      "verificationPayload": "",
      "verificationPayloadHash": "",
      "verificationArtifact": "",
      "verificationSignedBy": "",
      "verificationSignedAs": "",
      "verificationJwsHeader": "",
      "timestamp": "",
      "signedWithoutObjectReference": "",
      "objectType": "",
      "objectReference": ""
    }
  }
}

LIST - fetch all Agreements stored in the system.

get

LIST - fetch all Agreements stored in the system.

Authorizations

Query parameters

offsetintegerOptional

Requested index for start of resources to be provided in response requested by client

limitintegerOptional

Requested number of resources to be provided in response requested by client

Responses

application/json

objectOptional

get

HTTPcURLJavaScriptPython

GET /apis/GovStack/consent-management-bb//audit/data-agreements/ HTTP/1.1
Host: app.swaggerhub.com
Accept: */*

{
  "dataAgreements": [
    {
      "id": "",
      "version": "",
      "controller": {
        "id": "",
        "name": "",
        "url": ""
      },
      "policy": {
        "id": "",
        "name": "",
        "version": "",
        "url": "",
        "jurisdiction": "",
        "industrySector": "",
        "dataRetentionPeriodDays": "",
        "geographicRestriction": "",
        "storageLocation": ""
      },
      "purpose": "",
      "lawfulBasis": "",
      "dataUse": "",
      "dpia": "",
      "active": "",
      "forgettable": "",
      "compatibleWithVersion": {
        "id": "",
        "version": "",
        "controller": {
          "id": "",
          "name": "",
          "url": ""
        },
        "policy": {
          "id": "",
          "name": "",
          "version": "",
          "url": "",
          "jurisdiction": "",
          "industrySector": "",
          "dataRetentionPeriodDays": "",
          "geographicRestriction": "",
          "storageLocation": ""
        },
        "purpose": "",
        "lawfulBasis": "",
        "dataUse": "",
        "dpia": "",
        "active": "",
        "forgettable": "",
        "compatibleWithVersion": {
          "id": "",
          "version": "",
          "controller": {
            "id": "",
            "name": "",
            "url": ""
          },
          "policy": {
            "id": "",
            "name": "",
            "version": "",
            "url": "",
            "jurisdiction": "",
            "industrySector": "",
            "dataRetentionPeriodDays": "",
            "geographicRestriction": "",
            "storageLocation": ""
          },
          "purpose": "",
          "lawfulBasis": "",
          "dataUse": "",
          "dpia": "",
          "active": "",
          "forgettable": "",
          "compatibleWithVersion": {
            "id": "",
            "version": "",
            "controller": {
              "id": "",
              "name": "",
              "url": ""
            },
            "policy": {
              "id": "",
              "name": "",
              "version": "",
              "url": "",
              "jurisdiction": "",
              "industrySector": "",
              "dataRetentionPeriodDays": "",
              "geographicRestriction": "",
              "storageLocation": ""
            },
            "purpose": "",
            "lawfulBasis": "",
            "dataUse": "",
            "dpia": "",
            "active": "",
            "forgettable": "",
            "compatibleWithVersion": "[Circular Reference]",
            "lifecycle": {
              "id": "",
              "name": ""
            },
            "signature": {
              "id": "",
              "payload": "",
              "signature": "",
              "verificationMethod": "",
              "verificationPayload": "",
              "verificationPayloadHash": "",
              "verificationArtifact": "",
              "verificationSignedBy": "",
              "verificationSignedAs": "",
              "verificationJwsHeader": "",
              "timestamp": "",
              "signedWithoutObjectReference": "",
              "objectType": "",
              "objectReference": ""
            }
          },
          "lifecycle": {
            "id": "",
            "name": ""
          },
          "signature": {
            "id": "",
            "payload": "",
            "signature": "",
            "verificationMethod": "",
            "verificationPayload": "",
            "verificationPayloadHash": "",
            "verificationArtifact": "",
            "verificationSignedBy": "",
            "verificationSignedAs": "",
            "verificationJwsHeader": "",
            "timestamp": "",
            "signedWithoutObjectReference": "",
            "objectType": "",
            "objectReference": ""
          }
        },
        "lifecycle": {
          "id": "",
          "name": ""
        },
        "signature": {
          "id": "",
          "payload": "",
          "signature": "",
          "verificationMethod": "",
          "verificationPayload": "",
          "verificationPayloadHash": "",
          "verificationArtifact": "",
          "verificationSignedBy": "",
          "verificationSignedAs": "",
          "verificationJwsHeader": "",
          "timestamp": "",
          "signedWithoutObjectReference": "",
          "objectType": "",
          "objectReference": ""
        }
      },
      "lifecycle": {
        "id": "",
        "name": ""
      },
      "signature": {
        "id": "",
        "payload": "",
        "signature": "",
        "verificationMethod": "",
        "verificationPayload": "",
        "verificationPayloadHash": "",
        "verificationArtifact": "",
        "verificationSignedBy": "",
        "verificationSignedAs": "",
        "verificationJwsHeader": "",
        "timestamp": "",
        "signedWithoutObjectReference": "",
        "objectType": "",
        "objectReference": ""
      }
    }
  ]
}

READ - fetch a single Agreement.

get

READ - fetch a single Agreement.

Authorizations

Path parameters

dataAgreementIdstringRequired

Unique ID of an object

Responses

application/json

objectOptional

get

HTTPcURLJavaScriptPython

GET /apis/GovStack/consent-management-bb//audit/data-agreement/{dataAgreementId}/ HTTP/1.1
Host: app.swaggerhub.com
Accept: */*

{
  "dataAgreement": {
    "id": "",
    "version": "",
    "controller": {
      "id": "",
      "name": "",
      "url": ""
    },
    "policy": {
      "id": "",
      "name": "",
      "version": "",
      "url": "",
      "jurisdiction": "",
      "industrySector": "",
      "dataRetentionPeriodDays": "",
      "geographicRestriction": "",
      "storageLocation": ""
    },
    "purpose": "",
    "lawfulBasis": "",
    "dataUse": "",
    "dpia": "",
    "active": "",
    "forgettable": "",
    "compatibleWithVersion": {
      "id": "",
      "version": "",
      "controller": {
        "id": "",
        "name": "",
        "url": ""
      },
      "policy": {
        "id": "",
        "name": "",
        "version": "",
        "url": "",
        "jurisdiction": "",
        "industrySector": "",
        "dataRetentionPeriodDays": "",
        "geographicRestriction": "",
        "storageLocation": ""
      },
      "purpose": "",
      "lawfulBasis": "",
      "dataUse": "",
      "dpia": "",
      "active": "",
      "forgettable": "",
      "compatibleWithVersion": {
        "id": "",
        "version": "",
        "controller": {
          "id": "",
          "name": "",
          "url": ""
        },
        "policy": {
          "id": "",
          "name": "",
          "version": "",
          "url": "",
          "jurisdiction": "",
          "industrySector": "",
          "dataRetentionPeriodDays": "",
          "geographicRestriction": "",
          "storageLocation": ""
        },
        "purpose": "",
        "lawfulBasis": "",
        "dataUse": "",
        "dpia": "",
        "active": "",
        "forgettable": "",
        "compatibleWithVersion": {
          "id": "",
          "version": "",
          "controller": {
            "id": "",
            "name": "",
            "url": ""
          },
          "policy": {
            "id": "",
            "name": "",
            "version": "",
            "url": "",
            "jurisdiction": "",
            "industrySector": "",
            "dataRetentionPeriodDays": "",
            "geographicRestriction": "",
            "storageLocation": ""
          },
          "purpose": "",
          "lawfulBasis": "",
          "dataUse": "",
          "dpia": "",
          "active": "",
          "forgettable": "",
          "compatibleWithVersion": {
            "id": "",
            "version": "",
            "controller": {
              "id": "",
              "name": "",
              "url": ""
            },
            "policy": {
              "id": "",
              "name": "",
              "version": "",
              "url": "",
              "jurisdiction": "",
              "industrySector": "",
              "dataRetentionPeriodDays": "",
              "geographicRestriction": "",
              "storageLocation": ""
            },
            "purpose": "",
            "lawfulBasis": "",
            "dataUse": "",
            "dpia": "",
            "active": "",
            "forgettable": "",
            "compatibleWithVersion": "[Circular Reference]",
            "lifecycle": {
              "id": "",
              "name": ""
            },
            "signature": {
              "id": "",
              "payload": "",
              "signature": "",
              "verificationMethod": "",
              "verificationPayload": "",
              "verificationPayloadHash": "",
              "verificationArtifact": "",
              "verificationSignedBy": "",
              "verificationSignedAs": "",
              "verificationJwsHeader": "",
              "timestamp": "",
              "signedWithoutObjectReference": "",
              "objectType": "",
              "objectReference": ""
            }
          },
          "lifecycle": {
            "id": "",
            "name": ""
          },
          "signature": {
            "id": "",
            "payload": "",
            "signature": "",
            "verificationMethod": "",
            "verificationPayload": "",
            "verificationPayloadHash": "",
            "verificationArtifact": "",
            "verificationSignedBy": "",
            "verificationSignedAs": "",
            "verificationJwsHeader": "",
            "timestamp": "",
            "signedWithoutObjectReference": "",
            "objectType": "",
            "objectReference": ""
          }
        },
        "lifecycle": {
          "id": "",
          "name": ""
        },
        "signature": {
          "id": "",
          "payload": "",
          "signature": "",
          "verificationMethod": "",
          "verificationPayload": "",
          "verificationPayloadHash": "",
          "verificationArtifact": "",
          "verificationSignedBy": "",
          "verificationSignedAs": "",
          "verificationJwsHeader": "",
          "timestamp": "",
          "signedWithoutObjectReference": "",
          "objectType": "",
          "objectReference": ""
        }
      },
      "lifecycle": {
        "id": "",
        "name": ""
      },
      "signature": {
        "id": "",
        "payload": "",
        "signature": "",
        "verificationMethod": "",
        "verificationPayload": "",
        "verificationPayloadHash": "",
        "verificationArtifact": "",
        "verificationSignedBy": "",
        "verificationSignedAs": "",
        "verificationJwsHeader": "",
        "timestamp": "",
        "signedWithoutObjectReference": "",
        "objectType": "",
        "objectReference": ""
      }
    },
    "lifecycle": {
      "id": "",
      "name": ""
    },
    "signature": {
      "id": "",
      "payload": "",
      "signature": "",
      "verificationMethod": "",
      "verificationPayload": "",
      "verificationPayloadHash": "",
      "verificationArtifact": "",
      "verificationSignedBy": "",
      "verificationSignedAs": "",
      "verificationJwsHeader": "",
      "timestamp": "",
      "signedWithoutObjectReference": "",
      "objectType": "",
      "objectReference": ""
    }
  }
}