GridsApi
| Method | HTTP request | Description |
|---|---|---|
| assignGridByIdUsingPUT | PUT /api/web/v1/grids/{gridserialnumber}/assign | Assign a grid to a user by serial number |
| assignGridBySerialNumberUsingPUT | PUT /api/web/v1/users/{id}/grids/assign | Assign a user to a grid |
| assignedGridsPageUsingPOST | POST /api/web/v2/gridspaged/assigned | Lists a page of assigned grids |
| changeGridStateUsingPUT | PUT /api/web/v2/grids/{gridid}/changestate | Change state of grid |
| createGridUsingPOST | POST /api/web/v2/users/{userid}/grids | Create a grid |
| createUnassignedGridsUsingPOST | POST /api/web/v1/grids | Create unassigned grids |
| deleteGridUsingDELETE | DELETE /api/web/v2/grids/{gridid} | Delete a grid |
| deliverAssignedGridByEmailUsingPOST | POST /api/web/v1/grids/{gridid}/email | Email a grid card to the card owner |
| getGridBySerialNumberUsingGET | GET /api/web/v2/grids/sernum/{sernum} | Get a grid by serial number |
| getGridPropertiesUsingGET | GET /api/web/v1/grids/properties | Get grid properties |
| getGridUsingGET | GET /api/web/v2/grids/{gridid} | Get a grid |
| getSingleGridExportUsingGET | GET /api/web/v1/grids/{gridid}/export | Export a grid to PDF format |
| modifyUnassignedGridUsingPUT | PUT /api/web/v2/grids/{gridid} | Modify unassigned grid |
| unassignGridUsingPUT | PUT /api/web/v1/grids/{id}/unassign | Unassign a grid |
| unassignedGridsPageUsingPOST | POST /api/web/v1/gridspaged/unassigned | Lists a page of unassigned grids |
assignGridByIdUsingPUT
assignGridByIdUsingPUT(gridserialnumber, gridAssignParms)
Assign a grid to a user by serial number
Assign the specified grid to a user. Caller requires the GRIDS:EDIT permission.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| gridserialnumber | String | The Serial Number of the grid to assign. | |
| gridAssignParms | GridAssignParms |
Return type
null (empty response body)
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
assignGridBySerialNumberUsingPUT
assignGridBySerialNumberUsingPUT(id, gridAssignParms)
Assign a user to a grid
Assign the specified user a grid. Caller requires the GRIDS:EDIT permission.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | The UUID of the user to which a grid is to be assigned. | |
| gridAssignParms | GridAssignParms |
Return type
null (empty response body)
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
assignedGridsPageUsingPOST
GridsPage assignedGridsPageUsingPOST(searchParms)
Lists a page of assigned grids
Returns assigned grids for the provided search parameters. Caller requires the GRIDS:VIEW permission. The following searchByAttributes are supported:
- serialNumber: a numeric value. Allowed operators are: EQUALS, GREATER_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN, LESS_THAN_OR_EQUAL.
- state: ACTIVE, INACTIVE, PENDING, CANCELED. Allowed operator: EQUALS.
- expired: 'true' is the only value allowed. Allowed operator: EQUALS.
- createDate: a String value representing an ISO-8601 date in UTC time (e.g., 2018-08-04T18:15:30). Allowed operators are: GREATER_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN, LESS_THAN_OR_EQUAL.
- expiryDate: a String value representing an ISO-8601 date in UTC time (e.g., 2018-08-04T18:15:30). Allowed operators are: GREATER_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN, LESS_THAN_OR_EQUAL.
- lastUsedDate: a String value representing an ISO-8601 date in UTC time (e.g., 2018-08-04T18:15:30). Allowed operators are: GREATER_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN, LESS_THAN_OR_EQUAL.
- userId: a String value. Allowed operators are: EQUALS, NOT_EQUALS, CONTAINS, NOT_CONTAINS, STARTS_WITH, ENDS_WITH.
- groupId: a String value should be a UUID of an existing group. Allowed operator: EQUALS.
If you provide more than one search attribute, they are joined with an AND condition.
The orderByAttribute supports these attribute names: serialNumber, state, createDate, expiryDate, lastUsedDate, userId.
The results will only include grids that contain data in the orderByAttribute selected.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| searchParms | SearchParms |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
changeGridStateUsingPUT
changeGridStateUsingPUT(gridid, gridChangeStateParms)
Change state of grid
Change the state of the specified grid. Caller requires the GRIDS:EDIT permission.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| gridid | String | The UUID of the grid whose state is to be changed. | |
| gridChangeStateParms | GridChangeStateParms |
Return type
null (empty response body)
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
createGridUsingPOST
Grid createGridUsingPOST(userid, gridCreateParms)
Create a grid
Create a grid for the specified user. Caller requires the GRIDS:ADD permission.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| userid | String | The UUID of the user for which a grid will be created. | |
| gridCreateParms | GridCreateParms | [optional] |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
createUnassignedGridsUsingPOST
List<Grid> createUnassignedGridsUsingPOST(gridCreateParms)
Create unassigned grids
Create the specified number of unassigned grids. Caller requires the GRIDS:ADD permission.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| gridCreateParms | GridCreateParms |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
deleteGridUsingDELETE
deleteGridUsingDELETE(gridid)
Delete a grid
Delete the specified grid. Caller requires the GRIDS:REMOVE permission.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| gridid | String | The UUID of the grid to be deleted. |
Return type
null (empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
deliverAssignedGridByEmailUsingPOST
deliverAssignedGridByEmailUsingPOST(gridid, emailParms)
Email a grid card to the card owner
Email a grid card to the card owner. Caller requires the GRIDS:VIEW permission.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| gridid | String | The ID of the grid to email. | |
| emailParms | EmailParms | [optional] |
Return type
null (empty response body)
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
getGridBySerialNumberUsingGET
Grid getGridBySerialNumberUsingGET(sernum)
Get a grid by serial number
Get the grid for the specified serial number. Caller requires the GRIDS:VIEW permission.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| sernum | Long | The serial number of the grid to be retrieved. |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
getGridPropertiesUsingGET
GridProperties getGridPropertiesUsingGET()
Get grid properties
Get grid properties. Caller requires the GRIDS:VIEW permission.
Example
Parameters
This endpoint does not need any parameter.
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
getGridUsingGET
Grid getGridUsingGET(gridid)
Get a grid
Get the specified grid. Caller requires the GRIDS:VIEW permission.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| gridid | String | The UUID of the grid to be retrieved. |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
getSingleGridExportUsingGET
GridExport getSingleGridExportUsingGET(gridid)
Export a grid to PDF format
Export a grid to PDF format. Caller requires the GRIDS:VIEW permission.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| gridid | String | The ID of the grid to export. |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
modifyUnassignedGridUsingPUT
modifyUnassignedGridUsingPUT(gridid, gridParms)
Modify unassigned grid
Modify the specified unassigned grid. Caller requires the GRIDS:EDIT permission.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| gridid | String | The UUID of the grid to be modified. | |
| gridParms | GridParms |
Return type
null (empty response body)
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
unassignGridUsingPUT
unassignGridUsingPUT(id)
Unassign a grid
Unassigned the specified grid. Caller requires the GRIDS:EDIT permission.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | The UUID of the grid to unassign. |
Return type
null (empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
unassignedGridsPageUsingPOST
GridsPage unassignedGridsPageUsingPOST(searchParms)
Lists a page of unassigned grids
Returns unassigned grids for the provided search parameters. Caller requires the GRIDS:VIEW permission. The following searchByAttributes are supported:
- serialNumber: a numeric value. Allowed operators are: EQUALS, GREATER_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN, LESS_THAN_OR_EQUAL.
- createDate: a String value representing an ISO-8601 date in UTC time (e.g., 2018-08-04T18:15:30). Allowed operators are: GREATER_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN, LESS_THAN_OR_EQUAL.
- groupId: a String value should be a UUID of an existing group. Allowed operator: EQUALS.
If you provide more than one search attribute, they are joined with an AND condition.
The orderByAttribute supports these attribute names: serialNumber, createDate.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| searchParms | SearchParms |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |