Search documentation
karat

+

K

User Documentation ↗
Version 2.0

Get Marking Category

GET/api/v2/admin/markingCategories/{markingCategoryId}
Warning

This endpoint is in preview and may be modified or removed at any time. To use this endpoint, add preview=true to the request query parameters.

Get the MarkingCategory with the specified id.

Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:admin-read.

Path parameters

markingCategoryId
string

The ID of a marking category. For user-created categories, this will be a UUID. Markings associated with Organizations are placed in a category with ID "Organization".

Query parameters

preview
boolean
optional

Enables the use of preview functionality.

Response body

MarkingCategory
object
Hide child attributes

Hide child attributes

id
string

The ID of a marking category. For user-created categories, this will be a UUID. Markings associated with Organizations are placed in a category with ID "Organization".

name
string
description
string
optional
categoryType
string (enum)

Enum values: CONJUNCTIVE, DISJUNCTIVE

markingType
string (enum)

Enum values: MANDATORY, CBAC

markings
list<MarkingId>
optional
Show child attributes

Show child attributes

createdTime
string

The time at which the resource was created.

createdBy
string
optional

The Foundry user who created this resource

Examples

Request

Copied!
1 2 3 curl \ -H "Authorization: Bearer $TOKEN" \ "https://$HOSTNAME/api/v2/admin/markingCategories/0950264e-01c8-4e83-81a9-1a6b7f77621a?preview=true"

Response

Copied!
1 2 3 4 5 6 7 8 9 10 11 { "categoryType": "CONJUNCTIVE", "markings": [ "18212f9a-0e63-4b79-96a0-aae04df23336" ], "createdBy": "f05f8da4-b84c-4fca-9c77-8af0b13d11de", "name": "Customer Data", "createdTime": "2003-05-06T12:34:56.789Z", "id": "0950264e-01c8-4e83-81a9-1a6b7f77621a", "markingType": "MANDATORY" }

Error responses

Error Name
GetMarkingCategoryPermissionDeniedError CodePERMISSION_DENIED
Status Code403
DescriptionYou do not have permission to view the marking category.
ParametersmarkingCategoryId
MarkingCategoryNotFoundError CodeNOT_FOUND
Status Code404
DescriptionThe given MarkingCategory could not be found.
ParametersmarkingCategoryId