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)

[ { "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": "" } ]

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	Response (status 200)

Code Block

language	json

[
    {
        "typeName": "guid",
        "propertyName": "workflowTemplateId",
        "genericParameters": "",
        "isRequired": true
    },
    {
        "typeName": "string",
        "propertyName": "name",
        "genericParameters": "",
        "isRequired": truefalse
    },
    {
        "typeName": "string",
        "propertyName": "description",
        "genericParameters": "",
        "isRequired": false
    },
    {
        "typeName": "dictionary",
        "propertyName": "applications",
        "genericParameters": "string,guid",
        "isRequired": true
    },
    {
        "typeName": "iEnumerable",
        "propertyName": "chain",
        "genericParameters": "chainApiDto",
        "isRequired": false
    }
]

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. 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:

...

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

Headers:

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

[
    {
  "access_token      "id": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzYzI4YjFkYy05ZDA1LTQ5ZDgtYTMyNC1kNGI2N2IxYTg3MmQiLCJpc3MiOiJodHRwOi8vY2FudmFzdGVzdC5jb25uZWN0bXlhcHBzLmNvbSIsImlhdCI6MTY1MTA2ODA4MiwiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvZW1haWxhZGRyZXNzIjoibmF0YWxpYS55dWRuaWtvdmFAb3V0bG9vay5jb20iLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3VzZXJkYXRhIjoiNmZhMTIyZTQtMGQ0Yy00YTFkLTg4NjktN2MwYTg2YTM3YmYxIiwiaHR0cDovL3NjaGVtYXMubWljcm9zb2Z0LmNvbS93cy8yMDA4LzA2L2lkZW50aXR5L2NsYWltcy9yb2xlIjoiQWRtaW4iLCJMb2dnZWRTdXBwb3J0ZWRCeUNtYSI6IlRydWUiLCJNYW5hZ2VkU3VwcG9ydGVkQnlDbWEiOiJUcnVlIiwiZXhwIjoxNjUxMDY4OTgxLCJhdWQiOiJjbWEtdXNlcnMifQ.SllrAi0m1DR__9tYuSZJ4-qTk3pnxEi2G5vs6_cSvCE", "41a31538-1120-4bdf-a6cb-675eeedd7d2d",
        "accessTokenExpiresDateTimefirstName": "2022-04-27T14:16:21.9458102+00:00", "Nathan",
        "lastName": "Bray",
        "refresh_tokenemail": "6ed6d7ba271d43a0843f8f363fe27279 "nathan.bray@connectmyapps.com",
            "refreshTokenExpiresDateTimeorganizationId": "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

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

[
    { "00000000-0000-0000-0000-000000000000",
        "organizationName": "CMA Customer Bench",
        "roleId": "349889ad-4277-42d0-a268-5cd27230cfc5",
        "role": "User",
        "dateCreated": "2020-05-07T19:10:36.69"
    },
    {
        "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": "",
                "idOptional": "41a31538-1120-4bdf-a6cb-675eeedd7d2d"false,
        "firstName": "Nathan",         "lastNameDesc": "BrayTalentsoft client ID.",
        "email": "nathan.bray@connectmyapps.com",         "organizationIdHidden": "00000000-0000-0000-0000-000000000000", false
         "organizationName": "CMA Customer Bench"},
        "roleId": "349889ad-4277-42d0-a268-5cd27230cfc5",   {
     "role": "User",         "dateCreated": "2020-05-07T19:10:36.69"
ShortName": "client_secret",
   },
    {         "idName": "18cc3b9f-c14e-4c7d-892b-7cc5545abac0Client secret",
        "firstName": "Igor",
        "lastNameType": "Kostiantext",
        "email": "igor.kostian@connectmyapps.com",
        "organizationIdValue": "00000000-0000-0000-0000-000000000001",

       "organizationName": "ConnectMyApps AS",         "roleIdOptional": "9c525665-df99-4aee-9e52-1a55853db03b"false,
        "role": "Admin",
        "dateCreatedDesc": "2017-03-01T08:51:32.31"
 Talentsoft client secret.",
  },     {         "idHidden": "a305c3a2-cba5-4554-bb5d-ab7fcd5b4a4c",false
         "firstName": "Luke",  }
      "lastName": "Buckley"  ],
        "emailcredentialsJson": "luke.buckley@connectmyapps.com",{
            "organizationIdbaseUrl": "00000000-0000-0000-0000-000000000000",null,
            "organizationNameclient_id": null,
 "CMA Customer Bench",         "roleIdclient_secret": "9c525665-df99-4aee-9e52-1a55853db03b" null
        },
        "roletag": "Admin "Hr, Premium",
        "dateCreatedsessionTimeMins": "2013-06-01T18:56:22.763" 0,
       }
]

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

[ "sessionSlidingExpiry": false
    },
    {
        "id": "07ffd13d97cbc3b3-ba5732c7-4d1b4e4a-9c46b788-03c5c919eed0a332ea82aeff",
        "name": "TalentsoftQuinyx",
        "shortName": "TASOQUIN",
        "description": "HRWorkforce planning",
        "vendorUrl": "httpshttp://www.talentsoftquinyx.com/",
        "credentialFields": [
            {
                "ShortName": "baseUrlapikey",
                "Name": "BaseAPI urlkey",
                "Type": "text",
                "Value": "",
                "Optional": false,
                "Desc": "TalentsoftYour Quinyx API url.key",
                "Hidden": false
            },
            {
                "ShortName": "client_idenvironment",
                "Name": "Client IDEnvironment",
                "Type": "textselect",
                "Value": "",
                "Options": "live|Live Environment,test|Test Environment",
                "Optional": false,
                "Desc": "Talentsoft client ID "Choose which Quinyx environment you wish to use, live or test.",
                "Hidden": false
            },
        ],
     {   "credentialsJson": {
            "ShortNameapikey": "client_secret"null,
                "Nameenvironment": "Clientnull
secret",        },
        "Typetag": "textScheduling,Planning,Premium",
        "sessionTimeMins": 0,
        "ValuesessionSlidingExpiry": false
"",    },
	...,
    {
        "Optionalid": false"b5a4a9ed-a686-4b1e-af30-ffd84b7fb2e0",
                "Desc"name": "Talentsoft client secret.Talent Manager",
                "Hidden"shortName": false"HRTM",
        "description": "HR solution",
 }         ]"vendorUrl": "http://www.hr-manager.net",
        "credentialsJsoncredentialFields": [
  {          {
  "baseUrl": null,             "client_idShortName": null,"customeralias",
                "client_secretName": null"Customer alias",
       },         "tagType": "Hr, Premiumtext",

       "sessionTimeMins": 0,         "sessionSlidingExpiryValue": false"",
    },
    {         "idOptional": "97cbc3b3-32c7-4e4a-b788-a332ea82aeff"false,
        "name": "Quinyx",         "shortNameDesc": "QUINYour customer alias.",
 
      "description": "Workforce planning",         "vendorUrlHidden": "http://www.quinyx.com",false
           "credentialFields": [ },
            {
                "ShortName": "apikey",
                "Name": "Your API key",
                "Type": "text",
                "Value": "",
                "Optional": false,
                "Desc": "Your Quinyx API key.",
                "Hidden": false
            },
            {
      ],
         "ShortNamecredentialsJson": "environment",
   {
            "Namecustomeralias": "Environment"null,

               "Typeapikey": "select",null
                "Value": "",
       },
        "Optionstag": "HR"live|Live Environment,test|Test Environment",,
        "sessionTimeMins": 0,
        "OptionalsessionSlidingExpiry": false,

    }
]

Expand

title	Response (status 401)

Returned if the Authorization is incorrect or missing.

RegApplications

Returns account registerred applications

Expand

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

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

[
      {
        "Descid": "Choose which Quinyx environment you wish to use, live or test.",
                "Hidden": false
            }
        ]1710ff47-f590-43db-b0de-015676e99615",
        "credentialsJsonshortName": {"QUIN",
            "apikeyaccountId": null,
"6fa122e4-0d4c-4a1d-8869-7c0a86a37bf1",
           "environmentapplicationId": null
        }"97cbc3b3-32c7-4e4a-b788-a332ea82aeff",
        "tagname": "Scheduling,Planning,PremiumQuinyx",
        "sessionTimeMinstagText": 0"N-Quinyx",
        "sessionSlidingExpirydescription": false"Workforce planning",
   }, 	...,     {"isAuthenticated": true,
        "idisOAuthApp": "b5a4a9ed-a686-4b1e-af30-ffd84b7fb2e0"false,
        "namedateModified": "Talent Manager2022-04-19T15:56:22.1133746",
        "shortNamedateTimeUtcAuthenticated": "HRTM2022-04-19T15:56:22.0345429",
        "descriptiondateTimeForReAuth": "HR solution2022-04-19T15:56:22.0345429",
        "vendorUrlsessionTimeMins": "http://www.hr-manager.net"0,
        "credentialFieldssessionSlidingExpiry": [false,
        "faulted": false
  {  },
     {
        "ShortNameid": "customeraliasd2698be7-9f12-44b1-8e6d-0494436538a8",
    
           "NameshortName": "Customer aliasMSQL",
     
          "TypeaccountId": "text",
       6fa122e4-0d4c-4a1d-8869-7c0a86a37bf1",
        "ValueapplicationId": "276511d9-f07f-4fa6-b109-fdb4d62b2429",
       
        "Optionalname": false,"Microsoft      SQL On-premise",
          "DesctagText": "YourN-Microsoft customer alias.",
       SQL On-premise",
        "Hiddendescription": false"Database engine",
           }"isAuthenticated": true,
        "isOAuthApp": false,
  {      "dateModified": "2021-09-06T13:30:11.2590869",
         "ShortNamedateTimeUtcAuthenticated": "apikey2021-04-14T10:27:22.1672672",
        "dateTimeForReAuth": "2021-04-14T10:27:22.1672672",
        "NamesessionTimeMins": "Your0,
API key",       "sessionSlidingExpiry": false,
        "Typefaulted": false
"text",    },
    {
        "Valueid": "dbdd41cf-28de-4d2d-9771-7105c2165bcf",
       
        "OptionalshortName": false,
       "CMAF",
        "DescaccountId": "Your API key.6fa122e4-0d4c-4a1d-8869-7c0a86a37bf1",
                "Hidden"applicationId": false"9b6a04b3-c91f-4255-9033-6ac7b7a6f935",
        "name": "File Hub",
 }       "tagText": "File ]Hub",
        "credentialsJsondescription": {"File automation",
           "customeraliasisAuthenticated": nulltrue,
 
          "apikeyisOAuthApp": nullfalse,
        }"dateModified": "2022-04-20T14:00:27.1912258",
        "tagdateTimeUtcAuthenticated": "HR"null,
        "sessionTimeMinsdateTimeForReAuth": 0null,
        "sessionSlidingExpirysessionTimeMins": false0,
    }
]

Expand

title	Response (status 401)

Returned if the Authorization is incorrect or missing.

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

[    "sessionSlidingExpiry": false,
        "faulted": false
    },
    {
        "id": "1710ff47a067c363-f5907339-43db4fed-b0deb1ad-015676e99615efafd7603986",
        "shortName": "QUINFTP",
        "accountId": "6fa122e4-0d4c-4a1d-8869-7c0a86a37bf1",
        "applicationId": "97cbc3b35f814909-32c701ea-4e4a4395-b78896ee-a332ea82aeff5ba7614128fc",
        "name": "QuinyxFTP Server",
        "tagText": "N-QuinyxFTP Server",
        "description": "Workforce planningFile upload and download",
        "isAuthenticated": true,
        "isOAuthApp": false,
        "dateModified": "2022-0402-19T1501T15:5633:2249.11337469987294",
        "dateTimeUtcAuthenticated": "2022-0402-19T1501T15:5633:2249.03454299919226",
        "dateTimeForReAuth": "2022-0402-19T1501T15:5633:2249.03454299919226",
        "sessionTimeMins": 0,
        "sessionSlidingExpiry": false,
        "faulted": false
    },
    {
        "id": "d2698be7-9f12-44b1-8e6d-0494436538a8",
   ]

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

{
    "shortNameapplicationId": "MSQL97cbc3b3-32c7-4e4a-b788-a332ea82aeff",
   
    "accountIdtagText": "6fa122e4Quinyx 2022-0d4c-4a1d-8869-7c0a86a37bf104-28",
        "applicationId": "276511d9-f07f-4fa6-b109-fdb4d62b2429",
        "name": "Microsoft SQL On-premise",
 "credentialsJson": "{\"apikey\":\"01d6-3e54-cff2-c7d8\",\"environment\": \"test\"}"
}

Body example 2:

Code Block

language	json

{
      "tagTextapplicationId": "N-Microsoft SQL On-premise",
   5f814909-01ea-4395-96ee-5ba7614128fc",
    "descriptiontagText": "Database engineFTP 2022-05-03",
        "isAuthenticated"credentialsJson": "{\"username\": true,
        "isOAuthAppnull,\"password\": false,
        "dateModifiednull,\"port\": "2021-09-06T13:30:11.2590869",
        "dateTimeUtcAuthenticated": "2021-04-14T10:27:22.1672672",
        "dateTimeForReAuth": "2021-04-14T10:27:22.1672672",
        "sessionTimeMins": 0,
        "sessionSlidingExpiry": false,
        "faulted": false
    },
    {
        "id": "dbdd41cf-28de-4d2d-9771-7105c2165bcf",
        "shortName": "CMAF",null,\"address\": null,\"secure\": 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

[
    {
        "accountIdid": "6fa122e4bbe52876-0d4caca2-4a1d4ece-8869-7c0a86a37bf1",
        "applicationId": "9b6a04b3-c91f-4255-9033-6ac7b7a6f935ba31-11e0d98ddc19",
        "name": "File HubQuinyx Employee Export Into FTP(CSV)",
        "tagTextdescription": "File HubQuinyx Employee Export Into FTP(CSV)",
        "descriptiondateCreated": "File automation2020-08-14T17:12:29.7856246",
        "isAuthenticateddateModified": true"2022-03-17T13:54:07.0394189",
        "isOAuthAppstate": false"Published",
        "dateModifiedversion": "2022-04-20T14:00:27.19122580.1.7",
        "dateTimeUtcAuthenticateddraftIsCommitted": nullfalse,
        "dateTimeForReAuthdateCommitted": null"2021-02-26T16:51:29.3588575",
        "sessionTimeMinsorganizationId": 0null,
        "sessionSlidingExpiryapplications": false,
  [
     "faulted": false     },  "QUIN",
  {         "id": "a067c363-7339-4fed-b1ad-efafd7603986",FTP"
        "shortName": "FTP"],
        "accountIdchain": "6fa122e4-0d4c-4a1d-8869-7c0a86a37bf1",[
        "applicationId": "5f814909-01ea-4395-96ee-5ba7614128fc",   {
     "name": "FTP Server",         "tagTextuniqueBlockId": "N-FTP Server02d1424a-da90-4c12-9c28-96162e624bd7",
        "description": "File upload and download",
        "isAuthenticatedblockName": true,"API - Get Employees",
     "isOAuthApp": false,           "dateModifiedvariables": "2022-02-01T15:33:49.9987294", {
          "dateTimeUtcAuthenticated": "2022-02-01T15:33:49.9919226",         "dateTimeForReAuthapiKeys": "2022-02-01T15:33:49.9919226",[],
          "sessionTimeMins": 0,         "sessionSlidingExpirybadgeNo": null
false,          "faulted": false     },
]

RegApplication

Registers a new application and returns Id

Expand

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

Expand

title	Response (status 200)

Body JSON structure:

AddRegApplicationApiDto

Body example 1:

Code Block

language	json

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

Body example 2:

Code Block

language	json

{{
                "uniqueBlockId": "25782580-aabe-4a03-be1c-bc45dacd7e60",
        "applicationId": "5f814909-01ea-4395-96ee-5ba7614128fc",        "tagTextblockName": "FTP 2022-05-03Upload",
                "credentialsJsonvariables": "{\"username\":
null,\"password\": null,\"port\": null,\"address\": null,\"secure\": true}"
}

Headers:

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

Authorization:Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIyMDAxZDFlZS1jOWUxLTRhMDctOTZkNi1hNTMyNGEzMjczY2UiLCJpc3MiOiJodHRwOi8vY2FudmFzdGVzdC5jb25uZWN0bXlhcHBzLmNvbSIsImlhdCI6MTY1MTA2ODk2OSwiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvZW1haWxhZGRyZXNzIjoibmF0YWxpYS55dWRuaWtvdmFAb3V0bG9vay5jb20iLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3VzZXJkYXRhIjoiNmZhMTIyZTQtMGQ0Yy00YTFkLTg4NjktN2MwYTg2YTM3YmYxIiwiaHR0cDovL3NjaGVtYXMubWljcm9zb2Z0LmNvbS93cy8yMDA4LzA2L2lkZW50aXR5L2NsYWltcy9yb2xlIjoiQWRtaW4iLCJMb2dnZWRTdXBwb3J0ZWRCeUNtYSI6IlRydWUiLCJNYW5hZ2VkU3VwcG9ydGVkQnlDbWEiOiJUcnVlIiwiZXhwIjoxNjUxMDY5NTY5LCJhdWQiOiJjbWEtdXNlcnMifQ.v2Tbnw4bKuQSMAjtj36eVjrcMoE1vH93C6axpN9Y4wE

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

Expand

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.

WorkflowTemplates

Returns list of workflow templates provided by CMA and your organization

Expand

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

Code Block

language	json

[                 "filename": "NY_Employees_{date:yyyy-MM-dd-HH-mm}",
                    "fileformat": "csv",
                    "filepath": "/"
                }
            }
        ]
    },
    {
        "id": "bbe528763b76ca61-aca2bca9-4ece4995-ba3190ba-11e0d98ddc197190c1dd567b",
        "name": "QuinyxMyStore EmployeeCustomers Export Into FTP(CSV)Send email",
        "description": "QuinyxMyStore EmployeeCustomers Export Into FTP(CSV)Send email",
        "dateCreated": "20202021-0811-14T1708T11:1239:2958.7856246814",
        "dateModified": "20222021-0311-17T1309T15:5414:0714.0394189836809",
        "state": "Published",
        "version": "0.10.7",
        "draftIsCommitted": falsetrue,
        "dateCommitted": "2021-0211-26T1609T15:5114:2918.35885756103605",
        "organizationId": null,
        "applications": [
            "QUINMYST2",
            "FTPCMAF"
        ],
        "chain": [
            {
                "uniqueBlockId": "02d1424a-da90-4c12-9c28-96162e624bd7",
                "blockName": "API - Get Employees",,
        "chain": [
       "variables": {    {
                "apiKeysuniqueBlockId": []"729e4eb5-8022-43bb-b75b-524b1cb5f5b5",
                "blockName": "MyStore Get  Customers"badgeNo":,
null                "variables": {}
            },
            {
                "uniqueBlockId": "25782580a510ddbf-aabe2350-4a034ab6-be1c9014-bc45dacd7e60c81d0aa3f013",
                "blockName": "FTPSend Uploademail",
                "variables": {
                    "filenamesubject": "NY_Employees_{date:yyyy-MM-dd-HH-mm}MyStore Customers",
                    "fileformatfileName": "csvAllCustomers",
                    "filepathnote": "/Please see your customers in MyStore"
                }
            }
        ]
    },
    {
        "id": "3b76ca61018fda95-bca9a62f-49954f0b-90baaf12-7190c1dd567b3cfcd9146def",
        "name": "MyStoreTransferring of CustomersOrders Send& emailCustomers",
        "description": "MyStoreTransferring of CustomersOrders Send& emailCustomers",
        "dateCreated": "20212020-1108-08T1114T17:3922:5857.8142244016",
        "dateModified": "20212020-1112-09T1510T13:1402:1423.8368091685229",
        "state": "PublishedDraft",
        "version": "0.0.7"null,
        "draftIsCommitted": truenull,
        "dateCommitted": null,
        "organizationId"2021-11-09T15:14:18.6103605: null,
        "applications": [
            "MYST2",
            "organizationId": nullFIKE"
        ],
        "applicationschain": [
            {
  "MYST2",              "CMAFuniqueBlockId": "a43e433d-9def-4062-9e89-6ff01824f980",
       ],         "chainblockName": [ "MyStore Get orders",
                "variables": {
                    "uniqueBlockIdstatus": "729e4eb5-8022-43bb-b75b-524b1cb5f5b52",
                "blockName": "MyStore Get Customers",
    "age": null
               "variables": {}
            },
            {
                "uniqueBlockId": "a510ddbfd362db53-2350c46f-4ab64cf8-90148bee-c81d0aa3f0139a105ecde130",
                "blockName": "SendGet all emailcontacts",
                "variables": {
                    "subjecttestValue": "MyStore Customers",name"
                }
     "fileName": "AllCustomers",      },
            {
 "note": "Please see your customers in MyStore"         "uniqueBlockId": "6cf1b697-4145-4659-985c-4c9b76a57710",
      }          "blockName": "Post orders }& customers",
       ]     },    "variables": {
          "id": "018fda95-a62f-4f0b-af12-3cfcd9146def",         "nameshippingtext": "Shipping"Transferring
of Orders & Customers",         "description": "Transferring of Orders &}
Customers",         "dateCreated": "2020-08-14T17:22:57.2244016",   }
     "dateModified": "2020-12-10T13:02:23.1685229",   ]
     "state": "Draft",}
]

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

[
        "version": null,{
        "draftIsCommittedid": null"ef7a56e6-448f-4787-b58d-47b063d6e983",
        "dateCommittedname": null,"Quinyx Employee Export       "organizationId": nullInto FTP(CSV)",
        "applicationsdescription": "Quinyx [Employee Export Into FTP(CSV)",
        "status": "MYST2Ready",
   
        "FIKEisScheduled"
        ]: false,
        "chainschedulerFrequency": [
            {
       "{ \"cronSchedule\": \"0 0 * ? * *\"}",
        "uniqueBlockIdworkflowTemplateId": "a43e433dbbe52876-9defaca2-40624ece-9e89ba31-6ff01824f98011e0d98ddc19",
        "isCustomizedStructure": true,
        "blockNameaccountId": "MyStore Get orders",6fa122e4-0d4c-4a1d-8869-7c0a86a37bf1",
        "organizationId": "00000000-0000-0000-0000-000000000001",
        "variablesdateCreated": {"2022-02-22T15:29:22.3525209",
        "dateModified": "2022-04-13T06:30:56.2625076",
          "statusdateLastRun": "22022-04-12T10:35:32.731+00:00",
        "dateNextSchedule": null,
          "ageregApplicationIds": [
 null           "1710ff47-f590-43db-b0de-015676e99615",
     }       "fa2ee993-03cf-4baf-a8a0-684e92e74ded"
       } ],
        "currentBlock": 5
  {  },
     {
        "uniqueBlockIdid": "d362db53b459cf22-c46fad18-4cf844bf-8bee80dc-9a105ecde1306e8b78be1cc5",
       
        "blockNamename": "GetOrder all contactstransferring",
        "description": "Transfer orders from MyStore into Tripletex invoices with payments"variables":,
{            "status": "Ready",
        "testValue": "nameisScheduled": false,
        "schedulerFrequency": "{\"cronSchedule\":\"0 0 0/1 ? * * *\"}",
            }"workflowTemplateId": null,
        "isCustomizedStructure": false,
  {        "accountId": "6fa122e4-0d4c-4a1d-8869-7c0a86a37bf1",
        "uniqueBlockIdorganizationId": "6cf1b69700000000-41450000-46590000-985c0000-4c9b76a57710000000000001",
        "dateCreated": "2022-03-24T18:08:22.2543998",
        "blockNamedateModified": "Post orders & customers",
      2022-04-12T10:36:56.478261",
         "variablesdateLastRun": {"2022-04-12T10:36:57.877+00:00",
        "dateNextSchedule": "2022-04-05T17:00:00+00:00",
          "shippingtextregApplicationIds": "Shipping"[
            "281686d9-aedd-4359-89b4-8f878ad43b35",
   }         "03548816-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:3228.731976+00:00",
        "dateNextSchedule": null"2022-05-03T02:00:00+00:00",
        "regApplicationIds": [
            "1710ff47-f590-43db-b0de-015676e99615",
            "fa2ee993-03cf-4baf-a8a0-684e92e74ded"
        ],
        "currentBlock": 53
    },
    {
        "id": "b459cf224fb07016-ad186a38-44bf4031-80dc83d7-6e8b78be1cc52cd70af024d9",
        "name": "Order transferringBigResponse",
        "description": "Transfer orders from MyStore into Tripletex invoices with payments"description": "BigResponse",
        "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": "20222021-0310-24T1829T14:0812:2242.25439984563685",
        "dateModified": "2022-0402-12T1001T09:3658:5653.478261506504",
        "dateLastRun": "2022-04-12T10:36:57.877+00:00",
        "dateNextSchedule": "2022-04-05T17:00:00+00:00",
        "regApplicationIds": [
            "281686d9-aedd-4359-89b4-8f878ad43b35": "2021-11-26T16:35:57.573+00:00",
        "dateNextSchedule": null,
  "03548816-f945-4bb2-b66e-950dff826fb8"         "regApplicationIds": [],
        "currentBlock": 30
    },
    {
        "id": "a78cee1b8d85eb13-adca9663-47774ac7-92618502-f86e4640e7db46c5d38f9c1e",
        "name": "QuinyxRandomSpecialSymbols",
        "description": "randomSpecialSymbols",
        "status": "Ready",
        "isScheduled": truefalse,
        "schedulerFrequency": "{ \"cronSchedule\": \"0 0 2,6* ? * TUE *\"}",
        "workflowTemplateId": null,
        "isCustomizedStructure": false,
        "accountId": "6fa122e4-0d4c-4a1d-8869-7c0a86a37bf1",
        "organizationId": "00000000-0000-0000-0000-000000000001",
        "dateCreated": "2021-0409-02T0815T14:3355:1520.32380454327369",
        "dateModified": "2022-0402-12T1001T09:1956:5016.20249889089015",
        "dateLastRun": "20222021-0409-26T0615T14:0059:2802.97695+00:00",
        "dateNextSchedule": "2022-05-03T02:00:00+00:00"null,
        "regApplicationIds": [
            "1710ff47dbdd41cf-f59028de-43db4d2d-b0de9771-015676e996157105c2165bcf"
        ],
        "currentBlock": 31
    },
    {
        "id": "4fb07016f01eccf9-6a38f56c-4031420a-83d79da3-2cd70af024d9e938291514e8",
        "name": "BigResponseRandom",
        "description": "BigResponseRandom",
        "status": "Ready",
        "isScheduled": false,
        "schedulerFrequency": "{ \"cronSchedule\": \"0 0 *0/1 ? * * *\"}",
        "workflowTemplateId": null,
        "isCustomizedStructure": false,
        "accountId": "6fa122e4-0d4c-4a1d-8869-7c0a86a37bf1",
        "organizationId": "00000000-0000-0000-0000-000000000001",
        "dateCreated": "2021-1003-29T1431T09:1209:4231.45636851665459",
        "dateModified": "20222021-0211-01T0926T16:5837:5310.5065048509085",
        "dateLastRun": "2021-11-26T16:3537:5712.573128+00:00",
        "dateNextSchedule": "2021-09-20T11:00:00+00: null,
00",
        "regApplicationIds": [
            "1c08aaa2-52ae-4e74-bb9d-108f6f36b8a8"
       "regApplicationIds": [],
        "currentBlock": 4
0      },
    {
   }
]

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

{
    "id": "8d85eb13b459cf22-9663ad18-4ac744bf-850280dc-46c5d38f9c1e6e8b78be1cc5",
        "name": "SpecialSymbolsOrder transferring",
        "description": "SpecialSymbols",
   Transfer orders from MyStore into Tripletex invoices with payments",
    "status": "Ready",
   
    "isScheduled": false,
  
     "schedulerFrequency": "{ \"cronSchedule\": \"0 0 *0/1 ? * * *\"}",
   
    "workflowTemplateId": null,
 
      "isCustomizedStructure": false,
 
      "accountId": "6fa122e4-0d4c-4a1d-8869-7c0a86a37bf1",
        "organizationId": "00000000-0000-0000-0000-000000000001",
   
    "dateCreated": "20212022-0903-15T1424T18:5508:2022.43273692543998",
   
    "dateModified": "2022-0204-01T0912T10:36:56:16.9089015478261",
   
    "dateLastRun": "20212022-0904-15T1412T10:5936:0257.95877+00:00",
  
     "dateNextSchedule": null,
 "2022-04-05T17:00:00+00:00",
      "regApplicationIds": [
            "dbdd41cf281686d9-28deaedd-4d2d4359-977189b4-7105c2165bcf8f878ad43b35",
         ],"03548816-f945-4bb2-b66e-950dff826fb8"
    ],
    "currentBlock": 1
    },
    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

{   
     "idworkflowTemplateId": "f01eccf9bbe52876-f56caca2-420a4ece-9da3ba31-e938291514e811e0d98ddc19",
        "name": "Random",Test Quinyx Employee Export Into FTP(CSV)",
   "descriptionapplications": "Random{"QUIN":"e3320a16-4b20-4e33-840f-2f5d28e3e1ca", "FTP":"0741b73d-2b13-4a4a-a0c2-2ffad9548e06"},
   "chain":[
   "status": "Ready",        {
"isScheduled": false,         "schedulerFrequency": "{\"cronSchedule\":\"0 0 0/1 ? * * *\"}"uniqueBlockId": "02d1424a-da90-4c12-9c28-96162e624bd7",
        "workflowTemplateId": null,
        "isCustomizedStructurevariables": false,{
          "accountId": "6fa122e4-0d4c-4a1d-8869-7c0a86a37bf1",         "organizationIdapiKeys": ["00000000xxxx-0000xxxx-0000xxxx-0000-000000000001xxxx"],
          "dateCreated": "2021-03-31T09:09:31.1665459",         "dateModifiedbadgeNo": "2021-11-26T16:37:10.8509085",null
        "dateLastRun": "2021-11-26T16:37:12.128+00:00",        }
   "dateNextSchedule": "2021-09-20T11:00:00+00:00",         }
 "regApplicationIds":  [     ]
}       "1c08aaa2-52ae-4e74-bb9d-108f6f36b8a8"

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
{ ], "State": 500, "currentBlockMsg": 4"Unknown workflow template 1be52876-aca2-4ece-ba31-11e0d98ddc19" } ]

Workflow

...

DeleteWorkflow

Removes workflow by Id

Expand

title	GET https://<base-url>/WorkflowDeleteWorkflow/b459cf227b2dee52-ad185781-44bf49bf-80dc9895-6e8b78be1cc5d6d2b2b43e2c

Headers:

Consumer:5D1AEF05263B497182992E324517FFFD0FED85FBEC2342B19CE02AB5ED62D6ED

ManagedAccountIdSecretKey:6fa122e4a5ae515d-0d4cd53b-4a1d478c-886990bd-7c0a86a37bf1060c616d37b7

Authorization:Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIyMDAxZDFlZS1jOWUxLTRhMDctOTZkNi1hNTMyNGEzMjczY2UiLCJpc3MiOiJodHRwOi8vY2FudmFzdGVzdC5jb25uZWN0bXlhcHBzLmNvbSIsImlhdCI6MTY1MTA2ODk2OSwiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvZW1haWxhZGRyZXNzIjoibmF0YWxpYS55dWRuaWtvdmFAb3V0bG9vay5jb20iLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3VzZXJkYXRhIjoiNmZhMTIyZTQtMGQ0Yy00YTFkLTg4NjktN2MwYTg2YTM3YmYxIiwiaHR0cDovL3NjaGVtYXMubWljcm9zb2Z0LmNvbS93cy8yMDA4LzA2L2lkZW50aXR5L2NsYWltcy9yb2xlIjoiQWRtaW4iLCJMb2dnZWRTdXBwb3J0ZWRCeUNtYSI6IlRydWUiLCJNYW5hZ2VkU3VwcG9ydGVkQnlDbWEiOiJUcnVlIiwiZXhwIjoxNjUxMDY5NTY5LCJhdWQiOiJjbWEtdXNlcnMifQ.v2Tbnw4bKuQSMAjtj36eVjrcMoE1vH93C6axpN9Y4wEManagedAccountId: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)

{ "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",

Code Block

language	json

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

{   
   "dateCreatedworkflowId": "20220fdfd78c-03-24T18:08:22.2543998",
    "dateModified": "2022-04-12T10:36:56.478261",258f-49ed-9e8c-faef9d6598fa"
}     "dateLastRun": "2022-04-12T10:36:57.877+00:00",     "dateNextSchedule": "2022-04-05T17:00:00+00:00",

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

Code Block

language	json

{   
   "regApplicationIdsworkflowId": [
        "281686d90fdfd78c-aedd258f-435949ed-89b49e8c-8f878ad43b35faef9d6598fa",
   "runTillBlock": 2
}   "03548816-f945-4bb2-b66e-950dff826fb8"
    ],     "currentBlock": 3 }

Workflow

Registers a new workflow based on template

...

Body

...

AddWorkflowApiDto

...

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>/WorkflowScheduler

Body JSON structure:

UpdateWorkfowSchedulerApiDto

Body example:

Code Block

language	json

{   
   "

...

workflowId":

...

0fdfd78c-258f-

...

49ed-

...

9e8c-

...

faef9d6598fa"

...

"isScheduled": true,
   "scheduleFrequency": "{\"cronSchedule\":\"0 0/5 * ? * * *\"}"
}

...

Headers:

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

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 Scheduler enabled

or

Code Block
Workflow Scheduler disabled

Expand

title	Response (status 401)

Status Code: 401; Unauthorized

Versions Compared

Old Version 40

New Version Current

Key

GetMetaData

IP restriction

Authentication

APIs for help

GetMetaData

Describe

Authentication

APIs for organization administration

Accounts

Refresh token

Delete authentication tokens

Clients

Account

Application APIs

Applications

Applications

RegApplications

RegApplications

RegApplication

Workflow APIs

WorkflowTemplates

RegApplication

WorkflowTemplates

Workflows

Workflows

Workflow (get)

Workflow (post)

Workflow

DeleteWorkflow

RunWorkflow

Workflow

WorkflowScheduler

Page Comparison

Versions Compared

Old Version 40

New Version Current

Key

GetMetaData

IP restriction

Authentication

APIs for help

GetMetaData

Describe

Authentication

APIs for organization administration

Accounts

Refresh token

Delete authentication tokens

Clients

Account

Application APIs

Applications

Applications

RegApplications

RegApplications

RegApplication

Workflow APIs

WorkflowTemplates

RegApplication

WorkflowTemplates

Workflows

Workflows

Workflow (get)

Workflow (post)

Workflow

DeleteWorkflow

RunWorkflow

Workflow

WorkflowScheduler