PRD - https://canvas.connectmyapps.com/api

GetMetaData

For getting of all provided APIs you need to send following request:

...

title	GET https://<base-url>/GetMetaData

Headers:

...

IP restriction

You can send Canvas REST API requests from any server by default.

If you want to restict access by IP addresses, then please provide your IP addresses to ConnectMyApps support for adding them into white list.

Authentication

For enabling of access to your organization data by REST API you need to set <API access> flag ON and copy provided Secret and Consumer keys. These keys are for access to Canvas REST API and you will use them in request headers. Do not share provided keys with anybody and keep them in safe place because they are not saved in Canvas and you will not be able to get them anymore.

Use following authentication request for checking your access keys:

Expand

title	GET https://<base-url>/Authenticate

Headers:

Consumer:5D1AEF05263B497182992E324517FFFD0FED85FBEC2342B19CE02AB5ED62D6ED
SecretKey:a5ae515d-d53b-478c-90bd-060c616d37b7

Expand

title	Response (status 200)

Code Block

language	json

[
    {
        "name": "GetMetaData",
        "parameters": "",
        "verb": "GET",
        "authenticate": false,
        "description": "Returns controllers actions",
        "returns": "JSON array"
    },
    {
        "name": "Describe",
        "parameters": "String name",
        "verb": "GET",
        "authenticate": false,
        "description": "Describes object properties",
        "returns": ""
    },
    {
        "name": "Authenticate",
        "parameters": "",
        "verb": "GET",
        "authenticate": true,
        "description": "Returns access and refresh tokens",
        "returns": "JSON object"
    },
    {
        "name": "RefreshAccessToken",
        "parameters": "String refreshToken",
        "verb": "GET",
        "authenticate": true,
        "description": "Returns access and refresh tokens",
        "returns": "JSON object"
    },
    {
        "name": "DeleteToken",
        "parameters": "String refreshToken",
        "verb": "DELETE",
        "authenticate": true,
        "description": "Deletes a token by refresh token",
        "returns": "boolean"
    },
    {
        "name": "Applications",
        "parameters": "",
        "verb": "GET",
        "authenticate": false,
        "description": "Returns Canvas applications",
        "returns": "JSON Array"
    },
    {
        "name": "WorkflowTemplates",
        "parameters": "",
        "verb": "GET",
        "authenticate": false,
        "description": "Returns list of workflow templates",
        "returns": "JSON array"
    },
    {
        "name": "Clients",
        "parameters": "",
        "verb": "GET",
        "authenticate": false,
        "description": "Returns list of clients",
        "returns": "JSON array"
    },
    {
        "name": "RegApplications",
        "parameters": "",
        "verb": "GET",
        "authenticate": false,
        "description": "Returns account registerred applications",
        "returns": "JSON Array"
    },
    {
        "name": "Workflows",
        "parameters": "",
        "verb": "GET",
        "authenticate": false,
        "description": "Returns list of registered workflows",
        "returns": "JSON array"
    },
    {
        "name": "Workflow",
        "parameters": "Guid id",
        "verb": "GET",
        "authenticate": false,
        "description": "Returns registered workflow by id",
        "returns": "JSON"
    },
    {
        "name": "RegApplication",
        "parameters": "[FromBody]AddRegApplicationApiDto regApp",
        "verb": "POST",
        "authenticate": false,
        "description": "Registers a new application and returns Id",
        "returns": "Guid"
    },
    {
        "name": "Workflow",
        "parameters": "[FromBody]AddWorkflowApiDto workflow",
        "verb": "POST",
        "authenticate": false,
        "description": "Registers a new workflow based on template and returns Id",
        "returns": "Guid"
    },
    {
        "name": "DeleteWorkflow",
        "parameters": "Guid id",
        "verb": "GET",
        "authenticate": false,
        "description": "Deletes workflow by Id",
        "returns": "Guid"
    },
    {
        "name": "RunWorkflow",
        "parameters": "[FromBody]RunMetadataApiDto metadata",
        "verb": "POST",
        "authenticate": false,
        "description": "Runs workflow",
        "returns": "Guid"
    },
    {
        "name": "WorkflowScheduler",
        "parameters": "[FromBody]UpdateWorkfowSchedulerApiDto scheduler",
        "verb": "POST",
        "authenticate": false,
        "description": "Updates the workflow scheduler",
        "returns": ""
    },
    {
        "name": "Account",
        "parameters": "[FromBody]AddAccountApiDto data",
        "verb": "POST",
        "authenticate": false,
        "description": "Account registration",
        "returns": ""
    }
]

Describe

For getting of description about APIs parameters you can use following request:

Expand

title	GET https://<base-url>/Describe?name=AddWorkflowApiDto

Header:

no header

Expand

title	Response (status 200)

[ { "typeName": "guid",

Code Block

language	json

true

Expand

title	Response (status 401)

Returned if the Consumer or SecretKey are incorrect or missing.

APIs for help

There are two APIs, which describes list of all provided APIs

GetMetaData

For getting of all provided APIs you need to send following request:

Expand

title	GET https://<base-url>/GetMetaData

Headers:

no header

Expand

title	Response (status 200)

Code Block

language	json

[
    {
        "name": "GetMetaData",
        "parameters": "",
        "verb": "GET",
        "authenticate": false,
        "description": "Returns controllers actions",
        "returns": "JSON array"
    },
    {
        "name": "Describe",
        "parameters": "String name",
        "verb": "GET",
        "authenticate": false,
        "description": "Describes object properties",
        "returns": ""
    },
    {
        "name": "Authenticate",
        "parameters": "",
        "verb": "GET",
        "authenticate": false,
        "description": "Checks authentification",
        "returns": "boolean"
    },
    {
        "name": "Applications",
        "parameters": "",
        "verb": "GET",
        "authenticate": false,
        "description": "Returns Canvas applications",
        "returns": "JSON Array"
    },
    {
        "name": "WorkflowTemplates",
        "parameters": "",
        "verb": "GET",
        "authenticate": false,
        "description": "Returns list of workflow templates",
        "returns": "JSON array"
    },
    {
        "name": "Accounts",
        "parameters": "",
        "verb": "GET",
        "authenticate": false,
        "description": "Returns list of accounts in the organization",
        "returns": "JSON array"
    },
    {
        "name": "RegApplications",
        "parameters": "",
        "verb": "GET",
        "authenticate": false,
        "description": "Returns account registerred applications",
        "returns": "JSON Array"
    },
    {
        "name": "Workflows",
        "parameters": "",
        "verb": "GET",
        "authenticate": false,
        "description": "Returns list of registered workflows",
        "returns": "JSON array"
    },
    {
        "name": "Workflow",
        "parameters": "Guid id",
        "verb": "GET",
        "authenticate": false,
        "description": "Returns registered workflow by id",
        "returns": "JSON"
    },
    {
        "name": "RegApplication",
        "parameters": "[FromBody]AddRegApplicationApiDto regApp",
        "verb": "POST",
        "authenticate": false,
        "description": "Registers a new application and returns Id",
        "returns": "Guid"
    },
    {
        "name": "Workflow",
        "parameters": "[FromBody]AddWorkflowApiDto workflow",
        "verb": "POST",
        "authenticate": false,
        "description": "Registers a new workflow based on template and returns Id",
        "returns": "Guid"
    },
    {
        "name": "DeleteWorkflow",
        "parameters": "Guid id",
        "verb": "GET",
        "authenticate": false,
        "description": "Deletes workflow by Id",
        "returns": "Guid"
    },
    {
        "name": "RunWorkflow",
        "parameters": "[FromBody]RunMetadataApiDto metadata",
        "verb": "POST",
        "authenticate": false,
        "description": "Runs workflow",
        "returns": "Guid"
    },
    {
        "name": "WorkflowScheduler",
        "parameters": "[FromBody]UpdateWorkfowSchedulerApiDto scheduler",
        "verb": "POST",
        "authenticate": false,
        "description": "Updates the workflow scheduler",
        "returns": ""
    },
    {
        "name": "Account",
        "parameters": "[FromBody]AddAccountApiDto data",
        "verb": "POST",
        "authenticate": false,
        "description": "Account registration",
        "returns": ""
    }
]

Describe

For getting of description about APIs parameters you can use following request:

Expand

title	GET https://<base-url>/Describe?name=AddWorkflowApiDto

Header:

no header

Expand

title	Response (status 200)

Code Block

language	json

[
    {
        "typeName": "guid",
        "propertyName": "workflowTemplateId",
        "genericParameters": "",
        "isRequired": true
    },
    {
        "typeName": "string",
        "propertyName": "name",
        "genericParameters": "",
        "isRequired": false
    },
    {
        "typeName": "string",
        "propertyName": "workflowTemplateIddescription",
        "genericParameters": "",
        "isRequired": truefalse
    },
    {
        "typeName": "stringdictionary",
        "propertyName": "nameapplications",
        "genericParameters": "string,guid",
        "isRequired": true
    },
    {
        "typeName": "stringiEnumerable",
        "propertyName": "descriptionchain",
        "genericParameters": "chainApiDto",
        "isRequired": false
    },
    {
]

APIs for organization administration

Accounts

Returns list of all active accounts in your organization

Expand

title	GET https://<base-url>/Accounts

Headers:

Consumer:5D1AEF05263B497182992E324517FFFD0FED85FBEC2342B19CE02AB5ED62D6ED

SecretKey:a5ae515d-d53b-478c-90bd-060c616d37b7

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

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

title	Response (status 200)

Code Block

language	json

[
    {
   "typeName": "dictionary",    "id": "41a31538-1120-4bdf-a6cb-675eeedd7d2d",
        "propertyNamefirstName": "applicationsNathan",
        "genericParameterslastName": "string,guidBray",
        "isRequiredemail": true"nathan.bray@connectmyapps.com",
    },     {"organizationId": "00000000-0000-0000-0000-000000000000",
        "typeNameorganizationName": "iEnumerableCMA Customer Bench",
        "propertyNameroleId": "chain349889ad-4277-42d0-a268-5cd27230cfc5",
        "genericParametersrole": "chainApiDtoUser",
        "isRequireddateCreated": false"2020-05-07T19:10:36.69"
    }
]

Authentication

For enabling of access to your organization you need to set <API access> flag ON and copy provided Secret and Consumer keys. Do not share provided keys with anybody and keep them in safe place because they are not saved in Canvas and you will not be able to get them anymore.

Authentication request:

Expand

title	GET https://<base-url>/Authenticate

Headers:

Consumer:5D1AEF05263B497182992E324517FFFD0FED85FBEC2342B19CE02AB5ED62D6ED
SecretKey:a5ae515d-d53b-478c-90bd-060c616d37b7

Expand

title	Response (status 200)

Code Block

language	json

{
  "access_token": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzYzI4YjFkYy05ZDA1LTQ5ZDgtYTMyNC1kNGI2N2IxYTg3MmQiLCJpc3MiOiJodHRwOi8vY2FudmFzdGVzdC5jb25uZWN0bXlhcHBzLmNvbSIsImlhdCI6MTY1MTA2ODA4MiwiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvZW1haWxhZGRyZXNzIjoibmF0YWxpYS55dWRuaWtvdmFAb3V0bG9vay5jb20iLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3VzZXJkYXRhIjoiNmZhMTIyZTQtMGQ0Yy00YTFkLTg4NjktN2MwYTg2YTM3YmYxIiwiaHR0cDovL3NjaGVtYXMubWljcm9zb2Z0LmNvbS93cy8yMDA4LzA2L2lkZW50aXR5L2NsYWltcy9yb2xlIjoiQWRtaW4iLCJMb2dnZWRTdXBwb3J0ZWRCeUNtYSI6IlRydWUiLCJNYW5hZ2VkU3VwcG9ydGVkQnlDbWEiOiJUcnVlIiwiZXhwIjoxNjUxMDY4OTgxLCJhdWQiOiJjbWEtdXNlcnMifQ.SllrAi0m1DR__9tYuSZJ4-qTk3pnxEi2G5vs6_cSvCE",
  "accessTokenExpiresDateTime": "2022-04-27T14:16:21.9458102+00:00",
  "refresh_token": "6ed6d7ba271d43a0843f8f363fe27279",     
  "refreshTokenExpiresDateTime": "2022-04-28T14:01:21.9458102+00:00"
}

Expand

title	Response (status 401)

Returned if the Consumer or SecretKey are incorrect or missing.

Refresh token

For refreshing of access token you need to send following request:

Expand

title	GET https://<base-url>/RefreshAccessToken?refreshToken=6ed6d7ba271d43a0843f8f363fe27279

Headers:

Consumer:5D1AEF05263B497182992E324517FFFD0FED85FBEC2342B19CE02AB5ED62D6ED
SecretKey:a5ae515d-d53b-478c-90bd-060c616d37b7

Expand

title	Response (status 200)

Code Block

language	json

{
    "access_token": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIyMDAxZDFlZS1jOWUxLTRhMDctOTZkNi1hNTMyNGEzMjczY2UiLCJpc3MiOiJodHRwOi8vY2FudmFzdGVzdC5jb25uZWN0bXlhcHBzLmNvbSIsImlhdCI6MTY1MTA2ODk2OSwiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvZW1haWxhZGRyZXNzIjoibmF0YWxpYS55dWRuaWtvdmFAb3V0bG9vay5jb20iLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3VzZXJkYXRhIjoiNmZhMTIyZTQtMGQ0Yy00YTFkLTg4NjktN2MwYTg2YTM3YmYxIiwiaHR0cDovL3NjaGVtYXMubWljcm9zb2Z0LmNvbS93cy8yMDA4LzA2L2lkZW50aXR5L2NsYWltcy9yb2xlIjoiQWRtaW4iLCJMb2dnZWRTdXBwb3J0ZWRCeUNtYSI6IlRydWUiLCJNYW5hZ2VkU3VwcG9ydGVkQnlDbWEiOiJUcnVlIiwiZXhwIjoxNjUxMDY5NTY5LCJhdWQiOiJjbWEtdXNlcnMifQ.v2Tbnw4bKuQSMAjtj36eVjrcMoE1vH93C6axpN9Y4wE",
    "accessTokenExpiresDateTime": "2022-04-27T14:26:09.3528117+00:00",
    "refresh_token": "886be8d80a65477b8ce9b4b643fe6994",
    "refreshTokenExpiresDateTime": "2022-04-28T14:16:09.3528117+00:00"
}

Expand

title	Response (status 401)

Returned if the Consumer or SecretKey are incorrect or missing.

Expand

title	Response (status 404)

Returned if refresh token is not found

Delete authentication tokens

For deleting of authentication tokens you need to send following request:

Expand

title	DELETE https://<base-url>/DeleteToken?refreshToken=6ed6d7ba271d43a0843f8f363fe27279

Headers:

Consumer:5D1AEF05263B497182992E324517FFFD0FED85FBEC2342B19CE02AB5ED62D6ED
SecretKey:a5ae515d-d53b-478c-90bd-060c616d37b7

Expand

title	Response (status 200)

Code Block
true

Expand

title	Response (status 401)

Returned if the Consumer or SecretKey are incorrect or missing.

Expand

title	Response (status 404)

Returned if refresh token is not found

Applications

Returns list of all third-part applications supported by CMA

Expand

title	GET 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

title	Response (status 200)

Code Block

language	json

[
    {,
    {
        "id": "18cc3b9f-c14e-4c7d-892b-7cc5545abac0",
        "firstName": "Igor",
        "lastName": "Kostian",
        "email": "igor.kostian@connectmyapps.com",
        "organizationId": "00000000-0000-0000-0000-000000000001",
        "organizationName": "ConnectMyApps AS",
        "roleId": "9c525665-df99-4aee-9e52-1a55853db03b",
        "role": "Admin",
        "dateCreated": "2017-03-01T08:51:32.31"
    },
    {
        "id": "a305c3a2-cba5-4554-bb5d-ab7fcd5b4a4c",
        "firstName": "Luke",
        "lastName": "Buckley",
        "email": "luke.buckley@connectmyapps.com",
        "organizationId": "00000000-0000-0000-0000-000000000000",
        "organizationName": "CMA Customer Bench",
        "roleId": "9c525665-df99-4aee-9e52-1a55853db03b",
        "role": "Admin",
        "dateCreated": "2013-06-01T18:56:22.763"
    }
]

Account

Registers a new account and returns account Id. If account is created as inactive then an email to complete activation will be send by corresponded address.

Expand

title	POST https://<base-url>/Account

Body JSON structure:

AddAccountApiDto

Body example:

Code Block

language	json

{
    "firstName": "John",
    "lastName": "Smeet",
    "email": "john.smmet@сompany.com",
    "phone":"+470568765432",
    "roleName":"SuperPartner",
    "countryKey":"DE",
    "globalNotifications":true,
    "defaultNotificationEmail":"support@connectmyapps.com",    
    "activated":true
}

Headers:

Consumer:5D1AEF05263B497182992E324517FFFD0FED85FBEC2342B19CE02AB5ED62D6ED

SecretKey:a5ae515d-d53b-478c-90bd-060c616d37b7

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

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

title	Response (status 200)

Code Block

language	json

"296dce4a-3e24-495e-833c-e183ccfbf2d9"

Expand

title	Response (status 401)

Status Code: 401; Unauthorized

Expand

title	Response (status 400)

Code Block
Account has already been created

Expand

title	Response (status 400)

Code Block
Role Admin is not supported. Please use SuperPartner or User

Application APIs

Applications

Returns list of all third-part applications supported by CMA

Expand

title	GET https://<base-url>/Applications

Headers:

Consumer:5D1AEF05263B497182992E324517FFFD0FED85FBEC2342B19CE02AB5ED62D6ED

SecretKey:a5ae515d-d53b-478c-90bd-060c616d37b7

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

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

title	Response (status 200)

Code Block

language	json

[
    {
        "id": "07ffd13d-ba57-4d1b-9c46-03c5c919eed0",
        "name": "Talentsoft",
        "shortName": "TASO",
        "description": "HR",
        "vendorUrl": "https://www.talentsoft.com/",
        "credentialFields": [
            {
                "ShortName": "baseUrl",
                "Name": "Base url",
                "Type": "text",
                "Value": "",
                "Optional": false,
                "Desc": "Talentsoft API url.",
                "Hidden": false
            },
            {
                "ShortName": "client_id",
                "Name": "Client ID",
                "Type": "text",
                "Value": "",
                "Optional": false,
                "Desc": "Talentsoft client ID.",
                "Hidden": false
            },
            {
                "ShortName": "client_secret",
                "Name": "Client secret",
                "Type": "text",
                "Value": "",
                "Optional": false,
                "Desc": "Talentsoft client secret.",
                "Hidden": false
            }
        ],
        "credentialsJson": {
            "baseUrl": null,
            "client_id": null,
            "idclient_secret": "3c2da999-deca-4d16-b9a5-004bc1d5e0f9"null
        },
        "nametag": "ArrowHr, Premium",
        "shortNamesessionTimeMins": "ARSP"0,
        "descriptionsessionSlidingExpiry": "Cloud delivery and administration",false
    },
   "vendorUrl": "https://www.arrow.com/ecs/no/loesninger/sky/arrowsphere/", {
        "credentialFieldsid": "[\r\n  {\r\n97cbc3b3-32c7-4e4a-b788-a332ea82aeff",
        \"ShortName\name": \"apiKey\Quinyx",\r\n
        \"Name\shortName": \"API key\QUIN",\r\n
        \"Type\description": \"text\",\r\nWorkforce planning",
        \"Value\vendorUrl": \"\",\r\n"http://www.quinyx.com",
   \"Optional\": false,\r\n    \"Desc\credentialFields": \"Your[
Arrowsphere API key.\",\r\n    \"Hidden\": false\r\n  },\r\n  {\r\n      {
      \"ShortName\": \"environment\",\r\n    \"Name\": \"Environment\",\r\n    \"Type\ShortName": \"select\apikey",\r\n
    \"Value\": \"\",\r\n    \"Options\": \"live|Live Environment,test|Test Environment\",\r\n    \"Optional\Name": "API false,\r\nkey",
      \"Desc\": \"Choose which Arrowsphere environment you wish to use, live or test.\",\r\n"Type": "text",
    \"Hidden\": false\r\n  }\r\n]",         "tagValue": "Cloud",
                "sessionTimeMinsOptional": 0false,
          "sessionSlidingExpiry      "Desc": "Your falseQuinyx API key",
  },     {         "idHidden": "07ffd13d-ba57-4d1b-9c46-03c5c919eed0", false
           "name": "Talentsoft", },
         "shortName": "TASO",  {
      "description": "HR",         "vendorUrlShortName": "https://www.talentsoft.com/environment",
        "credentialFields": "[\r\n  {\r\n    \"ShortName\": \"baseUrl\",\r\n    \"Name\": \"Base url\Environment",\r\n   
\"Type\": \"text\",\r\n    \"Value\": \"\",\r\n    \"Optional\": false,\r\n      \"Desc\Type": \"Talentsoft API url.\",\r\n"select",
       \"Hidden\": false\r\n  },\r\n  {\r\n    \"ShortName\Value": \"client_id\",\r\n",
                \"Name\Options": \"Client ID\",\r\n"live|Live Environment,test|Test Environment",
     \"Type\": \"text\",\r\n      \"Value\": \"\",\r\n    \"Optional\": false,\r\n
                \"Desc\": \"Talentsoft client ID.\",\r\n"Choose which Quinyx environment you wish to use, live or test.",
                \"Hidden\": false\r\n  },\r\n  {\r\n
            }
        ],
   \"ShortName\": \"client_secret\",\r\n    \"Name\credentialsJson": \"Client secret\",\r\n {
       \"Type\": \"text\",\r\n    \"Value\apikey": \"\",\r\nnull,
       \"Optional\": false,\r\n    \"Desc\environment": \"Talentsoftnull
client secret.\",\r\n    \"Hidden\": false\r\n  }\r\n]",
        "tag": "HrScheduling,Planning, Premium",
        "sessionTimeMins": 0,
        "sessionSlidingExpiry": false
    },
	...,
    {
        "id": "2ad9b4c5b5a4a9ed-d40da686-46ac4b1e-8cd2af30-0dae50337693ffd84b7fb2e0",
        "name": "PlandayTalent Manager",
        "shortName": "PLANHRTM",
        "description": "WorkforceHR managmentsolution",
        "vendorUrl": "httpshttp://www.planday.com/hr-manager.net",
        "credentialFields": "[\r\n  {\r\n[
            {
                \"ShortName\": \"appid\",\r\ncustomeralias",
                \"Name\": \"Application Id\",\r\n"Customer alias",
                \"Type\": \"text\",\r\n
                \"Value\": \"\",\r\n
                \"Optional\": false,\r\n
                \"Desc\": \"PlandayYour applicationcustomer Id\",\r\nalias.",
                \"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\ShortName": \"Token\apikey",\r\n
   \"Hidden\": false\r\n  }\r\n]",             "tagName": "PlandayYour API key",
        "sessionTimeMins": 45,         "sessionSlidingExpiryType": false
 "text",
  },     {         "idValue": "720b3e57-c399-4531-8aa7-0f27b3ea99fa",
        "name        "Optional": "SalesScreen",false,
                "shortNameDesc": "SASCYour API key.",
                "descriptionHidden": "Salesfalse
visualization",         "vendorUrl": "http://www.dogu.no",  }
      "credentialFields": "[\r\n  {\r\n],
   \"ShortName\": \"key\",\r\n    \"Name\credentialsJson": \"Company key\",\r\n {
       \"Type\": \"text\",\r\n    \"Value\customeralias": \"\",\r\nnull,
       \"Optional\": false,\r\n    \"Desc\apikey": \"Yournull
SalesScreen API company key.\",\r\n    \"Hidden\": false\r\n     }\r\n]",
        "tag": "SalesHR",
        "sessionTimeMins": 0,
        "sessionSlidingExpiry": false
    },
    ...
]

Expand

title	Response (status 401)

Returned if the Authorization is incorrect or missing.

WorkflowTemplates

...

RegApplications

Returns account registerred applications

Expand

title	GET https://<base-url>/WorkflowTemplatesRegApplications

Headers:

Consumer:5D1AEF05263B497182992E324517FFFD0FED85FBEC2342B19CE02AB5ED62D6ED

SecretKey:a5ae515d-d53b-478c-90bd-060c616d37b7

ManagedAccountId:a4ba9a9b-ce81-4f06-81c6-032bf7d648f5Authorization: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

title	Response (status 200)

[

Code Block

language	json

[
    {
        "id": "1710ff47-f590-43db-b0de-015676e99615",
        "shortName": "QUIN",
         {"accountId": "6fa122e4-0d4c-4a1d-8869-7c0a86a37bf1",
        "idapplicationId": "bbe5287697cbc3b3-aca232c7-4ece4e4a-ba31b788-11e0d98ddc19a332ea82aeff",
        "name": "Quinyx Employee Export Into FTP(CSV)",
        "tagText": "N-Quinyx",
        "description": "Workforce planning",
        "isAuthenticated": true,
        "Quinyx Employee Export Into FTP(CSV)"isOAuthApp": false,
        "dateModified": "2022-04-19T15:56:22.1133746",
        "dateCreateddateTimeUtcAuthenticated": "20202022-0804-14T1719T15:1256:2922.78562460345429",
        "dateModifieddateTimeForReAuth": "2022-0304-17T1319T15:5456:07.0394189"22.0345429",
        "sessionTimeMins": 0,
        "statesessionSlidingExpiry": false,
        "Published"faulted": false
    },
    {
        "versionid": "0.1.7d2698be7-9f12-44b1-8e6d-0494436538a8",
        "draftIsCommittedshortName": false"MSQL",
        "dateCommittedaccountId": "2021-02-26T16:51:29.35885756fa122e4-0d4c-4a1d-8869-7c0a86a37bf1",
        "organizationIdapplicationId": null"276511d9-f07f-4fa6-b109-fdb4d62b2429",
        "applicationsname": ["Microsoft    SQL On-premise",
        "QUINtagText",: "N-Microsoft SQL On-premise",
        "description": "FTPDatabase engine",
        "isAuthenticated": ]true,
        "chainisOAuthApp": [false,
        "dateModified": "2021-09-06T13:30:11.2590869",
  {      "dateTimeUtcAuthenticated": "2021-04-14T10:27:22.1672672",
         "uniqueBlockIddateTimeForReAuth": "02d1424a2021-da90-4c12-9c28-96162e624bd704-14T10:27:22.1672672",
        "sessionTimeMins": 0,
        "blockNamesessionSlidingExpiry": "APIfalse,
- Get Employees",      "faulted": false
     },
   "variables": {
           "id": "dbdd41cf-28de-4d2d-9771-7105c2165bcf",
        "apiKeysshortName": []"CMAF",
        "accountId": "6fa122e4-0d4c-4a1d-8869-7c0a86a37bf1",
         "applicationId": "badgeNo": null9b6a04b3-c91f-4255-9033-6ac7b7a6f935",
        "name": "File Hub",
       }
  "tagText": "File Hub",
        "description": "File }automation",
        "isAuthenticated": true,
  {        "isOAuthApp": false,
        "uniqueBlockIddateModified": "257825802022-aabe-4a03-be1c-bc45dacd7e6004-20T14:00:27.1912258",
        "dateTimeUtcAuthenticated": null,
        "blockNamedateTimeForReAuth": null,
        "sessionTimeMins"FTP: Upload"0,
        "sessionSlidingExpiry": false,
        "variablesfaulted": {false
    },
    {
          "filenameid": "NY_Employees_{date:yyyy-MM-dd-HH-mm}",
           a067c363-7339-4fed-b1ad-efafd7603986",
        "fileformatshortName": "csvFTP",
        "accountId": "6fa122e4-0d4c-4a1d-8869-7c0a86a37bf1",
          "filepathapplicationId": "/"5f814909-01ea-4395-96ee-5ba7614128fc",
        "name": "FTP Server",
      }  "tagText": "N-FTP Server",
        }
   "description": "File upload and download",
    ]    "isAuthenticated": },
    {true,
        "idisOAuthApp": "3b76ca61-bca9-4995-90ba-7190c1dd567b"false,
        "namedateModified": "MyStore Customers Send email2022-02-01T15:33:49.9987294",
        "descriptiondateTimeUtcAuthenticated": "MyStore Customers Send email2022-02-01T15:33:49.9919226",
        "dateCreateddateTimeForReAuth": "20212022-1102-08T1101T15:3933:5849.8149919226",
        "dateModifiedsessionTimeMins": "2021-11-09T15:14:14.836809"0,
        "statesessionSlidingExpiry": "Published"false,
        "versionfaulted": "0.0.7",
    false
    },
]

RegApplication

Registers a new application and returns Id

Expand

title	POST https://<base-url>/RegApplication

Body JSON structure:

AddRegApplicationApiDto

Body example 1:

Code Block

language	json

{
    "draftIsCommittedapplicationId": true,
   "97cbc3b3-32c7-4e4a-b788-a332ea82aeff",
    "dateCommittedtagText": "2021Quinyx 2022-11-09T15:14:18.610360504-28",
        "organizationId": null,
   "credentialsJson": "{\"apikey\":\"01d6-3e54-cff2-c7d8\",\"environment\": \"test\"}"
}

Body example 2:

Code Block

language	json

{
    "applicationsapplicationId": [
      "5f814909-01ea-4395-96ee-5ba7614128fc",
    "tagText": "MYST2FTP 2022-05-03",
    "credentialsJson": "{\"username\": null,\"password\": null,\"port\": null,\"address\": null,\"secure\":   "CMAF"
        ],
        "chain": [
            {
                "uniqueBlockId": "729e4eb5-8022-43bb-b75b-524b1cb5f5b5",
    true}"
}

Headers:

Consumer:5D1AEF05263B497182992E324517FFFD0FED85FBEC2342B19CE02AB5ED62D6ED

SecretKey:a5ae515d-d53b-478c-90bd-060c616d37b7

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

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

title	Response (status 200)

Code Block

language	json

"eea37d64-5a93-478c-8216-6231c0a37f0a"

Expand

title	Response (status 401)

Status Code: 401; Unauthorized

Expand

title	Response (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.

Workflow APIs

WorkflowTemplates

Returns list of workflow templates provided by CMA and your organization

Expand

title	GET https://<base-url>/WorkflowTemplates

Headers:

Consumer:5D1AEF05263B497182992E324517FFFD0FED85FBEC2342B19CE02AB5ED62D6ED

SecretKey:a5ae515d-d53b-478c-90bd-060c616d37b7

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

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

title	Response (status 200)

Code Block

language	json

[
    {
           "blockNameid": "MyStore Get Customers",
       bbe52876-aca2-4ece-ba31-11e0d98ddc19",
        "variablesname": {}"Quinyx Employee Export Into FTP(CSV)",
        },
    "description": "Quinyx Employee Export Into FTP(CSV)",
       {        "dateCreated": "2020-08-14T17:12:29.7856246",
        "uniqueBlockIddateModified": "a510ddbf2022-2350-4ab6-9014-c81d0aa3f013",
       03-17T13:54:07.0394189",
        "blockNamestate": "Send emailPublished",
        "version": "0.1.7",
        "variablesdraftIsCommitted": {false,
        "dateCommitted": "2021-02-26T16:51:29.3588575",
          "subjectorganizationId": "MyStore Customers",null,
        "applications": [
           "fileName": "AllCustomersQUIN",
            "FTP"
       "note": "Please see your customers in MyStore" ],
        "chain": [
           } {
           }         ]"uniqueBlockId": "02d1424a-da90-4c12-9c28-96162e624bd7",
    },     {         "idblockName": "018fda95-a62f-4f0b-af12-3cfcd9146def",API - Get Employees",
          "name": "Transferring of Orders & Customers",
      "variables": {
       "description": "Transferring of Orders & Customers",
        "dateCreatedapiKeys": "2020-08-14T17:22:57.2244016",[],
         "dateModified": "2020-12-10T13:02:23.1685229",           "statebadgeNo": "Draft",null
        "version": null,       }
 "draftIsCommitted": null,         "dateCommitted": null},
 
      "organizationId": null,     {
   "applications": [            "uniqueBlockId": "MYST225782580-aabe-4a03-be1c-bc45dacd7e60",
            "FIKE"    "blockName":     ]"FTP Upload",
        "chain": [       "variables": {
    {                 "uniqueBlockIdfilename": "a43e433d-9def-4062-9e89-6ff01824f980NY_Employees_{date:yyyy-MM-dd-HH-mm}",
                    "blockNamefileformat": "csv"MyStore,
  Get orders",                 "variablesfilepath": { "/"
                }
            }
   "status": "2",     ]
    },
    {
        "ageid": null"3b76ca61-bca9-4995-90ba-7190c1dd567b",
        "name": "MyStore Customers Send email",
   }     "description": "MyStore Customers      }Send email",
        "dateCreated": "2021-11-08T11:39:58.814",
  {      "dateModified": "2021-11-09T15:14:14.836809",
         "uniqueBlockIdstate": "d362db53-c46f-4cf8-8bee-9a105ecde130Published",
        "version": "0.0.7",
        "blockNamedraftIsCommitted": "Get all contacts" true,
        "dateCommitted": "2021-11-09T15:14:18.6103605",
        "variablesorganizationId": null,
{        "applications": [
           "testValue": "nameMYST2",
            "CMAF"
   }     ],
       },  "chain": [
            {
                "uniqueBlockId": "6cf1b697729e4eb5-41458022-465943bb-985cb75b-4c9b76a57710524b1cb5f5b5",
                "blockName": "PostMyStore ordersGet & customersCustomers",
                "variables": {}
            },
            {
         "shippingtext": "Shipping"      "uniqueBlockId": "a510ddbf-2350-4ab6-9014-c81d0aa3f013",
          }      "blockName": "Send email",
    }         ]     }
]

Clients

Returns list of all accounts in your organization

Expand

title	GET 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

title	Response (status 200)

Code Block

language	json

[
    {"variables": {
           "id": "41a31538-1120-4bdf-a6cb-675eeedd7d2d",         "firstNamesubject": "NathanMyStore Customers",
        "lastName": "Bray",            "emailfileName": "nathan.bray@connectmyapps.comAllCustomers",
        "organizationId": "00000000-0000-0000-0000-000000000000",            "organizationNamenote": "CMA Customer Bench",Please see your customers in MyStore"
            "roleId": "349889ad-4277-42d0-a268-5cd27230cfc5",   }
     "role": "User",      }
  "dateCreated": "2020-05-07T19:10:36.69"      ]
    },
    {
        "id": "18cc3b9f018fda95-c14ea62f-4c7d4f0b-892baf12-7cc5545abac03cfcd9146def",
        "firstNamename": "IgorTransferring of Orders & Customers",
        "lastNamedescription": "KostianTransferring of Orders & Customers",
        "emaildateCreated": "igor.kostian@connectmyapps.com2020-08-14T17:22:57.2244016",
        "organizationIddateModified": "000000002020-0000-0000-0000-00000000000112-10T13:02:23.1685229",
        "organizationNamestate": "ConnectMyApps ASDraft",
        "roleIdversion": "9c525665-df99-4aee-9e52-1a55853db03b"null,
        "roledraftIsCommitted": null,
        "AdmindateCommitted": null,
        "dateCreatedorganizationId": "2017-03-01T08:51:32.31" null,
       }, "applications": [
  {         "id": "a305c3a2-cba5-4554-bb5d-ab7fcd5b4a4cMYST2",
          "firstName":  "LukeFIKE",
        "lastName": "Buckley"],
        "emailchain": "luke.buckley@connectmyapps.com",
[
       "organizationId": "00000000-0000-0000-0000-000000000000",    {
    "organizationName": "CMA Customer Bench",         "roleIduniqueBlockId": "9c525665a43e433d-df999def-4aee4062-9e529e89-1a55853db03b6ff01824f980",

       "role": "Admin",         "dateCreatedblockName": "2013-06-01T18:56:22.763"
    }
]

RegApplications

Returns account registerred applications

Expand

title	GET 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

title	Response (status 200)

Code Block

language	json

[MyStore Get orders",
       {         "idvariables": "1710ff47-f590-43db-b0de-015676e99615",{
                    "shortNamestatus": "QUIN2",
        "accountId": "6fa122e4-0d4c-4a1d-8869-7c0a86a37bf1"            "age": null
                }
            },
        "applicationId": "97cbc3b3-32c7-4e4a-b788-a332ea82aeff",    {
      "name": "Quinyx",         "tagTextuniqueBlockId": "N-Quinyx",d362db53-c46f-4cf8-8bee-9a105ecde130",
                "descriptionblockName": "WorkforceGet all planningcontacts",
        "isAuthenticated": true,
        "isOAuthAppvariables": {
 false,         "dateModified": "2022-04-19T15:56:22.1133746",         "dateTimeUtcAuthenticatedtestValue": "2022-04-19T15:56:22.0345429",name"
        "dateTimeForReAuth": "2022-04-19T15:56:22.0345429",       }
 "sessionTimeMins": 0,         "sessionSlidingExpiry": false},
        "faulted": false   {
 },      {         "iduniqueBlockId": "d2698be76cf1b697-9f124145-44b14659-8e6d985c-0494436538a84c9b76a57710",
                "shortNameblockName": "MSQLPost orders & customers",
        "accountId        "variables": "6fa122e4-0d4c-4a1d-8869-7c0a86a37bf1", {
          "applicationId": "276511d9-f07f-4fa6-b109-fdb4d62b2429",         "nameshippingtext": "Microsoft SQL On-premise","Shipping"
                }
"tagText": "N-Microsoft SQL On-premise",         "description": "Database engine",}
        ]
 "isAuthenticated": true,  }
]

Workflows

Returns list of registered workflows

Expand

title	GET https://<base-url>/Workflows

Headers:

Consumer:5D1AEF05263B497182992E324517FFFD0FED85FBEC2342B19CE02AB5ED62D6ED

SecretKey:a5ae515d-d53b-478c-90bd-060c616d37b7

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

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

title	Response (status 200)

Code Block

language	json

[
    {
"isOAuthApp": false,         "dateModifiedid": "2021-09-06T13:30:11.2590869ef7a56e6-448f-4787-b58d-47b063d6e983",
        "dateTimeUtcAuthenticatedname": "2021-04-14T10:27:22.1672672Quinyx Employee Export Into FTP(CSV)",
        "dateTimeForReAuthdescription": "2021-04-14T10:27:22.1672672Quinyx Employee Export Into FTP(CSV)",
        "sessionTimeMinsstatus": 0"Ready",
        "sessionSlidingExpiryisScheduled": false,
        "schedulerFrequency": "{ \"faultedcronSchedule\": false\"0 0 * ? * *\"}",
    {
        "idworkflowTemplateId": "dbdd41cfbbe52876-28deaca2-4d2d4ece-9771ba31-7105c2165bcf11e0d98ddc19",
        "shortNameisCustomizedStructure": "CMAF"true,
        "accountId": "6fa122e4-0d4c-4a1d-8869-7c0a86a37bf1",
        "applicationIdorganizationId": "9b6a04b300000000-c91f0000-42550000-90330000-6ac7b7a6f935000000000001",
        "namedateCreated": "File Hub2022-02-22T15:29:22.3525209",
        "tagTextdateModified": "File Hub2022-04-13T06:30:56.2625076",
        "descriptiondateLastRun": "File automation2022-04-12T10:35:32.731+00:00",
        "isAuthenticateddateNextSchedule": truenull,
        "isOAuthAppregApplicationIds": false, [
            "1710ff47-f590-43db-b0de-015676e99615",
           "dateModified": "2022-04-20T14:00:27.1912258",fa2ee993-03cf-4baf-a8a0-684e92e74ded"
        "dateTimeUtcAuthenticated": null],
        "dateTimeForReAuthcurrentBlock": null,5
    },
   "sessionTimeMins": 0, {
        "sessionSlidingExpiryid": false"b459cf22-ad18-44bf-80dc-6e8b78be1cc5",
        "faultedname": false"Order transferring",
   },     {
        "id": "a067c363-7339-4fed-b1ad-efafd7603986""description": "Transfer orders from MyStore into Tripletex invoices with payments",
        "shortNamestatus": "FTPReady",
        "accountId": "6fa122e4-0d4c-4a1d-8869-7c0a86a37bf1""isScheduled": false,
        "applicationId": "5f814909-01ea-4395-96ee-5ba7614128fcschedulerFrequency": "{\"cronSchedule\":\"0 0 0/1 ? * * *\"}",
        "nameworkflowTemplateId": "FTP Server"null,
        "tagTextisCustomizedStructure": "N-FTP Server"false,
        "descriptionaccountId": "File upload and download6fa122e4-0d4c-4a1d-8869-7c0a86a37bf1",
        "isAuthenticatedorganizationId": true"00000000-0000-0000-0000-000000000001",
        "isOAuthAppdateCreated": false"2022-03-24T18:08:22.2543998",
        "dateModified": "2022-0204-01T1512T10:3336:4956.9987294478261",
        "dateTimeUtcAuthenticateddateLastRun": "2022-0204-01T1512T10:3336:49.991922657.877+00:00",
        "dateTimeForReAuthdateNextSchedule": "2022-0204-01T15:33:49.991922605T17:00:00+00:00",
        "sessionTimeMinsregApplicationIds": 0, [
            "sessionSlidingExpiry": false,281686d9-aedd-4359-89b4-8f878ad43b35",
            "faulted": false03548816-f945-4bb2-b66e-950dff826fb8"
        }],
]

Workflows

Returns list of registered workflows

Expand

title	GET 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

title	Response (status 200)

Code Block

language	json

[
        "currentBlock": 3
    },
    {
        "id": "ef7a56e6a78cee1b-448fadca-47874777-b58d9261-47b063d6e983f86e4640e7db",
        "name": "Quinyx Employee Export Into FTP(CSV)QuinyxRandom",
        "description": "Quinyx Employee Export Into FTP(CSV)random",
        "status": "Ready",
        "isScheduled": falsetrue,
        "schedulerFrequency": "{ \"cronSchedule\": \"0 0 *2,6 ? * TUE *\"}",
        "workflowTemplateId": "bbe52876-aca2-4ece-ba31-11e0d98ddc19"null,
        "isCustomizedStructure": truefalse,
        "accountId": "6fa122e4-0d4c-4a1d-8869-7c0a86a37bf1",
        "organizationId": "00000000-0000-0000-0000-000000000001",
        "dateCreated": "20222021-0204-22T1502T08:2933:2215.35252093238045",
        "dateModified": "2022-04-13T0612T10:3019:5650.26250762024988",
        "dateLastRun": "2022-04-12T1026T06:3500:32.731+00:00",28.976+00:00",
        "dateNextSchedule": "2022-05-03T02:00:00+00:00",
        "regApplicationIds": [
            "1710ff47-f590-43db-b0de-015676e99615"
        "dateNextSchedule": null],
        "regApplicationIdscurrentBlock": [3
    },
    {
        "id": "1710ff474fb07016-f5906a38-43db4031-b0de83d7-015676e996152cd70af024d9",
            "fa2ee993-03cf-4baf-a8a0-684e92e74ded""name": "BigResponse",
        ] "description": "BigResponse",
        "currentBlockstatus": 5"Ready",
      },  "isScheduled": false,
 {       "schedulerFrequency": "{ \"idcronSchedule\": "b459cf22-ad18-44bf-80dc-6e8b78be1cc5\"0 0 * ? * *\"}",
        "nameworkflowTemplateId": "Order transferring"null,
        "descriptionisCustomizedStructure": "Transfer orders from MyStore into Tripletex invoices with paymentsfalse,
        "accountId": "6fa122e4-0d4c-4a1d-8869-7c0a86a37bf1",
        "statusorganizationId": "Ready00000000-0000-0000-0000-000000000001",
        "isScheduleddateCreated": false"2021-10-29T14:12:42.4563685",
        "schedulerFrequencydateModified": "{\"cronSchedule\":\"0 0 0/1 ? * * *\"}"2022-02-01T09:58:53.506504",
        "dateLastRun": "2021-11-26T16:35:57.573+00:00",
        "workflowTemplateIddateNextSchedule": null,
        "isCustomizedStructureregApplicationIds": false[],
        "accountIdcurrentBlock": "6fa122e4-0d4c-4a1d-8869-7c0a86a37bf1",0
    },
   "organizationId": "00000000-0000-0000-0000-000000000001", {
        "dateCreatedid": "2022-03-24T18:08:22.25439988d85eb13-9663-4ac7-8502-46c5d38f9c1e",
        "dateModifiedname": "2022-04-12T10:36:56.478261SpecialSymbols",
        "dateLastRundescription": "2022-04-12T10:36:57.877+00:00SpecialSymbols",
        "dateNextSchedule": "2022-04-05T17:00:00+00:00status": "Ready",
        "regApplicationIdsisScheduled": [false,
        "schedulerFrequency": "{ \"cronSchedule\":  "281686d9-aedd-4359-89b4-8f878ad43b35",
   \"0 0 * ? * *\"}",
        "03548816-f945-4bb2-b66e-950dff826fb8"workflowTemplateId": null,
        ]"isCustomizedStructure": false,
        "currentBlockaccountId": 3"6fa122e4-0d4c-4a1d-8869-7c0a86a37bf1",
    },     {"organizationId": "00000000-0000-0000-0000-000000000001",
        "iddateCreated": "a78cee1b2021-adca-4777-9261-f86e4640e7db09-15T14:55:20.4327369",
        "namedateModified": "QuinyxRandom2022-02-01T09:56:16.9089015",
        "descriptiondateLastRun": "random2021-09-15T14:59:02.95+00:00",
        "statusdateNextSchedule": "Ready"null,
        "isScheduledregApplicationIds": true,
  [
     "schedulerFrequency": "{\"cronSchedule\":\"0 0 2,6 ? * TUE *\"}","dbdd41cf-28de-4d2d-9771-7105c2165bcf"
        "workflowTemplateId": null],
        "isCustomizedStructurecurrentBlock": false,1
    },
   "accountId": "6fa122e4-0d4c-4a1d-8869-7c0a86a37bf1", {
        "organizationIdid": "00000000f01eccf9-0000f56c-0000420a-00009da3-000000000001e938291514e8",
        "dateCreatedname": "2021-04-02T08:33:15.3238045Random",
        "dateModifieddescription": "2022-04-12T10:19:50.2024988Random",
        "dateLastRunstatus": "2022-04-26T06:00:28.976+00:00Ready",
        "dateNextScheduleisScheduled": "2022-05-03T02:00:00+00:00"false,
        "regApplicationIdsschedulerFrequency": [
            "1710ff47-f590-43db-b0de-015676e99615"
        ]"{\"cronSchedule\":\"0 0 0/1 ? * * *\"}",
        "currentBlockworkflowTemplateId": 3null,
    },     {"isCustomizedStructure": false,
        "idaccountId": "4fb070166fa122e4-6a380d4c-40314a1d-83d78869-2cd70af024d97c0a86a37bf1",
        "nameorganizationId": "BigResponse00000000-0000-0000-0000-000000000001",
        "descriptiondateCreated": "BigResponse2021-03-31T09:09:31.1665459",
        "statusdateModified": "Ready2021-11-26T16:37:10.8509085",
        "isScheduled": false,
        "schedulerFrequency": "{ \"cronSchedule\": \"0 0 * ? * *\"}dateLastRun": "2021-11-26T16:37:12.128+00:00",
        "workflowTemplateIddateNextSchedule": null"2021-09-20T11:00:00+00:00",
        "isCustomizedStructureregApplicationIds": [
false,           "accountId": "6fa122e41c08aaa2-0d4c52ae-4a1d4e74-8869bb9d-7c0a86a37bf1"108f6f36b8a8"
        ],
        "organizationIdcurrentBlock": "00000000-0000-0000-0000-000000000001",4
        "dateCreated": "2021-10-29T14:12:42.4563685",
        "dateModified": "2022-02-01T09:58:53.506504",
   }
]

Workflow (get)

Returns registered workflow by id

Expand

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

Headers:

Consumer:5D1AEF05263B497182992E324517FFFD0FED85FBEC2342B19CE02AB5ED62D6ED

SecretKey:a5ae515d-d53b-478c-90bd-060c616d37b7

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

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

title	Response (status 200)

Code Block

language	json

{
    "dateLastRunid": "2021-11-26T16:35:57.573+00:00",
 b459cf22-ad18-44bf-80dc-6e8b78be1cc5",
      "dateNextSchedulename": "Order nulltransferring",
    "description": "Transfer orders from "regApplicationIds": [],
   MyStore into Tripletex invoices with payments",
    "currentBlockstatus": 0"Ready",
    }"isScheduled": false,
    "schedulerFrequency": "{\"cronSchedule\":\"0 0 0/1 ? * *    "id": "8d85eb13-9663-4ac7-8502-46c5d38f9c1e",
   *\"}",
    "nameworkflowTemplateId": "SpecialSymbols"null,
    "isCustomizedStructure": false,
    "descriptionaccountId": "SpecialSymbols6fa122e4-0d4c-4a1d-8869-7c0a86a37bf1",
   
    "statusorganizationId": "Ready00000000-0000-0000-0000-000000000001",
        "isScheduleddateCreated": false,
"2022-03-24T18:08:22.2543998",
       "schedulerFrequencydateModified": "{ \"cronSchedule\": \"0 0 * ? * *\"}",
   2022-04-12T10:36:56.478261",
    "dateLastRun": "2022-04-12T10:36:57.877+00:00",
    "workflowTemplateIddateNextSchedule": null,
"2022-04-05T17:00:00+00:00",
       "isCustomizedStructureregApplicationIds": false,[
        "accountId": "6fa122e4-0d4c-4a1d-8869-7c0a86a37bf1281686d9-aedd-4359-89b4-8f878ad43b35",
        "organizationId": "00000000-0000-0000-0000-000000000001",03548816-f945-4bb2-b66e-950dff826fb8"
    ],
    "dateCreatedcurrentBlock": "2021-09-15T14:55:20.4327369",
 3
}

Workflow (post)

Registers a new workflow based on template

Expand

title	POST https://<base-url>/Workflow

Body JSON structure:

AddWorkflowApiDto

Body example:

Code Block

language	json

{   
   "dateModifiedworkflowTemplateId": "2022-02-01T09:56:16.9089015",
    bbe52876-aca2-4ece-ba31-11e0d98ddc19",
   "dateLastRunname": "2021-09-15T14:59:02.95+00:00",
    Test Quinyx Employee Export Into FTP(CSV)",
   "dateNextScheduleapplications": null,
        "regApplicationIds": [
            "dbdd41cf-28de-4d2d-9771-7105c2165bcf"
   {"QUIN":"e3320a16-4b20-4e33-840f-2f5d28e3e1ca", "FTP":"0741b73d-2b13-4a4a-a0c2-2ffad9548e06"},
   "chain":[
    ],        {
"currentBlock": 1     },     {         "iduniqueBlockId": "f01eccf902d1424a-f56cda90-420a4c12-9da39c28-e938291514e896162e624bd7",
        "name": "Random",         "descriptionvariables": "Random", {
          "status": "Ready",         "isScheduledapiKeys": false,["xxxx-xxxx-xxxx-xxxx"],
             "schedulerFrequency": "{\"cronSchedule\":\"0 0 0/1 ? * * *\"}badgeNo",: null
       "workflowTemplateId": null,        }
"isCustomizedStructure": false,         "accountId": "6fa122e4-0d4c-4a1d-8869-7c0a86a37bf1",
 }
       "organizationId": "00000000-0000-0000-0000-000000000001",
 ]
}        "dateCreated": "2021-03-31T09:09:31.1665459",
        "dateModified": "2021-11-26T16:37:10.8509085",
        "dateLastRun": "2021-11-26T16:37:12.128+00:00",

Headers:

Consumer:5D1AEF05263B497182992E324517FFFD0FED85FBEC2342B19CE02AB5ED62D6ED

SecretKey:a5ae515d-d53b-478c-90bd-060c616d37b7

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

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

title	Response (status 200)

Code Block

language	json

"0fdfd78c-258f-49ed-9e8c-faef9d6598fa"

Expand

title	Response (status 401)

Status Code: 401; Unauthorized

Expand

title	Response (status 500)

Code Block
{ "dateNextScheduleState": "2021-09-20T11:00:00+00:00", 500, "regApplicationIdsMsg": ["Unknown workflow "1c08aaa2-52ae-4e74-bb9d-108f6f36b8a8" ], "currentBlock": 4 } ]

Workflow

...

template 1be52876-aca2-4ece-ba31-11e0d98ddc19"
}

DeleteWorkflow

Removes workflow by Id

Headers:

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

Authorization:Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIyMDAxZDFlZS1jOWUxLTRhMDctOTZkNi1hNTMyNGEzMjczY2UiLCJpc3MiOiJodHRwOi8vY2FudmFzdGVzdC5jb25uZWN0bXlhcHBzLmNvbSIsImlhdCI6MTY1MTA2ODk2OSwiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvZW1haWxhZGRyZXNzIjoibmF0YWxpYS55dWRuaWtvdmFAb3V0bG9vay5jb20iLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3VzZXJkYXRhIjoiNmZhMTIyZTQtMGQ0Yy00YTFkLTg4NjktN2MwYTg2YTM3YmYxIiwiaHR0cDovL3NjaGVtYXMubWljcm9zb2Z0LmNvbS93cy8yMDA4LzA2L2lkZW50aXR5L2NsYWltcy9yb2xlIjoiQWRtaW4iLCJMb2dnZWRTdXBwb3J0ZWRCeUNtYSI6IlRydWUiLCJNYW5hZ2VkU3VwcG9ydGVkQnlDbWEiOiJUcnVlIiwiZXhwIjoxNjUxMDY5NTY5LCJhdWQiOiJjbWEtdXNlcnMifQ.v2Tbnw4bKuQSMAjtj36eVjrcMoE1vH93C6axpN9Y4wE

Expand

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

DeleteWorkflow/7b2dee52-5781-49bf-9895-d6d2b2b43e2c

Headers:

Consumer:5D1AEF05263B497182992E324517FFFD0FED85FBEC2342B19CE02AB5ED62D6ED

SecretKey:a5ae515d-d53b-478c-90bd-060c616d37b7

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

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

title	Response (status 200)

Code Block

language	json

{
    "id": "b459cf22-ad18-44bf-80dc-6e8b78be1cc5",
    "name": "Order transferring",
    "description": "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": "2022-03-24T18:08:22.2543998",
    "dateModified": "2022-04-12T10:36:56.478261",
    "dateLastRun": "2022-04-12T10:36:57.877+00:00",
    "dateNextSchedule": "2022-04-05T17:00:00+00:00",
    "regApplicationIds": [
        "281686d9-aedd-4359-89b4-8f878ad43b35",
        "03548816-f945-4bb2-b66e-950dff826fb8"
    ],
    "currentBlock": 3
}

RegApplication

...

true

Expand

title	Response (status 401)

Status Code: 401; Unauthorized

RunWorkflow

Runs workflow or needed blocks

Expand

title	POST https://<base-url>/RunWorkflow

Body JSON structure:

RunMetadataApiDto

Body example 1 for running by default:

Code Block

language	json

{   
   "workflowId": "0fdfd78c-258f-49ed-9e8c-faef9d6598fa"
}

Body example 2 for running from start till block #2:

Code Block

language	json

{   
   "workflowId": "0fdfd78c-258f-49ed-9e8c-faef9d6598fa",
   "runTillBlock": 2
}

Body example 3 for running of blocks between #2 and #4:

Code Block

language	json

{   
   "workflowId": "0fdfd78c-258f-49ed-9e8c-faef9d6598fa",
   "runFromBlock": 2,
   "runTillBlock": 4 
}

Headers:

Consumer:5D1AEF05263B497182992E324517FFFD0FED85FBEC2342B19CE02AB5ED62D6ED

SecretKey:a5ae515d-d53b-478c-90bd-060c616d37b7

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

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

title	Response (status 200)

Code Block

language	json

Workflow will now run

Expand

title	Response (status 401)

Status Code: 401; Unauthorized

WorkflowScheduler

Sets ON/OFF a workflow scheduler. The scheduler frequency should be set in CRON format.

Expand

title	POST https://<base-url>/RegApplicationWorkflowScheduler

Body typeJSON structure:

AddRegApplicationApiDtoUpdateWorkfowSchedulerApiDto

Body example:

Code Block

language	json

{   
   "applicationIdworkflowId": "97cbc3b30fdfd78c-32c7258f-4e4a49ed-b7889e8c-a332ea82aefffaef9d6598fa",

   "tagTextisScheduled": "Quinyx 2022-04-28",
 true,
   "credentialsJsonscheduleFrequency": "{\"apikeycronSchedule\":\"01d6-3e54-cff2-c7d8\",\"environment\": \"test\"0 0/5 * ? * * *\"}"
}

Headers:

Consumer:5D1AEF05263B497182992E324517FFFD0FED85FBEC2342B19CE02AB5ED62D6ED

SecretKey:a5ae515d-d53b-478c-90bd-060c616d37b7

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

title	Response (status 200)

"eea37d64-5a93-478c-8216-6231c0a37f0a"

Code Block

language	json

Workflow Scheduler enabled

or

Code Block
Workflow Scheduler disabled

Expand

title	Response (status 401)

Status Code: 401; Unauthorized

Versions Compared

Old Version 35

New Version Current

Key

GetMetaData

IP restriction

Authentication

Describe

APIs for help

GetMetaData

Describe

APIs for organization administration

Accounts

Authentication

Refresh token

Delete authentication tokens

Applications

Account

Application APIs

Applications

WorkflowTemplates

RegApplications

RegApplication

Workflow APIs

WorkflowTemplates

Clients

RegApplications

Workflows

Workflows

Workflow (get)

Workflow (post)

Workflow

DeleteWorkflow

RegApplication

RunWorkflow

WorkflowScheduler

Page Comparison

Versions Compared

Old Version 35

New Version Current

Key

GetMetaData

IP restriction

Authentication

Describe

APIs for help

GetMetaData

Describe

APIs for organization administration

Accounts

Authentication

Refresh token

Delete authentication tokens

Applications

Account

Application APIs

Applications

WorkflowTemplates

RegApplications

RegApplication

Workflow APIs

WorkflowTemplates

Clients

RegApplications

Workflows

Workflows

Workflow (get)

Workflow (post)

Workflow

DeleteWorkflow

RegApplication

RunWorkflow

WorkflowScheduler