Create

Create a job/phase stage

ParameterMandatoryDescriptionExamplesMore Info
APIYesThe API areaworkflow.json
GeneralYesParameters described in overviewsee overviewStructure of an API call
ActionYesThe action to performaction=create
InputYesJSON stringsee below
JSON InputMandatoryDescriptionExamples
stageJobAndPhaseYesClient code"stageJobAndPhase": "43/0004373.001"
stageWorkflowTypeYesFirst name569
stageDescriptionNoStage 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
    }
  ]
}