(Quick Reference) Service: Upsert

Description: This web service is used to insert an item group object to the database if it does not already exist, or update it.

URL with external_id:

https://BASE_URL/api/VERSION/itemGroups/reference/{id}

Method: POST

Request content type: application/json

Parameters:

NameDescriptionTypeRequiredExample values
referencethe reference of the new item groupStringYes 
namethe name of the new item groupStringYes 
descriptionsome details of the new groupStringNo 
reference must be unique

Success Output

Success case: response.status=201
{
    "id": 23,
    "reference": "RG-3",
    "name": "ItemGroup3",
    "description": null,
    "organization": "Lyon",
    "dateCreated": "2016-08-18T10:53:58Z",
    "lastUpdated": "2016-08-18T10:53:58Z"
}

Failure Output

Failure case:response.status = 400
{
    "error": "missing_param",
    "error_description": "reference parameter is missing"
}
{
    "error": "not_unique",
    "error_description": "reference already used"
}
{
     "error": "save_failed",
     "error_description": "Failed to save instance"
}

Failure case:response.status = 500
{
    "error": "server_error",
    "error_description": "Oops! Something went wrong..."
}