Get Flow Data Endpoint
This endpoint is called to get data for a specific workflow. To choose which workflow, you will need to get the flow_id, which is the string of characters after /workboard/ in the URL when entering a workflow:
Some of the variables you need for other endpoints can be found in the response of this endpoint.
Request:
GET https://api.idiana.com/api/v3/flow/{flow_id}Headers:
accept: "application/json, text/plain, */*"
authorization: bearer {bearer}Example
Request:
curl -X 'GET' \
'https://api.idiana.io/api/v3/flow/f7a6f081-cafb-5bf4-9f2d-12934fef0b75/' \
-H accept: "application/json, text/plain, */*"Response:
"id": "f7a6f081-cafb-5bf4-9f2d-12934fef0b75",
"flowOriginId": "afed3993-2ec3-4be9-aed2-68725b0799f1",
"displayName": "Tutorial Workflow",
"name": "tutorials/workflow/entity/generated-ccdcb0db-1464-4f19-a7ce-bf046133610f",
"group": null,
"entityType": "Entity",
"createdDate": "2024-02-20T06:22:25.6849843+00:00",
"createdBy": {
"id": "fdf38d0f-d6f2-5c3a-9efc-ff395f93ca1c",
"email": "tutorial@stephantesting.33mail.com",
"name": "Tutorial",
"displayName": "Tutorial",
"roles": [
"Owner",
"Everyone",
"FlowOwner",
"ReadOnly"
],
"link": "https://api-test.idiana.io/api/v1/identity/fdf38d0f-d6f2-5c3a-9efc-ff395f93ca1c?workItemId=f7a6f081-cafb-5bf4-9f2d-12934fef0b75",
"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
},
"lastModifiedTicks": 638440157050680838,
"lastModified": "2024-02-20T08:48:25.0680838+00:00",
"uniqueName": "tutorials/workflow/entity/generated-ccdcb0db-1464-4f19-a7ce-bf046133610f/v7",
"flowType": "tutorials/entity/workflow",
"environment": "Tutorials",
"resourceVersion": 7,
"resourceRevision": 0,
"branchName": "",
"imageUrl": "https://cdn.rise-x.com/diana/icons/FlowIcon.svg",
"description": "Draft default description",
"steps": [],
"globalActions": [],
"layoutProperties": [],
"flowProperties": [],
"dataMap": null,
"users": {
"Users": [
{
"id": "20000000-2000-2000-2000-200000000000",
"email": "system@rise-x.io",
"name": "System User",
"displayName": "System User",
"roles": [
"ReadOnly"
],
"link": "https://api-test.idiana.io/api/v2/identity/20000000-2000-2000-2000-200000000000?id=f7a6f081-cafb-5bf4-9f2d-12934fef0b75&dt=Flow",
"companyName": "Diana (System)",
"companyAddress": "1 Cloud Platform",
"companyNumber": null,
"companyId": "20000000-2000-2000-2000-200000000000",
"companyUri": "/api/v1/Company/20000000-2000-2000-2000-200000000000",
"expiry": "9999-12-31T23:59:59.9999999+00:00",
"isGuestUser": false,
"imageUrl": "https://cdn.rise-x.com/diana/icons/person.png",
"signature": null,
"emailHash": null,
"publicKey": null
},
{
"id": "fdf38d0f-d6f2-5c3a-9efc-ff395f93ca1c",
"email": "tutorial@stephantesting.33mail.com",
"name": "Tutorial",
"displayName": "Tutorial",
"roles": [
"Owner",
"Everyone",
"FlowOwner",
"ReadOnly"
],
"link": "https://api-test.idiana.io/api/v1/identity/fdf38d0f-d6f2-5c3a-9efc-ff395f93ca1c?workItemId=f7a6f081-cafb-5bf4-9f2d-12934fef0b75",
"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
}
]
},
"company": {
"displayName": "STEPHANTESTING 33MAIL",
"id": "a6a5b802-c26f-5293-8b4f-2fff58741443",
"dianaDataType": "Company",
"resourceType": "Company",
"link": "https://api-test.idiana.io/api/v1/company/a6a5b802-c26f-5293-8b4f-2fff58741443",
"view": "https://api-test.idiana.io/",
"relationship": "Company"
},
"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,
"activeLocks": [],
"subscriptionFeatures": null,
"isLicensed": true,
"canEdit": true,
"canClone": true,
"canDelete": true,
"hideWorkLevelViewers": false,
"addJsonDataString": true,
"exporters": [],
"lastModifiedBy": {
"id": "fdf38d0f-d6f2-5c3a-9efc-ff395f93ca1c",
"email": "tutorial@stephantesting.33mail.com",
"name": "Tutorial",
"displayName": "Tutorial",
"roles": [
"Owner",
"Everyone",
"FlowOwner",
"ReadOnly"
],
"link": "https://api-test.idiana.io/api/v1/identity/fdf38d0f-d6f2-5c3a-9efc-ff395f93ca1c?workItemId=f7a6f081-cafb-5bf4-9f2d-12934fef0b75",
"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
},
"flowFeatures": null,
"featureFlags": null,
"totalWorkItems": 0,
"customViews": [],
"supportedViewModes": [
{
"mode": 0,
"name": "Kanban"
},
{
"mode": 1,
"name": "DataGrid"
}
],
"defaultViewMode": null,
"icon": null,
"draftFlowId": "",
"relationshipName": null,
"publishedDate": "2024-02-20T08:50:51.4859323+00:00",
"exportConfigurations": [],
"defaultData": null,
"workflowSource": "NoCode",
"status": "Active",
"flowResourceType": "Work"
}