This section provides information on how to initiate a PMF process.
· Method – POST
· REST Endpoint - /pmf-exec/rest-api/v1/PMFService/execute
· Content-Type - Application/Json
The following table lists the Request Headers.
Name |
Type |
Required |
Value |
ofs_service_id |
String |
Yes |
OFS_FSAFND |
Content-Type |
String |
No |
application/json |
After the pipeline is executed, responseStatus indicates “SUCCESS” or “failed” based on the result of the execution.
The following table lists the Request Body.
Name |
Type |
Required |
Description |
SummaryPayload |
OBJECT |
Yes |
This is an object with the properties mentioned below |
objectid |
STRING |
Yes |
Specify an unique string identifier for the execution. Allowed characters are alphabets , numbers, Hyphen(-),and Underscore(_) No other special characters are allowed For example: 'test123' |
processID |
STRING |
Yes |
Process ID of the Run Pipeline |
objecttype |
STRING |
NO |
Specify an empty string |
locale |
STRING |
Yes |
Specify values as 'en-us' |
applicationparams |
OBJECT |
Yes |
Specify values for the run time execution parameters. |
This section provides the list of parameters in the JSON Response.
The following table provides details for the query parameters returned in the response body.
Table: POST JSON Response
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 if the process execution has started Successfully/Failed |
processID |
STRING |
Process ID of the Run Pipeline |
workflowStatus |
STRING |
Status of the process execution |
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 |