Versions Compared

Key

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

...

Expand
titleResponse (status 404)

Returned if refresh token is not found

Applications

...

Clients

Returns list of all accounts in your organization

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

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": "3c2da99941a31538-deca1120-4d164bdf-b9a5a6cb-004bc1d5e0f9675eeedd7d2d",
        "namefirstName": "ArrowNathan",
        "shortNamelastName": "ARSPBray",
        "descriptionemail": "Cloud delivery and administrationnathan.bray@connectmyapps.com",
        "vendorUrlorganizationId": "https://www.arrow.com/ecs/no/loesninger/sky/arrowsphere/00000000-0000-0000-0000-000000000000",
        "credentialFieldsorganizationName": "CMA "[\r\n  {\r\nCustomer Bench",
        \"ShortName\roleId": \"apiKey\",\r\n"349889ad-4277-42d0-a268-5cd27230cfc5",
        \"Name\role": \"API key\User",\r\n
   \"Type\": \"text\",\r\n    \"Value\dateCreated": \"\",\r\n"2020-05-07T19:10:36.69"
   \"Optional\": false,\r\n },
    {
\"Desc\": \"Your Arrowsphere API key.\",\r\n    \"Hidden\id": false\r\n  },\r\n  {\r\n"18cc3b9f-c14e-4c7d-892b-7cc5545abac0",
        \"ShortName\firstName": \"environment\Igor",\r\n
        \"Name\lastName": \"Environment\Kostian",\r\n
        \"Type\email": \"select\",\r\n"igor.kostian@connectmyapps.com",
        \"Value\organizationId": \"\",\r\n"00000000-0000-0000-0000-000000000001",
        \"Options\organizationName": \"live|Live Environment,test|Test Environment\",\r\nConnectMyApps AS",
   \"Optional\": false,\r\n    \"Desc\roleId": \"Choose which Arrowsphere environment you wish to use, live or test.\",\r\n    \"Hidden\": false\r\n  }\r\n]"9c525665-df99-4aee-9e52-1a55853db03b",
        "role": "Admin",
        "tagdateCreated": "Cloud"2017-03-01T08:51:32.31"
    },
    {
        "sessionTimeMinsid": 0"a305c3a2-cba5-4554-bb5d-ab7fcd5b4a4c",
        "sessionSlidingExpiryfirstName": false"Luke",
    },     {"lastName": "Buckley",
        "idemail": "07ffd13d-ba57-4d1b-9c46-03c5c919eed0luke.buckley@connectmyapps.com",
        "nameorganizationId": "Talentsoft00000000-0000-0000-0000-000000000000",
        "shortNameorganizationName": "TASOCMA Customer Bench",
        "descriptionroleId": "HR9c525665-df99-4aee-9e52-1a55853db03b",
        "vendorUrlrole": "https://www.talentsoft.com/Admin",
        "credentialFieldsdateCreated": "[\r\n  {\r\n    \"ShortName\": \"baseUrl\",\r\n2013-06-01T18:56:22.763"
   \"Name\": \"Base url\",\r\n    \"Type\": \"text\",\r\n    \"Value\": \"\",\r\n    \"Optional\": false,\r\n    \"Desc\": \"Talentsoft API url.\",\r\n    \"Hidden\": false\r\n  },\r\n  {\r\n    \"ShortName\": \"client_id\",\r\n    \"Name\": \"Client ID\",\r\n    \"Type\": \"text\",\r\n    \"Value\": \"\",\r\n    \"Optional\": false,\r\n    \"Desc\": \"Talentsoft client ID.\",\r\n    \"Hidden\": false\r\n  },\r\n   }
]

Applications

Returns list of all third-part applications supported by CMA

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

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": "3c2da999-deca-4d16-b9a5-004bc1d5e0f9",
        "name": "Arrow",
        "shortName": "ARSP",
        "description": "Cloud delivery and administration",
        "vendorUrl": "https://www.arrow.com/ecs/no/loesninger/sky/arrowsphere/",
        "credentialFields": "[\r\n  {\r\n    \"ShortName\": \"client_secretapiKey\",\r\n    \"Name\": \"ClientAPI secretkey\",\r\n    \"Type\": \"text\",\r\n    \"Value\": \"\",\r\n    \"Optional\": false,\r\n    \"Desc\": \"TalentsoftYour Arrowsphere clientAPI secretkey.\",\r\n    \"Hidden\": false\r\n  },\r\n]",  {\r\n       "tag\"ShortName\": "Hr, Premium\"environment\",\r\n         "sessionTimeMins": 0,\"Name\": \"Environment\",\r\n         "sessionSlidingExpiry\"Type\": false
    },\"select\",\r\n     {
        "id\"Value\": "2ad9b4c5-d40d-46ac-8cd2-0dae50337693",\"\",\r\n         "name\"Options\": "Planday",\"live|Live Environment,test|Test Environment\",\r\n    \"Optional\": false,\r\n    \"shortNameDesc\": "PLAN",
    \"Choose which Arrowsphere environment you wish to use, live or test.\",\r\n    \"descriptionHidden\": "Workforce managment false\r\n  }\r\n]",
        "vendorUrltag": "https://www.planday.com/Cloud",
        "credentialFieldssessionTimeMins": "[\r\n0,
 {\r\n    \"ShortName\": \"appid\",\r\n    \"Name\sessionSlidingExpiry": \"Application Id\",\r\nfalse
    \"Type\},
    {
        "id": \"text\",\r\n"07ffd13d-ba57-4d1b-9c46-03c5c919eed0",
        \"Value\name": \"\Talentsoft",\r\n
   \"Optional\": false,\r\n    \"Desc\shortName": \"Planday application Id\",\r\n"TASO",
        \"Hidden\description": false\r\n  },\r\n  {\r\n "HR",
        \""vendorUrl": "https://www.talentsoft.com/",
        "credentialFields": "[\r\n  {\r\n    \"ShortName\": \"tokenbaseUrl\",\r\n    \"Name\": \"TokenBase url\",\r\n    \"Type\": \"text\",\r\n    \"Value\": \"\",\r\n    \"Optional\": false,\r\n    \"Desc\": \"TokenTalentsoft API url.\",\r\n    \"Hidden\": false\r\n  },\r\n]",  {\r\n       "tag\"ShortName\": "Planday API\"client_id\",\r\n    \"Name\": \"Client ID\",\r\n    \"sessionTimeMinsType\": 45,\"text\",\r\n    \"Value\": \"\",\r\n    \"sessionSlidingExpiryOptional\": false
    },,\r\n     {
 \"Desc\": \"Talentsoft client ID.\",\r\n       "id": "720b3e57-c399-4531-8aa7-0f27b3ea99fa",
   \"Hidden\": false\r\n  },\r\n  {\r\n     \"nameShortName\": \"SalesScreenclient_secret\",\r\n         "shortName\"Name\": \"SASC",
        "description": "Sales visualization",
        "vendorUrl": "http://www.dogu.no",
        "credentialFields": "[\r\n  {\Client secret\",\r\n    \"ShortNameType\": \"keytext\",\r\n    \"NameValue\": \"Company key\",\r\n    \"TypeOptional\": \"text\"false,\r\n    \"ValueDesc\": \"Talentsoft client secret.\",\r\n    \"OptionalHidden\": false,\r\n  }\r\n]",
        \"Desc\tag": "Hr, \"Your SalesScreen API company key.\",\r\nPremium",
        "sessionTimeMins": 0,
        \"Hidden\sessionSlidingExpiry": false\r\n
    }\r\n]",,
    {
        "tagid": "Sales2ad9b4c5-d40d-46ac-8cd2-0dae50337693",
        "sessionTimeMinsname": 0"Planday",
        "sessionSlidingExpiryshortName": false"PLAN",
    },     ...
]
Expand
titleResponse (status 401)

Returned if the Authorization is incorrect or missing.

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"description": "Workforce managment",
        "vendorUrl": "https://www.planday.com/",
        "credentialFields": "[\r\n  {\r\n    \"ShortName\": \"appid\",\r\n    \"Name\": \"Application Id\",\r\n    \"Type\": \"text\",\r\n    \"Value\": \"\",\r\n    \"Optional\": false,\r\n    \"Desc\": \"Planday application Id\",\r\n    \"Hidden\": false\r\n  },\r\n  {\r\n    \"ShortName\": \"token\",\r\n    \"Name\": \"Token\",\r\n    \"Type\": \"text\",\r\n    \"Value\": \"\",\r\n    \"Optional\": false,\r\n    \"Desc\": \"Token\",\r\n    \"Hidden\": false\r\n  }\r\n]",
        "dateCommittedtag": "2021-02-26T16:51:29.3588575Planday API",
        "organizationIdsessionTimeMins": null45,
        "applicationssessionSlidingExpiry": [false
    },
       "QUIN",{
            "FTP"
        ]"id": "720b3e57-c399-4531-8aa7-0f27b3ea99fa",
        "chainname": ["SalesScreen",
        "shortName": "SASC",
  {      "description": "Sales visualization",
        "uniqueBlockIdvendorUrl": "02d1424a-da90-4c12-9c28-96162e624bd7http://www.dogu.no",
            "credentialFields": "[\r\n  {\r\n    \"blockNameShortName\": "API - Get Employees",\"key\",\r\n    \"Name\": \"Company key\",\r\n    \"Type\": \"text\",\r\n      \"variablesValue\": {\"\",\r\n    \"Optional\": false,\r\n    \"Desc\": \"Your SalesScreen API company key.\",\r\n       "apiKeys\"Hidden\": [] false\r\n  }\r\n]",
           "tag": "Sales",
        "badgeNosessionTimeMins": null
                }
            },
            {
0,
               "uniqueBlockId"sessionSlidingExpiry": "25782580-aabe-4a03-be1c-bc45dacd7e60",false
    },
           "blockName": "FTP Upload",
                "variables": {
                    "filename": "NY_Employees_{date:yyyy-MM-dd-HH-mm}",
                    "fileformat": "csv",
                    "filepath": "/"
                }
            }
        ]
    },
    {
        "id": "3b76ca61-bca9-4995-90ba-7190c1dd567b",
        "name": "MyStore Customers Send email",
        "description": "MyStore Customers Send email",...
]
Expand
titleResponse (status 401)

Returned if the Authorization is incorrect or missing.

RegApplications

Returns account registerred applications

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

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
[
    {
        "dateCreatedid": "20211710ff47-11-08T11:39:58.814",
        "dateModified": "2021-11-09T15:14:14.836809f590-43db-b0de-015676e99615",
        "stateshortName": "PublishedQUIN",
        "versionaccountId": "0.0.7",
        "draftIsCommitted": true,
        "dateCommitted": "2021-11-09T15:14:18.61036056fa122e4-0d4c-4a1d-8869-7c0a86a37bf1",
        "organizationIdapplicationId": null"97cbc3b3-32c7-4e4a-b788-a332ea82aeff",
        "applicationsname": ["Quinyx",
            "MYST2"tagText": "N-Quinyx",
        "description": "Workforce   "CMAF"planning",
        "isAuthenticated": ]true,
        "chainisOAuthApp": [false,
        "dateModified": "2022-04-19T15:56:22.1133746",
  {      "dateTimeUtcAuthenticated": "2022-04-19T15:56:22.0345429",
         "uniqueBlockIddateTimeForReAuth": "729e4eb52022-8022-43bb-b75b-524b1cb5f5b504-19T15:56:22.0345429",
        "sessionTimeMins": 0,
        "blockNamesessionSlidingExpiry": "MyStorefalse,
Get Customers",       "faulted": false
    },
   "variables": {}
            }"id": "d2698be7-9f12-44b1-8e6d-0494436538a8",
        "shortName": "MSQL",
  {      "accountId": "6fa122e4-0d4c-4a1d-8869-7c0a86a37bf1",
         "uniqueBlockIdapplicationId": "a510ddbf276511d9-2350f07f-4ab64fa6-9014b109-c81d0aa3f013fdb4d62b2429",
          "name": "Microsoft SQL On-premise",
         "blockNametagText": "Send emailN-Microsoft SQL On-premise",
        "description": "Database engine",
        "variablesisAuthenticated": {true,
        "isOAuthApp": false,
          "subjectdateModified": "MyStore Customers2021-09-06T13:30:11.2590869",
           "dateTimeUtcAuthenticated": "2021-04-14T10:27:22.1672672",
        "fileNamedateTimeForReAuth": "AllCustomers2021-04-14T10:27:22.1672672",
        "sessionTimeMins": 0,
          "notesessionSlidingExpiry": "Please see your customers in MyStore"false,
        "faulted": false
    },
  }  {
        "id":  }"dbdd41cf-28de-4d2d-9771-7105c2165bcf",
         ]"shortName": "CMAF",
    },     {"accountId": "6fa122e4-0d4c-4a1d-8869-7c0a86a37bf1",
        "idapplicationId": "018fda959b6a04b3-a62fc91f-4f0b4255-af129033-3cfcd9146def6ac7b7a6f935",
        "name": "File "Transferring of Orders & CustomersHub",
        "tagText": "File Hub",
        "description": "Transferring of Orders & Customers"File automation",
        "isAuthenticated": true,
        "dateCreatedisOAuthApp": "2020-08-14T17:22:57.2244016"false,
        "dateModified": "20202022-1204-10T1320T14:0200:2327.16852291912258",
        "statedateTimeUtcAuthenticated": "Draft"null,
        "versiondateTimeForReAuth": null,
        "draftIsCommittedsessionTimeMins": null0,
        "dateCommittedsessionSlidingExpiry": nullfalse,
        "organizationIdfaulted": null,false
    },
   "applications": [{
            "MYST2"id": "a067c363-7339-4fed-b1ad-efafd7603986",
            "FIKE""shortName": "FTP",
        ],
        "chain": ["accountId": "6fa122e4-0d4c-4a1d-8869-7c0a86a37bf1",
        "applicationId": "5f814909-01ea-4395-96ee-5ba7614128fc",
   {     "name": "FTP Server",
         "uniqueBlockIdtagText": "a43e433d-9def-4062-9e89-6ff01824f980",
   N-FTP Server",
            "blockNamedescription": "MyStoreFile upload Getand ordersdownload",
        "isAuthenticated": true,
        "variablesisOAuthApp": {false,
        "dateModified": "2022-02-01T15:33:49.9987294",
          "statusdateTimeUtcAuthenticated": "2"2022-02-01T15:33:49.9919226",
           "dateTimeForReAuth": "2022-02-01T15:33:49.9919226",
        "agesessionTimeMins": null0,
        "sessionSlidingExpiry": false,
      }       "faulted": false
     },
]

RegApplication

Registers a new application and returns Id

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

Body JSON structure:

AddRegApplicationApiDto

Body example:

Code Block
languagejson
{
    "applicationId": "97cbc3b3-32c7-4e4a-b788-a332ea82aeff",
     {
   "tagText": "Quinyx 2022-04-28",
    "credentialsJson": "{\"apikey\":\"01d6-3e54-cff2-c7d8\",\"environment\":       "uniqueBlockId": "d362db53-c46f-4cf8-8bee-9a105ecde130",
       \"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)
Code Block
languagejson
"eea37d64-5a93-478c-8216-6231c0a37f0a"

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
[
    {
        "blockNameid": "Get all contacts",
       bbe52876-aca2-4ece-ba31-11e0d98ddc19",
        "variablesname": {"Quinyx Employee Export Into FTP(CSV)",
                "testValue"description": "name"Quinyx Employee Export               }
            },
         Into FTP(CSV)",
  {      "dateCreated": "2020-08-14T17:12:29.7856246",
         "uniqueBlockIddateModified": "6cf1b6972022-4145-4659-985c-4c9b76a5771003-17T13:54:07.0394189",
        "state": "Published",
        "blockNameversion": "Post orders & customers"0.1.7",
        "draftIsCommitted": false,
        "dateCommitted": "2021-02-26T16:51:29.3588575",
        "variablesorganizationId": {null,
        "applications": [
            "shippingtextQUIN":,
 "Shipping"           "FTP"
     }   ],
        "chain": [
}         ]   {
 } ]

Clients

Returns list of all accounts in your organization

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

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
[     {         "iduniqueBlockId": "41a3153802d1424a-da90-11204c12-4bdf-a6cb-675eeedd7d2d",9c28-96162e624bd7",
                "blockName": "API - Get Employees",
                "variables": {
                    "apiKeys": [],
                    "firstNamebadgeNo": "Nathan",null
        "lastName": "Bray",       }
 "email": "nathan.bray@connectmyapps.com",         "organizationId": "00000000-0000-0000-0000-000000000000", },
             "organizationName": "CMA Customer Bench",{
                "roleIduniqueBlockId": "349889ad25782580-4277aabe-42d04a03-a268be1c-5cd27230cfc5bc45dacd7e60",
         "role       "blockName": "UserFTP Upload",
         "dateCreated": "2020-05-07T19:10:36.69"       "variables": {
      },     {         "idfilename": "18cc3b9f-c14e-4c7d-892b-7cc5545abac0",NY_Employees_{date:yyyy-MM-dd-HH-mm}",
          "firstName": "Igor",         "lastNamefileformat": "Kostiancsv",
          "email": "igor.kostian@connectmyapps.com",         "organizationIdfilepath": "00000000-0000-0000-0000-000000000001",/"
        "organizationName": "ConnectMyApps AS",      }
  "roleId": "9c525665-df99-4aee-9e52-1a55853db03b",         "role": "Admin",
  }
       "dateCreated": "2017-03-01T08:51:32.31" ]
    },
    {
        "id": "a305c3a23b76ca61-cba5bca9-45544995-bb5d90ba-ab7fcd5b4a4c7190c1dd567b",
        "firstNamename": "LukeMyStore Customers Send email",
        "lastNamedescription": "BuckleyMyStore Customers Send email",
        "emaildateCreated": "luke.buckley@connectmyapps.com2021-11-08T11:39:58.814",
        "organizationIddateModified": "000000002021-0000-0000-0000-00000000000011-09T15:14:14.836809",
        "organizationNamestate": "CMA Customer BenchPublished",
        "roleIdversion": "9c525665-df99-4aee-9e52-1a55853db03b0.0.7",
        "roledraftIsCommitted": "Admin"true,
        "dateCreateddateCommitted": "20132021-0611-01T1809T15:5614:2218.763"
    }
]

RegApplications

Returns account registerred applications

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

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
[
    {6103605",
        "organizationId": null,
        "idapplications": "1710ff47-f590-43db-b0de-015676e99615", [
            "MYST2",
            "shortName": "QUIN"CMAF"
        ],
        "accountIdchain": "6fa122e4-0d4c-4a1d-8869-7c0a86a37bf1", [
            {
                "applicationIduniqueBlockId": "97cbc3b3729e4eb5-32c78022-4e4a43bb-b788b75b-a332ea82aeff524b1cb5f5b5",

       "name": "Quinyx",         "tagTextblockName": "N-QuinyxMyStore Get Customers",
 
      "description": "Workforce planning",         "isAuthenticatedvariables": true, {}
           "isOAuthApp": false},
         "dateModified": "2022-04-19T15:56:22.1133746",  {
      "dateTimeUtcAuthenticated": "2022-04-19T15:56:22.0345429",         "dateTimeForReAuthuniqueBlockId": "2022a510ddbf-2350-04-19T15:56:22.0345429",
        "sessionTimeMins": 04ab6-9014-c81d0aa3f013",
        "sessionSlidingExpiry": false,         "faultedblockName": false"Send email",
   },     {         "idvariables": "d2698be7-9f12-44b1-8e6d-0494436538a8", {
          "shortName": "MSQL",         "accountIdsubject": "6fa122e4-0d4c-4a1d-8869-7c0a86a37bf1MyStore Customers",
          "applicationId": "276511d9-f07f-4fa6-b109-fdb4d62b2429",         "namefileName": "Microsoft SQL On-premiseAllCustomers",
        "tagText": "N-Microsoft SQL On-premise",         "descriptionnote": "Database engine",Please see your customers in MyStore"
            "isAuthenticated": true,   }
     "isOAuthApp": false,      }
  "dateModified": "2021-09-06T13:30:11.2590869",     ]
   "dateTimeUtcAuthenticated": "2021-04-14T10:27:22.1672672",
  },
    {
        "dateTimeForReAuthid": "2021-04-14T10:27:22.1672672018fda95-a62f-4f0b-af12-3cfcd9146def",
        "sessionTimeMinsname": 0,"Transferring of Orders       "sessionSlidingExpiry": false& Customers",
        "faulteddescription": false"Transferring of Orders &  },
    {Customers",
        "iddateCreated": "dbdd41cf2020-28de-4d2d-9771-7105c2165bcf08-14T17:22:57.2244016",
        "shortNamedateModified": "CMAF2020-12-10T13:02:23.1685229",
        "accountIdstate": "6fa122e4-0d4c-4a1d-8869-7c0a86a37bf1Draft",
        "applicationIdversion": "9b6a04b3-c91f-4255-9033-6ac7b7a6f935"null,
        "namedraftIsCommitted": "File Hub"null,
        "tagTextdateCommitted": "File Hub"null,
        "descriptionorganizationId": "File automation",null,
        "applications": [
  "isAuthenticated": true,         "isOAuthAppMYST2":,
  false,         "dateModified": "2022-04-20T14:00:27.1912258",FIKE"
        "dateTimeUtcAuthenticated": null],
        "dateTimeForReAuthchain": [
null,         "sessionTimeMins": 0,  {
      "sessionSlidingExpiry": false,         "faulteduniqueBlockId": false"a43e433d-9def-4062-9e89-6ff01824f980",
    },     {         "idblockName": "a067c363-7339-4fed-b1ad-efafd7603986MyStore Get orders",
        "shortName        "variables": "FTP",{
          "accountId": "6fa122e4-0d4c-4a1d-8869-7c0a86a37bf1",         "applicationIdstatus": "5f814909-01ea-4395-96ee-5ba7614128fc2",
         "name": "FTP Server",         "tagTextage": "N-FTP Server", null
               "description": "File upload and download", }
           "isAuthenticated": true},
         "isOAuthApp": false,  {
      "dateModified": "2022-02-01T15:33:49.9987294",         "dateTimeUtcAuthenticateduniqueBlockId": "2022d362db53-c46f-02-01T15:33:49.9919226",4cf8-8bee-9a105ecde130",
                "dateTimeForReAuthblockName": "2022-02-01T15:33:49.9919226Get all contacts",
        "sessionTimeMins": 0,         "sessionSlidingExpiryvariables": false, {
             "faulted": false     },
]

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
[ "testValue": "name"
                }
            },
            {
        "id        "uniqueBlockId": "ef7a56e66cf1b697-448f4145-47874659-b58d985c-47b063d6e9834c9b76a57710",
                "nameblockName": "QuinyxPost Employeeorders Export Into FTP(CSV)",
     & customers",
  "description": "Quinyx Employee Export Into FTP(CSV)",         "statusvariables": "Ready",{
        "isScheduled": false,         "schedulerFrequency": "{ \"cronSchedule\shippingtext": \"Shipping"0
0 * ? * *\"}",         "workflowTemplateId": "bbe52876-aca2-4ece-ba31-11e0d98ddc19",   }
     "isCustomizedStructure": true,      }
  "accountId": "6fa122e4-0d4c-4a1d-8869-7c0a86a37bf1",      ]
     "organizationId": "00000000-0000-0000-0000-000000000001",
        "dateCreated": "2022-02-22T15:29:22.3525209",}
]

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
[
    {
        "dateModifiedid": "2022ef7a56e6-04-13T06:30:56.2625076",
        "dateLastRun": "2022-04-12T10:35:32.731+00:00448f-4787-b58d-47b063d6e983",
        "dateNextSchedulename": null,
        "regApplicationIds":Quinyx [Employee Export            "1710ff47-f590-43db-b0de-015676e99615Into FTP(CSV)",
        "description": "Quinyx Employee Export Into "fa2ee993-03cf-4baf-a8a0-684e92e74ded"FTP(CSV)",
         ]"status": "Ready",
        "currentBlockisScheduled": 5false,
    },    "schedulerFrequency": "{ \"cronSchedule\": \"0 0 * ? * *\"}",
        "idworkflowTemplateId": "b459cf22bbe52876-ad18aca2-44bf4ece-80dcba31-6e8b78be1cc511e0d98ddc19",
        "nameisCustomizedStructure": true,
     "Order transferring   "accountId": "6fa122e4-0d4c-4a1d-8869-7c0a86a37bf1",
        "descriptionorganizationId": "Transfer orders from MyStore into Tripletex invoices with payments00000000-0000-0000-0000-000000000001",
        "statusdateCreated": "Ready2022-02-22T15:29:22.3525209",
        "isScheduleddateModified": false"2022-04-13T06:30:56.2625076",
        "schedulerFrequencydateLastRun": "{\"cronSchedule\":\"0 0 0/1 ? * * *\"}"2022-04-12T10:35:32.731+00:00",
        "workflowTemplateIddateNextSchedule": null,
        "regApplicationIds": [
 "isCustomizedStructure": false,         "accountId": "6fa122e41710ff47-0d4cf590-4a1d43db-8869b0de-7c0a86a37bf1015676e99615",
           "organizationId": "00000000fa2ee993-000003cf-00004baf-0000a8a0-000000000001"684e92e74ded"
        ],
        "dateCreatedcurrentBlock": "2022-03-24T18:08:22.2543998",
 5
    },
    {
        "dateModifiedid": "2022-04-12T10:36:56.478261b459cf22-ad18-44bf-80dc-6e8b78be1cc5",
        "dateLastRunname": "2022-04-12T10:36:57.877+00:00Order transferring",
        "dateNextScheduledescription": "2022-04-05T17:00:00+00:00Transfer orders from MyStore into Tripletex invoices with payments",
        "regApplicationIdsstatus": [
   "Ready",
        "281686d9-aedd-4359-89b4-8f878ad43b35"isScheduled": false,
            "03548816-f945-4bb2-b66e-950dff826fb8"
        ]"schedulerFrequency": "{\"cronSchedule\":\"0 0 0/1 ? * * *\"}",
        "currentBlockworkflowTemplateId": 3null,
      },  "isCustomizedStructure": false,
 {         "idaccountId": "a78cee1b6fa122e4-adca0d4c-47774a1d-92618869-f86e4640e7db7c0a86a37bf1",
        "nameorganizationId": "QuinyxRandom00000000-0000-0000-0000-000000000001",
        "descriptiondateCreated": "random2022-03-24T18:08:22.2543998",
        "statusdateModified": "Ready2022-04-12T10:36:56.478261",
        "isScheduleddateLastRun": true"2022-04-12T10:36:57.877+00:00",
        "schedulerFrequencydateNextSchedule": "{\"cronSchedule\":\"0 0 2,6 ? * TUE *\"}2022-04-05T17:00:00+00:00",
        "workflowTemplateIdregApplicationIds": [
   null,         "isCustomizedStructure": false,281686d9-aedd-4359-89b4-8f878ad43b35",
           "accountId": "6fa122e403548816-0d4cf945-4a1d4bb2-8869b66e-7c0a86a37bf1"950dff826fb8"
        ],
        "organizationIdcurrentBlock": "00000000-0000-0000-0000-000000000001",
 3
    },
    {
        "dateCreatedid": "2021-04-02T08:33:15.3238045a78cee1b-adca-4777-9261-f86e4640e7db",
        "dateModifiedname": "2022-04-12T10:19:50.2024988"QuinyxRandom",
        "dateLastRundescription": "2022-04-26T06:00:28.976+00:00random",
        "dateNextSchedulestatus": "2022-05-03T02:00:00+00:00Ready",
        "regApplicationIdsisScheduled": [true,
        "schedulerFrequency": "{\"cronSchedule\":\"0 0 2,6 ? * "1710ff47-f590-43db-b0de-015676e99615"TUE *\"}",
        ]"workflowTemplateId": null,
        "currentBlockisCustomizedStructure": 3false,
    },     {"accountId": "6fa122e4-0d4c-4a1d-8869-7c0a86a37bf1",
        "idorganizationId": "4fb0701600000000-6a380000-40310000-83d70000-2cd70af024d9000000000001",
        "namedateCreated": "BigResponse2021-04-02T08:33:15.3238045",
        "descriptiondateModified": "BigResponse2022-04-12T10:19:50.2024988",
        "statusdateLastRun": "Ready2022-04-26T06:00:28.976+00:00",
        "isScheduleddateNextSchedule": false"2022-05-03T02:00:00+00:00",
        "schedulerFrequencyregApplicationIds": "{ \"cronSchedule\": \"0 0 * ? * *\"}"[
            "1710ff47-f590-43db-b0de-015676e99615"
        ],
        "workflowTemplateIdcurrentBlock": null,3
    },
   "isCustomizedStructure": false, {
        "accountIdid": "6fa122e44fb07016-0d4c6a38-4a1d4031-886983d7-7c0a86a37bf12cd70af024d9",
        "organizationIdname": "00000000-0000-0000-0000-000000000001BigResponse",
        "dateCreateddescription": "2021-10-29T14:12:42.4563685BigResponse",
        "dateModifiedstatus": "2022-02-01T09:58:53.506504Ready",
        "dateLastRunisScheduled": "2021-11-26T16:35:57.573+00:00",
        "dateNextSchedule": nullfalse,
        "schedulerFrequency": "{ \"cronSchedule\": \"0 0 * ? * *\"}",
        "regApplicationIdsworkflowTemplateId": []null,
        "currentBlockisCustomizedStructure": 0false,
    },     {"accountId": "6fa122e4-0d4c-4a1d-8869-7c0a86a37bf1",
        "idorganizationId": "8d85eb1300000000-96630000-4ac70000-85020000-46c5d38f9c1e000000000001",
        "namedateCreated": "SpecialSymbols2021-10-29T14:12:42.4563685",
        "descriptiondateModified": "SpecialSymbols2022-02-01T09:58:53.506504",
        "statusdateLastRun": "Ready2021-11-26T16:35:57.573+00:00",
        "isScheduleddateNextSchedule": falsenull,
        "schedulerFrequencyregApplicationIds": "{ \"cronSchedule\": \"0 0 * ? * *\"}", [],
        "currentBlock": 0
    },
   "workflowTemplateId": null, {
        "isCustomizedStructureid": false"8d85eb13-9663-4ac7-8502-46c5d38f9c1e",
        "accountIdname": "6fa122e4-0d4c-4a1d-8869-7c0a86a37bf1SpecialSymbols",
        "organizationIddescription": "00000000-0000-0000-0000-000000000001SpecialSymbols",
        "dateCreatedstatus": "2021-09-15T14:55:20.4327369Ready",
        "dateModified": "2022-02-01T09:56:16.9089015"isScheduled": false,
        "dateLastRunschedulerFrequency": "{ "2021-09-15T14:59:02.95+00:00\"cronSchedule\": \"0 0 * ? * *\"}",
        "dateNextScheduleworkflowTemplateId": null,
        "regApplicationIdsisCustomizedStructure": [false,
            "dbdd41cf-28de-4d2d-9771-7105c2165bcf""accountId": "6fa122e4-0d4c-4a1d-8869-7c0a86a37bf1",
         ]"organizationId": "00000000-0000-0000-0000-000000000001",
        "currentBlockdateCreated": 1
    },
    {"2021-09-15T14:55:20.4327369",
         "iddateModified": "f01eccf92022-f56c-420a-9da3-e938291514e802-01T09:56:16.9089015",
        "namedateLastRun": "Random2021-09-15T14:59:02.95+00:00",
        "descriptiondateNextSchedule": "Random"null,
        "statusregApplicationIds": "Ready", [
            "isScheduled": falsedbdd41cf-28de-4d2d-9771-7105c2165bcf"
        ],
        "schedulerFrequencycurrentBlock": "{\"cronSchedule\":\"0 0 0/1 ? * * *\"}",1
    },
    {
        "workflowTemplateIdid": null"f01eccf9-f56c-420a-9da3-e938291514e8",
        "isCustomizedStructurename": false"Random",
        "accountIddescription": "6fa122e4-0d4c-4a1d-8869-7c0a86a37bf1Random",
        "organizationIdstatus": "00000000-0000-0000-0000-000000000001Ready",
        "dateCreatedisScheduled": "2021-03-31T09:09:31.1665459"false,
        "dateModifiedschedulerFrequency": "2021-11-26T16:37:10.8509085",
        "dateLastRun": "2021-11-26T16:37:12.128+00:00"{\"cronSchedule\":\"0 0 0/1 ? * * *\"}",
        "dateNextScheduleworkflowTemplateId": "2021-09-20T11:00:00+00:00"null,
        "regApplicationIdsisCustomizedStructure": [false,
           "accountId": "1c08aaa26fa122e4-52ae0d4c-4e744a1d-bb9d8869-108f6f36b8a87c0a86a37bf1",
        ] "organizationId": "00000000-0000-0000-0000-000000000001",
        "dateCreated"currentBlock": 4: "2021-03-31T09:09:31.1665459",
       }
]

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
{ "dateModified": "2021-11-26T16:37:10.8509085",
        "dateLastRun": "2021-11-26T16:37:12.128+00:00",
        "iddateNextSchedule": "b459cf222021-ad18-44bf-80dc-6e8b78be1cc5",09-20T11:00:00+00:00",
        "nameregApplicationIds": "Order transferring", [
            "description": "Transfer orders from MyStore into Tripletex invoices with payments",1c08aaa2-52ae-4e74-bb9d-108f6f36b8a8"
        ],
        "status": "Ready",
    "isScheduled": false,
    "schedulerFrequency": "{\"cronSchedule\":\"0 0 0/1 ? * * *\"}currentBlock": 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": "b459cf22-ad18-44bf-80dc-6e8b78be1cc5",
    "workflowTemplateIdname": "Order nulltransferring",
    "isCustomizedStructuredescription": false,
    "accountId": "6fa122e4-0d4c-4a1d-8869-7c0a86a37bf1 "Transfer orders from MyStore into Tripletex invoices with payments",
    "organizationIdstatus": "00000000-0000-0000-0000-000000000001Ready",
    "dateCreatedisScheduled": "2022-03-24T18:08:22.2543998"false,
    "dateModifiedschedulerFrequency": "2022-04-12T10:36:56.478261",
    "dateLastRun": "2022-04-12T10:36:57.877+00:00{\"cronSchedule\":\"0 0 0/1 ? * * *\"}",
    "dateNextScheduleworkflowTemplateId": "2022-04-05T17:00:00+00:00"null,
    "regApplicationIdsisCustomizedStructure": [false,
        "281686d9-aedd-4359-89b4-8f878ad43b35"accountId": "6fa122e4-0d4c-4a1d-8869-7c0a86a37bf1",
       "organizationId": "0354881600000000-f9450000-4bb20000-b66e0000-950dff826fb8000000000001",
    ] "dateCreated": "2022-03-24T18:08:22.2543998",
    "currentBlockdateModified": 3
}

RegApplication

Registers a new application and returns Id

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

Body JSON structure:

AddRegApplicationApiDto

Body example:

Code Block
languagejson
{"2022-04-12T10:36:56.478261",
    "applicationIddateLastRun": "97cbc3b32022-32c7-4e4a-b788-a332ea82aeff04-12T10:36:57.877+00:00",
    "tagTextdateNextSchedule": "Quinyx 2022-04-2805T17:00:00+00:00",
    "credentialsJsonregApplicationIds": [
       "{\"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)
Code Block
languagejson
"eea37d64-5a93-478c-8216-6231c0a37f0a" "281686d9-aedd-4359-89b4-8f878ad43b35",
        "03548816-f945-4bb2-b66e-950dff826fb8"
    ],
    "currentBlock": 3
}