The Get Products operation will return a list of Self Service products.
Request
Request URI
| Method | Request URI |
|---|---|
| GET | https://{company-name}.helloid.com/api/v1/selfservice/products |
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. |
| 409(CONFLICT) | Indicates that the operation was not successful. If there were validation errors, the response will include an error result. |
Please also see error result.
Please also see common HTTP status codes.
Response parameters
The response contains a list of products elements.
Product object
| Parameter | Description |
|---|---|
| selfServiceProductGUID | The GUID of the product |
| name | The name of the product |
| description | The description of the product |
| managedByGroupName | The name of the group that manages this product |
| category | The category name of the product |
| code | The code (SKU) of the product |
| isEnabled | Indicates if the product is enabled |
| isAutoApprove | Indicates if the product is automatically approved |
| isAutoDeny | Indicates if the product is automatically denied |
| isCommentable | Indicates if comments can be added when requesting the product |
| Icon | The hash of a custom icon. |
| FaIcon | The name of a font-awesome icon. |
| UseFaIcon | A boolean value indicating if the specified font-awesome icon should be used. |
| MultipleRequestOption | A value indicating how often a product can be requested. Possible values: 1: Once 2: Always |
| ReminderTimeout | The timeout duration of the reminders in days, where 0 means never. |
| OwnershipMaxDuration | The duration that that can be requested for this product in days, where 0 means indefinitely. |
| HasTimeLimit | Can there be a maximum duration of product ownership |
| LimitType | What type is the duration limit. Options: Fixed / Maximum |
| ManagerCanOverrideDuration | Can the duration as requested by a user be overridden when approving. |
| HasRiskFactor | Indicates if the product has a risk factor. |
| RiskFactor | The risk factor of the product. This value can be null or a number between 1 and 10. |
| MaxCount | The maximum times a product can be requested. |
| ShowPrice | Show the price of the product to the end user. |
| Price | The price of a product. Can be a number with decimals, divided by a comma or point. |
Sample response body
[
{
"selfServiceProductGUID": "2730f5a9-78c0-458e-af4b-0546377c5e36",
"name": "Product1",
"description": "Product description",
"managedByGroupName": "Administrators",
"category": "Applications",
"code": "20170608GSTBXJEDQE",
"isEnabled": false,
"isAutoApprove": false,
"isAutoDeny": false,
"isCommentable": false,
"icon": null,
"faIcon": null,
"useFaIcon": false,
"multipleRequestOption": 1,
"reminderTimeout": 30,
"ownershipMaxDuration": 90,
"hasTimeLimit": true,
"managerCanOverrideDuration": true,
"limitType": "Fixed",
"hasRiskFactor": true,
"riskFactor": 8,
"maxCount": 2,
"showPrice": false,
"price": 50
},
{
"selfServiceProductGUID": "2aa6d349-0886-4b19-a201-0c3c0e85e370",
"name": "Product2",
"description": "Product 2 description",
"managedByGroupName": null,
"category": "Applications",
"code": null,
"isEnabled": false,
"isAutoApprove": false,
"isAutoDeny": false,
"isCommentable": false,
"icon": null,
"faIcon": null,
"useFaIcon": false,
"multipleRequestOption": 1,
"reminderTimeout": 30,
"ownershipMaxDuration": 0,
"hasTimeLimit": false,
"managerCanOverrideDuration": false,
"limitType": "Maximum",
"hasRiskFactor": false,
"riskFactor": null,
"maxCount": null
"showPrice": true,
"price": 10.99
}
]
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/products