(Quick Reference)
Service: Show
Description: This web service return an existing assigned item group object of the specified id in JSON format
Method: GET
URL:
https://BASE_URL/api/VERSION/itemGroupAssign/{id}
Parameters:
Name | Description | Type | Required | Example values |
---|
id | id of the desired assigned item group | Long | Yes | 777 |
URL with external_id:
https://BASE_URL/api/VERSION/itemGroupAssign/reference/{itemId}/{groupId}
Parameters:
Name | Description | Type | Required | Examples values |
---|
itemId | reference of the item | String | Yes | I-002 |
groupId | reference of the item group | String | Yes | IG-001 |
Success Output
Success case: response.status=200
{
"id": 159,
"itemReference": "R-A-001",
"itemGroupReference": "RG-3",
"item": {
"id": 1751,
"reference": "R-A-001",
"name": "article1",
"href": "/api/v1.0/items/1751"
},
"itemGroup": {
"id": 23,
"reference": "RG-3",
"name": "new ItemGroup3",
"href": "/api/v1.0/itemGroups/23"
},
"organization": "Lyon",
"dateCreated": "2016-08-23T11:23:27Z",
"lastUpdated": "2016-08-23T11:23:27Z"
}
Failure Output
Failure case:response.status = 404
{
"error": "not_found",
"error_description": "The item group assign with the id 999 doesn't exist."
}
Failure case:response.status = 400
{
"error": "invalid_param_type",
"error_description": "The type of parameter id you provided is not valid for this request."
}