Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

GET https://<base-url>/WorkflowTemplates
Expand
titlePOST https://<base-url>/RegApplication

Body JSON structure:

AddRegApplicationApiDto

Body example 1:

Code Block
languagejson
{
    "applicationId": "97cbc3b3-32c7-4e4a-b788-a332ea82aeff",
    "tagText": "Quinyx 2022-04-28",
    "credentialsJson": "{\"apikey\":\"01d6-3e54-cff2-c7d8\",\"environment\": \"test\"}"
}

Headers:

ManagedAccountId:a4ba9a9b-ce81-4f06-81c6-032bf7d648f5

Authorization:Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIyMDAxZDFlZS1jOWUxLTRhMDctOTZkNi1hNTMyNGEzMjczY2UiLCJpc3MiOiJodHRwOi8vY2FudmFzdGVzdC5jb25uZWN0bXlhcHBzLmNvbSIsImlhdCI6MTY1MTA2ODk2OSwiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvZW1haWxhZGRyZXNzIjoibmF0YWxpYS55dWRuaWtvdmFAb3V0bG9vay5jb20iLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3VzZXJkYXRhIjoiNmZhMTIyZTQtMGQ0Yy00YTFkLTg4NjktN2MwYTg2YTM3YmYxIiwiaHR0cDovL3NjaGVtYXMubWljcm9zb2Z0LmNvbS93cy8yMDA4LzA2L2lkZW50aXR5L2NsYWltcy9yb2xlIjoiQWRtaW4iLCJMb2dnZWRTdXBwb3J0ZWRCeUNtYSI6IlRydWUiLCJNYW5hZ2VkU3VwcG9ydGVkQnlDbWEiOiJUcnVlIiwiZXhwIjoxNjUxMDY5NTY5LCJhdWQiOiJjbWEtdXNlcnMifQ.v2Tbnw4bKuQSMAjtj36eVjrcMoE1vH93C6axpN9Y4wE

Info

ManagedAccountId - is an optional header. You need to use it if you want to manage some account and get data to which account has access

Expand
titleResponse (status 200)
Expand
title

Body example 2:

Code Block
languagejson
"eea37d64-5a93-478c-8216-6231c0a37f0a"

WorkflowTemplates

Returns list of workflow templates provided by CMA and your organization

{
    "applicationId": "5f814909-01ea-4395-96ee-5ba7614128fc",
    "tagText": "FTP 2022-05-03",
    "credentialsJson": "{\"username\": null,\"password\": null,\"port\": null,\"address\": null,\"secure\": true}"
}

Headers:

ManagedAccountId:a4ba9a9b-ce81-4f06-81c6-032bf7d648f5

Authorization:Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIyMDAxZDFlZS1jOWUxLTRhMDctOTZkNi1hNTMyNGEzMjczY2UiLCJpc3MiOiJodHRwOi8vY2FudmFzdGVzdC5jb25uZWN0bXlhcHBzLmNvbSIsImlhdCI6MTY1MTA2ODk2OSwiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvZW1haWxhZGRyZXNzIjoibmF0YWxpYS55dWRuaWtvdmFAb3V0bG9vay5jb20iLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3VzZXJkYXRhIjoiNmZhMTIyZTQtMGQ0Yy00YTFkLTg4NjktN2MwYTg2YTM3YmYxIiwiaHR0cDovL3NjaGVtYXMubWljcm9zb2Z0LmNvbS93cy8yMDA4LzA2L2lkZW50aXR5L2NsYWltcy9yb2xlIjoiQWRtaW4iLCJMb2dnZWRTdXBwb3J0ZWRCeUNtYSI6IlRydWUiLCJNYW5hZ2VkU3VwcG9ydGVkQnlDbWEiOiJUcnVlIiwiZXhwIjoxNjUxMDY5NTY5LCJhdWQiOiJjbWEtdXNlcnMifQ.v2Tbnw4bKuQSMAjtj36eVjrcMoE1vH93C6axpN9Y4wE

Info

ManagedAccountId - is an optional header. You need to use it if you want to manage some account and get data to which account has access

Expand
titleResponse (status 200)
Code Block
languagejson
[
    {
        "id": "bbe52876-aca2-4ece-ba31-11e0d98ddc19",
        "name": "Quinyx Employee Export Into FTP(CSV)",
        "description": "Quinyx Employee Export Into FTP(CSV)",
        "dateCreated": "2020-08-14T17:12:29.7856246",
        "dateModified": "2022-03-17T13:54:07.0394189","eea37d64-5a93-478c-8216-6231c0a37f0a"
Expand
titleResponse (status 401)

Status Code: 401; Unauthorized

Expand
titleResponse (status 400)
Code Block
Authentication Error: You must enter a value for User name.
You must enter a value for Password.
You must enter a value for Port.
You must enter a value for Server address.

WorkflowTemplates

Returns list of workflow templates provided by CMA and your organization

Expand
titleGET https://<base-url>/WorkflowTemplates

Headers:

ManagedAccountId:a4ba9a9b-ce81-4f06-81c6-032bf7d648f5

Authorization:Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIyMDAxZDFlZS1jOWUxLTRhMDctOTZkNi1hNTMyNGEzMjczY2UiLCJpc3MiOiJodHRwOi8vY2FudmFzdGVzdC5jb25uZWN0bXlhcHBzLmNvbSIsImlhdCI6MTY1MTA2ODk2OSwiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvZW1haWxhZGRyZXNzIjoibmF0YWxpYS55dWRuaWtvdmFAb3V0bG9vay5jb20iLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3VzZXJkYXRhIjoiNmZhMTIyZTQtMGQ0Yy00YTFkLTg4NjktN2MwYTg2YTM3YmYxIiwiaHR0cDovL3NjaGVtYXMubWljcm9zb2Z0LmNvbS93cy8yMDA4LzA2L2lkZW50aXR5L2NsYWltcy9yb2xlIjoiQWRtaW4iLCJMb2dnZWRTdXBwb3J0ZWRCeUNtYSI6IlRydWUiLCJNYW5hZ2VkU3VwcG9ydGVkQnlDbWEiOiJUcnVlIiwiZXhwIjoxNjUxMDY5NTY5LCJhdWQiOiJjbWEtdXNlcnMifQ.v2Tbnw4bKuQSMAjtj36eVjrcMoE1vH93C6axpN9Y4wE

Info

ManagedAccountId - is an optional header. You need to use it if you want to manage some account and get data to which account has access

Expand
titleResponse (status 200)
Code Block
languagejson
[
    {
        "id": "bbe52876-aca2-4ece-ba31-11e0d98ddc19",
        "name": "Quinyx Employee Export Into FTP(CSV)",
        "description": "Quinyx Employee Export Into FTP(CSV)",
        "dateCreated": "2020-08-14T17:12:29.7856246",
        "dateModified": "2022-03-17T13:54:07.0394189",
        "state": "Published",
        "version": "0.1.7",
        "draftIsCommitted": false,
        "dateCommitted": "2021-02-26T16:51:29.3588575",
        "organizationId": null,
        "applications": [
            "QUIN",
            "FTP"
        ],
        "chain": [
            {
                "uniqueBlockId": "02d1424a-da90-4c12-9c28-96162e624bd7",
                "blockName": "API - Get Employees",
                "variables": {
                    "apiKeys": [],
                    "badgeNo": null
                }
           "state": "Published" },
        "version": "0.1.7",    {
      "draftIsCommitted": false,         "dateCommitteduniqueBlockId": "2021-02-26T16:51:29.358857525782580-aabe-4a03-be1c-bc45dacd7e60",
        "organizationId": null,         "applicationsblockName": ["FTP Upload",
           "QUIN",         "variables": {
   "FTP"         ],         "chainfilename": [
        "NY_Employees_{date:yyyy-MM-dd-HH-mm}",
   {                 "uniqueBlockIdfileformat": "02d1424a-da90-4c12-9c28-96162e624bd7csv",
                    "blockNamefilepath": "API - Get Employees",/"
                "variables":}
{             }
       "apiKeys": [],
    },
      {
        "badgeNoid": null"3b76ca61-bca9-4995-90ba-7190c1dd567b",
        "name": "MyStore Customers Send email",
   }     "description": "MyStore Customers      }Send email",
            {
     "dateCreated": "2021-11-08T11:39:58.814",
          "uniqueBlockIddateModified": "257825802021-aabe-4a03-be1c-bc45dacd7e6011-09T15:14:14.836809",
                "blockName"state": "FTP UploadPublished",
    
           "variablesversion": {"0.0.7",
          "draftIsCommitted": true,
         "filenamedateCommitted": "NY_Employees_{date:yyyy-MM-dd-HH-mm}2021-11-09T15:14:18.6103605",
           "organizationId": null,
        "fileformatapplications": "csv",
     [
            "MYST2",
  "filepath": "/"         "CMAF"
       } ],
        "chain": [
 }         ]  {
  },     {         "iduniqueBlockId": "3b76ca61729e4eb5-bca98022-499543bb-90bab75b-7190c1dd567b524b1cb5f5b5",
                "nameblockName": "MyStore Get Customers Send email",",
                "descriptionvariables": "MyStore Customers Send email", {}
            },
            {
    "dateCreated": "2021-11-08T11:39:58.814",            "dateModifieduniqueBlockId": "2021-11-09T15:14:14.836809",a510ddbf-2350-4ab6-9014-c81d0aa3f013",
                "stateblockName": "PublishedSend email",
                "versionvariables": "0.0.7", {
          "draftIsCommitted": true,         "dateCommittedsubject": "2021-11-09T15:14:18.6103605MyStore Customers",
          "organizationId": null,         "applicationsfileName": [ "AllCustomers",
                    "note"MYST2: ",Please see your customers in MyStore"
        "CMAF"        }
],         "chain": [  }
        ]
 {   },
    {
        "uniqueBlockIdid": "729e4eb5018fda95-8022a62f-43bb4f0b-b75baf12-524b1cb5f5b53cfcd9146def",
        "name": "Transferring of Orders & Customers",
        "blockNamedescription": "MyStore GetTransferring of Orders & Customers",
        "dateCreated": "2020-08-14T17:22:57.2244016",
        "dateModified"variables": {}
 : "2020-12-10T13:02:23.1685229",
        "state": "Draft",
          }"version": null,
        "draftIsCommitted": null,
  {      "dateCommitted": null,
         "uniqueBlockIdorganizationId": "a510ddbf-2350-4ab6-9014-c81d0aa3f013",null,
        "applications": [
           "blockName": "Send emailMYST2",
            "FIKE"
   "variables": {    ],
        "chain": [
      "subject": "MyStore Customers",    {
                "fileNameuniqueBlockId": "AllCustomersa43e433d-9def-4062-9e89-6ff01824f980",
   
                "noteblockName": "PleaseMyStore seeGet yourorders",
customers in MyStore"              "variables": {
 }             }      "status": "2",
 ]     },     {         "idage": "018fda95-a62f-4f0b-af12-3cfcd9146def", null
          "name": "Transferring of Orders & Customers", }
       "description": "Transferring of Orders & Customers"},
        "dateCreated": "2020-08-14T17:22:57.2244016",    {
      "dateModified": "2020-12-10T13:02:23.1685229",         "stateuniqueBlockId": "Draftd362db53-c46f-4cf8-8bee-9a105ecde130",

       "version": null,         "draftIsCommittedblockName": null,"Get all contacts",
      "dateCommitted": null,         "organizationIdvariables": null,{
        "applications": [            "testValue": "MYST2name",
            "FIKE"    }
    ],         "chain": [},
            {
                "uniqueBlockId": "a43e433d6cf1b697-9def4145-40624659-9e89985c-6ff01824f9804c9b76a57710",
                "blockName": "MyStorePost orders Get& orderscustomers",
                "variables": {
                    "status": "2",
                    "age": null
            shippingtext": "Shipping"
   }             },
            {}
        ]
       "uniqueBlockId": "d362db53-c46f-4cf8-8bee-9a105ecde130",
 }
]

Workflows

Returns list of registered workflows

Expand
titleGET https://<base-url>/Workflows

Headers:

ManagedAccountId:a4ba9a9b-ce81-4f06-81c6-032bf7d648f5

Authorization:Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIyMDAxZDFlZS1jOWUxLTRhMDctOTZkNi1hNTMyNGEzMjczY2UiLCJpc3MiOiJodHRwOi8vY2FudmFzdGVzdC5jb25uZWN0bXlhcHBzLmNvbSIsImlhdCI6MTY1MTA2ODk2OSwiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvZW1haWxhZGRyZXNzIjoibmF0YWxpYS55dWRuaWtvdmFAb3V0bG9vay5jb20iLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3VzZXJkYXRhIjoiNmZhMTIyZTQtMGQ0Yy00YTFkLTg4NjktN2MwYTg2YTM3YmYxIiwiaHR0cDovL3NjaGVtYXMubWljcm9zb2Z0LmNvbS93cy8yMDA4LzA2L2lkZW50aXR5L2NsYWltcy9yb2xlIjoiQWRtaW4iLCJMb2dnZWRTdXBwb3J0ZWRCeUNtYSI6IlRydWUiLCJNYW5hZ2VkU3VwcG9ydGVkQnlDbWEiOiJUcnVlIiwiZXhwIjoxNjUxMDY5NTY5LCJhdWQiOiJjbWEtdXNlcnMifQ.v2Tbnw4bKuQSMAjtj36eVjrcMoE1vH93C6axpN9Y4wE

Info

ManagedAccountId - is an optional header. You need to use it if you want to manage some account and get data to which account has access

Expand
titleResponse (status 200)
Code Block
languagejson
[
     {
        "blockNameid": "Get all contactsef7a56e6-448f-4787-b58d-47b063d6e983",
        "name": "Quinyx Employee Export Into FTP(CSV)",
        "variablesdescription": {"Quinyx Employee Export Into FTP(CSV)",
        "status": "Ready",
        "testValueisScheduled": "name"false,
        "schedulerFrequency": "{ \"cronSchedule\": \"0 0 * ? * *\"}",
            }"workflowTemplateId": "bbe52876-aca2-4ece-ba31-11e0d98ddc19",
        "isCustomizedStructure": true,
  {        "accountId": "6fa122e4-0d4c-4a1d-8869-7c0a86a37bf1",
        "uniqueBlockIdorganizationId": "6cf1b69700000000-41450000-46590000-985c0000-4c9b76a57710000000000001",
        "dateCreated": "2022-02-22T15:29:22.3525209",
        "blockNamedateModified": "Post orders & customers",
       2022-04-13T06:30:56.2625076",
        "variablesdateLastRun": {"2022-04-12T10:35:32.731+00:00",
           "dateNextSchedule": null,
        "shippingtextregApplicationIds": "Shipping"[
            "1710ff47-f590-43db-b0de-015676e99615",
   }             }"fa2ee993-03cf-4baf-a8a0-684e92e74ded"
        ],
    }
]

Workflows

Returns list of registered workflows

Expand
titleGET https://<base-url>/Workflows

Headers:

ManagedAccountId:a4ba9a9b-ce81-4f06-81c6-032bf7d648f5

Authorization:Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIyMDAxZDFlZS1jOWUxLTRhMDctOTZkNi1hNTMyNGEzMjczY2UiLCJpc3MiOiJodHRwOi8vY2FudmFzdGVzdC5jb25uZWN0bXlhcHBzLmNvbSIsImlhdCI6MTY1MTA2ODk2OSwiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvZW1haWxhZGRyZXNzIjoibmF0YWxpYS55dWRuaWtvdmFAb3V0bG9vay5jb20iLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3VzZXJkYXRhIjoiNmZhMTIyZTQtMGQ0Yy00YTFkLTg4NjktN2MwYTg2YTM3YmYxIiwiaHR0cDovL3NjaGVtYXMubWljcm9zb2Z0LmNvbS93cy8yMDA4LzA2L2lkZW50aXR5L2NsYWltcy9yb2xlIjoiQWRtaW4iLCJMb2dnZWRTdXBwb3J0ZWRCeUNtYSI6IlRydWUiLCJNYW5hZ2VkU3VwcG9ydGVkQnlDbWEiOiJUcnVlIiwiZXhwIjoxNjUxMDY5NTY5LCJhdWQiOiJjbWEtdXNlcnMifQ.v2Tbnw4bKuQSMAjtj36eVjrcMoE1vH93C6axpN9Y4wE

Info

ManagedAccountId - is an optional header. You need to use it if you want to manage some account and get data to which account has access

Expand
titleResponse (status 200)
Code Block
languagejson
[    "currentBlock": 5
    },
    {
        "id": "ef7a56e6b459cf22-448fad18-478744bf-b58d80dc-47b063d6e9836e8b78be1cc5",
        "name": "Quinyx Employee Export Into FTP(CSV)Order transferring",
        "description": "Quinyx Employee Export Into FTP(CSV)Transfer orders from MyStore into Tripletex invoices with payments",
        "status": "Ready",
        "isScheduled": false,
        "schedulerFrequency": "{ \"cronSchedule\": \"0 0 *0/1 ? * * *\"}",
        "workflowTemplateId": "bbe52876-aca2-4ece-ba31-11e0d98ddc19"null,
        "isCustomizedStructure": truefalse,
        "accountId": "6fa122e4-0d4c-4a1d-8869-7c0a86a37bf1",
        "organizationId": "00000000-0000-0000-0000-000000000001",
        "dateCreated": "2022-0203-22T1524T18:2908:22.35252092543998",
        "dateModified": "2022-04-13T0612T10:3036:56.2625076478261",
        "dateLastRun": "2022-04-12T10:3536:3257.731877+00:00",
        "dateNextSchedule": null"2022-04-05T17:00:00+00:00",
        "regApplicationIds": [
            "1710ff47281686d9-f590aedd-43db4359-b0de89b4-015676e996158f878ad43b35",
            "fa2ee99303548816-03cff945-4baf4bb2-a8a0b66e-684e92e74ded950dff826fb8"
        ],
        "currentBlock": 53
    },
    {
        "id": "b459cf22a78cee1b-ad18adca-44bf4777-80dc9261-6e8b78be1cc5f86e4640e7db",
        "name": "Order transferringQuinyxRandom",
        "description": "Transfer orders from MyStore into Tripletex invoices with paymentsrandom",
        "status": "Ready",
        "isScheduled": falsetrue,
        "schedulerFrequency": "{\"cronSchedule\":\"0 0 0/12,6 ? * *TUE *\"}",
        "workflowTemplateId": null,
        "isCustomizedStructure": false,
        "accountId": "6fa122e4-0d4c-4a1d-8869-7c0a86a37bf1",
        "organizationId": "00000000-0000-0000-0000-000000000001",
        "dateCreated": "20222021-0304-24T1802T08:0833:2215.25439983238045",
        "dateModified": "2022-04-12T10:3619:5650.4782612024988",
        "dateLastRun": "2022-04-12T1026T06:3600:5728.877976+00:00",
        "dateNextSchedule": "2022-0405-05T1703T02:00:00+00:00",
        "regApplicationIds": [
            "281686d91710ff47-aeddf590-435943db-89b4b0de-8f878ad43b35015676e99615",
            "03548816-f945-4bb2-b66e-950dff826fb8"
        ],
        "currentBlock": 3
    },
    {
        "id": "a78cee1b4fb07016-adca6a38-47774031-926183d7-f86e4640e7db2cd70af024d9",
        "name": "QuinyxRandomBigResponse",
        "description": "randomBigResponse",
        "status": "Ready",
        "isScheduled": truefalse,
        "schedulerFrequency": "{ \"cronSchedule\": \"0 0 2,6* ? * TUE *\"}",
        "workflowTemplateId": null,
        "isCustomizedStructure": false,
        "accountId": "6fa122e4-0d4c-4a1d-8869-7c0a86a37bf1",
        "organizationId": "00000000-0000-0000-0000-000000000001",
        "dateCreated": "2021-0410-02T0829T14:3312:1542.32380454563685",
        "dateModified": "2022-0402-12T1001T09:1958:5053.2024988506504",
        "dateLastRun": "2022-04-26T06:00:28.976+00:00",
        "dateNextSchedule": "20222021-0511-03T0226T16:0035:0057.573+00:00",
        "regApplicationIdsdateNextSchedule": [
null,
           "1710ff47-f590-43db-b0de-015676e99615"
        "regApplicationIds": [],
        "currentBlock": 30
    },
    {
        "id": "4fb070168d85eb13-6a389663-40314ac7-83d78502-2cd70af024d946c5d38f9c1e",
        "name": "BigResponseSpecialSymbols",
        "description": "BigResponseSpecialSymbols",
        "status": "Ready",
        "isScheduled": false,
        "schedulerFrequency": "{ \"cronSchedule\": \"0 0 * ? * *\"}",
        "workflowTemplateId": null,
        "isCustomizedStructure": false,
        "accountId": "6fa122e4-0d4c-4a1d-8869-7c0a86a37bf1",
        "organizationId": "00000000-0000-0000-0000-000000000001",
        "dateCreated": "2021-1009-29T1415T14:1255:4220.45636854327369",
        "dateModified": "2022-02-01T09:5856:5316.5065049089015",
        "dateLastRun": "2021-1109-26T1615T14:3559:5702.57395+00:00",
        "dateNextSchedule": null,
": null,
        "regApplicationIds": [
            "dbdd41cf-28de-4d2d-9771-7105c2165bcf"
       "regApplicationIds": [],
        "currentBlock": 01
    },
    {
        "id": "8d85eb13f01eccf9-9663f56c-4ac7420a-85029da3-46c5d38f9c1ee938291514e8",
        "name": "SpecialSymbolsRandom",
        "description": "SpecialSymbolsRandom",
        "status": "Ready",
        "isScheduled": false,
        "schedulerFrequency": "{ \"cronSchedule\": \"0 0 *0/1 ? * * *\"}",
        "workflowTemplateId": null,
        "isCustomizedStructure": false,
        "accountId": "6fa122e4-0d4c-4a1d-8869-7c0a86a37bf1",
        "organizationId": "00000000-0000-0000-0000-000000000001",
        "dateCreated": "2021-0903-15T1431T09:5509:2031.43273691665459",
        "dateModified": "20222021-0211-01T0926T16:5637:1610.90890158509085",
        "dateLastRun": "2021-0911-15T1426T16:5937:0212.95128+00:00",
        "dateNextSchedule": null"2021-09-20T11:00:00+00:00",
        "regApplicationIds": [
            "dbdd41cf1c08aaa2-28de52ae-4d2d4e74-9771bb9d-7105c2165bcf108f6f36b8a8"
        ],
        "currentBlock": 1
    },
  4
 {   }
]

Workflow

Returns registered workflow by id

Expand
titleGET https://<base-url>/Workflow/b459cf22-ad18-44bf-80dc-6e8b78be1cc5

Headers:

ManagedAccountId:6fa122e4-0d4c-4a1d-8869-7c0a86a37bf1

Authorization:Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIyMDAxZDFlZS1jOWUxLTRhMDctOTZkNi1hNTMyNGEzMjczY2UiLCJpc3MiOiJodHRwOi8vY2FudmFzdGVzdC5jb25uZWN0bXlhcHBzLmNvbSIsImlhdCI6MTY1MTA2ODk2OSwiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvZW1haWxhZGRyZXNzIjoibmF0YWxpYS55dWRuaWtvdmFAb3V0bG9vay5jb20iLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3VzZXJkYXRhIjoiNmZhMTIyZTQtMGQ0Yy00YTFkLTg4NjktN2MwYTg2YTM3YmYxIiwiaHR0cDovL3NjaGVtYXMubWljcm9zb2Z0LmNvbS93cy8yMDA4LzA2L2lkZW50aXR5L2NsYWltcy9yb2xlIjoiQWRtaW4iLCJMb2dnZWRTdXBwb3J0ZWRCeUNtYSI6IlRydWUiLCJNYW5hZ2VkU3VwcG9ydGVkQnlDbWEiOiJUcnVlIiwiZXhwIjoxNjUxMDY5NTY5LCJhdWQiOiJjbWEtdXNlcnMifQ.v2Tbnw4bKuQSMAjtj36eVjrcMoE1vH93C6axpN9Y4wE

Info

ManagedAccountId - is an optional header. You need to use it if you want to manage some account and get data to which account has access

Expand
titleResponse (status 200)
Code Block
languagejson
{
    "id": "f01eccf9b459cf22-f56cad18-420a44bf-9da380dc-e938291514e86e8b78be1cc5",
   
    "name": "RandomOrder transferring",
        "description": "Random",
    Transfer orders from MyStore into Tripletex invoices with payments",
    "status": "Ready",
 
      "isScheduled": false,
   
    "schedulerFrequency": "{\"cronSchedule\":\"0 0 0/1 ? * * *\"}",

       "workflowTemplateId": null,
   
    "isCustomizedStructure": false,
   
    "accountId": "6fa122e4-0d4c-4a1d-8869-7c0a86a37bf1",
  
     "organizationId": "00000000-0000-0000-0000-000000000001",
        "dateCreated": "20212022-03-31T0924T18:0908:3122.16654592543998",
   
    "dateModified": "20212022-1104-26T1612T10:3736:1056.8509085478261",
   
    "dateLastRun": "20212022-1104-26T1612T10:3736:1257.128877+00:00",
 
      "dateNextSchedule": "20212022-0904-20T1105T17:00:00+00:00",
   
    "regApplicationIds": [
   
        "1c08aaa2281686d9-52aeaedd-4e744359-bb9d89b4-108f6f36b8a88f878ad43b35",
         ],"03548816-f945-4bb2-b66e-950dff826fb8"
    ],
    "currentBlock": 4
   3
}
]

Workflow

...

Returns registered workflow by id

Expand
titleGET https://<base-url>/Workflow/b459cf22-ad18-44bf-80dc-6e8b78be1cc5

Headers:

ManagedAccountId:6fa122e4-0d4c-4a1d-8869-7c0a86a37bf1

Authorization:Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIyMDAxZDFlZS1jOWUxLTRhMDctOTZkNi1hNTMyNGEzMjczY2UiLCJpc3MiOiJodHRwOi8vY2FudmFzdGVzdC5jb25uZWN0bXlhcHBzLmNvbSIsImlhdCI6MTY1MTA2ODk2OSwiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvZW1haWxhZGRyZXNzIjoibmF0YWxpYS55dWRuaWtvdmFAb3V0bG9vay5jb20iLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3VzZXJkYXRhIjoiNmZhMTIyZTQtMGQ0Yy00YTFkLTg4NjktN2MwYTg2YTM3YmYxIiwiaHR0cDovL3NjaGVtYXMubWljcm9zb2Z0LmNvbS93cy8yMDA4LzA2L2lkZW50aXR5L2NsYWltcy9yb2xlIjoiQWRtaW4iLCJMb2dnZWRTdXBwb3J0ZWRCeUNtYSI6IlRydWUiLCJNYW5hZ2VkU3VwcG9ydGVkQnlDbWEiOiJUcnVlIiwiZXhwIjoxNjUxMDY5NTY5LCJhdWQiOiJjbWEtdXNlcnMifQ.v2Tbnw4bKuQSMAjtj36eVjrcMoE1vH93C6axpN9Y4wE

Info

ManagedAccountId - is an optional header. You need to use it if you want to manage some account and get data to which account has access

...

Registers a new workflow based on template

Expand
titlePOST https://<base-url>/Workflow

Body JSON structure:

AddWorkflowApiDto

Body example:

Code Block
languagejson
{   
   "workflowTemplateId": 

...

"bbe52876-aca2-4ece-ba31-11e0d98ddc19",
   "name": "Test Quinyx Employee Export Into FTP(CSV)",
   "applications": {"QUIN":"e3320a16-4b20-4e33-840f-2f5d28e3e1ca", "FTP":"0741b73d-2b13-4a4a-a0c2-2ffad9548e06"},
   

...

"

...

chain":[

...

         

...

 

...

 

...

 

...

{

...

 

...

 

...

 

...

 

...

 

...

     

...

 

...

     "

...

uniqueBlockId": 

...

"02d1424a-da90-4c12-9c28-96162e624bd7",
    

...

 

...

 

...

 

...

 

...

 

...

 

...

 

...

     "

...

variables": {
 

...

     

...

 

...

     

...

        "

...

apiKeys": ["

...

cc92-

...

510a-

...

86df-

...

b276"],
          

...

          "

...

badgeNo":

...

 null
     

...

 

...

     

...

 

...

    }

...

 

...

         

...

  }
      

...

  ]
}  

...

     

...

Headers:

ManagedAccountId:6fa122e4-0d4c-4a1d-8869-7c0a86a37bf1

Authorization:Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIyMDAxZDFlZS1jOWUxLTRhMDctOTZkNi1hNTMyNGEzMjczY2UiLCJpc3MiOiJodHRwOi8vY2FudmFzdGVzdC5jb25uZWN0bXlhcHBzLmNvbSIsImlhdCI6MTY1MTA2ODk2OSwiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvZW1haWxhZGRyZXNzIjoibmF0YWxpYS55dWRuaWtvdmFAb3V0bG9vay5jb20iLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3VzZXJkYXRhIjoiNmZhMTIyZTQtMGQ0Yy00YTFkLTg4NjktN2MwYTg2YTM3YmYxIiwiaHR0cDovL3NjaGVtYXMubWljcm9zb2Z0LmNvbS93cy8yMDA4LzA2L2lkZW50aXR5L2NsYWltcy9yb2xlIjoiQWRtaW4iLCJMb2dnZWRTdXBwb3J0ZWRCeUNtYSI6IlRydWUiLCJNYW5hZ2VkU3VwcG9ydGVkQnlDbWEiOiJUcnVlIiwiZXhwIjoxNjUxMDY5NTY5LCJhdWQiOiJjbWEtdXNlcnMifQ.v2Tbnw4bKuQSMAjtj36eVjrcMoE1vH93C6axpN9Y4wE

Info

ManagedAccountId - is an optional header. You need to use it if you want to manage some account and get data to which account has access

Expand
titleResponse (status 200)
Code Block
languagejson
"0fdfd78c-258f-49ed-9e8c-faef9d6598fa"