Tasks

1 min

currently docuflow has an endpoint to create tasks on top of files and assign them to a user (among other things) { "tab" "examples", "url" "https //localhost 82/scrud/createtask", "name" "create tasks", "method" "post", "request" { "pathparameters" \[], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[ { "kind" "required", "name" "id(zid)", "type" "string", "description" "unique id of box file or folder " }, { "kind" "required", "name" "type(ztype)", "type" "string", "description" "name of metadata template in box " }, { "kind" "required", "name" "selectedcms", "type" "string", "description" "value should always be set to \\"box\\" to let docuflow know which configured content system to search " }, { "kind" "required", "name" "body(ztextbody)", "type" "array", "description" "json array of strings (each index being a seperate line) \n\nor can take a single string value \\"singlelineexample\\"" }, { "kind" "required", "name" "duedate(zduedate)", "type" "string", "description" "date the task is due\n\n2100 12 31 (yyyy mm dd)\n" }, { "kind" "required", "name" "recipients(zrecipients)", "type" "array", "description" "array of strings of recipients of the task (email id)\n\n user may require permissions to file before being able to be assigned a task " }, { "kind" "required", "name" "tasktype(ztasktype)", "type" "string", "children" \[], "description" "type of task assigned for a general task, task type is \\"complete\\" " } ], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "qnynaqpohj1uw zegafj6", "code" "", "language" "200" }, { "id" "frmyak2f3gpeahrtkdavt", "code" "", "language" "500" } ], "selectedlanguageid" "qnynaqpohj1uw zegafj6" }, "examples" { "languages" \[ { "id" "npeo0ussrolpgszc5fphh", "code" "{\r\n \\"cmsname\\" \\"insertproductionsystemname (located in docuflow gui)\\",\r\n \\"id\\" \\"insert box file id\\",\r\n\t\\"tasktype\\" \\"insert task type (described in params)\\",\r\n\t\\"recipients\\" \r\n \[\r\n \\"admin\@versafile com\\",\r\n \t \\"admin2\@versafile com\\"\r\n ],\r\n\t\\"body\\" \[\r\n \\"hi\\",\r\n \t \\"thank you \\"\r\n ],\r\n\t\\"duedate\\" \\"2021 12 30\\", \r\n \\"selectedcms\\" \\"box\\",\r\n\r\n\r\n}", "language" "json" }, { "id" "zhu ix53onpcu7rtssn1n", "code" "", "language" "none" } ], "selectedlanguageid" "npeo0ussrolpgszc5fphh" }, "description" "create a general task on a file", "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" } } { "tab" "examples", "url" "https //localhost 82/scrud/createtask", "name" "create tasks", "method" "post", "request" { "pathparameters" \[], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[ { "kind" "required", "name" "id(zid)", "type" "string", "description" "unique id of box file or folder " }, { "kind" "required", "name" "type(ztype)", "type" "string", "description" "name of metadata template in box " }, { "kind" "required", "name" "selectedcms", "type" "string", "description" "value should always be set to \\"box\\" to let docuflow know which configured content system to search " }, { "kind" "required", "name" "body(ztextbody)", "type" "array", "description" "json array of strings (each index being a seperate line) \n\nor can take a single string value \\"singlelineexample\\"" }, { "kind" "required", "name" "duedate(zduedate)", "type" "string", "description" "date the task is due\n\n2100 12 31 (yyyy mm dd)\n" }, { "kind" "required", "name" "recipients(zrecipients)", "type" "array", "description" "array of strings of recipients of the task (email id)\n\n user may require permissions to file before being able to be assigned a task " }, { "kind" "required", "name" "tasktype(ztasktype)", "type" "string", "children" \[], "description" "type of task assigned for a review task, task type is \\"review\\"" } ], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "qnynaqpohj1uw zegafj6", "code" "", "language" "200" }, { "id" "frmyak2f3gpeahrtkdavt", "code" "", "language" "500" } ], "selectedlanguageid" "qnynaqpohj1uw zegafj6" }, "examples" { "languages" \[ { "id" "npeo0ussrolpgszc5fphh", "code" "{\r\n \\"cmsname\\" \\"insertproductionsystemname (located in docuflow gui)\\",\r\n \\"id\\" \\"insert box file id\\",\r\n\t\\"tasktype\\" \\"insert task type (described in params)\\",\r\n\t\\"recipients\\" \r\n \[\r\n \\"admin\@versafile com\\",\r\n \t \\"admin2\@versafile com\\"\r\n ],\r\n\t\\"body\\" \[\r\n \\"hi\\",\r\n \t \\"thank you \\"\r\n ],\r\n\t\\"duedate\\" \\"2021 12 30\\", \r\n \\"selectedcms\\" \\"box\\",\r\n\r\n\r\n}", "language" "json" }, { "id" "zhu ix53onpcu7rtssn1n", "code" "", "language" "none" } ], "selectedlanguageid" "npeo0ussrolpgszc5fphh" }, "description" "create a review task on a file", "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" } }