Search documentation
karat

+

K

User Documentation ↗
Version 2.0

Get Markings Batch

POST/api/v2/admin/markings/getBatch
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.

Execute multiple get requests on Marking.

The maximum batch size for this endpoint is 500.

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

Query parameters

preview
boolean
optional

Enables the use of preview functionality.

Request body

body
list<GetMarkingsBatchRequestElement>
Hide child attributes

Hide child attributes

GetMarkingsBatchRequestElement
object
Show child attributes

Show child attributes

Response body

GetMarkingsBatchResponse
object
Hide child attributes

Hide child attributes

data
map<MarkingId, Marking>
optional
Show child attributes

Show child attributes

Examples

Request

Copied!
1 2 3 4 5 curl -X POST \ -H "Content-type: application/json" \ -H "Authorization: Bearer $TOKEN" \ "https://$HOSTNAME/api/v2/admin/markings/getBatch?preview=true" \ -d '[{"markingId":"18212f9a-0e63-4b79-96a0-aae04df23336"}]'

Response

Copied!
1 2 3 4 5 6 7 8 9 10 11 12 13 { "data": { "18212f9a-0e63-4b79-96a0-aae04df23336": { "createdBy": "f05f8da4-b84c-4fca-9c77-8af0b13d11de", "organization": "ri.multipass..organization.c30ee6ad-b5e4-4afe-a74f-fe4a289f2faa", "name": "PII", "description": "Contains personally identifiable information about our customers", "createdTime": "2003-05-06T12:34:56.789Z", "id": "18212f9a-0e63-4b79-96a0-aae04df23336", "categoryId": "0950264e-01c8-4e83-81a9-1a6b7f77621a" } } }