(Quick Reference)
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}
Parameters:
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}
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
{
"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..."
}