Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This POST service will retrieve the workflowRequestStatus based on the workflowRequestId in the request. Most of the Status statuses are interim statuses. Only , only COMPLETED and FAILED are final status. Your request will fall into one of these two upon completion. The following are all of the possible statuses that can be returned:

  • INITIATED,
  • PENDING_APPROVAL,
  • SCHEDULED,
  • ABORTED
  • REJECTED,
  • READY,
  • SUBMITTED,
  • COMPLETED,
  • FAILED


Info
titleAPI URL
POST http://host:port/flexdeploy/rest/workflow/getWorkflowRequestStatus

...

Code Block
languagejs
titleSample JSON Request
linenumberstrue
{
	"authentication":
	{
		"userId": "userid",
		"password": "mypassword"
	},
	"workflowRequestId": "28208"
}

Parameters

Parameter

Required

Type

Description

authentication

Y

See Common Parameters below.

Object

The authentication parameter is comprised of 2 fields.

  • userId – a valid user id for FlexDeploy
  • password – the associated password


workflowRequestId

Y

Long

The requestId to retrieve the status for.

...