Required capabilities:
labelsAcl:WRITE
Creates label definitions that can be used across different resource types. The label definitions are uniquely identified by their external id.
List of label definitions to create
required | Array of objects (ExternalLabelDefinition) [ 1 .. 1000 ] items unique |
A list of label definitions.
The response for a failed request.
{- "items": [
- {
- "externalId": "my.known.id",
- "name": "string",
- "description": "string",
- "dataSetId": 1
}
]
}{- "items": [
- {
- "externalId": "my.known.id",
- "name": "string",
- "description": "string",
- "dataSetId": 1,
- "createdTime": 1730204346000
}
]
}Required capabilities:
labelsAcl:READ
Use advanced filtering options to find label definitions.
A list of label definitions.
The response for a failed request.
{- "filter": {
- "name": "string",
- "externalIdPrefix": "string",
- "dataSetIds": [
- {
- "id": 1
}
]
}, - "cursor": "4zj0Vy2fo0NtNMb229mI9r1V3YG5NBL752kQz1cKtwo",
- "limit": 100
}{- "items": [
- {
- "externalId": "my.known.id",
- "name": "string",
- "description": "string",
- "dataSetId": 1,
- "createdTime": 1730204346000
}
], - "nextCursor": "string"
}Required capabilities:
labelsAcl:READ
Retrieve labels using their external ids
A list of label definitions.
The response for a failed request.
{- "items": [
- {
- "externalId": "my.known.id"
}
], - "ignoreUnknownIds": false
}{- "items": [
- {
- "externalId": "my.known.id",
- "name": "string",
- "description": "string",
- "dataSetId": 1,
- "createdTime": 1730204346000
}
], - "nextCursor": "string"
}Required capabilities:
labelsAcl:WRITE
Delete all the label definitions specified by their external ids. The resource items that have the corresponding label attached remain unmodified. It is up to the client to clean up the resource items from their attached labels if necessary.
List of external ids of label definitions to delete.
required | Array of objects (LabelDefinitionExternalId) [ 1 .. 1000 ] items unique |
Empty response.
The response for a failed request.
{- "items": [
- {
- "externalId": "my.known.id"
}
]
}{ }