Parses classification marking strings (e.g. MTS//MNF) into their component marking IDs.
Strings that cannot be parsed are returned in errors with a human-readable message.
Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:admin-read.
objectlist<string>optionalThe classification strings to parse, e.g. MTS//MNF. Requests must contain between 1 and 1000 entries.
Duplicate entries count toward this limit but are parsed only once. An empty list returns a
MissingBatchRequest error, and more than 1000 entries returns a BatchRequestSizeExceededLimit error.
objectmap<string, array>optionalMap of valid classification strings to their component marking IDs. Strings that could not be parsed are absent from this map and appear in 'errors' instead.
map<string, string>optionalMap of classification strings that could not be parsed to a human-readable error message.
1
2
3
4
5
curl -X POST \
\t-H "Content-type: application/json" \
\t-H "Authorization: Bearer $TOKEN" \
"https://$HOSTNAME/api/v2/admin/markings/parseClassifications" \
-d '{"classificationStrings":["MTS//MNF","INVALID_MARKING"]}'1
2
3
4
5
6
7
8
9
10
11
{
"parsed": {
"MTS//MNF": [
"MNF",
"MTS"
]
},
"errors": {
"INVALID_MARKING": "Unknown marking: INVALID_MARKING"
}
}| Error Name | ||
|---|---|---|
Parse | Error Code | PERMISSION_DENIED |
| Status Code | 403 | |
| Description | The provided token does not have permission to parse the given classification strings. | |
| Parameters | classificationStrings | |
Cbac | Error Code | INVALID_ARGUMENT |
| Status Code | 400 | |
| Description | CBAC is not available. | |
| Parameters | | |
Missing | Error Code | INVALID_ARGUMENT |
| Status Code | 400 | |
| Description | Batch requests must contain at least one element. | |
| Parameters | | |
Batch | Error Code | INVALID_ARGUMENT |
| Status Code | 400 | |
| Description | The submitted batch request was too large. | |
| Parameters | maximumBatchSize, providedBatchSize | |
See Errors for a general overview of errors in the platform.