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:

 "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-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": "41a31538-1120-4bdf-a6cb-675eeedd7d2d",
        "firstName": "Nathan",
        "lastName": "Bray",
        "email": "nathan.bray@connectmyapps.com",
        "organizationId": "00000000-0000-0000-0000-000000000000",
        "organizationName": "CMA Customer Bench",
        "roleId": "349889ad-4277-42d0-a268-5cd27230cfc5",
        "role": "User",
        "dateCreated": "2020-05-07T19:10:36.69"
    },
    "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": "18cc3b9f07ffd13d-c14eba57-4c7d4d1b-892b9c46-7cc5545abac003c5c919eed0",
        "firstNamename": "IgorTalentsoft",
        "lastNameshortName": "KostianTASO",
        "emaildescription": "igor.kostian@connectmyapps.comHR",
        "organizationIdvendorUrl": "00000000-0000-0000-0000-000000000001https://www.talentsoft.com/",
        "organizationNamecredentialFields": "ConnectMyApps AS",
  [
            {
      "roleId": "9c525665-df99-4aee-9e52-1a55853db03b",         "roleShortName": "AdminbaseUrl",
        "dateCreated": "2017-03-01T08:51:32.31"
    },        "Name": "Base url",
       {         "idType": "a305c3a2-cba5-4554-bb5d-ab7fcd5b4a4ctext",
        "firstName        "Value": "Luke",
        "lastName": "Buckley",         "emailOptional": "luke.buckley@connectmyapps.com",
 false,
      "organizationId": "00000000-0000-0000-0000-000000000000",         "organizationNameDesc": "CMATalentsoft CustomerAPI Benchurl.",
         "roleId       "Hidden": "9c525665-df99-4aee-9e52-1a55853db03b",false
        "role": "Admin",    },
    "dateCreated": "2013-06-01T18:56:22.763"        {
}
]

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

[       {         "idShortName": "07ffd13d-ba57-4d1b-9c46-03c5c919eed0",client_id",
                "nameName": "TalentsoftClient ID",
                "shortNameType": "TASOtext",
        "description        "Value": "HR",
                "vendorUrlOptional": false,
                "Desc"https://www.talentsoft.com/",: "Talentsoft client ID.",
                "Hidden": false
           "credentialFields": [ },
            {
                "ShortName": "baseUrlclient_secret",
                "Name": "BaseClient urlsecret",
                "Type": "text",
                "Value": "",
                "Optional": false,
                "Desc": "Talentsoft APIclient urlsecret.",
                "Hidden": false
            },
        ],
    {    "credentialsJson": {
            "ShortNamebaseUrl": null,
            "client_id",
   : null,
            "Nameclient_secret": "Clientnull
ID",        },
        "Typetag": "textHr, Premium",
        "sessionTimeMins": 0,
        "ValuesessionSlidingExpiry": false
 "",   },
    {
        "Optionalid": false, "97cbc3b3-32c7-4e4a-b788-a332ea82aeff",
        "name": "Quinyx",
        "DescshortName": "TalentsoftQUIN",
client ID.",       "description": "Workforce planning",
        "HiddenvendorUrl": false"http://www.quinyx.com",
            },"credentialFields": [
            {
                "ShortName": "client_secretapikey",
                "Name": "ClientAPI secretkey",
                "Type": "text",
                "Value": "",
                "Optional": false,
                "Desc": "TalentsoftYour Quinyx clientAPI secret.key",
                "Hidden": false
            },
        ],    {
    "credentialsJson": {             "baseUrlShortName": null,"environment",
                "client_idName": null"Environment",
            "client_secret    "Type": null"select",
        },         "tagValue": "Hr, Premium",
        "sessionTimeMins": 0,         "sessionSlidingExpiryOptions": false
 "live|Live Environment,test|Test Environment",
  },     {         "idOptional": "97cbc3b3-32c7-4e4a-b788-a332ea82aeff",
 false,
      "name": "Quinyx",         "shortNameDesc": "QUIN",Choose which Quinyx environment you wish to use, live "description": "Workforce planningor test.",
        "vendorUrl": "http://www.quinyx.com",
        "credentialFieldsHidden": [false
            }
{        ],
        "ShortNamecredentialsJson": "apikey",
    {
            "Nameapikey": "API key"null,

               "Typeenvironment": "text",null
        },
        "Valuetag": "Scheduling,Planning,Premium",
        "sessionTimeMins": 0,
        "OptionalsessionSlidingExpiry": false,
    },
	...,
    {
        "Descid": "Your Quinyx API key","b5a4a9ed-a686-4b1e-af30-ffd84b7fb2e0",
        "name": "Talent Manager",
        "HiddenshortName": false"HRTM",
        "description": "HR solution",
 },       "vendorUrl": "http://www.hr-manager.net",
    {    "credentialFields": [
           "ShortName": "environment", {
                "NameShortName": "Environmentcustomeralias",
                "TypeName": "selectCustomer alias",
                "ValueType": "text",
                "OptionsValue": "live|Live Environment,test|Test Environment",
                "Optional": false,
                "Desc": "ChooseYour which Quinyx environment you wish to use, live or testcustomer alias.",
                "Hidden": false
            },
        ],    {
    "credentialsJson": {             "apikeyShortName": null,
            "environment": null"apikey",
         },
        "tagName": "Scheduling,Planning,PremiumYour API key",
 
      "sessionTimeMins": 0,         "sessionSlidingExpiryType": false
 "text",
  },
	...,     {         "idValue": "b5a4a9ed-a686-4b1e-af30-ffd84b7fb2e0",
                "nameOptional": "Talent Manager"false,

       "shortName": "HRTM",         "descriptionDesc": "HR solutionYour API key.",
        "vendorUrl": "http://www.hr-manager.net",         "credentialFieldsHidden": [false
            }
{        ],
        "ShortNamecredentialsJson": {
            "customeralias",
   : null,
            "Nameapikey": "Customernull
alias",        },
        "Typetag": "textHR",
        "sessionTimeMins": 0,
        "ValuesessionSlidingExpiry": "",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

[
    {
    "Optional": false,                 "Desc"id": "Your customer alias.",
                "Hidden": false
            },
            {1710ff47-f590-43db-b0de-015676e99615",
        "shortName": "QUIN",
        "ShortNameaccountId": "apikey6fa122e4-0d4c-4a1d-8869-7c0a86a37bf1",
        "applicationId": "97cbc3b3-32c7-4e4a-b788-a332ea82aeff",
        "Namename": "YourQuinyx",
API key",       "tagText": "N-Quinyx",
        "Typedescription": "textWorkforce planning",
        "isAuthenticated": true,
        "ValueisOAuthApp": ""false,
        "dateModified": "2022-04-19T15:56:22.1133746",
        "OptionaldateTimeUtcAuthenticated": false,
       "2022-04-19T15:56:22.0345429",
        "DescdateTimeForReAuth": "Your API key.2022-04-19T15:56:22.0345429",
        "sessionTimeMins": 0,
        "HiddensessionSlidingExpiry": false,
        "faulted": false
  }  },
    {
 ],         "credentialsJsonid": {
   "d2698be7-9f12-44b1-8e6d-0494436538a8",
        "customeraliasshortName": null"MSQL",
            "apikey": null"accountId": "6fa122e4-0d4c-4a1d-8869-7c0a86a37bf1",
         }"applicationId": "276511d9-f07f-4fa6-b109-fdb4d62b2429",
        "tagname": "HRMicrosoft SQL On-premise",
        "sessionTimeMinstagText": 0 "N-Microsoft SQL On-premise",
        "sessionSlidingExpirydescription": false"Database     }
]

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

[
    {engine",
        "isAuthenticated": true,
        "isOAuthApp": false,
        "iddateModified": "1710ff472021-f590-43db-b0de-015676e9961509-06T13:30:11.2590869",
        "shortNamedateTimeUtcAuthenticated": "QUIN2021-04-14T10:27:22.1672672",
        "accountIddateTimeForReAuth": "6fa122e42021-0d4c-4a1d-8869-7c0a86a37bf104-14T10:27:22.1672672",
        "applicationIdsessionTimeMins": "97cbc3b3-32c7-4e4a-b788-a332ea82aeff"0,
        "sessionSlidingExpiry": false,
        "namefaulted": "Quinyx",false
    },
   "tagText": "N-Quinyx", {
        "descriptionid": "Workforce planningdbdd41cf-28de-4d2d-9771-7105c2165bcf",
        "isAuthenticatedshortName": true"CMAF",
        "isOAuthAppaccountId": false"6fa122e4-0d4c-4a1d-8869-7c0a86a37bf1",
        "dateModifiedapplicationId": "2022-04-19T15:56:22.11337469b6a04b3-c91f-4255-9033-6ac7b7a6f935",
        "dateTimeUtcAuthenticatedname": "2022-04-19T15:56:22.0345429File Hub",
        "dateTimeForReAuthtagText": "2022-04-19T15:56:22.0345429File Hub",
        "description": "sessionTimeMins": 0File automation",
        "sessionSlidingExpiryisAuthenticated": falsetrue,
        "faultedisOAuthApp": false
    },
    {
        "iddateModified": "d2698be72022-9f12-44b1-8e6d-0494436538a804-20T14:00:27.1912258",
        "shortNamedateTimeUtcAuthenticated": "MSQL"null,
        "accountIddateTimeForReAuth": "6fa122e4-0d4c-4a1d-8869-7c0a86a37bf1"null,
        "applicationIdsessionTimeMins": "276511d9-f07f-4fa6-b109-fdb4d62b2429"0,
        "namesessionSlidingExpiry": "Microsoft SQL On-premise"false,
        "tagTextfaulted": "N-Microsoft SQL On-premise"false
    },
    {
        "descriptionid": "Database enginea067c363-7339-4fed-b1ad-efafd7603986",
        "isAuthenticatedshortName": true"FTP",
        "isOAuthAppaccountId": false"6fa122e4-0d4c-4a1d-8869-7c0a86a37bf1",
        "dateModifiedapplicationId": "2021-09-06T13:30:11.25908695f814909-01ea-4395-96ee-5ba7614128fc",
        "dateTimeUtcAuthenticatedname": "2021-04-14T10:27:22.1672672FTP Server",
        "dateTimeForReAuthtagText": "2021-04-14T10:27:22.1672672N-FTP Server",
        "sessionTimeMinsdescription": 0 "File upload and download",
        "sessionSlidingExpiryisAuthenticated": falsetrue,
        "faultedisOAuthApp": false,
    },     {"dateModified": "2022-02-01T15:33:49.9987294",
        "iddateTimeUtcAuthenticated": "dbdd41cf-28de2022-4d2d-9771-7105c2165bcf02-01T15:33:49.9919226",
        "shortNamedateTimeForReAuth": "CMAF2022-02-01T15:33:49.9919226",
        "accountIdsessionTimeMins": "6fa122e4-0d4c-4a1d-8869-7c0a86a37bf1"0,
        "applicationIdsessionSlidingExpiry": "9b6a04b3-c91f-4255-9033-6ac7b7a6f935"false,
        "namefaulted": false
"File Hub",   },
]

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

{
    "tagTextapplicationId": "File Hub",
   97cbc3b3-32c7-4e4a-b788-a332ea82aeff",
    "descriptiontagText": "File automationQuinyx 2022-04-28",
        "isAuthenticated": true,
        "isOAuthApp": false,
   "credentialsJson": "{\"apikey\":\"01d6-3e54-cff2-c7d8\",\"environment\": \"test\"}"
}

Body example 2:

Code Block

language	json

{
    "dateModifiedapplicationId": "2022-04-20T14:00:27.1912258",
5f814909-01ea-4395-96ee-5ba7614128fc",
       "dateTimeUtcAuthenticatedtagText": null,
   "FTP 2022-05-03",
    "credentialsJson": "{\"dateTimeForReAuthusername\": null,\"password\": null,\"port\":        "sessionTimeMins": 0,
        "sessionSlidingExpiry": false,
        "faulted": false
    },
    {
        "id": "a067c363-7339-4fed-b1ad-efafd7603986",
        "shortName": "FTP",
        "accountId": "6fa122e4-0d4c-4a1d-8869-7c0a86a37bf1",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

[
    {
         "applicationIdid": "5f814909bbe52876-01eaaca2-43954ece-96eeba31-5ba7614128fc11e0d98ddc19",
        "name": "FTPQuinyx Server",Employee         "tagText": "N-FTP Server",
        "description": "File upload and download",
        "isAuthenticated": true,
        "isOAuthApp": falseExport Into FTP(CSV)",
        "dateModifieddescription": "2022-02-01T15:33:49.9987294Quinyx Employee Export Into FTP(CSV)",
        "dateTimeUtcAuthenticateddateCreated": "20222020-0208-01T1514T17:3312:4929.99192267856246",
        "dateTimeForReAuthdateModified": "2022-0203-01T1517T13:3354:4907.99192260394189",
        "sessionTimeMinsstate": 0"Published",
        "sessionSlidingExpiryversion": false"0.1.7",
        "faulteddraftIsCommitted": 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

{,
        "applicationIddateCommitted": "97cbc3b32021-32c7-4e4a-b788-a332ea82aeff02-26T16:51:29.3588575",
        "tagTextorganizationId": null,
  "Quinyx 2022-04-28",     "credentialsJsonapplications": "{\"apikey\":\"01d6-3e54-cff2-c7d8\",\"environment\": \"test\"}"
}

Body example 2:

Code Block

language	json

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

Headers:

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

Authorization:Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIyMDAxZDFlZS1jOWUxLTRhMDctOTZkNi1hNTMyNGEzMjczY2UiLCJpc3MiOiJodHRwOi8vY2FudmFzdGVzdC5jb25uZWN0bXlhcHBzLmNvbSIsImlhdCI6MTY1MTA2ODk2OSwiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvZW1haWxhZGRyZXNzIjoibmF0YWxpYS55dWRuaWtvdmFAb3V0bG9vay5jb20iLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3VzZXJkYXRhIjoiNmZhMTIyZTQtMGQ0Yy00YTFkLTg4NjktN2MwYTg2YTM3YmYxIiwiaHR0cDovL3NjaGVtYXMubWljcm9zb2Z0LmNvbS93cy8yMDA4LzA2L2lkZW50aXR5L2NsYWltcy9yb2xlIjoiQWRtaW4iLCJMb2dnZWRTdXBwb3J0ZWRCeUNtYSI6IlRydWUiLCJNYW5hZ2VkU3VwcG9ydGVkQnlDbWEiOiJUcnVlIiwiZXhwIjoxNjUxMDY5NTY5LCJhdWQiOiJjbWEtdXNlcnMifQ.v2Tbnw4bKuQSMAjtj36eVjrcMoE1vH93C6axpN9Y4wE

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

Expand

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

[
    {{
                "uniqueBlockId": "02d1424a-da90-4c12-9c28-96162e624bd7",
                "blockName": "API - Get Employees",
                "variables": {
                    "idapiKeys": "bbe52876-aca2-4ece-ba31-11e0d98ddc19",[],
         "name": "Quinyx Employee Export Into FTP(CSV)",
           "badgeNo": null
                }
       "description": "Quinyx Employee Export Into FTP(CSV)",},
            {
 "dateCreated": "2020-08-14T17:12:29.7856246",               "dateModifieduniqueBlockId": "2022-03-17T13:54:07.0394189",25782580-aabe-4a03-be1c-bc45dacd7e60",
          "state      "blockName": "PublishedFTP Upload",
                "versionvariables": "0.1.7",{
          "draftIsCommitted": false,         "dateCommittedfilename": "2021-02-26T16:51:29.3588575NY_Employees_{date:yyyy-MM-dd-HH-mm}",
        "organizationId": null,            "applicationsfileformat": ["csv",
                 "QUIN",   "filepath": "/"
        "FTP"        }
],         "chain": [  }
        ]
 {   },
    {
        "uniqueBlockIdid": "02d1424a3b76ca61-da90bca9-4c124995-9c2890ba-96162e624bd77190c1dd567b",
                "blockName"name": "APIMyStore -Customers GetSend Employeesemail",
       
        "variablesdescription": {"MyStore Customers           Send email",
        "apiKeysdateCreated": [],
    "2021-11-08T11:39:58.814",
               "badgeNo"dateModified": null"2021-11-09T15:14:14.836809",
        "state": "Published",
      }  "version": "0.0.7",
        "draftIsCommitted": }true,
        "dateCommitted": "2021-11-09T15:14:18.6103605",
  {        "organizationId": null,
        "uniqueBlockIdapplications": "25782580-aabe-4a03-be1c-bc45dacd7e60",
   [
            "blockName": "FTP Upload",
 MYST2",
              "variablesCMAF":
{        ],
        "chain": [
   "filename": "NY_Employees_{date:yyyy-MM-dd-HH-mm}",         {
                "fileformatuniqueBlockId": "csv729e4eb5-8022-43bb-b75b-524b1cb5f5b5",
                    "filepathblockName": "/MyStore Get Customers",
                "variables": {}
            },
        ]    {
},       {         "iduniqueBlockId": "3b76ca61a510ddbf-bca92350-49954ab6-90ba9014-7190c1dd567bc81d0aa3f013",
                "nameblockName": "MyStore Customers Send email",
                "descriptionvariables": "MyStore Customers Send email",{
                    "dateCreatedsubject": "2021-11-08T11:39:58.814MyStore Customers",
          "dateModified": "2021-11-09T15:14:14.836809",         "statefileName": "PublishedAllCustomers",
          "version": "0.0.7",         "draftIsCommittednote": true,"Please see your customers in MyStore"
   "dateCommitted": "2021-11-09T15:14:18.6103605",         "organizationId": null,   }
     "applications": [      }
      "MYST2",  ]
    },
    {
"CMAF"         ]"id": "018fda95-a62f-4f0b-af12-3cfcd9146def",
        "chainname": [
      "Transferring of Orders & Customers",
     {   "description": "Transferring of Orders & Customers",
        "uniqueBlockIddateCreated": "729e4eb52020-8022-43bb-b75b-524b1cb5f5b508-14T17:22:57.2244016",

               "blockName"dateModified": "MyStore Get Customers",
   2020-12-10T13:02:23.1685229",
            "variablesstate": {}"Draft",
            }"version": null,
        "draftIsCommitted": null,
  {      "dateCommitted": null,
         "uniqueBlockIdorganizationId": "a510ddbf-2350-4ab6-9014-c81d0aa3f013",null,
        "applications": [
          "blockName":  "Send emailMYST2",
            "FIKE"
   "variables": {    ],
        "chain": [
      "subject": "MyStore Customers",    {
                "fileNameuniqueBlockId": "AllCustomersa43e433d-9def-4062-9e89-6ff01824f980",

                   "noteblockName": "PleaseMyStore seeGet yourorders",
customers in MyStore"              "variables": {
 }             }      "status": "2",
 ]     },     {         "idage": "018fda95-a62f-4f0b-af12-3cfcd9146def", null
         "name": "Transferring of Orders & Customers",  }
       "description": "Transferring of Orders & Customers"},
         "dateCreated": "2020-08-14T17:22:57.2244016",  {
      "dateModified": "2020-12-10T13:02:23.1685229",         "stateuniqueBlockId": "Draftd362db53-c46f-4cf8-8bee-9a105ecde130",
        "version": null,         "draftIsCommittedblockName": null,"Get all contacts",
      "dateCommitted": null,         "organizationIdvariables": null,{
        "applications": [           "testValue":  "MYST2name",
            "FIKE"      }
  ],         "chain": [ },
            {
                "uniqueBlockId": "a43e433d6cf1b697-9def4145-40624659-9e89985c-6ff01824f9804c9b76a57710",
                "blockName": "MyStorePost orders Get& orderscustomers",
                "variables": {
                    "statusshippingtext": "2",Shipping"
                }
            }
        ]
   "age": null
                }
            },
       }
]

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

[
    {
 
              "uniqueBlockId"id": "d362db53ef7a56e6-c46f448f-4cf84787-8beeb58d-9a105ecde13047b063d6e983",
        "name": "Quinyx Employee Export Into FTP(CSV)",
  "blockName": "Get all contacts",   "description": "Quinyx Employee Export Into FTP(CSV)",
        "variablesstatus": {"Ready",
        "isScheduled": false,
        "schedulerFrequency": "{ \"testValuecronSchedule\": \"name"0 0 * ? * *\"}",
        "workflowTemplateId": "bbe52876-aca2-4ece-ba31-11e0d98ddc19",
 }             }"isCustomizedStructure": true,
        "accountId": "6fa122e4-0d4c-4a1d-8869-7c0a86a37bf1",
  {        "organizationId": "00000000-0000-0000-0000-000000000001",
        "uniqueBlockIddateCreated": "6cf1b6972022-4145-4659-985c-4c9b76a5771002-22T15:29:22.3525209",
        "dateModified": "2022-04-13T06:30:56.2625076",
        "blockNamedateLastRun": "Post orders & customers",
 2022-04-12T10:35:32.731+00:00",
              "variables"dateNextSchedule": {null,
        "regApplicationIds": [
          "shippingtext":  "Shipping"1710ff47-f590-43db-b0de-015676e99615",
            "fa2ee993-03cf-4baf-a8a0-684e92e74ded"
   }           ],
 }         ]"currentBlock": 5
    }
]

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

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

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": "f01eccf9b459cf22-f56cad18-420a44bf-9da380dc-e938291514e86e8b78be1cc5",
  
     "name": "RandomOrder transferring",
        "description": "Random",Transfer orders from MyStore into Tripletex invoices with payments",
    "status": "Ready",
   
    "isScheduled": false,
    false,
    "schedulerFrequency": "{\"cronSchedule\":\"0 0 0/1 ? * * *\"}",
   
    "workflowTemplateId": null,

       "isCustomizedStructure": false,

       "accountId": "6fa122e4-0d4c-4a1d-8869-7c0a86a37bf1",
   
    "organizationId": "00000000-0000-0000-0000-000000000001",
   
    "dateCreated": "20212022-03-31T0924T18:0908:3122.16654592543998",
   
    "dateModified": "20212022-1104-26T1612T10:3736:1056.8509085478261",
    "dateLastRun": "2022-04-12T10:36:57.877+00:00",
    "dateLastRundateNextSchedule": "20212022-1104-26T1605T17:3700:12.12800+00:0000",
    "regApplicationIds": [
        "281686d9-aedd-4359-89b4-8f878ad43b35",
        "dateNextSchedule": "2021-09-20T11:00:00+00:00",03548816-f945-4bb2-b66e-950dff826fb8"
    ],
    "regApplicationIdscurrentBlock": [
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

{   
        "1c08aaa2-52ae-4e74-bb9d-108f6f36b8a8""workflowTemplateId": "bbe52876-aca2-4ece-ba31-11e0d98ddc19",
   "name": "Test Quinyx Employee Export ],
    Into FTP(CSV)",
   "currentBlockapplications": 4
    }
]

Workflow

Returns registered workflow by id

Expand

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

Headers:

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

Authorization:Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIyMDAxZDFlZS1jOWUxLTRhMDctOTZkNi1hNTMyNGEzMjczY2UiLCJpc3MiOiJodHRwOi8vY2FudmFzdGVzdC5jb25uZWN0bXlhcHBzLmNvbSIsImlhdCI6MTY1MTA2ODk2OSwiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvZW1haWxhZGRyZXNzIjoibmF0YWxpYS55dWRuaWtvdmFAb3V0bG9vay5jb20iLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3VzZXJkYXRhIjoiNmZhMTIyZTQtMGQ0Yy00YTFkLTg4NjktN2MwYTg2YTM3YmYxIiwiaHR0cDovL3NjaGVtYXMubWljcm9zb2Z0LmNvbS93cy8yMDA4LzA2L2lkZW50aXR5L2NsYWltcy9yb2xlIjoiQWRtaW4iLCJMb2dnZWRTdXBwb3J0ZWRCeUNtYSI6IlRydWUiLCJNYW5hZ2VkU3VwcG9ydGVkQnlDbWEiOiJUcnVlIiwiZXhwIjoxNjUxMDY5NTY5LCJhdWQiOiJjbWEtdXNlcnMifQ.v2Tbnw4bKuQSMAjtj36eVjrcMoE1vH93C6axpN9Y4wE

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

Expand

title	Response (status 200)

Code Block

language	json

{"QUIN":"e3320a16-4b20-4e33-840f-2f5d28e3e1ca", "FTP":"0741b73d-2b13-4a4a-a0c2-2ffad9548e06"},
   "chain":[
            {
    "id            "uniqueBlockId": "b459cf2202d1424a-ad18da90-44bf4c12-80dc9c28-6e8b78be1cc596162e624bd7",
                "namevariables": "Order transferring",{
      "description": "Transfer orders from MyStore into Tripletex invoices with payments",     "statusapiKeys": "Ready",["xxxx-xxxx-xxxx-xxxx"],
                    "isScheduledbadgeNo": false,null
    "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",

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": "2022-04-05T17:00:00+00:00"500,
    "regApplicationIdsMsg": ["Unknown workflow        "281686d9-aedd-4359-89b4-8f878ad43b35",
        "03548816-f945-4bb2-b66e-950dff826fb8"
    ],
    "currentBlock": 3
}

Workflow

...

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

DeleteWorkflow

Removes workflow by Id

Expand

title	GET https://<base-url>/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

true

Expand

title	Response (status 401)

Status Code: 401; Unauthorized

RunWorkflow

Runs workflow or needed blocks

Expand

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

Body JSON structure:

AddWorkflowApiDtoRunMetadataApiDto

Body example 1 for running by default:

Code Block

language	json

{   
   "workflowTemplateIdworkflowId": "bbe528760fdfd78c-aca2258f-4ece49ed-ba319e8c-11e0d98ddc19",faef9d6598fa"
}        "name": "Test Quinyx Employee Export Into FTP(CSV)",

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

Code Block

language	json

{   
  "applications": {"QUINworkflowId":"e3320a16-4b20-4e33-840f-2f5d28e3e1ca", "FTP":"0741b73d-2b13-4a4a-a0c2-2ffad9548e06"}0fdfd78c-258f-49ed-9e8c-faef9d6598fa",
   "chainrunTillBlock":[ 2
}           {

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

Code Block

language	json

{   
   "uniqueBlockIdworkflowId": "02d1424a0fdfd78c-da90258f-4c1249ed-9c289e8c-96162e624bd7faef9d6598fa",
      "runFromBlock": 2,
         "variables"runTillBlock": {4 
}                   "apiKeys": ["cc92-510a-86df-b276"],
                    "badgeNo": null

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:

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)

Code Block

language	json

"0fdfd78c-258f-49ed-9e8c-faef9d6598fa"Workflow Scheduler enabled

or

Code Block
Workflow Scheduler disabled

Expand

title	Response (status 401)

Status Code: 401; Unauthorized

...

Versions Compared

Old Version 41

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

Workflow

DeleteWorkflow

RunWorkflow

WorkflowScheduler

Page Comparison

Versions Compared

Old Version 41

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

Workflow

DeleteWorkflow

RunWorkflow

WorkflowScheduler