Workflow Type List

Returns a list of valid workflows - for the optional move stage feature

Workflow Type List

ParameterMandatoryDescriptionExamplesMore Info
APIYesThe API areatspending.json
GeneralYesParameters described in overviewsee overviewStructure of an API call
CompanyYesThe company numbercompany=1
ActionYesThe action to performaction=workflowtypelist
JobNoJob numberjob=1/00008306
Job PhaseNoJob phase numberjobphase=1/00008306.001

Example request (OAuth 2.0):

Authorization: Bearer <access_token>
http://<SERVER>/jsonapi/tspending.json?&version=6&action=workflowtypelist&company=1

Example request (legacy username/password):

http://<SERVER>/jsonapi/tspending.json?&version=6&action=workflowtypelist&company=1&user=<username>&password=<password>

Example response:

{
  "responsecode": 1,
  "responsestatus": "OK",
  "errorcode": 0,
  "errormessage": "",
  "totalrows": 37,
  "totalpages": 1,
  "responsemessage": "",
  "pagerows": 0,
  "pagenumber": 1,
  "success": true,
  "synapiversion": 3.8,
  "data": [
    {
      "stagetypeCode": "537#",
      "stagetypeDescription": "Blue",
      "stagetypeSelected": false
    },
    {
      "stagetypeCode": "552#",
      "stagetypeDescription": "Brochures",
      "stagetypeSelected": false
    }
  ]
}