Submit Endpoint
This endpoint is called to submit a task on a specific work item or asset. Submitting a task in a workflow opens up the next task, while submitting an asset edit saves this information until it is edited again. Submitting a newly created asset finalises the creation of that asset.
Using the Get flow data endpoint gives you access to all the variables you need to fill in the variables required. Click here to learn how to use the Get flow data endpoint.
Request:
POST https://api.idiana.io/api/v3/flow/submit/{work_id}?eventName={event_name}Data:
{
"stepName": {step_name},
"invitation": {
"destinations": [
{
"actionId": "00000000-0000-0000-0000-000000000000",
"sourceStep": "Submit",
"targetStep": "{target_step}",
"description": "Submitted",
"message": null,
"toDataPath": [
{
"partyName": "task-9131f21d-8337-5c5f-b1a5-5160a205b322",
"dataPath": "$.tutorialTask1.tutorialTask1.searchPeople"
}
],
"ccDataPath": [],
"to": [
{
"id": "{user_id}",
"email": "{user_email}",
"name": "{user_name}",
"displayName": "{user_display_name}",
"roles": ["{roles}"],
"link": null,
"companyName": "{company_name}",
"companyAddress": "",
"companyNumber": "",
"companyId": "{company_id}",
"companyUri": "{company_uri}",
"expiry": "9999-12-31T23:59:59.9999999+00:00",
"isGuestUser": false,
"imageUrl": null,
"signature": null,
"emailHash": null,
"publicKey": null,
"partyName": "Everyone",
"targetStepName": "Unknown",
"remove": false
}
],
"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": "{data_path}",
"sourceStep": "Submit",
"targetStep": "{target_step}",
"description": "Submitted"
},
"hasInvites": false
}
]
}
}Headers:
accept: "application/json, text/plain, */*"
content-type: "application/json"
authorization: bearer {bearer}Example
Request:
curl -X 'POST' \
'https://api.idiana.io/api/v3/flow/submit/482d192f-0049-4975-9a51-b83a5d78d400?eventName=untitledstep/generated-4188d0e4-1239-4165-8021-eda5ece4d3e0/submituntitledstep/generated-4188d0e4-1239-4165-8021-eda5ece4d3e0' \
-H 'accept: "*/*"
-H 'content-type: "application/json"Data:
{
"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",
"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": [
{
"id": "fdf38d0f-d6f2-5c3a-9efc-ff395f93ca1c",
"email": "tutorial@stephantesting.33mail.com",
"name": "Tutorial",
"displayName": "Tutorial",
"roles": [],
"link": null,
"companyName": "STEPHANTESTING 33MAIL",
"companyAddress": "",
"companyNumber": "",
"companyId": "a6a5b802-c26f-5293-8b4f-2fff58741443",
"companyUri": "/api/v1/Company/a6a5b802-c26f-5293-8b4f-2fff58741443",
"expiry": "9999-12-31T23:59:59.9999999+00:00",
"isGuestUser": false,
"imageUrl": null,
"signature": null,
"emailHash": null,
"publicKey": null,
"partyName": "Everyone",
"targetStepName": "Unknown",
"remove": false
}
],
"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
}
]
}
}Response:
{"id":"482d192f-0049-4975-9a51-b83a5d78d400","displayName":"Tutorial Workflow","workCode":"STM-2024-017","lastModified":"2024-02-27T07:01:30.3088364+00:00","messages":null,"data":{"tutorialTask1":{"tutorialTask1":{"searchPeople":[{"id":"fdf38d0f-d6f2-5c3a-9efc-ff395f93ca1c","email":"tutorial@stephantesting.33mail.com","name":"Tutorial","displayName":"Tutorial","roles":[],"link":null,"companyName":"STEPHANTESTING 33MAIL","companyAddress":"","companyNumber":"","companyId":"a6a5b802-c26f-5293-8b4f-2fff58741443","companyUri":"/api/v1/Company/a6a5b802-c26f-5293-8b4f-2fff58741443","expiry":"9999-12-31T23:59:59.9999999+00:00","isGuestUser":false,"imageUrl":null,"signature":null,"emailHash":null,"publicKey":null,"partyName":"Everyone","targetStepName":"Unknown","remove":false,"isReadOnly":false}],"numberInputTutorial":4,"textInputTutorial":"saewdes"}},"tutorialTask2":{"tutorialTask2":{"textInput":"124"}}},"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":false,"isComplete":true,"isNotStarted":false,"status":"Complete","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":"00000000-0000-0000-0000-000000000000","activeStepName":null,"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","task-9131f21d-8337-5c5f-b1a5-5160a205b322","Owner","FlowOwner"],"link":"https://api-test.idiana.io/api/v1/identity/fdf38d0f-d6f2-5c3a-9efc-ff395f93ca1c?workItemId=482d192f-0049-4975-9a51-b83a5d78d400","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":"0xBD0E8DB9EA90E77DC357722139CDD35BE2D04021ACF4105F3EF09FFC0BEFF16E","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","task-9131f21d-8337-5c5f-b1a5-5160a205b322","Owner","FlowOwner"],"link":"https://api-test.idiana.io/api/v1/identity/fdf38d0f-d6f2-5c3a-9efc-ff395f93ca1c?workItemId=482d192f-0049-4975-9a51-b83a5d78d400","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":"0xBD0E8DB9EA90E77DC357722139CDD35BE2D04021ACF4105F3EF09FFC0BEFF16E","publicKey":"0x1A84F6D7bb3Bc1EFDDEbAa282849817b65C83bad"}],"task-9131f21d-8337-5c5f-b1a5-5160a205b322":[{"id":"fdf38d0f-d6f2-5c3a-9efc-ff395f93ca1c","email":"tutorial@stephantesting.33mail.com","name":"Tutorial","displayName":"Tutorial","roles":["Everyone","task-a3af0125-af79-5f96-bacd-bb31738da193","task-9131f21d-8337-5c5f-b1a5-5160a205b322","Owner","FlowOwner"],"link":"https://api-test.idiana.io/api/v1/identity/fdf38d0f-d6f2-5c3a-9efc-ff395f93ca1c?workItemId=482d192f-0049-4975-9a51-b83a5d78d400","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":"0xBD0E8DB9EA90E77DC357722139CDD35BE2D04021ACF4105F3EF09FFC0BEFF16E","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","task-9131f21d-8337-5c5f-b1a5-5160a205b322","Owner","FlowOwner"],"link":"https://api-test.idiana.io/api/v1/identity/fdf38d0f-d6f2-5c3a-9efc-ff395f93ca1c?workItemId=482d192f-0049-4975-9a51-b83a5d78d400","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":"0xBD0E8DB9EA90E77DC357722139CDD35BE2D04021ACF4105F3EF09FFC0BEFF16E","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","task-9131f21d-8337-5c5f-b1a5-5160a205b322","Owner","FlowOwner"],"link":"https://api-test.idiana.io/api/v1/identity/fdf38d0f-d6f2-5c3a-9efc-ff395f93ca1c?workItemId=482d192f-0049-4975-9a51-b83a5d78d400","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":"0xBD0E8DB9EA90E77DC357722139CDD35BE2D04021ACF4105F3EF09FFC0BEFF16E","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-27T02:46:54.1137776+00:00","activeLocks":[],"chains":{"currentState":{"chainName":"currentState","events":[{"displayName":"Submit","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:22:47.483+00:00","eventIndex":0,"value":null},{"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-27T02:46:54.113+00:00","eventIndex":1,"value":null}]}},"name":null,"firstStepData":null,"dataMap":{},"lastModifiedBy":"fdf38d0f-d6f2-5c3a-9efc-ff395f93ca1c","lastModifiedByUri":null,"lastModifiedTicks":638446140903088364,"imageUrl":null,"canEdit":true,"status":"Complete","workState":0,"workStateName":"Ok","workStateColor":"muted","entityPath":"","productPath":"","flowType":"tutorials/entity/workflow","flowOriginId":"afed3993-2ec3-4be9-aed2-68725b0799f1","printerContext":[],"fields":[],"date":"2024-02-27T07:01:30.3088364+00:00","canDelete":true,"actions":[{"workId":"482d192f-0049-4975-9a51-b83a5d78d400","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-a689c8f3-3c0f-40fa-8472-b7395d777261/submituntitledstep__generated-d7880708-63b6-4ba9-803a-50efdc9e53df","events":[{"id":"ec3b8bae-8953-518e-9226-a7b67573f57c","eventName":"untitledstep/generated-d7880708-63b6-4ba9-803a-50efdc9e53df/submituntitledstep/generated-d7880708-63b6-4ba9-803a-50efdc9e53df","name":"tutorials/workflow/entity/generated-ccdcb0db-1464-4f19-a7ce-bf046133610f/untitledstep/generated-d7880708-63b6-4ba9-803a-50efdc9e53df/submituntitledstep/generated-d7880708-63b6-4ba9-803a-50efdc9e53df/v1","displayName":"Submit","submitUri":"https://api-test.idiana.io/api/v3/flow/submit/482d192f-0049-4975-9a51-b83a5d78d400?eventName=untitledstep/generated-d7880708-63b6-4ba9-803a-50efdc9e53df/submituntitledstep/generated-d7880708-63b6-4ba9-803a-50efdc9e53df","synchronousSubmitUri":null}],"workCode":"STM-2024-017","canExecute":true,"roles":null,"invitation":{"destinations":[{"actionId":"00000000-0000-0000-0000-000000000000","sourceStep":"Submit","targetStep":"End","description":"Close flow.","message":null,"toDataPath":[{"partyName":"task-9131f21d-8337-5c5f-b1a5-5160a205b322","dataPath":"$.invites.task-9131f21d-8337-5c5f-b1a5-5160a205b322"}],"ccDataPath":[],"to":[{"id":"fdf38d0f-d6f2-5c3a-9efc-ff395f93ca1c","name":"Tutorial","email":"tutorial@stephantesting.33mail.com","targetStepName":null,"partyName":"task-9131f21d-8337-5c5f-b1a5-5160a205b322","remove":false,"inviteType":1,"changed":true,"publicKey":null,"tokenPayload":null,"guestToken":null,"account":null}],"cc":[],"none":[],"isLocked":false,"sourceStepName":"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","targetStepName":"End","stepInvitation":{"partyName":"task-9131f21d-8337-5c5f-b1a5-5160a205b322","dataPath":"$.invites.task-9131f21d-8337-5c5f-b1a5-5160a205b322","sourceStep":"Submit","targetStep":"End","description":"Close flow."},"hasInvites":true}],"stepInvitation":[{"partyName":"task-9131f21d-8337-5c5f-b1a5-5160a205b322","dataPath":"$.invites.task-9131f21d-8337-5c5f-b1a5-5160a205b322","sourceStep":"Submit","targetStep":"End","description":"Close flow."}],"invites":[{"id":"fdf38d0f-d6f2-5c3a-9efc-ff395f93ca1c","name":"Tutorial","email":"tutorial@stephantesting.33mail.com","targetStepName":null,"partyName":"task-9131f21d-8337-5c5f-b1a5-5160a205b322","remove":false,"inviteType":1,"changed":true,"publicKey":null,"tokenPayload":null,"guestToken":null,"account":null}],"roles":["task-9131f21d-8337-5c5f-b1a5-5160a205b322"],"lookupAdditionalUsers":true},"stepId":"9131f21d-8337-5c5f-b1a5-5160a205b322","destinations":[{"actionId":"00000000-0000-0000-0000-000000000000","sourceStep":"Submit","targetStep":"End","description":"Close flow.","message":null,"toDataPath":[{"partyName":"task-9131f21d-8337-5c5f-b1a5-5160a205b322","dataPath":"$.invites.task-9131f21d-8337-5c5f-b1a5-5160a205b322"}],"ccDataPath":[],"to":[{"id":"fdf38d0f-d6f2-5c3a-9efc-ff395f93ca1c","name":"Tutorial","email":"tutorial@stephantesting.33mail.com","targetStepName":null,"partyName":"task-9131f21d-8337-5c5f-b1a5-5160a205b322","remove":false,"inviteType":1,"changed":true,"publicKey":null,"tokenPayload":null,"guestToken":null,"account":null}],"cc":[],"none":[],"isLocked":false,"sourceStepName":"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","targetStepName":"End","stepInvitation":{"partyName":"task-9131f21d-8337-5c5f-b1a5-5160a205b322","dataPath":"$.invites.task-9131f21d-8337-5c5f-b1a5-5160a205b322","sourceStep":"Submit","targetStep":"End","description":"Close flow."},"hasInvites":true}],"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":"d31d9c09-bd38-55e9-85a7-88327fe5fc24","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":"Submitted","previousState":"","workGridProperties":[],"roleName":"task-9131f21d-8337-5c5f-b1a5-5160a205b322","rowId":"482d192f-0049-4975-9a51-b83a5d78d400","expansionIndex":-1,"tasks":[],"canDelegate":true,"flowDisplayName":"Tutorial Workflow","closedEditorRoles":null,"integrationReceipts":{}}