This endpoint is called to create a new work item for a selected workflow. It creates a new work item from a specific task, meaning that there are several inputs required to execute this. The flowId, step_id and task_id are all needed to specify which workflow to create a work item in and at what task the work item is started.
Request:
POST https://api.idiana.io/api/v3/flow/{flowId}/startAt?stepName={step_name}Data:
{}Headers:
accept: "application/json, text/plain, */*"
authorization: bearer {bearer}
content-type: "application/json-patch+json"Example
Request:
curl -X 'POST' \
'https://api.idiana.io/api/v3/flow/f7a6f081-cafb-5bf4-9f2d-12934fef0b75/startAt?stepName=tutorials%2Fworkflow%2Fentity%2Fgenerated-ccdcb0db-1464-4f19-a7ce-bf046133610f%2Funtitledstep__generated-4188d0e4-1239-4165-8021-eda5ece4d3e0%2Funtitledtask__generated-29686957-699f-46f5-ba5a-fff61435b827' \
-H 'accept: "application/json, text/plain, */*"'
-H 'content-type: "application/json-patch+json"'Data:
{}Response:
{"id":"20a63132-d42c-4384-a3f0-2226c9b37833","displayName":"Tutorial Workflow","workCode":"STM-2024-020","lastModified":"2024-02-27T07:46:15.4980706+00:00","messages":null,"data":{},"schemaVersion":2,"steps":[{"displayName":"Tutorial Step 1","name":"tutorials/workflow/entity/generated-ccdcb0db-1464-4f19-a7ce-bf046133610f/untitledstep__generated-4188d0e4-1239-4165-8021-eda5ece4d3e0","id":"bc6927e0-66b8-5b9c-b487-e1ba2a5aa56e","flowId":"afed3993-2ec3-4be9-aed2-68725b0799f1","steps":[],"actions":[],"events":[],"isEndNode":false,"isActive":true,"isComplete":false,"isNotStarted":false,"status":"InProgress","hasSteps":false,"hasActions":false,"allowStartAt":true,"layout":null,"conditionalLayouts":null,"initiatorPartyName":null,"userPermissions":null,"printContext":null,"version":1,"panelConfig":null,"buttonConfig":null,"askBeforeExit":null,"hideActionUser":false,"hideEditPermissions":false,"hideEditData":false,"roles":null,"workGridProperty":null,"imageUrl":null}],"activeStepId":"bc6927e0-66b8-5b9c-b487-e1ba2a5aa56e","activeStepName":"tutorials/workflow/entity/generated-ccdcb0db-1464-4f19-a7ce-bf046133610f/untitledstep__generated-4188d0e4-1239-4165-8021-eda5ece4d3e0","attachments":[],"users":{"Everyone":[{"id":"fdf38d0f-d6f2-5c3a-9efc-ff395f93ca1c","email":"tutorial@stephantesting.33mail.com","name":"Tutorial","displayName":"Tutorial","roles":["Everyone","task-a3af0125-af79-5f96-bacd-bb31738da193","Owner","FlowOwner"],"link":"https://api-test.idiana.io/api/v1/identity/fdf38d0f-d6f2-5c3a-9efc-ff395f93ca1c?workItemId=20a63132-d42c-4384-a3f0-2226c9b37833","companyName":null,"companyAddress":null,"companyNumber":null,"companyId":"00000000-0000-0000-0000-000000000000","companyUri":"/api/v1/Company/00000000-0000-0000-0000-000000000000","expiry":"9999-12-31T23:59:59.9999999+00:00","isGuestUser":false,"imageUrl":null,"signature":null,"emailHash":"0x18EA25F8DCDFDDB196744BF1210C3AD84705FEA1B0C5F63AF24F4BD279824F4D","publicKey":"0x1A84F6D7bb3Bc1EFDDEbAa282849817b65C83bad"}],"task-a3af0125-af79-5f96-bacd-bb31738da193":[{"id":"fdf38d0f-d6f2-5c3a-9efc-ff395f93ca1c","email":"tutorial@stephantesting.33mail.com","name":"Tutorial","displayName":"Tutorial","roles":["Everyone","task-a3af0125-af79-5f96-bacd-bb31738da193","Owner","FlowOwner"],"link":"https://api-test.idiana.io/api/v1/identity/fdf38d0f-d6f2-5c3a-9efc-ff395f93ca1c?workItemId=20a63132-d42c-4384-a3f0-2226c9b37833","companyName":null,"companyAddress":null,"companyNumber":null,"companyId":"00000000-0000-0000-0000-000000000000","companyUri":"/api/v1/Company/00000000-0000-0000-0000-000000000000","expiry":"9999-12-31T23:59:59.9999999+00:00","isGuestUser":false,"imageUrl":null,"signature":null,"emailHash":"0x18EA25F8DCDFDDB196744BF1210C3AD84705FEA1B0C5F63AF24F4BD279824F4D","publicKey":"0x1A84F6D7bb3Bc1EFDDEbAa282849817b65C83bad"}],"Owner":[{"id":"fdf38d0f-d6f2-5c3a-9efc-ff395f93ca1c","email":"tutorial@stephantesting.33mail.com","name":"Tutorial","displayName":"Tutorial","roles":["Everyone","task-a3af0125-af79-5f96-bacd-bb31738da193","Owner","FlowOwner"],"link":"https://api-test.idiana.io/api/v1/identity/fdf38d0f-d6f2-5c3a-9efc-ff395f93ca1c?workItemId=20a63132-d42c-4384-a3f0-2226c9b37833","companyName":null,"companyAddress":null,"companyNumber":null,"companyId":"00000000-0000-0000-0000-000000000000","companyUri":"/api/v1/Company/00000000-0000-0000-0000-000000000000","expiry":"9999-12-31T23:59:59.9999999+00:00","isGuestUser":false,"imageUrl":null,"signature":null,"emailHash":"0x18EA25F8DCDFDDB196744BF1210C3AD84705FEA1B0C5F63AF24F4BD279824F4D","publicKey":"0x1A84F6D7bb3Bc1EFDDEbAa282849817b65C83bad"}],"FlowOwner":[{"id":"fdf38d0f-d6f2-5c3a-9efc-ff395f93ca1c","email":"tutorial@stephantesting.33mail.com","name":"Tutorial","displayName":"Tutorial","roles":["Everyone","task-a3af0125-af79-5f96-bacd-bb31738da193","Owner","FlowOwner"],"link":"https://api-test.idiana.io/api/v1/identity/fdf38d0f-d6f2-5c3a-9efc-ff395f93ca1c?workItemId=20a63132-d42c-4384-a3f0-2226c9b37833","companyName":null,"companyAddress":null,"companyNumber":null,"companyId":"00000000-0000-0000-0000-000000000000","companyUri":"/api/v1/Company/00000000-0000-0000-0000-000000000000","expiry":"9999-12-31T23:59:59.9999999+00:00","isGuestUser":false,"imageUrl":null,"signature":null,"emailHash":"0x18EA25F8DCDFDDB196744BF1210C3AD84705FEA1B0C5F63AF24F4BD279824F4D","publicKey":"0x1A84F6D7bb3Bc1EFDDEbAa282849817b65C83bad"}]},"company":null,"flowId":"f7a6f081-cafb-5bf4-9f2d-12934fef0b75","entityType":"Entity","workVersion":0,"workRevision":7,"cardLayout":{"id":"d2334ff9-02c5-4db6-8026-7e9df3310992","title":"","displayName":null,"selected":false,"cardConfig":{"card":"default","version":1,"title":"$.tutorialTask1.tutorialTask1.searchPeople[0].displayName","subTitle":["$.workCode"],"secondaryLabel":"asset search tutorial","secondaryValue":"$.tutorialTask1.tutorialTask1.assetSearchTutorial[0].displayName","statusText":"$.chains.currentState.events[1].displayName","statusClassName":"$.chains.currentState.events[1].color","statusChain":"$.chains.pop","items":[{"label":"text input tutorial","value":"$.tutorialTask1.tutorialTask1.textInputTutorial","color":"currentColor","icon":null,"dateFormat":null,"mode":null},{"label":"number input tutorial","value":"$.tutorialTask1.tutorialTask1.numberInputTutorial","color":"currentColor","icon":null,"dateFormat":null,"mode":null}],"itemMode":null,"icon":{"imageUrl":"$.data.icon.imageUrl","color":"$.data.icon.color","shape":"$.data.icon.icon"}}},"summaryCardLayout":null,"createdBy":{"id":"fdf38d0f-d6f2-5c3a-9efc-ff395f93ca1c","email":"tutorial@stephantesting.33mail.com","name":"Tutorial","displayName":"Tutorial","roles":[],"link":null,"companyName":null,"companyAddress":null,"companyNumber":null,"companyId":"00000000-0000-0000-0000-000000000000","companyUri":"/api/v1/Company/00000000-0000-0000-0000-000000000000","expiry":"9999-12-31T23:59:59.9999999+00:00","isGuestUser":false,"imageUrl":null,"signature":null,"emailHash":null,"publicKey":null},"createdDate":"2024-02-27T07:46:15.4980706+00:00","activeLocks":[],"chains":{"currentState":{"chainName":"currentState","events":[{"displayName":"Submitted","workType":null,"color":"muted","bgColor":null,"icon":null,"stateName":"Submitted","userAccount":"Tutorial","userId":"fdf38d0f-d6f2-5c3a-9efc-ff395f93ca1c","userName":null,"roleName":"*","dateTimeIso":"2024-02-27T07:46:15.526+00:00","eventIndex":0,"value":null},{"displayName":"Draft","workType":null,"color":"muted","bgColor":null,"icon":null,"stateName":"Draft","userAccount":"Tutorial","userId":"fdf38d0f-d6f2-5c3a-9efc-ff395f93ca1c","userName":null,"roleName":"*","dateTimeIso":"2024-02-27T07:46:15.498+00:00","eventIndex":1,"value":null}]}},"name":null,"firstStepData":null,"dataMap":{},"lastModifiedBy":"fdf38d0f-d6f2-5c3a-9efc-ff395f93ca1c","lastModifiedByUri":null,"lastModifiedTicks":638446167754980706,"imageUrl":null,"canEdit":true,"status":"InProgress","workState":0,"workStateName":"Ok","workStateColor":"muted","entityPath":"","productPath":"","flowType":"tutorials/entity/workflow","flowOriginId":"afed3993-2ec3-4be9-aed2-68725b0799f1","printerContext":[],"fields":[],"date":"2024-02-27T07:46:15.4980706+00:00","canDelete":true,"actions":[{"workId":"20a63132-d42c-4384-a3f0-2226c9b37833","flowId":"f7a6f081-cafb-5bf4-9f2d-12934fef0b75","flowOriginId":"afed3993-2ec3-4be9-aed2-68725b0799f1","stepDisplayName":"Submitted","stepName":"tutorials/workflow/entity/generated-ccdcb0db-1464-4f19-a7ce-bf046133610f/untitledstep__generated-4188d0e4-1239-4165-8021-eda5ece4d3e0/untitledtask__generated-29686957-699f-46f5-ba5a-fff61435b827/submituntitledstep__generated-4188d0e4-1239-4165-8021-eda5ece4d3e0","events":[{"id":"51f657be-8875-584d-a940-a7a4a28cf736","eventName":"untitledstep/generated-4188d0e4-1239-4165-8021-eda5ece4d3e0/submituntitledstep/generated-4188d0e4-1239-4165-8021-eda5ece4d3e0","name":"tutorials/workflow/entity/generated-ccdcb0db-1464-4f19-a7ce-bf046133610f/untitledstep/generated-4188d0e4-1239-4165-8021-eda5ece4d3e0/submituntitledstep/generated-4188d0e4-1239-4165-8021-eda5ece4d3e0/v1","displayName":"Submit","submitUri":"https://api-test.idiana.io/api/v3/flow/submit/20a63132-d42c-4384-a3f0-2226c9b37833?eventName=untitledstep/generated-4188d0e4-1239-4165-8021-eda5ece4d3e0/submituntitledstep/generated-4188d0e4-1239-4165-8021-eda5ece4d3e0","synchronousSubmitUri":null}],"workCode":"STM-2024-020","canExecute":true,"roles":null,"invitation":{"destinations":[{"actionId":"00000000-0000-0000-0000-000000000000","sourceStep":"Submit","targetStep":"Tutorial Task 2","description":"Submitted","message":null,"toDataPath":[{"partyName":"task-9131f21d-8337-5c5f-b1a5-5160a205b322","dataPath":"$.tutorialTask1.tutorialTask1.searchPeople"}],"ccDataPath":[],"to":[],"cc":[],"none":[],"isLocked":false,"sourceStepName":"tutorials/workflow/entity/generated-ccdcb0db-1464-4f19-a7ce-bf046133610f/untitledstep__generated-4188d0e4-1239-4165-8021-eda5ece4d3e0/untitledtask__generated-29686957-699f-46f5-ba5a-fff61435b827/submituntitledstep__generated-4188d0e4-1239-4165-8021-eda5ece4d3e0","targetStepName":"tutorials/workflow/entity/generated-ccdcb0db-1464-4f19-a7ce-bf046133610f/untitledstep__generated-4188d0e4-1239-4165-8021-eda5ece4d3e0/untitledtask__generated-a689c8f3-3c0f-40fa-8472-b7395d777261/submituntitledstep__generated-d7880708-63b6-4ba9-803a-50efdc9e53df","stepInvitation":{"partyName":"task-9131f21d-8337-5c5f-b1a5-5160a205b322","dataPath":"$.tutorialTask1.tutorialTask1.searchPeople","sourceStep":"Submit","targetStep":"Tutorial Task 2","description":"Submitted"},"hasInvites":false}],"stepInvitation":[{"partyName":"task-9131f21d-8337-5c5f-b1a5-5160a205b322","dataPath":"$.tutorialTask1.tutorialTask1.searchPeople","sourceStep":"Submit","targetStep":"Tutorial Task 2","description":"Submitted"}],"invites":[],"roles":["task-9131f21d-8337-5c5f-b1a5-5160a205b322"],"lookupAdditionalUsers":true},"stepId":"a3af0125-af79-5f96-bacd-bb31738da193","destinations":[{"actionId":"00000000-0000-0000-0000-000000000000","sourceStep":"Submit","targetStep":"Tutorial Task 2","description":"Submitted","message":null,"toDataPath":[{"partyName":"task-9131f21d-8337-5c5f-b1a5-5160a205b322","dataPath":"$.tutorialTask1.tutorialTask1.searchPeople"}],"ccDataPath":[],"to":[],"cc":[],"none":[],"isLocked":false,"sourceStepName":"tutorials/workflow/entity/generated-ccdcb0db-1464-4f19-a7ce-bf046133610f/untitledstep__generated-4188d0e4-1239-4165-8021-eda5ece4d3e0/untitledtask__generated-29686957-699f-46f5-ba5a-fff61435b827/submituntitledstep__generated-4188d0e4-1239-4165-8021-eda5ece4d3e0","targetStepName":"tutorials/workflow/entity/generated-ccdcb0db-1464-4f19-a7ce-bf046133610f/untitledstep__generated-4188d0e4-1239-4165-8021-eda5ece4d3e0/untitledtask__generated-a689c8f3-3c0f-40fa-8472-b7395d777261/submituntitledstep__generated-d7880708-63b6-4ba9-803a-50efdc9e53df","stepInvitation":{"partyName":"task-9131f21d-8337-5c5f-b1a5-5160a205b322","dataPath":"$.tutorialTask1.tutorialTask1.searchPeople","sourceStep":"Submit","targetStep":"Tutorial Task 2","description":"Submitted"},"hasInvites":false}],"systemActions":[{"activities":[],"name":"$GoBack","normalisedName":"$GOBACK","simpleName":"$GoBack","displayName":"$GoBack","actionTypeName":"DianaSubmitWorkAction","comments":null,"imageName":null,"layoutId":null,"tooltip":null,"actionType":0,"resourceVersion":0,"resourceRevision":0,"revision":0,"id":"f78d9a70-6360-554b-97d4-7e757f20c619","version":1,"execute":[],"write":[],"read":[],"eventName":"$GoBack","destination":{"destinationType":"Previous","target":"Previous"},"mode":2,"stepStartMode":0,"created":"0001-01-01T00:00:00+00:00","createdBy":"00000000-0000-0000-0000-000000000000","lastModified":"0001-01-01T00:00:00+00:00","lastModifiedBy":"00000000-0000-0000-0000-000000000000","color":null,"properties":null,"dianaDataType":15,"entityType":null,"data":null,"dataMap":null,"attachments":null,"acl":null,"companyId":"00000000-0000-0000-0000-000000000000","partitionKey":null,"flowId":"00000000-0000-0000-0000-000000000000","flowOriginId":"00000000-0000-0000-0000-000000000000","flowType":null,"ccRoles":null,"executeStatus":"Complete","relationships":null,"expression":null,"allowStartAt":false,"completedName":null,"sendDefaultEmail":false,"executeMode":0,"validateData":null,"tokenType":"GuestLogin","panelConfig":null,"skipValidation":null,"actionInvite":null}]}],"relationships":[],"currentState":"Draft","previousState":"","workGridProperties":[],"roleName":"task-a3af0125-af79-5f96-bacd-bb31738da193","rowId":"20a63132-d42c-4384-a3f0-2226c9b37833","expansionIndex":-1,"tasks":[],"canDelegate":true,"flowDisplayName":"Tutorial Workflow","closedEditorRoles":null,"integrationReceipts":{}}