Execute Pipeline

End Point Details:

• Method – POST
• REST Endpoint - rest-api/v1/PMFService/execute

Table 5-6 Request Headers

Name	Type	Required	Value
Content-Type	String	Yes	application/json

Request JSON Parameters:

Table 5-7 Request JSON Parameters

Name	Type	Description
SummaryPayload	Object	This is an object with the properties mentioned below.
objectID	String	Specify an unique string identifier for the execution. Allowed characters are alphabets , numbers, Hyphen(-),and Underscore(_) No other special characters are allowed. For Example: ProcessExecObj1
processId	String	Process ID of the pipeline For Example: RNBISPMF002
objectType	String	Specify Object type if exists or null. For Example: null
infodom	String	Information Domain Name. For Example: OFSA829INF3
locale	String	Locale selected. For Example: ‘en_US'
Securitymap	Object	Specify security map if exists or null
applicationparams	Object	Specify values for the run time execution parameters Specify values for the Run execution parameters in JSON format..

Request JSON Sample:

/rest-api/v1/PMFService/execute

{

"SummaryPayload": {

"objectId": "ProcessExecObj1",

"processId": "RNBISPMF002",

"objectType": "null",

"locale": "en_US",

"infodom":"OFSA829INF3",

"securitymap" :{},

"applicationparams":{"FIC_MIS_DATE":"2020-04-

01","BASEL_CONF_ID":"22","CONSOTYPE":"SOLO","IS_BACKDATED_EXEC":"Y","SIGCUR":

"YES","EXP_DATA":"INCR"}

}

}

Response JSON Parameters:

This section provides the list of parameters in the JSON Response.

Table 5-8 Query Parameters returned in the response body

Name	Type	Description
processInstanceId	String	Instance Id of the process being executed
stopExecutionFlag	String	Flag indicates if the execution stopped due to internal failure
processStatus	String	It indicates status of the process initiation
processID	String	Process ID of the pipeline
workflowStatus	String	Status of the process initiation
lastActivity	String	It is the next activity ID in the process to be executed
responseJSON	String	Response of a particular task, if any
responseStatus	String	Rest API standard status

Response JSON Sample:

{

"payload": {

"processInstanceID": "1634536080515_3f80680b-3276-42ac-a41c-a573d0697c23",

"stopExecutionFlag": false,

"processStatus": "SUCCESS",

"processID": "1634536080515",

"workflowStatus": "COMPLETED",

"lastActivity": "Job_1583994521890",

"responseJSON": "",

"responseStatus": "SUCCESS"

}