Version 2.0

Replace Marking Category

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

Replace the MarkingCategory with the specified id.

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

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.

Request body

ReplaceMarkingCategoryRequest

object

Hide child attributes

name

string

description

string

Response body

MarkingCategory

object

The replaced MarkingCategory

Hide child attributes

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

categoryType

string (enum)

Enum values: CONJUNCTIVE, DISJUNCTIVE

markingType

string (enum)

Enum values: MANDATORY, CBAC

markings

list<MarkingId>

optional

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!

curl -X PUT \
\t-H "Content-type: application/json" \
\t-H "Authorization: Bearer $TOKEN" \
	"https://$HOSTNAME/api/v2/admin/markingCategories/0950264e-01c8-4e83-81a9-1a6b7f77621a?preview=true" \
	-d '{"name":"Customer Data","description":"Markings related to data about our customers"}'

Response

Copied!

{
  "categoryType": "CONJUNCTIVE",
  "markings": [
    "18212f9a-0e63-4b79-96a0-aae04df23336"
  ],
  "createdBy": "f05f8da4-b84c-4fca-9c77-8af0b13d11de",
  "name": "Customer Data",
  "description": "Markings related to data about our customers",
  "createdTime": "2003-05-06T12:34:56.789Z",
  "id": "0950264e-01c8-4e83-81a9-1a6b7f77621a",
  "markingType": "MANDATORY"
}

Error responses

Error Name
`GetMarkingCategoryPermissionDenied`	Error Code	`PERMISSION_DENIED`
	Status Code	403
	Description	The provided token does not have permission to view the marking category.
	Parameters	`markingCategoryId`
`ReplaceMarkingCategoryPermissionDenied`	Error Code	`PERMISSION_DENIED`
	Status Code	403
	Description	Could not replace the MarkingCategory.
	Parameters	`markingCategoryId`
`MarkingCategoryNotFound`	Error Code	`NOT_FOUND`
	Status Code	404
	Description	The given MarkingCategory could not be found.
	Parameters	`markingCategoryId`

See Errors for a general overview of errors in the platform.