External APIs for Base Workflow
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"1345096","collectionId":"37f4377e-85bc-4175-a2ef-8fa2f26fb167","publishedId":"SWE84Hd1","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2020-02-08T02:31:18.000Z"},"item":[{"name":"Job","item":[{"name":"Post","item":[{"name":"Get posts of job","id":"00d3042c-d8a3-48e6-b043-e48f48523c8c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{workflow_access_token}}","type":"text"},{"key":"id","value":"2202","description":"required, id of job
\n","type":"text"},{"key":"last_id","value":"912","description":"optional, default is for loading the newest posts, another for loading comments older than post with 'last_id'\nAPI support get 10 posts in each API request
\n","type":"text"}]},"url":"https://workflow.{{domain}}/extapi/v1/job/post/load","urlObject":{"protocol":"https","path":["extapi","v1","job","post","load"],"host":["workflow","{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"00d3042c-d8a3-48e6-b043-e48f48523c8c"}],"id":"ff40fcaa-54e4-4466-bc96-c51ab53e6edb","_postman_id":"ff40fcaa-54e4-4466-bc96-c51ab53e6edb","description":""},{"name":"Comment","item":[{"name":"Get comments of job","id":"c5877ff3-edf6-4303-b5a9-3a70ac475ec9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{workflow_access_token}}","type":"text"},{"key":"hid","value":"MjQzLnBvc3Rzt","description":"required, hid of a post in job
\n","type":"text"},{"key":"method","value":"prev","description":"optional, default is 'page', supported values 'page', 'prev'
\n","type":"text"},{"key":"position","value":"912","description":"optional, default is 0, depends on method params\nif method is \"prev\", it will load comments that is older than comment with \"position\" id\nif method is \"page\", it will load comments in page with order \"position\", we have 10 comments each page\nAPI support get 10 comments in each API request
\n","type":"text"}]},"url":"https://workflow.{{domain}}/extapi/v1/job/comment/load","urlObject":{"protocol":"https","path":["extapi","v1","job","comment","load"],"host":["workflow","{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"c5877ff3-edf6-4303-b5a9-3a70ac475ec9"}],"id":"26e52fef-8505-48ad-8699-5982fc47de49","_postman_id":"26e52fef-8505-48ad-8699-5982fc47de49","description":""},{"name":"Get job","id":"bac2b028-4bc6-4513-a2c2-1c80525b1704","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","type":"text","value":"{{workflow_access_token}}"},{"description":"REQUIRED, id of the job
\n","key":"id","type":"text","value":""}]},"url":"https://workflow.{{domain}}/extapi/v1/job/get","description":"Get info job and it's workflow, todos, activities, files, stages in workflow
\n","urlObject":{"protocol":"https","path":["extapi","v1","job","get"],"host":["workflow","{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"bac2b028-4bc6-4513-a2c2-1c80525b1704"},{"name":"Get job with custom field table","id":"5b5981e4-1743-4398-b3d3-b7d085a5df15","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{workflow_access_token}}","type":"text"},{"key":"id","value":"22775","description":"REQUIRED, id of the job
\n","type":"text"}]},"url":"https://workflow.{{domain}}/extapi/v1/job/custom.table","description":"Get info job and it's workflow, stages in workflow and custom field table
\n","urlObject":{"protocol":"https","path":["extapi","v1","job","custom.table"],"host":["workflow","{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"5b5981e4-1743-4398-b3d3-b7d085a5df15"},{"name":"Create job","id":"a2d2d459-8efd-40b8-b87a-291b87aa4896","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{workflow_access_token}}","type":"text"},{"key":"creator_username","value":"bachkien","description":"username of creator (required)
\n","type":"text"},{"key":"username","value":"hungkien","description":"username of assignee (can be blank)
\n","type":"text"},{"key":"followers","value":"tragiang","type":"text"},{"key":"workflow_id","value":"1","type":"text"},{"key":"name","value":"Test create job from API ","type":"text"},{"key":"content","value":"Base Enterprise","type":"text"},{"key":"tags","value":"workplus,workflow,wework,request,base","type":"text"},{"key":"custom_so_hop_dong","value":"HD12345","description":"custom field, type text | custom_{input_key}
\n","type":"text"},{"key":"custom_gia_tri_hop_dong","value":"150000000","description":"custom field, type int | custom_{input_key}
\n","type":"text"},{"key":"custom_ngay_ky-date","value":"15/12/2019","description":"custom field, type datetime, date value, format dd/mm/YYYY | custom_{input_key}-date
\n","type":"text"},{"key":"custom_ngay_ky-time","value":"15:05","description":"custom field, type datetime, time value, format H:i | custom_{input_key}-time
\n","type":"text"}]},"url":"https://workflow.{{domain}}/extapi/v1/job/create","description":"Create new job, input creator, assignee, followers, workflow, name, content, tags, custom fields
\n","urlObject":{"protocol":"https","path":["extapi","v1","job","create"],"host":["workflow","{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"a2d2d459-8efd-40b8-b87a-291b87aa4896"},{"name":"Edit job","id":"f05e3692-19a2-4d1c-9937-43e3a318ce26","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{workflow_access_token}}","type":"text"},{"key":"id","value":"","description":"JOB ID, REQUIRED
\n","type":"text"},{"key":"name","value":"new name","description":"New job name, optional
\n","type":"text"},{"key":"content","value":"new content","description":"New job content, optional
\n","type":"text"},{"key":"tags","value":"workplus,workflow,wework,request,base","type":"text"},{"key":"custom_so_hop_dong","value":"HD10000","description":"custom field, type text | custom_{input_key}
\n","type":"text"},{"key":"custom_gia_tri_hop_dong","value":"350000000","description":"custom field, type int | custom_{input_key}
\n","type":"text"},{"key":"custom_ngay_ky-date","value":"25/12/2019","description":"custom field, type datetime, date value, format dd/mm/YYYY | custom_{input_key}-date
\n","type":"text"},{"key":"custom_ngay_ky-time","value":"15:05","description":"custom field, type datetime, time value, format H:i | custom_{input_key}-time
\n","type":"text"}]},"url":"https://workflow.{{domain}}/extapi/v1/job/edit","description":"Edit job, only support name, content, tags and custom fields
\n","urlObject":{"protocol":"https","path":["extapi","v1","job","edit"],"host":["workflow","{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"f05e3692-19a2-4d1c-9937-43e3a318ce26"},{"name":"Move next job","id":"7fb0ff0c-8431-45cb-bc37-d3473015b2eb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{workflow_access_token}}","type":"text"},{"key":"id","value":"7043","description":"required, id of job
\n","type":"text"},{"key":"mover_username","value":"caonguyen","description":"required, username of mover
\n","type":"text"},{"key":"note","value":"Đã chuyển khoản trước","description":"optional, describe what had been done
\n","type":"text"},{"key":"assignee","value":"linh","description":"required or not by stage setting
\n","type":"text"},{"key":"deadline-date","value":"11/11/2021","description":"required or not by stage setting, date value, format dd/mm/YYYY
\n","type":"text"},{"key":"deadline-time","value":"19:30","description":"required or not by stage setting, time value, format H:i
\n","type":"text"},{"key":"custom_gia_tri_don_hang","value":"120000","description":"required or not by stage setting
\n","type":"text"}]},"url":"https://workflow.{{domain}}/extapi/v1/job/next","urlObject":{"protocol":"https","path":["extapi","v1","job","next"],"host":["workflow","{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"7fb0ff0c-8431-45cb-bc37-d3473015b2eb"},{"name":"Move back job","id":"ac0c93b3-4bd4-4c20-8ee0-39855fea838a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{workflow_access_token}}","type":"text"},{"key":"id","value":"50654","description":"REQUIRED, ID of job
\n","type":"text"},{"key":"mover_username","value":"admin","description":"REQUIRED, username of mover
\n","type":"text"},{"key":"stage_id","value":"10309","description":"REQUIRED, ID of target stage
\n","type":"text"}]},"url":"https://workflow.{{domain}}/extapi/v1/job/back","urlObject":{"protocol":"https","path":["extapi","v1","job","back"],"host":["workflow","{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"ac0c93b3-4bd4-4c20-8ee0-39855fea838a"},{"name":"Mark failed job","id":"efe1ab1d-983f-4936-bae8-2abbdf204db5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{workflow_access_token}}","type":"text"},{"key":"id","value":"3340","description":"required, id of job
\n","type":"text"},{"key":"username","value":"admin","description":"required, username of user
\n","type":"text"},{"key":"failed_reason_id","value":"lhvfaeljfjcrqrhqdqyuvlakmamvlxyz","description":"required, id of failed reason
\n","type":"text"},{"key":"note","value":"mark failed job","description":"optional, describe more detail for failed reason
\n","type":"text"},{"key":"custom_input_key","value":"test","description":"required or not by stage setting
\n","type":"text"}]},"url":"https://workflow.{{domain}}/extapi/v1/job/fail","urlObject":{"protocol":"https","path":["extapi","v1","job","fail"],"host":["workflow","{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"efe1ab1d-983f-4936-bae8-2abbdf204db5"}],"id":"905fafb3-1a71-45de-b1c1-bb57932384b7","_postman_id":"905fafb3-1a71-45de-b1c1-bb57932384b7","description":""},{"name":"Jobs","item":[{"name":"Get all jobs","id":"c0a7d832-2a1c-4c3a-8a85-95b11f485539","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{workflow_access_token}}","type":"text"},{"key":"page_id","value":"","description":"Optional, page_id
\n","type":"text"},{"key":"workflow_id","value":"","description":"Optional, query on workflow_id
\n","type":"text"},{"key":"username","value":"@kien","description":"Optional, query on assigned user (username)
\n","type":"text"},{"key":"creator_username","value":"@admin","description":"Optional, query on creator user (username)
\n","type":"text"},{"key":"q","value":"","description":"Optional, query string by name
\n","type":"text"},{"key":"status","value":"done","description":"Optional. Support {active, done, failed, overdue}
\n","type":"text"},{"key":"limit","value":"","description":"Optional, number records per page, default 20, max 500
\n","type":"text"},{"key":"created_from","value":"","description":"Optional, date created job from
\n","type":"text"},{"key":"created_to","value":"","description":"Optional, date created job to
\n","type":"text"},{"key":"deadline_from","value":"","description":"Optional, date deadline job from
\n","type":"text"},{"key":"deadline_to","value":"","description":"Optional, date deadline job to
\n","type":"text"},{"key":"finish_from","value":"","description":"Optional, date finished job from (done, failed)
\n","type":"text"},{"key":"finish_to","value":"","description":"Optional, date finished job to (done, failed)
\n","type":"text"},{"key":"updated_from","value":"01/06/2021","description":"Optional, date last updated job from
\n","type":"text"},{"key":"updated_to","value":"01/07/2021","description":"Optional, date last updated job to
\n","type":"text"}]},"url":"https://workflow.{{domain}}/extapi/v1/jobs/get","description":"Get all jobs, paginated by id, support filter by workflow, assigned user and job name
\n","urlObject":{"protocol":"https","path":["extapi","v1","jobs","get"],"host":["workflow","{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"c0a7d832-2a1c-4c3a-8a85-95b11f485539"}],"id":"4da25d6a-8e6f-47d2-b461-4b1e85ce1129","_postman_id":"4da25d6a-8e6f-47d2-b461-4b1e85ce1129","description":""},{"name":"Workflow","item":[{"name":"Get workflow","id":"189de133-cb19-4335-9572-9975afc3bb00","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{workflow_access_token}}","type":"text"},{"key":"id","value":"","description":"WORKFLOW ID, REQUIRED
\n","type":"text"}]},"url":"https://workflow.{{domain}}/extapi/v1/workflow/get","description":"Get info workflow, stages and form
\n","urlObject":{"protocol":"https","path":["extapi","v1","workflow","get"],"host":["workflow","{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"189de133-cb19-4335-9572-9975afc3bb00"},{"name":"Get all jobs in a workflow","id":"a8c1a5b3-b7a3-41f4-b6fc-f7bdefd863ad","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{workflow_access_token}}","type":"text"},{"key":"page_id","value":"","description":"Optional, page_id
\n","type":"text"},{"key":"id","value":"649","description":"WORKFLOW ID, REQUIRED
\n","type":"text"},{"key":"stage_id","value":"","description":"Optional, stage_id in workflow
\n","type":"text"},{"key":"q","value":"","description":"Optional, query string
\n","type":"text"},{"key":"status","value":"done","description":"Optional. Support {active, done, failed, overdue}
\n","type":"text"},{"key":"limit","value":"","description":"Optional, number records per page, default 20, max 500
\n","type":"text"},{"key":"created_from","value":"","description":"Optional, date created job from
\n","type":"text"},{"key":"created_to","value":"","description":"Optional, date created job to
\n","type":"text"},{"key":"deadline_from","value":"","description":"Optional, date deadline job from
\n","type":"text"},{"key":"deadline_to","value":"","description":"Optional, date deadline job to
\n","type":"text"},{"key":"finish_from","value":"01/06/2021","description":"Optional, date finished job from (done, failed)
\n","type":"text"},{"key":"finish_to","value":"01/07/2021","description":"Optional, date finished job to (done, failed)
\n","type":"text"},{"key":"updated_from","value":"","description":"Optional, date last updated job from
\n","type":"text"},{"key":"updated_to","value":"","description":"Optional, date last updated job to
\n","type":"text"},{"key":"created_by","value":"@admin","description":"Optional, username of job creator
\n","type":"text"},{"key":"assignee","value":"@kien","description":"Optional, username of job assignee
\n","type":"text"}]},"url":"https://workflow.{{domain}}/extapi/v1/workflow/jobs","description":"Get all jobs in a workflow, paginated by id, support filter by stage and job name
\n","urlObject":{"protocol":"https","path":["extapi","v1","workflow","jobs"],"host":["workflow","{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"a8c1a5b3-b7a3-41f4-b6fc-f7bdefd863ad"},{"name":"Get all stages in a workflow","id":"f77f8733-1f49-40f5-8468-d813f04ffded","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{workflow_access_token}}","type":"text"},{"key":"id","value":"","description":"WORKFLOW ID, REQUIRED
\n","type":"text"}]},"url":"https://workflow.{{domain}}/extapi/v1/workflow/stages","description":"Get all stages in a workflow
\n","urlObject":{"protocol":"https","path":["extapi","v1","workflow","stages"],"host":["workflow","{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"f77f8733-1f49-40f5-8468-d813f04ffded"}],"id":"e1c893ed-4047-4183-bd3f-01e00078e4a8","_postman_id":"e1c893ed-4047-4183-bd3f-01e00078e4a8","description":""},{"name":"Workflows","item":[{"name":"Get all workflows","id":"6420b540-b4b1-44f2-b4c2-ae8f1b3fff27","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{workflow_access_token}}","type":"text"},{"key":"page_id","value":"0","description":"Optional, page_id
\n","type":"text"}]},"url":"https://workflow.{{domain}}/extapi/v1/workflows/get","description":"Get all workflows, paginated by id
\n","urlObject":{"protocol":"https","path":["extapi","v1","workflows","get"],"host":["workflow","{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"6420b540-b4b1-44f2-b4c2-ae8f1b3fff27"}],"id":"96ffb23c-cba4-4724-aeb5-3d986c21abc3","_postman_id":"96ffb23c-cba4-4724-aeb5-3d986c21abc3","description":""}],"event":[{"listen":"prerequest","script":{"id":"4df36601-9f67-440e-84fd-3dfb29c252ef","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"020cbefd-80e5-4b7a-a8c2-fb483defe5f8","type":"text/javascript","exec":[""]}}]}