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

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

limit integerrequired

Default value: 10

Number of items returned per page. Requested number of resources to be provided in response requested by client

revisionId stringrequired

An object with id revisionId

Responses

200

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 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": "",
      "name": "",
      "description": "",
      "sensitivity": "",
      "category": ""
    }
  ],
  "pagination": {
    "currentPage": 0,
    "totalItems": 0,
    "totalPages": 0,
    "limit": 0,
    "hasPrevious": true,
    "hasNext": true
  }
}

400

bad input parameter

Response Headers

Loading...