Sequence.GetStatus
  • 14 May 2024
  • 1 Minute to read
  • Contributors
  • Dark
    Light
  • PDF

Sequence.GetStatus

  • Dark
    Light
  • PDF

Article summary

Description

Gets the status of each step for a given sequence.

URL parameters

NameRequiredTypeDescription
SequenceIDTruenumericUnique identifier of the sequence.

Returns

NameTypeDescription
ResultstringSuccess if the operation was successful.
StepStepStep object.

Sample request

curl -X GET "https://api.mozenda.com/rest?WebServiceKey=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX&Service=Mozenda10&Operation=Sequence.GetStatus&SequenceID=1005"

Sample responses

XML

<?xml version="1.0" encoding="utf-8"?>
<SequenceGetStatusResponse 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
	<Result>Success</Result>
	<StepList>
		<Step>
			<SequenceStepID>1001</SequenceStepID>
			<StepNumber>1</StepNumber>
			<Step>Run Products</Step>
			<Config />
			<Status>Ready</Status>
			<Progress />
			<StepType>AgentRun</StepType>
			<StepItemID>1036</StepItemID>
			<Settings />
			<ConcurrentJobs>1</ConcurrentJobs>
			<ResumeErrorCount>0</ResumeErrorCount>
			<ResumeErrorCodes />
		</Step>
		<Step>
			<SequenceStepID>1002</SequenceStepID>
			<StepNumber>2</StepNumber>
			<Step>Publish Products</Step>
			<Config>PublishEmail</Config>
			<Status>Ready</Status>
			<Progress />
			<StepType>PublishData</StepType>
			<StepItemID>1016</StepItemID>
			<Settings />
			<ConcurrentJobs>0</ConcurrentJobs>
			<ResumeErrorCount>0</ResumeErrorCount>
			<ResumeErrorCodes />
		</Step>
	</StepList>
</SequenceGetStatusResponse>

JSON (add &ResponseFormat=JSON)

{
   "Step":[
      {
         "SequenceStepID":1010,
         "StepNumber":"1",
         "Step":"Run Test-01",
         "Config":"ResumeErrors Parameters",
         "Status":"Done",
         "Progress":"",
         "StepType":"AgentRun",
         "StepItemID":"1026",
         "Settings":"",
         "ConcurrentJobs":"1",
         "ResumeErrorCount":"2",
         "ResumeErrorCodes":""
      },
      {
         "SequenceStepID":1011,
         "StepNumber":"2",
         "Step":"Run Test-02",
         "Config":"ResumeErrors ConcurrentJobs Parameters",
         "Status":"Paused",
         "Progress":"18 out of 26 items (69.23%)",
         "StepType":"AgentRun",
         "StepItemID":"1027",
         "Settings":"",
         "ConcurrentJobs":"20",
         "ResumeErrorCount":"2",
         "ResumeErrorCodes":""
      },
      {
         "SequenceStepID":1012,
         "StepNumber":"3",
         "Step":"Run Test-03",
         "Config":"ResumeErrors ConcurrentJobs Parameters",
         "Status":"Queued",
         "Progress":"",
         "StepType":"AgentRun",
         "StepItemID":"1028",
         "Settings":"",
         "ConcurrentJobs":"200",
         "ResumeErrorCount":"2",
         "ResumeErrorCodes":""
      },
      {
         "SequenceStepID":1013,
         "StepNumber":"4",
         "Step":"Run Test-04",
         "Config":"ResumeErrors ConcurrentJobs Parameters",
         "Status":"Queued",
         "Progress":"",
         "StepType":"AgentRun",
         "StepItemID":"1029",
         "Settings":"",
         "ConcurrentJobs":"200",
         "ResumeErrorCount":"2",
         "ResumeErrorCodes":""
      }
   ],
   "JsonResult":{
      "Command":"Sequence.GetStatus",
      "AutoLoggedIn":false,
      "WebConsoleKey":"",
      "Result":"Success",
      "ErrorCode":"",
      "ErrorDescription":"",
      "ErrorList":[

      ],
      "ExecutionTime":{
         "Ticks":0,
         "Days":0,
         "Hours":0,
         "Milliseconds":0,
         "Minutes":0,
         "Seconds":0,
         "TotalDays":0,
         "TotalHours":0,
         "TotalMilliseconds":0,
         "TotalMinutes":0,
         "TotalSeconds":0
      }
   }
}


Enterprise Feature

Please contact your sales representative at +1 (801) 995-4550 or sales@mozenda.com for more information about enabling Sequences on your account.


Was this article helpful?