(Quick Reference)
27 Assign items to groups - Reference Documentation
Version: 2.1
27 Assign items to groups
27.1 List
Service: List
Description: This web service return the list of assigned item groups in JSON format
URL:
https://BASE_URL/api/VERSION/itemGroupAssign
: GET
Parameters:
Pagination parameters:
| Name | Description | Type | Required | Possible values |
|---|
| offset | Tells where to start returning records from the entire set of results | Integer | No | |
| max | limits the number of resources requested to return | Integer | No | |
| sort | Orders the results by the specified field | String | No | |
| order | Orders ascending (ASC) or descending DESC | Integer | No | asc, desc |
Filters parameters:
| Name | Description | Type | Required | Example values |
|---|
| dateCreated_gt | Filters by the resource's creation date time and operator greater than | Date | no | 2016-08-15T14:52:48Z |
| dateCreated_gte | Filters by the resource's creation date time and operator greater than or equal | Date | no | |
| dateCreated_lt | Filters by the resource's creation date time and operator less than | Date | no | |
| dateCreated_lte | Filters by the resource's creation date time and operator less than or equal | Date | no | |
| lastUpdated_gt | Filters by the resource's last-modified date time and operator greater than | Date | no | |
| lastUpdated_gte | Filters by the resource's last-modified date time and operator greater than or equal | Date | no | |
| lastUpdated_lt | Filters by the resource's last-modified date time and operator less than | Date | no | |
| lastUpdated_lte | Filters by the resource's last-modified date time and operator less than or equal | Date | no | |
| groupReference | Wildcard search by the resource's reference | String | no | groupReference=Ref-6* , groupReference=*ef-6 , groupReference=*ef-6* |
Dates should be formatted as the ISO-8601 format (YYYY-MM-DDTHH:MM:SSZ)
Success Output
Success case: response.status=200
{
"paging": {
"total": 2,
"max": 100,
"offset": 0,
"previous": null,
"next": null
},
"data": [
{
"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"
},
{
"id": 160,
"itemReference": "R-A-001",
"itemGroupReference": "RG-2",
"item": {
"id": 1751,
"reference": "R-A-001",
"name": "article1",
"href": "/api/v1.0/items/1751"
},
"itemGroup": {
"id": 22,
"reference": "RG-2",
"name": "ItemGroup2",
"href": "/api/v1.0/itemGroups/22"
},
"organization": "Lyon",
"dateCreated": "2016-08-23T11:33:13Z",
"lastUpdated": "2016-08-23T11:33:13Z"
}
]
} Failure Output
Failure case:response.status = 400
{
"error": "invalid_param",
"error_description": "The parameters [dateCreated_gta] you provided are not valid for this request."
}{
"error": "invalid_datetime_format",
"error_description": "Invalid datetime filter (not ISO-8601 formatted): [2016-08-1Z]"
} Failure case:response.status = 500
{
"error": "server_error",
"error_description": "Oops! Something went wrong..."
}27.2 Show
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}:
| 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}:
| 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."
}27.3 Delete
Service: Delete
Description: This web service is used in order to delete an existing assigned item group object from the database
Method: DELETE
URL:
https://BASE_URL/api/VERSION/itemGroupAssign/{id}:
| Name | Description | Type | Required | Examples values |
|---|
| id | Id of the desired assigned item group to delete | Long | Yes | 777 |
URL with external_id:
https://BASE_URL/api/VERSION/itemGroupAssign/reference/{itemId}/{groupId}:
| 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
{
"success": "true",
"success_description": "Instance deleted successfully"
} Failure Output
Failure case:response.status = 400
{
"error": "invalid_param_type",
"error_description": "The type of parameter id you provided is not valid for this request."
}{
"error": "delete_failed",
"error_description": "Failed to delete instance"
} Failure case:response.status = 404
{
"error": "not_found",
"error_description": "The item group assign with the id 100 doesn't exist."
} Failure case:response.status = 500
{
"error": "server_error",
"error_description": "Oops! Something went wrong..."
}27.4 Update
Service: Update
Description: This web service is used to update an existing assigned item group object to the database
Method: PUT
Request content type: application/json
URL:
https://BASE_URL/api/VERSION/itemGroupAssign/{id}:
| Name | Description | Type | Required | Example values |
|---|
| id | id of the desired assigned item group to update | Long | Yes | 111 |
| groupId | the id of the item group to be assigned | Long | Yes | 777 |
| itemId | the id of the new item group to assign to an itemGroup | Long | Yes | 123 |
URL with external_id:
https://BASE_URL/api/VERSION/itemGroupAssign/reference/{itemId}/{groupId}:
| 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-1",
"item": {
"id": 1751,
"reference": "R-A-001",
"name": "article1",
"href": "/api/v1.0/items/1751"
},
"itemGroup": {
"id": 21,
"reference": "RG-1",
"name": "ItemGroup1",
"href": "/api/v1.0/itemGroups/21"
},
"organization": "Lyon",
"dateCreated": "2016-08-23T11:23:27Z",
"lastUpdated": "2016-08-23T11:57:22Z"
} Failure Output
Failure case:response.status = 400
{
"error": "missing_param",
"error_description": "groupId parameter is missing"
}{
"error": "already_assigned",
"error_description": "item is already assigned to itemGroup."
}{
"error": "invalid_param_type",
"error_description": "The type of parameter id you provided is not valid for this request."
}{
"error": "save_failed",
"error_description": "Failed to save instance"
} Failure case:response.status = 404
{
"error": "not_found",
"error_description": "The item group with the id 999 doesn't exist."
} Failure case:response.status = 500
{
"error": "server_error",
"error_description": "Oops! Something went wrong..."
}27.5 Create
Service: Save
Description: This web service is used to add a new assigned item group object into the database
URL:
https://BASE_URL/api/VERSION/itemGroupAssign
: POST
Request content type: application/json
Parameters:
| Name | Description | Type | Required | Example values |
|---|
| groupId | the id of the item group to be assigned | Long/String | Yes | 777 |
| itemId | the id of the new item group to assign to an itemGroup | Long/String | Yes | 123 |
| useExternalId | By default, it is set to false. set it to true if you want to use external ids. | Boolean | no | true , false |
Success Output
Success case: response.status=201
{
"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 = 400
{
"error": "missing_param",
"error_description": "groupId parameter is missing"
}{
"error": "already_assigned",
"error_description": "item is already assigned to itemGroup."
}{
"error": "save_failed",
"error_description": "Failed to save instance"
} Failure case:response.status = 404
{
"error": "not_found",
"error_description": "The item group with the id 999 doesn't exist."
} Failure case:response.status = 500
{
"error": "server_error",
"error_description": "Oops! Something went wrong..."
}
