...
PRD - https://canvas.connectmyapps.com/api
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 | |||||
---|---|---|---|---|---|
| |||||
|
Describe
For getting of description about APIs parameters you can use following request:
...
Expand | |||||
---|---|---|---|---|---|
| |||||
|
APIs for authentication
There are three APIs for working with authentication tokens
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.
...
Expand | ||
---|---|---|
| ||
Returned if the Consumer or SecretKey are incorrect or missing. |
Refresh token
For refreshing of access token you need to send following request:
...
Expand | ||
---|---|---|
| ||
Returned if refresh token is not found |
Delete authentication tokens
For deleting of authentication tokens you need to send following request:
...
Expand | ||
---|---|---|
| ||
Returned if refresh token is not found |
APIs for organization administration
Clients
Returns list of all accounts in your organization
...
Expand | |||||
---|---|---|---|---|---|
| |||||
|
Application APIs
Applications
Returns list of all third-part applications supported by CMA
...
Expand | ||
---|---|---|
| ||
Returned if the Authorization is incorrect or missing. |
RegApplications
Returns account registerred applications
...
Expand | |||||
---|---|---|---|---|---|
| |||||
|
RegApplication
Registers a new application and returns Id
...
Expand | ||
---|---|---|
| ||
|
Workflow APIs
WorkflowTemplates
Returns list of workflow templates provided by CMA and your organization
...
Expand | |||||
---|---|---|---|---|---|
| |||||
|
Workflows
Returns list of registered workflows
...
Expand | |||||
---|---|---|---|---|---|
| |||||
|
Workflow
Returns registered workflow by id
...
Expand | |||||
---|---|---|---|---|---|
| |||||
|
Workflow
Registers a new workflow based on template
...
Expand | ||
---|---|---|
| ||
Status Code: 401; Unauthorized |
DeleteWorkflow
Removes workflow by Id
Expand | ||
---|---|---|
| ||
Headers: ManagedAccountId:6fa122e4-0d4c-4a1d-8869-7c0a86a37bf1 Authorization:Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIyMDAxZDFlZS1jOWUxLTRhMDctOTZkNi1hNTMyNGEzMjczY2UiLCJpc3MiOiJodHRwOi8vY2FudmFzdGVzdC5jb25uZWN0bXlhcHBzLmNvbSIsImlhdCI6MTY1MTA2ODk2OSwiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvZW1haWxhZGRyZXNzIjoibmF0YWxpYS55dWRuaWtvdmFAb3V0bG9vay5jb20iLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3VzZXJkYXRhIjoiNmZhMTIyZTQtMGQ0Yy00YTFkLTg4NjktN2MwYTg2YTM3YmYxIiwiaHR0cDovL3NjaGVtYXMubWljcm9zb2Z0LmNvbS93cy8yMDA4LzA2L2lkZW50aXR5L2NsYWltcy9yb2xlIjoiQWRtaW4iLCJMb2dnZWRTdXBwb3J0ZWRCeUNtYSI6IlRydWUiLCJNYW5hZ2VkU3VwcG9ydGVkQnlDbWEiOiJUcnVlIiwiZXhwIjoxNjUxMDY5NTY5LCJhdWQiOiJjbWEtdXNlcnMifQ.v2Tbnw4bKuQSMAjtj36eVjrcMoE1vH93C6axpN9Y4wE
|
...
Expand | ||
---|---|---|
| ||
Status Code: 401; Unauthorized |
RunWorkflow
Runs workflow
Expand | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||
Body JSON structure: RunMetadataApiDto Body example 1 for running by default:
Body example 2 for running from start till block #2:
Body example 3 for running of blocks between #2 and #4:
Headers: ManagedAccountId:6fa122e4-0d4c-4a1d-8869-7c0a86a37bf1 Authorization:Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIyMDAxZDFlZS1jOWUxLTRhMDctOTZkNi1hNTMyNGEzMjczY2UiLCJpc3MiOiJodHRwOi8vY2FudmFzdGVzdC5jb25uZWN0bXlhcHBzLmNvbSIsImlhdCI6MTY1MTA2ODk2OSwiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvZW1haWxhZGRyZXNzIjoibmF0YWxpYS55dWRuaWtvdmFAb3V0bG9vay5jb20iLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3VzZXJkYXRhIjoiNmZhMTIyZTQtMGQ0Yy00YTFkLTg4NjktN2MwYTg2YTM3YmYxIiwiaHR0cDovL3NjaGVtYXMubWljcm9zb2Z0LmNvbS93cy8yMDA4LzA2L2lkZW50aXR5L2NsYWltcy9yb2xlIjoiQWRtaW4iLCJMb2dnZWRTdXBwb3J0ZWRCeUNtYSI6IlRydWUiLCJNYW5hZ2VkU3VwcG9ydGVkQnlDbWEiOiJUcnVlIiwiZXhwIjoxNjUxMDY5NTY5LCJhdWQiOiJjbWEtdXNlcnMifQ.v2Tbnw4bKuQSMAjtj36eVjrcMoE1vH93C6axpN9Y4wE
|
...