API

API mub | Workflow - Get documents workflow BP

This article is itended to document the API mub | Documents BP. Route: GET => http://api.mub.cloud/api/v2/workflow/ {workflow_generals_id}/bp/documents API Field Field Type Description, example. workflow_generals_id N…

Moises ScarpinPublicado 08 de fev. de 20241 min de leitura

This article is itended to document the API mub | Documents BP.

 Route: GET => http://api.mub.cloud/api/v2/workflow/{workflow_generals_id}/bp/documents

API Field Field Type Description, example.
workflow_generals_id Number  Example: 334.
 

See below full object of request and expected response.

Request example:

http://api.mub.cloud/api/v2/workflow/334/bp/documents

Response example:

{
    "success": true,
    "message": "Workflow BP Documents successfully listed!",
    "data": [
        {
            "id": null,
            "category": "DOCUMENTATION",
            "valid_from": "11/11/2021",
            "valid_to": "31/12/2999",
            "issuer": "SSP",
            "identification": "234234234",
            "created_at": null,
            "updated_at": null,
            "consulted_at": "11/11/2021",
            "bp_generals_id": null,
            "bp_aux_document_types_id": 1,
            "bp_aux_document_status_id": null,
            "url_upload_file": [
                {
                    "url": "tmp/618d1e66f1aee.xlsm",
                    "description": "BDR_Big_Data_Rules_CBMM_clientes_reXXXXX.xlsm",
                    "file_name": "BDR_Big_Data_Rules_CBMM_clientes_reXXXXX.xlsm",
                    "file_size": "729.61 kB",
                    "file_type": false,
                    "file_extension": "xlsm",
                    "file_mime_type": "application/vnd.ms-excel.sheet.macroEnabled.12"
                }
            ]
        },
        {
            "id": null,
            "category": "REGISTRATIONS_LICENSES",
            "valid_from": "11/11/2021",
            "valid_to": "31/12/2999",
            "issuer": null,
            "identification": "24234234",
            "created_at": null,
            "updated_at": null,
            "consulted_at": "11/11/2021",
            "bp_generals_id": null,
            "bp_aux_document_types_id": 14,
            "bp_aux_document_status_id": null,
            "url_upload_file": [
                {
                    "url": "tmp/618d1e8a39ceb.docx",
                    "description": "Salesforce (3).docx",
                    "file_name": "Salesforce (3).docx",
                    "file_size": "317.27 kB",
                    "file_type": "docx",
                    "file_extension": "docx",
                    "file_mime_type": "application/vnd.openxmlformats-officedocument.wordprocessingml.document"
                }
            ]
        }
    ]
}