The Get Self Service Categories operation will return a list of the Self Service categories.
Request
Request URI
| Method | Request URI |
|---|---|
| GET | https://{company-name}.helloid.com/api/v1/selfservice/categories |
Request parameters
| Parameter | Description |
|---|---|
| {company-name} | The company name of the target company |
Request headers
None.
Response
Response status
| Code | Description |
|---|---|
| 200(OK) | Indicates that the operation was successful and the resource is created. |
| 400(BAD REQUEST) | Indicates that the operation was not successful. The content type was incorrect or the request body was malformed. |
| 401(UNAUTHORIZED) | Indicates that no authentication header was given or the api key and secret were invalid. If the api key and secret were valid check the configuration in your portal, it is possibilty these were IP restricted or are disabled. |
| 404(NOTFOUND) | Indicates that the specified category does not exists. |
Please also see error result.
Please also see common HTTP status codes.
Response parameters
The response contains a list of category objects.
Self Service Category object
| Parameter | Description |
|---|---|
| selfServiceCategoryGUID | The GUID of the category. |
| name | The name of the category. |
| isEnabled | A boolean value indicating if the category is enabled or disabled. |
| autoDeny | A boolean value indicating if the requests linked to this category will be automatically denied. |
| autoApprove | A boolean value indicating if the requests linked to this category will be automatically approved. |
| automaticallyHandleAfterDays | The number of days after which requests in this category will be handled automatically. |
Sample response body
[
{
"selfServiceCategoryGUID": "dc0cd581-f156-42e9-9c48-975e1de6d29d",
"name": "Hardware",
"isEnabled": true,
"autoDeny": false,
"autoApprove": false,
"automaticallyHandleAfterDays": 30
},
{
"selfServiceCategoryGUID": "7be53dc8-976c-4707-8336-ab40f0e7af79",
"name": "Financial",
"isEnabled": true,
"autoDeny": false,
"autoApprove": false,
"automaticallyHandleAfterDays": 30
}
]
Example request with cURL
Replace placeholder values surrounded by { } with the actual values.
curl -u {api-key}:{api-secret} -X GET https://{company-name}.helloid.com/api/v1/selfservice/categories