Batch taxonomy permission operations
post
/content/management/api/v1.1/taxonomies/{id}/permissions/.batch
Supports synchronous invocation only.
Request payload can have maximum of 25 items. Each item is processed independently.
Request payload can have maximum of 25 items. Each item is processed independently.
Request
Supported Media Types
- application/json
Path Parameters
-
id: string
id of the taxonomy.
Query Parameters
-
links(optional): string
This is an optional parameter. This parameter accepts a comma-separated list of links to be returned in the response.Allowed Values:
[ "results" ]
-
operations: string
This parameter accepts a comma-separated list of operation names. The allowed value is add
Header Parameters
-
Prefer(optional): string
This parameter is used to control the interaction type (synchronous/asynchronous) of the request. If the header is provided with value respond-async, it indicates that asynchronous interaction is preferred. Otherwise, synchronous interaction is preferred. Asynchronous request is responded with 202 status with a status link in the location header. Synchronous request is responded with 200 along with response body.Allowed Values:
[ "respond-sync" ]
-
X-Requested-With: string
A custom header to mitigate CSRF attacks.Allowed Values:
[ "XMLHttpRequest" ]
Perform a batch of permission operations with the given information in the payload.
The request body contains permission operation add
The add block of the payload accepts a list of permissions that will be created.
The request body contains permission operation add
The add block of the payload accepts a list of permissions that will be created.
Root Schema : BatchJobBeanResourcePermissionCreate
Type:
object
BatchJobBean
Show Source
-
errorCount(optional):
integer(int32)
Read Only:
true
count of failed items. -
id(optional):
string
Read Only:
true
The id of the job. -
itemsCount(optional):
integer(int32)
Read Only:
true
total count of processed items. -
links(optional):
array links
Read Only:
true
Links -
operations:
array operations
Operations to perform, It is a required property in the post request.
-
successCount(optional):
integer(int32)
Read Only:
true
count of successfully processed items.
Nested Schema : links
Type:
array
Read Only:
true
Links
Show Source
-
Array of:
object Link
Link of the resource.
Nested Schema : operations
Type:
array
Operations to perform, It is a required property in the post request.
Show Source
Nested Schema : Link
Type:
object
Link of the resource.
Show Source
-
href(optional):
string
The target resource's URI. It could be template URI. It is a required property in the get response.
-
mediaType(optional):
string
Media type.
-
method(optional):
string
What HTTP method can be used to access the target resource.
-
profile(optional):
string
Link to the metadata that describes the target resource.
-
rel(optional):
string
Relation type. It is a required property in the get response.
-
templated(optional):
boolean
Whether the URI is a template.
Nested Schema : add
Type:
Show Source
array
-
Array of:
object ResourcePermissionCreate
ResourcePermissionCreate
Nested Schema : ResourcePermissionCreate
Type:
object
ResourcePermissionCreate
Show Source
-
email(optional):
string
email of the user.
-
fullName(optional):
string
full name of the user.
-
groupType(optional):
string
Allowed Values:
[ "CEC", "IDP" ]
type of the group. -
id(optional):
string
userId login name of the user.
-
links(optional):
array links
Read Only:
true
Links -
message(optional):
string
-
role(optional):
object PermissionRole
PermissionRole
-
roleName(optional):
string
name of the role on the resource. Deprecated. Replaced by the 'role' property.
-
type(optional):
string
Allowed Values:
[ "user", "group" ]
type of the user.
Nested Schema : links
Type:
array
Read Only:
true
Links
Show Source
-
Array of:
object Link
Link of the resource.
Nested Schema : PermissionRole
Type:
object
PermissionRole
Show Source
-
description(optional):
string
Description of the role. Only applicable to custom editorial or publishing roles.
-
id(optional):
string
ID of the role. Only applicable to permission sets and custom editorial or publishing roles.
-
links(optional):
array links
Links
-
name(optional):
string
Name of the role.
-
type(optional):
string
Allowed Values:
[ "standard", "custom", "editorial", "publishing" ]
Type of the role. Values are 'standard', 'custom', 'editorial', and 'publishing'.
Response
Supported Media Types
- application/json
200 Response
OK.
400 Response
Bad request.
403 Response
Forbidden.
404 Response
Not found.
500 Response
Internal server error.