Mozenda API Category: Sequences

Sequence.AddStepParameters

October 31, 2017

Description Adds one or more parameters to a step. Required parameters SequenceStepID , One or more parameters that you want to add to the step with their values. Use the format StepParameter.<ParamName>=<Value>. Note: A Sequence.GetStatus API call can be used to quickly get the SequenceStepID. Returns A message indicating whether

Read More

Sequence.ClearStepParameters

October 31, 2017

Description Clear all the parameters for a step. Required parameters SequenceStepID Note: A Sequence.GetStatus API call can be used to quickly get the SequenceStepID. Returns A message indicating whether the command was successful. Example request url https://api.mozenda.com/rest?WebServiceKey=A0D9167A-2E68-42EA-BB51-9F7EBDB4EE33&Service=Mozenda10&Operation=Sequence.ClearStepParameters&SequenceStepID=1001 Example response Note:

Read More

Sequence.GetStepParameters

October 31, 2017

Description Get the currently configured step parameters. Required parameters SequenceStepID Note: A Sequence.GetStatus API call can be used to quickly get the SequenceStepID. Returns A response containing the names and values of each parameter associated with the step. Example request url https://api.mozenda.com/rest?WebServiceKey=A0D9167A-2E68-42EA-BB51-9F7EBDB4EE33&Service=Mozenda10&Operation=Sequence.GetStepParameters&SequenceStepID=1001 Example response <?xml version="1.0" encoding="utf-8"?> <GetStepParametersResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

Read More

Sequence.GetList

September 16, 2017

Description Get a list of sequences for the account. Required parameters None Returns A response containing the ItemID, Name, Status, Config, Progress, NextRunTime, LastRunTime, and LastRunResult for each sequence. Example request url https://api.mozenda.com/rest?WebServiceKey=7BA008DF-6B13-492C-97E6-1B1042D1DC02&Service=Mozenda10&Operation=Sequence.GetList Example response <?xml version="1.0" encoding="utf-8"?> <SequenceGetListResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <Result>Success</Result> <SequenceCount>2</SequenceCount> <SequencesList> <Sequences> <ItemID>1001</ItemID> <Name>Beginning Of Day</Name>

Read More

Sequence.GetStatus

September 16, 2017

Description Gets the status of each step for a given sequence. Required parameters SequenceID Returns A response containing the ItemID, StepNumber, Step, Config, Status, Progress, StepType, StepItemID, Settings, ConcurrentJobs, ResumeErrorCount, and ResumeErrorCodes for each step in the sequence. Example request url https://api.mozenda.com/rest?WebServiceKey=7BA008DF-6B13-492C-97E6-1B1042D1DC02&Service=Mozenda10&Operation=Sequence.GetStatus&SequenceID=1001 Example response <?xml version="1.0" encoding="utf-8"?> <SequenceGetStatusResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

Read More

Sequence.Cancel

September 16, 2017

Description Cancels a sequence in the system. Note: A sequence must be in a Paused or Error State to cancel. Required parameters SequenceID Returns A message indicating whether the command was successful. Example request url https://api.mozenda.com/rest?WebServiceKey=7BA008DF-6B13-492C-97E6-1B1042D1DC02&Service=Mozenda10&Operation=Sequence.Cancel&SequenceID=1001 Example response Note: Please

Read More

Sequence.Resume

September 16, 2017

Description Resumes a sequence that is in a Paused or Error state. Required parameters SequenceID Returns A message indicating whether the command was successful. Example request url https://api.mozenda.com/rest?WebServiceKey=7BA008DF-6B13-492C-97E6-1B1042D1DC02&Service=Mozenda10&Operation=Sequence.Resume&SequenceID=1001 Example response Note: Please contact your sales representative at +1 (801) 995-4550

Read More

Sequence.Pause

September 16, 2017

Description Issues the 'Pause' command for a sequence currently running in the system. Required parameters SequenceID Returns A message indicating whether the command was successful. Example request url https://api.mozenda.com/rest?WebServiceKey=7BA008DF-6B13-492C-97E6-1B1042D1DC02&Service=Mozenda10&Operation=Sequence.Pause&SequenceID=1001 Example response Note: Please contact your sales representative at +1 (801)

Read More

Sequence.Run

September 16, 2017

Description Starts a specific sequence. Required parameters SequenceID Optional parameters StepNumber (Starts the Sequence at the step number specified and skips all previous steps.) Returns The result of the operation and, if the request was successful, the JobID. Example request url https://api.mozenda.com/rest?WebServiceKey=7BA008DF-6B13-492C-97E6-1B1042D1DC02&Service=Mozenda10&Operation=Sequence.Run&SequenceID=1001&StepNumber=1002 Example response <?xml version="1.0" encoding="utf-8"?> <SequenceRunResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

Read More

Need more information?

We'd love to hear from you.

100% Privacy. You are that important to us. Privacy Policy