API mub | Workflow - Workflow step action BP

This article is itended to document the API mub | step execution BP Route: PATCH => http://api.mub.cloud/api/v2/workflow/steps/ {workflos_steps_id} ***** APPROVE AND MAINTAIN:***** API Field Field Type Description, ex…

Moises ScarpinPublicado 08 de fev. de 20241 min de leitura

This article is itended to document the API mub | step execution BP

Route: PATCH => http://api.mub.cloud/api/v2/workflow/steps/{workflos_steps_id}

*****APPROVE AND MAINTAIN:*****

API Field	Field Type	Description, example.
workflos_steps_id	Number	Example: 478.
status	String	Example: "APPROVE_AND_MAINTAIN".

See below full object of request and expected response.

Request example:

http://api.mub.cloud/api/v2/workflow/steps/478

{
    "status": "APPROVE_AND_MAINTAIN"
}

Response example:

{
    "success": true,
    "message": "Workflow successfully updated!",
    "data": {
        "id": 478,
        "status": "FINISHED"
    }
}

***** SEND BACK WITH RESTART: *****

API Field	Field Type	Description, example.
workflos_steps_id	Number	Example: 480.
send_to_correction_id	Number	Example: 478.
status	String	Example: "SENDBACKRESTART".
comment	String	Example: "A comment".
comment_available_to_external	Boolean	Values: true\|false Example: true

See below full object of request and expected response.

Request example:

http://api.mub.cloud/api/v2/workflow/steps/480

{
    "send_to_correction_id": 478,
    "status": "SENDBACKRESTART",
    "comment": "A comment",
    "comment_available_to_external": true
}

Response example:

{
    "success": true,
    "message": "Workflow successfully updated!",
    "data": {
        "id": 480,
        "status": "SENDBACKRESTART"
    }
}

*****REJECT:*****

API Field	Field Type	Description, example.
workflos_steps_id	Number	Example: 478.
status	String	Example: "REJECT".
comment	String	"A comment about rejection"
comment_available_to_external	Boolean	Values: true\|false Example: true

See below full object of request and expected response.

Request example:

http://api.mub.cloud/api/v2/workflow/steps/478

{
    "status": "REJECT",
    "comment": "A comment about rejection",
    "comment_available_to_external": true
}
Response example:

{
    "status": "REJECT",
    "comment": "A comment about rejection",
    "comment_available_to_external": true
}