/createApprovalWorkflow

1 min

POST

Calling this request can be used for adding a new approval workflow to the MPC user management.

Request Example:

.. code-block::

createApprovalWorkflow( id="2376234", name="approval workflow name", type=0, approver_groups=[ { "UserIds"=["[email protected]", "[email protected]"], "UserGroupIds"=["123", "456"], "NumberOfTotalApproversNeededFromThisApproverGroup"=2 } ], request_extra_data={ "MessageNumber": 5, "SessionId": "3478593863424051983840947" } )

Response Example:

.. code-block::

{
    "FunctionData": {
        "StatusCode": 0,
        "StatusCodeDescription": "Approval workflow created successfully"
    },
    "Meta": {
        "AccessToken": "2911...9a7",
        "Destination": "04bc...9e2",
        "Source": "3dcf...ba4",
        "Time": "2025-05-22 17:00:44.605"
    }
}

Error Responses

Error Type	Http Code	GK8 error code	Reason / Description	Example Response
Backend Response	400	1	Approval workflow already exists	"StatusCode": 1
Backend Response	400	2	Approval workflow name already exists	"StatusCode": 2
Backend Response	400	3	Invalid name	"StatusCode": 3
Backend Response	400	4	Unknown approval workflow type	"StatusCode": 4
Backend Response	400	5	Invalid number of total approvers needed from this approval group	"StatusCode": 5
Backend Response	400	6	Empty approval group list	"StatusCode": 6
Backend Response	400	7	Not enough users in approval group	"StatusCode": 7, "ApprovalWorkflowIndex": 0
Backend Response	400	8	Duplicate user	"StatusCode": 8, "UserId": "[email protected]"
Backend Response	400	9	Unknown user in approval group	"StatusCode": 9, "UserIds": ["[email protected]","[email protected]"]
Backend Response	400	10	Duplicate user group	"StatusCode": 10, "UserGroupId": "123"
Backend Response	400	11	Unknown user group in approval group	"StatusCode": 11, "UserGroupIds": ["123","456"]
Backend Response	400	12	No approval permission for user in transaction approval workflow (UserIds deprecated in V19)	"StatusCode": 12, "UsersWithoutApprovalPermission": [{ "UserId": "[email protected]", "UserName": "Example User", "UserRole": "RoleName" }]
Backend Response	400	13	No approval permission for user in administrative approval workflow (UserIds deprecated in V19)	"StatusCode": 13, "UsersWithoutApprovalPermission": [{ "UserId": "[email protected]", "UserName": "Example User" }]
Backend Response	400	14	Approval workflow is unsatisfiable	"StatusCode": 14, "UserIds": ["[email protected]","[email protected]"]

idstringa unique id for the new approval workflow

namestringa unique name of the updated approval workflow or the previous one

typeobject<p>an ApprovalWorkflowType (see MpcDriven/ApprovalWorkflow.py)</p>

request_extra_dataobjectadditional data for the administrative request

approver_groupsarray<p>a list of ApproverGroup - defines the updated approver groups for the approval workflow - (see MpcDriven/ApprovalWorkflow.py)</p>

acceptstringGenerated from available response content types

bodyobject

200success

curl --request POST \
     --url '/createApprovalWorkflow?id=123&name=MyApprovalWorkflow&type={%22ApprovalWorkflowType%22%3A%22None%22}&request_extra_data={%0A%20%20%22MessageNumber%22%3A%205%2C%0A%20%20%22SessionId%22%3A%20%223478593863424051983840947%22%0A}%0A&approver_groups=array' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "FunctionData": {
     "Id": "2376234",
     "Name": "approval workflow name",
     "ApproverGroups": [
     {
     "NumberOfTotalApproversNeededFromThisApproverGroup": 2
     }
     ],
     "RequestExtraData": {
     "MessageNumber": 5,
     "SessionId": "3478593863424051983840947"
     }
     },
     "Meta": {
     "FunctionName": "createApprovalWorkflow",
     "RandomData": "288cd49d4b8bf00e7d6114b78d5668d5581d6b953fafef779133caa844cd4229",
     "Destination": "b9cb8afe52f1d52521cf2b62dfe12146156ad5328f83c62c20c7da81b263356a61340de745c858998544c041798b01c2f4fac31bebe52a19280a32cd57d6d374ea",
     "Time": "2021-02-07T18:37:46.948Z",
     "Source": "048b99461a70a49abe63fd585cb224177a22a92d2e9e4ddfbc0027887bee9d1843388f42a3eb2e740565e115ad8b7981abf59e3b03b771f4b063b53c517d7a9d99",
     "AccessToken": "51311c84d2c8fd2fafbe56ceb1fb30a99d3417abfc55769577338ab286798087"
     }
     }'