Absorb Integration API (v2)
Download OpenAPI specification:Download
Retrieves a list of direct reports for a manager.
Authorizations:
path Parameters
ManagerId required | string <guid> The manager's user ID. |
query Parameters
_filter | string One or more filter operations to be performed on the collection. The referenced fields must allow filtering. See the respective report's schema for which fields can be filtered. Supports most of the OData filter syntax. Supported operations: * eq, * ne, * gt, * ge, * lt, * le, * and, * or, * not, * () Supported functions: * substringof('value',fieldName), * endswith(fieldName,'value'), * startswith(fieldName,'value'), * tolower(fieldName), * toupper(fieldName) Examples:
|
_sort | string Optional list of comma-separated fields to sort the collection by. The referenced fields must allow sorting. See the respective report's schema for which fields can be sorted. If not specified, all report fields are returned. To sort in a descending manner, prefix the field name with |
_limit | string The maximum number of items to return in the current page of the collection. |
_offset | string The number of pages to offset into the collection. |
header Parameters
x-api-key | string |
x-api-version | string 2 |
Responses
Response Schema: application/json
totalItems | integer <int32> The total number of items in the unbounded collection |
returnedItems | integer <int32> The number of items in the bound collection being returned |
limit | integer <int32> The current page size for the collection |
offset | integer <int32> The current offset for the collection |
Array of objects (DirectReportResource) The paged collection of direct reports. |
Response samples
- 200
- 404
- 422
{- "totalItems": 0,
- "returnedItems": 0,
- "limit": 0,
- "offset": 0,
- "directReports": [
- {
- "id": "string",
- "firstName": "string",
- "middleName": "string",
- "lastName": "string",
- "username": "string",
- "emailAddress": "string",
- "isManager": true,
- "directReportCount": 0
}
]
}
Updates a list of direct reports for a manager.
Authorizations:
path Parameters
managerId required | string <guid> The manager's user ID. |
header Parameters
x-api-key | string |
x-api-version | string 2 |
Request Body schema: application/json
The request containing the list of direct reports to update.
directReportIds required | Array of strings <guid> [ items <guid > ] The manager's direct report user Ids to be updated with for the user. |
Responses
Response Schema: application/json
totalItems | integer <int32> The total number of items in the unbounded collection |
returnedItems | integer <int32> The number of items in the bound collection being returned |
limit | integer <int32> The current page size for the collection |
offset | integer <int32> The current offset for the collection |
Array of objects (DirectReportResource) The paged collection of direct reports. |
Request samples
- Payload
{- "directReportIds": [
- "string"
]
}
Response samples
- 200
- 404
- 422
{- "totalItems": 0,
- "returnedItems": 0,
- "limit": 0,
- "offset": 0,
- "directReports": [
- {
- "id": "string",
- "firstName": "string",
- "middleName": "string",
- "lastName": "string",
- "username": "string",
- "emailAddress": "string",
- "isManager": true,
- "directReportCount": 0
}
]
}
Retrieves a list of manager roles.
Authorizations:
query Parameters
_filter | string One or more filter operations to be performed on the collection. The referenced fields must allow filtering. See the respective report's schema for which fields can be filtered. Supports most of the OData filter syntax. Supported operations: * eq, * ne, * gt, * ge, * lt, * le, * and, * or, * not, * () Supported functions: * substringof('value',fieldName), * endswith(fieldName,'value'), * startswith(fieldName,'value'), * tolower(fieldName), * toupper(fieldName) Examples:
|
_sort | string Optional list of comma-separated fields to sort the collection by. The referenced fields must allow sorting. See the respective report's schema for which fields can be sorted. If not specified, all report fields are returned. To sort in a descending manner, prefix the field name with |
_limit | string The maximum number of items to return in the current page of the collection. |
_offset | string The number of pages to offset into the collection. |
header Parameters
x-api-key | string |
x-api-version | string 2 |
Responses
Response Schema: application/json
totalItems | integer <int32> The total number of items in the unbounded collection |
returnedItems | integer <int32> The number of items in the bound collection being returned |
limit | integer <int32> The current page size for the collection |
offset | integer <int32> The current offset for the collection |
Array of objects (ManagerRoleResource) The paged collection of roles. |
Response samples
- 200
- 403
- 422
{- "totalItems": 0,
- "returnedItems": 0,
- "limit": 0,
- "offset": 0,
- "roles": [
- {
- "id": "string",
- "name": "string",
- "description": "string"
}
]
}
List a specified manager's manager roles.
Authorizations:
path Parameters
managerId required | string <guid> The manager's user ID. |
query Parameters
_filter | string One or more filter operations to be performed on the collection. The referenced fields must allow filtering. See the respective report's schema for which fields can be filtered. Supports most of the OData filter syntax. Supported operations: * eq, * ne, * gt, * ge, * lt, * le, * and, * or, * not, * () Supported functions: * substringof('value',fieldName), * endswith(fieldName,'value'), * startswith(fieldName,'value'), * tolower(fieldName), * toupper(fieldName) Examples:
|
_sort | string Optional list of comma-separated fields to sort the collection by. The referenced fields must allow sorting. See the respective report's schema for which fields can be sorted. If not specified, all report fields are returned. To sort in a descending manner, prefix the field name with |
_limit | string The maximum number of items to return in the current page of the collection. |
_offset | string The number of pages to offset into the collection. |
header Parameters
x-api-key | string |
x-api-version | string 2 |
Responses
Response Schema: application/json
totalItems | integer <int32> The total number of items in the unbounded collection |
returnedItems | integer <int32> The number of items in the bound collection being returned |
limit | integer <int32> The current page size for the collection |
offset | integer <int32> The current offset for the collection |
Array of objects (ManagerRoleResource) The paged collection of roles. |
Response samples
- 200
- 404
- 422
{- "totalItems": 0,
- "returnedItems": 0,
- "limit": 0,
- "offset": 0,
- "roles": [
- {
- "id": "string",
- "name": "string",
- "description": "string"
}
]
}
Update a specified manager's manager roles.
Authorizations:
path Parameters
managerId required | string <guid> The manager's user ID. |
header Parameters
x-api-key | string |
x-api-version | string 2 |
Request Body schema: application/json
roleIds required | Array of strings <guid> non-empty [ items <guid > ] The manager role IDs to be updated with for the manager. |
Responses
Response Schema: application/json
totalItems | integer <int32> The total number of items in the unbounded collection |
returnedItems | integer <int32> The number of items in the bound collection being returned |
limit | integer <int32> The current page size for the collection |
offset | integer <int32> The current offset for the collection |
Array of objects (ManagerRoleResource) The paged collection of roles. |
Request samples
- Payload
{- "roleIds": [
- "string"
]
}
Response samples
- 200
- 404
- 422
{- "totalItems": 0,
- "returnedItems": 0,
- "limit": 0,
- "offset": 0,
- "roles": [
- {
- "id": "string",
- "name": "string",
- "description": "string"
}
]
}