List data attributes

GET 
/service/data-agreement/:dataAgreementId/data-attributes

This endpoint is used to read the data attributes defined in a particular data agreement revision.

Request

Path Parameters

dataAgreementId stringrequired

Unique ID of an object

Query Parameters

offset integerrequired

Default value: 0

Number of records to skip for pagination. A negative or unreadable value falls back to 0.

limit integerrequired

Default value: 10

Maximum number of records to return per page.

revisionId stringrequired

An object with ID revisionId

Responses

200

Data attributes for data agreement listed successfully

Response Headers

application/json

Schema

Schema

dataAttributes object[]
Array [
id string
Data attribute ID
name stringrequired
Name of the attribute, for instance "name" or "age"
description stringrequired
Description of the attribute
sensitivity boolean
Sensitivity of data attribute
category string
Category of data attribute
scope string
Scope required for data attribute
]
pagination object

currentPage integer

Current page number

totalItems integer

Total number of items available

totalPages integer

Total number of pages based on limit

limit integer

Number of items per page

hasPrevious boolean

Indicates if there's a previous page

hasNext boolean

Indicates if there's a next page

Example (from schema)

{
  "dataAttributes": [
    {
      "id": "65471222e8c7c3bb3c2c8501",
      "name": "Name",
      "description": "Full name of the individual",
      "sensitivity": false,
      "category": "Personal",
      "scope": "read"
    }
  ],
  "pagination": {
    "currentPage": 1,
    "totalItems": 25,
    "totalPages": 3,
    "limit": 10,
    "hasPrevious": false,
    "hasNext": true
  }
}

400

bad input parameter

Response Headers

401

Unauthorized

Response Headers

application/json

Schema

Schema

errorCode integerrequired
errorDescription stringrequired

Example (from schema)

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

500

Internal server error

Response Headers

application/json

Schema

Schema

errorCode integerrequired
errorDescription stringrequired

Example (from schema)

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

Loading...