Delete a valueset by id
DELETE/v1/valuesets/:id
Delete a valueset by id
Request
Path Parameters
id numberrequired
Valueset id
Responses
- 200
- 400
- 403
- 404
- 500
Valueset deleted
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
id integerrequired
Valueset primary identifier
name stringrequired
Possible values: <= 64 characters
Valueset name
type stringrequired
Possible values: [SYSTEM
, CUSTOM
]
Valueset type
descriptions
object[]
required
Valueset descriptions
language stringrequired
Possible values: >= 2 characters
and <= 2 characters
Language is set as 2 character country code.
value string
Localized field value
lastModifiedBy integer
The userId of the user that changed the valueset
lastModifiedAt date-timerequired
Valueset last modified date
createdBy integer
The userId of the user that created the valueset
createdAt date-timerequired
Valueset creation date
{
"id": 12345,
"name": "My valueset name",
"type": "CUSTOM",
"descriptions": [
{
"lang": "EN",
"value": "my valueset description"
}
],
"lastModifiedBy": 0,
"lastModifiedAt": "2024-11-26T09:27:23.744Z",
"createdBy": 0,
"createdAt": "2024-11-26T09:27:23.744Z"
}
Bad request
Forbidden
Valueset not found
Unknown delete valueset error
Loading...