Create bulk print enrollment request V2
POST/api/web/v2/print
Create bulk print enrollment request. Caller requires the ISSUANCE:ADD permission to access this resource.
Note: Request body payload must not exceed 200 KB.
Request
- application/json
Body
required
List of Enrollment Ids (Id should be in Base64 string format)
printer
object
required
Details of printer to be used in bulk operation. It includes name and hopper values. For the name field, value is required but for hopper, value is optional. If value of the hopper is not provided, it will be set to 1 by default
Hopper to be used (Optional), default value is 1
Name of the printer. Value is printer's name given while adding the printer using create printer API. Refer readPrinter/readPrinters API to get the value of 'name' field.
Responses
- 200
- 400
- 401
- 404
- 500
OK
- application/json
- Schema
- Example (from schema)
Schema
The error message describing the first error encountered processing the bulk operation.
The row number of the first row that failed.
The unique UUID of the bulk operation.
The time this bulk operation was initialized.
The name of this bulk operation.
The time at which the bulk operation completed processing.
The time at which the bulk operation began processing.
How long the bulk operation took to complete processing.
The number of rows that have failed when processed.
The number of rows successfully processed.
Possible values: [FAILED
, CANCELLED
, COMPLETED
, AWAITING_DATA
, PROCESSING
, SCHEDULED
]
The state of the bulk operation.
Possible values: [IMPORT_USERS
, IMPORT_GROUPS
, IMPORT_USER_GROUPS
, IMPORT_HARDWARE_TOKENS
, IMPORT_SMART_CARDS
, IMPORT_ENROLLMENTS
, PRINT_ENROLLMENTS
, SEND_MFP
, ASSIGN_ENTRUST_ST
, ASSIGN_GOOGLE_ST
, ASSIGN_PASSWORDS
, RESET_PASSWORDS
, DELETE_USERS
, IMPORT_IDENTITYGUARD
, IMPORT_GRIDS
, EXPORT_ASSIGNEDGRIDS
, EXPORT_ASSIGNEDTOKENS
, EXPORT_AUDITEVENTS
, EXPORT_SELFAUDITEVENTS
, EXPORT_UNASSIGNEDGRIDS
, EXPORT_UNASSIGNEDTOKENS
, EXPORT_USERS
, SET_REGISTRATION
, SET_VERIFICATION
, ASSIGN_GRIDS
, EXPORT_USAGE
, CREATE_UNASSIGNED_GRIDS
, ASSIGN_HARDWARE_TOKENS
, SET_GRIDS
, EXPORT_ENROLLMENTS
, DELETE_GROUPS
, EXPORT_GROUPS
, RESET_TOKENS
, DELETE_ENROLLMENTS
, PROVISION_SCIM
, CREATE_TENANT
, REVOKE_MFP
, DELETE_GRIDS
]
The type of bulk operation.
{
"errorMessage": "string",
"firstFailedRow": 0,
"id": "string",
"initTime": "2019-02-19T13:15:27Z",
"name": "string",
"processingEndTime": "2019-02-19T13:15:27Z",
"processingStartTime": "2019-02-19T13:15:27Z",
"processingTime": 0,
"rowsFailed": 0,
"rowsProcessed": 0,
"state": "FAILED",
"type": "IMPORT_USERS"
}
Bad request
- application/json
- Schema
- Example (from schema)
Schema
The server error code
A human-readable representation of the error
The target of the error
{
"code": "string",
"message": "string",
"target": "string"
}
Authorization information is missing or invalid
- application/json
- Schema
- Example (from schema)
Schema
The server error code
A human-readable representation of the error
The target of the error
{
"code": "string",
"message": "string",
"target": "string"
}
The specified resource was not found
- application/json
- Schema
- Example (from schema)
Schema
The server error code
A human-readable representation of the error
The target of the error
{
"code": "string",
"message": "string",
"target": "string"
}
Unexpected error
- application/json
- Schema
- Example (from schema)
Schema
The server error code
A human-readable representation of the error
The target of the error
{
"code": "string",
"message": "string",
"target": "string"
}