Update data attribute

PUT 
/config/data-agreements/data-attribute/:dataAttributeId

This endpoint updates an existing data attribute defined in a data agreement. If updated, the associated data agreement revision is incremented automatically.

Request

Path Parameters

dataAttributeId stringrequired

Unique ID of an object

application/json

Body

dataAttribute objectrequired

Data attributes contain specifications of exactly what is collected.

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

Responses

200

Data attribute updated successfully

Response Headers

application/json

Schema

Schema

dataAttribute object

Data attributes contain specifications of exactly what is collected.

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

Example (from schema)

{
  "dataAttribute": {
    "id": "65471222e8c7c3bb3c2c8501",
    "name": "Name",
    "description": "Full name of the individual",
    "sensitivity": false,
    "category": "Personal",
    "scope": "read"
  }
}

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...