8 Service APIs
This section provides a reference for APIs that should be implemented by this Building Block.
8 Service APIs
8.1 API specification
8.1.1 Config APIs
CREATE - Creates a new Policy object and returns the new object and a PolicyRevision
- : Grants access to org operations
A set consisting of the new Policy object created, together with the initial Revision object.
bad input parameter
READ - get a Policy object + latest Revision. If a PolicyFilter is supplied and contains a revision_id, then this specific revision is returned.
READ - get a Policy object + latest Revision. If a PolicyFilter is supplied and contains a revision_id, then this specific revision is returned.
- : Grants access to org operations
Unique ID of an object
An object with id revisionId
bad input parameter
UPDATE - Updates an existing Policy object, returning the updated version and a new revision. Updating a Policy does not affect existing references in Agreement, the new revision should be specified for Agreement.
UPDATE - Updates an existing Policy object, returning the updated version and a new revision. Updating a Policy does not affect existing references in Agreement, the new revision should be specified for Agreement.
- : Grants access to org operations
Unique ID of an object
bad input parameter
DELETE - Deletes an existing Policy object, returning the updated version and a new revision. Deleting a Policy is not possible if it's associated with active Agreement.
DELETE - Deletes an existing Policy object, returning the updated version and a new revision. Deleting a Policy is not possible if it's associated with active Agreement.
- : Grants access to org operations
Unique ID of an object
bad input parameter
LIST - returns the current Policy
- : Grants access to org operations
Unique ID of an object
Requested index for start of resources to be provided in response requested by client
Requested number of resources to be provided in response requested by client
bad input parameter
LIST - Fetches list of readable Policy objects
- : Grants global read access
- : Grants global write access
- : Grants access to org operations
- : Grants access to data consumer operations
- : Grants access to specific individual read/write operations
- : Grants access to specific auditor read operations
An object with id revisionId
Requested index for start of resources to be provided in response requested by client
Requested number of resources to be provided in response requested by client
A list of Policy objects readable for the current session's credentials.
bad input parameter
8.1.2 Service APIs
CREATE - Creates an Individual in the Consent system
- : Grants access to org operations
bad input parameter
READ - Fetch an Individual in the Consent system
- : Grants access to org operations
Unique ID of an object
bad input parameter
UPDATE - Updates an Individual in the Consent system
- : Grants access to org operations
Unique ID of an object
bad input parameter
LIST - lists individuals in the system
- : Grants access to org operations
Requested index for start of resources to be provided in response requested by client
Requested number of resources to be provided in response requested by client
bad input parameter
READ - fetches the latest version of a Policy and the presented revisionId of an associated Agreement
READ - fetches the latest version of a Policy and the presented revisionId of an associated Agreement
- : Grants access to org operations
Unique ID of an object
An object with id revisionId
bad input parameter
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 - 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.
- : Grants access to specific individual read/write operations
No content
bad input parameter
No content
8.1.3 Audit APIs
READ
- : Grants global read access
- : Grants global write access
- : Grants access to org operations
- : Grants access to data consumer operations
- : Grants access to specific individual read/write operations
- : Grants access to specific auditor read operations
Unique ID of an object
bad input parameter
Last updated
Was this helpful?