API Workflow

Read.

Gets details of a Workflow Request and the corresponding Response and Signoff. The Current Workflow Requests WrqCurrentFlagOnly parameter is used to indicate whether or not we only want to read the current Workflow Request.

Authentication: Windows

Privilege : Administrator , Power User

Method: PxStat.Workflow.Workflow_API.Read

Parameters:

Name	Type	Default	Description
RlsCode	Int	0 or empty	Release Code
WrqCurrentFlagOnly	Boolean	true	Flag to indicate if we only want to view Current Workflow Requests

Return: Array [Object]

Name	Type	Description
RlsCode	Int	Release Code
WrqDatetime	Datetime	Time and Date of scheduled release
WrqEmergencyFlag	Boolean	Emergency flag indicator
WrqReservationFlag	Boolean	Reservation flag indicator
WrqArchiveFlag	Boolean	Archive flag indicator
WrqAlertFlag	Boolean	Alert flag indicator
RqsCode	String	Workflow Request Code, e.g. one of "PUBLISH","FLAG","ROLLBACK","DELETE"
RqsValue	String	Description of the Workflow Request type
RqsCmmValue	String	Comment for the Workflow Request
RqsCcnCreateUsername	String	AD username of the account that created the Workflow Request
RqsDtgCreateDatetime	Datetime	Time and Date of Workflow Request creation
RspCode	String	Workflow Response Code, e.g. one of "APPROVED","REJECTED"
RspValue	String	Description of Workflow Response
RspCmmValue	String	Comment for Workflow Response
RspCcnCreateUsername	String	AD username of the account the created the Workflow Response
RspDtgCreateDatetime	Datetime	Time and Date of Workflow Response creation
SgnCode	String	Workflow Signoff Code, e.g. one of "APPROVED","REJECTED"
SgnValue	String	Description of the Workflow Signoff
SgnCmmValue	String	Comment for the Workflow Signoff
SgnCcnCreateUsername	String	AD username of the account the created the Workflow Signoff
SgnDtgCreateDatetime	Datetime	Time and Date of Workflow Signoff creation

ReadAwaitingSignoff.

Reads a list of Workflows that are in a state of Awaiting Signoff.

Authentication: Windows

Privilege : Administrator , PowerUser

Method: PxStat.Workflow.Workflow_API.ReadAwaitingSignoff

Parameters:

Name	Type	Default	Description
RlsCode	Int	0 or empty	Release Code
LngIsoCode	String		Iso Code of requested langauge

Return: Array [ Object ]

Name	Type	Description
`RlsCode`	Int	Release Code
`MtrCode`	String	Matrix Code
`GrpCode`	String	Code of the Group to which the Release is assigned
`GrpName`	String	Name of the Group to which the Release is assigned
`RqsCode`	String	Workflow Request Code, e.g. one of "PUBLISH","FLAG","ROLLBACK","DELETE"
`RqsValue`	String	Description of the Workflow Request Yype
`CmmRequestValue`	String	Comment for the Workflow Request
`CmmResponseValue`	String	Comment for the Workflow Response
`RlsEmergencyFlag`	Boolean	Emergency Release Flag
`WrqDatetime`	Datetime	Requested start date/time of release
`DhtDatetime`	Datetime	Date/time request was made
`CcnUsername`	String	User id of the user who created the request
`MtrTitle`	String	Matrix Title*
*If a version of the matrix exists in the LngIsoCode parameter, the matrix title will be returned in that language. Otherwise the default language version is returned.

ReadLive.

Reads Workflows for which there are no approvals yet.

Authentication: Windows

Privilege : Administrator , PowerUser

Method: PxStat.Workflow.Workflow_API.ReadLive

Parameters:

Name	Type	Default	Description
LngIsoCode	String		Language ISO Code

Return: Array [ Object ]

Name	Type	Description
`RlsCode`	Int	Release Code
`MtrCode`	String	Matrix Code
`GrpCode`	String	Code of the Group to which the Release is assigned
`GrpName`	String	Name of the Group to which the Release is assigned
`CcnUsername`	String	Workflow Request Code, e.g. one of "PUBLISH","FLAG","ROLLBACK","DELETE"
`RlsReservationFlag`	String	Indicates Reservation
`RlsArchiveFlag`	String	Indicates Archive
`MtrOfficialFlag`	String	Indicates Official
`RlsLiveDatimeFrom`	String	Start time and date the release
`MtrTitle`	String	Title of Matrix*
*If a version of the matrix exists in the LngIsoCode parameter, the matrix title will be returned in that language. Otherwise the default language version is returned.

ReadAwaitingResponse.

Reads a list of Workflows that are in a state of Awaiting Response.

Authentication: Windows

Privilege : Administrator , PowerUser

Method: PxStat.Workflow.Workflow_API.ReadAwaitingResponse

Parameters:

Name	Type	Default	Description
RlsCode	Int	0 or empty	Release Code
LngIsoCode	String		Iso Code of requested langauge

Return: Array [ Object ]

Name	Type	Description
`RlsCode`	Int	Release Code
`MtrCode`	String	Matrix Code
`GrpCode`	String	Code of the Group to which the Release is assigned
`GrpName`	String	Name of the Group to which the Release is assigned
`RqsCode`	String	Workflow Request Code, e.g. one of "PUBLISH","FLAG","ROLLBACK","DELETE"
`RqsValue`	String	Description of the Workflow Request Type
`CmmRequestValue`	String	Comment for the Workflow Request
`RlsEmergencyFlag`	Boolean	Emergency Release Flag
`WrqDatetime`	Datetime	Requested start date/time of release
`DhtDatetime`	Datetime	Date/time request was made
`CcnUsername`	String	User id of the user who created the request
`MtrTitle`	String	Matrix Title*
*If a version of the matrix exists in the LngIsoCode parameter, the matrix title will be returned in that language. Otherwise the default language version is returned.

ReadWorkInProgress.

Reads a list of Workflows that are in a state of Work In Progress.

Authentication: Windows

Privilege : Administrator , PowerUser

Method: PxStat.Workflow.Workflow_API.ReadWorkInProgress

Parameters:

Name	Type	Default	Description
RlsCode	Int	0 or empty	Release code
LngIsoCode	String		Iso Code of requested langauge

Return: Array [ Object ]

Name	Type	Description
`RlsCode`	Int	Release Code
`MtrCode`	String	Matrix Code
`GrpCode`	String	Code of the Group to which the Release is assigned
`GrpName`	String	Name of the Group to which the Release is assigned
`RqsValue`	String	Type of Request
`CcnUsername`	String	User who created the request
`DhtDatetime`	String	Date/time request was created
`MtrTitle`	String	Matrix Title*
*If a version of the matrix exists in the LngIsoCode parameter, the matrix title will be returned in that language. Otherwise the default language version is returned.

ReadHistory.

Reads a Workflow History.

Authentication: Windows

Privilege : Administrator , Moderator , Power User

Method: PxStat.Workflow.Workflow_API.ReadHistory

Parameters:

Name	Type	Default	Description
RlsCode	Int	0 or empty	Release Code
LngIsoCode	String		Iso Code of requested langauge

Return: Array [ Object ]

Name	Type	Description
`RlsCode`	Int
`RqsCode`	String	Workflow Request code, e.g. one of "PUBLISH","FLAG","ROLLBACK","DELETE"
`RqsValue`	String	Description of the Workflow Request Type
`WrqCmmValue`	String	Comment for the Workflow Request
`WrqDateTime`	Datetime	Time and Date of scheduled release
`WrqEmergencyFlag`	Boolean	Emergency flag indicator
`WrqReservationFlag`	Boolean	Reservation flag indicator
`WrqAlertFlag`	Boolean	Alert flag indicator
`WrqArchiveFlag`	Boolean	Archive flag indicator
`WrqDtgCreateCcnUsername`	String	AD username of the account that created the Workflow Request
`WrqDtgCreateDateTime`	Datetime	Time and Date of Workflow Request creation
`RspCode`	String	Workflow Response code, e.g. one of "APPROVED","REJECTED"
`RspValue`	String	Description of Workflow Response
`WrsCmmValue`	String	Comment for Workflow Response
`WrsDtgCreateCcnUsername`	String	AD username of the account that created the Workflow Response
`WrsDtgCreateDateTime`	Datetime	Time and Date of Workflow Response creation
`SgnCode`	String	Workflow Signoff code, e.g. one of "APPROVED","REJECTED"
`SgnValue`	String	Description of the Workflow Signoff
`WsgCmmValue`	String	Comment for Workflow Signoff
`WsgDtgCreateCcnUsername`	String	AD username of the account that created the Signoff
`WsgDtgCreateDateTime`	Datetime	Time and Date of Workflow Signoff creation