Update a phase
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://<SERVER>/jsonapi/phases.json?user=user&password=user&action=update&company=1&version=45&input={
"data": [
{
"phaseJobAndPhase": "1/00000210.001",
"phaseDescription": "New description"
}
]
}
Example response:
{
"responsecode": 1,
"responsestatus": "OK",
"errorcode": 0,
"errormessage": "",
"responsemessage": "data processed successfully.",
"warningmessage": "",
"success": true,
"synversion": "12.960.0060",
"synapiversion": 3.95,
"data": [
{
"phaseJobAndPhase": "1/00000210.001",
"phaseuuid": "7BBD6173F013EA4087AE1302B58C43E0",
"phaseTimeStampModified": 1697031205,
"phaseRecordVersionNumber": 338
}
]
}
To discover which fields are editable make a call to the "phase details" endpoint and specify '&style=modelstructure' see Meta-data