Returns one or all of the product assignments in your HelloID environment.
Request
Request URI
| Method | Request URI |
|---|---|
| GET | https://{company-name}.helloid.com/api/v1/product-assignment |
| GET | https://{company-name}.helloid.com/api/v1/product-assignment/by-assignment/{<AssignmentGuid> Guid} |
| GET | https://{company-name}.helloid.com/api/v1/product-assignment/by-user/{<UserGuid> Guid}?skip={<Skip int>}&take={Take int} |
| GET | https://{company-name}.helloid.com/api/v1/product-assignment/by-product/{<ProductGuid> Guid}?skip={<Skip int>}&take={Take int} |
| GET | https://{company-name}.helloid.com/api/v1/product-assignment/by-source/{<Source> string}?skip={<Skip int>}&take={Take int} |
Request parameters
| Parameter | Description |
|---|---|
| {company-name} | The company name of the target company |
| {<AssignmentGuid>Guid} | The guid of a assignment/request, gets a single assignment |
|
{<UserGuid> Guid} |
The guid of a user, gets all assignments for that user |
|
{<ProductGuid> Guid} |
The guid of a product, gets all assignments for that product |
|
{<Source> string} |
The source of an assignment, gets all assignments for that source |
|
{<Skip int>} |
The amount of assignments you want to skip |
|
{<Take int>} |
The amount of assignments you want to retrieve |
Request body
No request body
Request body parameters
No request body parameters
Response
Response status
| Code | Description |
|---|---|
| 200(OK) | Indicates that the operation was successful. |
| 400(BAD REQUEST) | Indicates that the operation was not successful. There were validation errors 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. |
Please also see error result.
Please also see common HTTP status codes.
Sample response body
{
[
{
"assignmentGuid": "ee289065-d3c8-4046-aed4-5f866afd5663",
"requestedAt": "2022-05-31T08:14:13.927",
"approvedAt": "2022-05-31T08:14:14.047",
"source": "custom assignment source",
"userGuid": "ef640b2f-4610-4848-ad5e-d2fb4181ca93",
"userName": "AUser",
"productGuid": "7b0256b8-f9ee-49fa-a93e-05cefb4a9ad3",
"productName": "CypressProduct - multiple request",
"productSku": "ABCD1235",
"approvalHistory": [],
"returnDate": null
},
{
"assignmentGuid": "f0074f44-e36e-4db7-9e91-d5502a093d94",
"requestedAt": "2022-05-31T08:14:13.637",
"approvedAt": "2022-05-31T08:14:13.763",
"source": "custom assignment source",
"userGuid": "ef640b2f-4610-4848-ad5e-d2fb4181ca93",
"userName": "AUser",
"productGuid": "7b0256b8-f9ee-49fa-a93e-05cefb4a9ad3",
"productName": "CypressProduct - multiple request",
"productSku": "ABCD1235",
"approvalHistory": [],
"returnDate": null
},
{
"assignmentGuid": "5770c865-8245-4db1-aa99-88eaea44a9f1",
"requestedAt": "2022-05-31T08:14:13.36",
"approvedAt": "2022-05-31T08:14:13.48",
"source": "custom assignment source",
"userGuid": "ef640b2f-4610-4848-ad5e-d2fb4181ca93",
"userName": "AUser",
"productGuid": "7b0256b8-f9ee-49fa-a93e-05cefb4a9ad3",
"productName": "CypressProduct - multiple request",
"productSku": "ABCD1235",
"approvalHistory": [],
"returnDate": null
}
]
}
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/product-assignment/by-user/ef640b2f-4610-4848-ad5e-d2fb4181ca93