Details

Get details of certain workflow owned by the organization

Request

POST https://api.cloudplan.biz/api/workflow/details

{
    "cp_id": "5F75C898FC65D8E33F9757F2D9F25CBF"
}

Reply

{
    "status": 200,
    "result": true,
    "params": {
        "cp_id": "5F75C898FC65D8E33F9757F2D9F25CBF"
    },
    "data": {
        "project_name": "zzzz - 2020-10-01 14:16:24",
        "project_description": "zzzzzzzzz",
        "project_deadline": 1602159396,
        "project_message_signer": "xxxxxxxx",
        "project_runtime": 604800,
        "project_remind_freq": 86400,
        "cp_id": "5F75C898FC65D8E33F9757F2D9F25CBF",
        "project_type": "contract",
        "created": 1601554584,
        "status": "running",
        "creator_cp_id": "5DF20CE3DD3DBE0EE1397A5977E781A8",
        "start_time": 1601554596,
        "starter_cp_id": "5DF20CE3DD3DBE0EE1397A5977E781A8",
        "starter_email": "user1@cloudplan.net",
        "signing_steps": [
            [
                {
                    "user_cp_id": "5DF20CE3DD3DBE0EE1397A5977E781A8",
                    "email": "user1@cloudplan.net",
                    "token": "5F749D2D54BF373DCB3316550100A378",
                    "name": "",
                    "rule": "must_sign"
                }
            ]
        ],
        "documents": [
            {
                "file_cp_id": "5F71CC6A71472280FF7004CF8130D72D",
                "file_name": "File-1",
                "folder_cp_id": "plain",
                "file_options": []
            }
        ],
        "target_folder_cp_id": "5F184A7EBD9281BF6B1C0C06E68EF34F",
        "document_fields": [
            {
                "x": 25.28,
                "y": 21.27,
                "width": 16.7,
                "height": 3.34,
                "page": "1",
                "file_cp_id": "5F71CC6A71472280FF7004CF8130D72D",
                "email": "user1@cloudplan.net",
                "display_type": "signature",
                "cp_id": "5F71CCEF9EF8A29F44362AA3D6679151",
                "step": 0,
                "dateformat": "Y-m-d",
                "required": true,
                "prefilled": true,
                "show_only": false,
                "title": "Unterschrift",
                "background_color": "transparent",
                "border_show": false,
                "title_show": true
            },
            {
                "x": 46.59,
                "y": 8.78,
                "width": 13.97,
                "height": 3.11,
                "page": "1",
                "file_cp_id": "5F71CC6A71472280FF7004CF8130D72D",
                "email": "user1@cloudplan.net",
                "display_type": "integer",
                "cp_id": "5F71CCEF3AD359380350E81770E3D721",
                "step": 0,
                "required": true,
                "prefilled": true,
                "show_only": false,
                "title": "Number",
                "text": "fgnnnnn",
                "fontsize": 2,
                "background_color": "transparent",
                "border_show": false,
                "title_show": true
            }
        ]
    }
}

Error Codes

workflow_not_found
workflow_not_owned
invalid_cp_id