BackgroundJobs
Get BackgroundJobs
Changed onGET request to retrieve a single object.
get/api/v2/ui/backgroundJobs/{id}
Request
- Base URLhttps://docs.hashtopolis.org
- AuthHTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
idinteger required
Example:10
Query parameters
includestring[]
Relationships to include in the response, comma seperated. Possible options: user
Response
successful operation
Example response
{
"data": {
"id": 1,
"relationships": {
"user": {
"data": {
"id": 1
}
}
}
},
"included": [
{
"id": 1
}
]
}Changes
- info
endpoint added
- info