Absorb Integration API (v1)

Download OpenAPI specification:Download

Resources

List resources.

Authorizations:

api_key

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: _filter=`firstname eq 'Jeffrey'` _filter=`id eq guid'a14c149a-2ce0-41d4-b532-02189ad3cb22'` _filter=`startsWith(lastname,'leb') or dateAdded ge datetime'1998-03-06T20:38:07Z'`
_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 `-`. For example, `_sort=name,-date`, sorts the collection of items by `name` (ascending) and then by `date` (descending).
_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 1

Responses

Response Schema: application/json

Array

id	string <guid> `Filterable` The unique resource identifier
name	string `Sortable` `Filterable` The resource's name.
description	string `Filterable` The resource's description.
file	string `Sortable` The resource's associated file, if any.

Response samples

200
422

Content type

application/json

[{"id": "string",
"name": "string",
"description": "string",
"file": "string"
}
]

Get resource.

Authorizations:

api_key

path Parameters

id

required

string <guid>

The resource ID.

header Parameters

x-api-key	string
x-api-version	string 1

Responses

Response Schema: application/json

id	string <guid> The unique resource identifier
name	string The resource's name.
description	string The resource's description.
file	string The resource's associated file, if any.

Response samples

200
404

Content type

application/json

{"id": "string",
"name": "string",
"description": "string",
"file": "string"
}

List resources available to a specific user.

Authorizations:

api_key

path Parameters

userId

required

string <guid>

The user ID.

header Parameters

x-api-key	string
x-api-version	string 1

Responses

Response Schema: application/json

Array

id	string <guid> The unique resource identifier
name	string The resource's name.
description	string The resource's description.
file	string The resource's associated file, if any.

Response samples

200
404

Content type

application/json

[{"id": "string",
"name": "string",
"description": "string",
"file": "string"
}
]

List resources for the current authenticated user.

Authorizations:

api_key

header Parameters

x-api-key	string
x-api-version	string 1

Responses

Response Schema: application/json

Array

id	string <guid> The unique resource identifier
name	string The resource's name.
description	string The resource's description.
file	string The resource's associated file, if any.

Response samples

200

Content type

application/json

[{"id": "string",
"name": "string",
"description": "string",
"file": "string"
}
]

Course Resources

List resources from a specific course.

Authorizations:

api_key

path Parameters

courseId

required

string <guid>

The course ID.

header Parameters

x-api-key	string
x-api-version	string 1

Responses

Response Schema: application/json

Array

id	string <guid> The unique resource identifier
name	string The resource's name.
description	string The resource's description.
file	string The resource's associated file, if any.

Response samples

200
404

Content type

application/json

[{"id": "string",
"name": "string",
"description": "string",
"file": "string"
}
]

Get resource from a specific course.

Authorizations:

api_key

path Parameters

resourceId required	string <guid> The resource ID.
courseId required	string <guid> The course ID.

header Parameters

x-api-key	string
x-api-version	string 1

Responses

Response Schema: application/json

id	string <guid> The unique resource identifier
name	string The resource's name.
description	string The resource's description.
file	string The resource's associated file, if any.

Response samples

200
404

Content type

application/json

{"id": "string",
"name": "string",
"description": "string",
"file": "string"
}

List resources associated with a specified enrollment for a specific user.

Authorizations:

api_key

path Parameters

userId required	string <guid> The user ID.
courseId required	string <guid> The course ID.

header Parameters

x-api-key	string
x-api-version	string 1

Responses

Response Schema: application/json

Array

id	string <guid> The unique resource identifier
name	string The resource's name.
description	string The resource's description.
file	string The resource's associated file, if any.

Response samples

200
404

Content type

application/json

[{"id": "string",
"name": "string",
"description": "string",
"file": "string"
}
]

List resources available from a specific course for the current authenticated user.

Authorizations:

api_key

path Parameters

id

required

string <guid>

The course ID.

header Parameters

x-api-key	string
x-api-version	string 1

Responses

Response Schema: application/json

Array

id	string <guid> The unique resource identifier
name	string The resource's name.
description	string The resource's description.
file	string The resource's associated file, if any.

Response samples

200
404

Content type

application/json

[{"id": "string",
"name": "string",
"description": "string",
"file": "string"
}
]