Parameter | Mandatory | Description | Examples | More Info |
---|
API | Yes | The API area | phases.json | |
General | Yes | Parameters described in overview | user=user&password=user | Structure of an API call |
Action | Yes | The action to perform | action=update | |
Input | Yes | JSON string | See below | |
JSON Input | Mandatory | Description | Examples |
---|
Identifier | Yes | Job ID or UUID | "phaseJobAndPhase":"1/00000105.001" |
Update data | Yes | Data to update | "phaseDescription":"New description" |
*Example request - updating the quoted value & description:*
http:///jsonapi/phases.json?user=user&password=user&action=update&company=1&version=3.9&input={
"data": [
{
"phaseJobAndPhase": "43/AB0C100.003",
"phaseDescription": "New description"
}
]
}
*Example response:*
[block:code]
{
"codes": [
{
"code": "{\n\"responsecode\": 1,\n\"responsestatus\": \"OK\",\n\"errorcode\": 0,\n\"errormessage\": \"\",\n\"responsemessage\": \"data processed successfully.\",\n\"warningmessage\": \"\",\n\"success\": true,\n\"synversion\": \"12.790j\",\n\"synapiversion\": 3.8,\n\"data\": [\n{\n\"phaseJobAndPhase\": \"1/00000105.001\",\n\"phaseuuid\": \"D61FA8E852C6184E8570248FC2F75F7E\",\n\"phaseTimeStampModified\": 1650556901,\n\"phaseRecordVersionNumber\": 2\n}\n]\n}",
"language": "json"
}
]
}
[/block]
###Note:
To discover which fields are editable make a call to the "Phase details" endpoint and specify '&style=modelstructure' see [Meta-data](ref:meta-data)