Create a job/phase stage
Parameter | Mandatory | Description | Examples | More Info |
---|---|---|---|---|
API | Yes | The API area | workflow.json | |
General | Yes | Parameters described in overview | see overview | Structure of an API call |
Action | Yes | The action to perform | action=create | |
Input | Yes | JSON string | see below |
JSON Input | Mandatory | Description | Examples |
---|---|---|---|
stageJobAndPhase | Yes | Client code | "stageJobAndPhase": "43/0004373.001" |
stageWorkflowType | Yes | First name | 569 |
stageDescription | No | Stage name | "Stage 1 - Initial stage" |
Example request:
Note: the options for stageWorkflowType can be found using a call to the stages table Stages API (see stagetypeId)
http://<SERVER>/jsonapi/workflow.json?user=user&password=user&version=4&action=create&input={
"data": [
{
"stageJobAndPhase": "43/0004373.001",
"stageWorkflowType": 569,
"stageDescription": "Stage 1 - want to call it Mikes 1"
}
]
}
_Example response:_
{
"responsecode": 1,
"responsestatus": "OK",
"errorcode": 0,
"errormessage": "",
"responsemessage": "data processed successfully.",
"warningmessage": "",
"success": true,
"synversion": "13.010.0070",
"synapiversion": 4.01,
"data": [
{
"stageUuid": "ABA4D4E835F3424488796A028AA7F943",
"stageCode": "43/W0000010746",
"stageTimeStampModified": 1731935415,
"stageRecordVersionNumber": 2
}
]
}