Integration | Integration Config
Service to manage entities of type 'IntegrationConfig'.
Overview
| URL | api/{tenantKey}/{orgKey}/integration/integrationConfigs |
| Methods Supported | GET, POST, PUT, DELETE |
All Operations
This service includes the following operations:
- GET:
- POST:
-
PUT:
- PUT Set IsActive IntegrationConfig
- PUT Set ConfigKey IntegrationConfig
- PUT Set AuthType IntegrationConfig
- PUT Set ClientId IntegrationConfig
- PUT Set ClientSecret IntegrationConfig
- PUT Set Scope IntegrationConfig
- PUT Set BearerToken IntegrationConfig
- PUT Set Username IntegrationConfig
- PUT Set Password IntegrationConfig
- DELETE:
All Resources
This service uses the following resources:
All Enumerations
This service uses the following enumerations:
GET IntegrationConfigs (odata)
Returns a page of the list of all the entity records available.
The following elements are optional:
| opts | (ODataQueryOptions) OData query option. |
Response:
| When successful, the response body contains the list of records available. See IntegrationConfigResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET IntegrationConfig by identifier
Returns the entity record that matches the specified identifier.
The following elements are required:
| id | (string) The record identifier. |
Response:
| When successful, the response body contains the entity record. See IntegrationConfigResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
GET IntegrationConfig by key
Returns the entity record that matches the specified key.
The following elements are required:
| configKey | (string) Config. |
Response:
| When successful, the response body contains the entity record. See IntegrationConfigResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
POST IntegrationConfigs
Creates a new entity record.
The following elements are required:
| integrationConfigResource | (ApiIntegrationConfigResource) The request body should contain the entity record that should be created. See ApiIntegrationConfigResource. |
Response:
| When successful, the response body contains the new entity record identifier. The resource header location property contains the URL for the new entity record. See ApiIntegrationConfigResource. |
Response status codes:
| 201 | Created. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set AuthType IntegrationConfig
Updates the value of attribute 'AuthType' in the specified entity record.
The following elements are required:
| configKey | (string) Config. |
| value | (enum AuthType) The request body should contain the new value for the attribute. See AuthType. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set BearerToken IntegrationConfig
Updates the value of attribute 'BearerToken' in the specified entity record.
The following elements are required:
| configKey | (string) Config. |
| value | (string) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set ClientId IntegrationConfig
Updates the value of attribute 'ClientId' in the specified entity record.
The following elements are required:
| configKey | (string) Config. |
| value | (string) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set ClientSecret IntegrationConfig
Updates the value of attribute 'ClientSecret' in the specified entity record.
The following elements are required:
| configKey | (string) Config. |
| value | (string) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set ConfigKey IntegrationConfig
Updates the value of attribute 'ConfigKey' in the specified entity record.
The following elements are required:
| configKey | (string) Config. |
| value | (string) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set IsActive IntegrationConfig
Updates the value of attribute 'IsActive' in the specified entity record.
The following elements are required:
| configKey | (string) Config. |
| value | (bool) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
PUT Set Password IntegrationConfig
Updates the value of attribute 'Password' in the specified entity record.
The following elements are required:
| configKey | (string) Config. |
| value | (string) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set Scope IntegrationConfig
Updates the value of attribute 'Scope' in the specified entity record.
The following elements are required:
| configKey | (string) Config. |
| value | (string) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set Username IntegrationConfig
Updates the value of attribute 'Username' in the specified entity record.
The following elements are required:
| configKey | (string) Config. |
| value | (string) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
DELETE IntegrationConfig by identifier
Deletes the entity record that matches the specified identifier.
The following elements are required:
| id | (string) The record identifier. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 204 | Deleted. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
DELETE IntegrationConfig by key
Deletes the entity record that matches the specified key.
The following elements are required:
| configKey | (string) Config. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 204 | Deleted. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
Resources
ApiIntegrationConfigResource
The following elements are required:
| configKey | (string) Config. |
The following elements are optional:
| authType | (enum AuthType) Auth Type.
See AuthType. |
| clientId | (string) Client Id. |
| clientSecret | (string) Client Secret. |
| scope | (string) Scope. |
| bearerToken | (string) Bearer Token. |
| username | (string) Username. |
| password | (string) Password. |
IntegrationConfigResource
The following elements are required:
| configKey | (string) Config. |
The following elements are optional:
| authType | (enum AuthType) Auth Type.
See AuthType. |
| clientId | (string) Client Id. |
| clientSecret | (string) Client Secret. |
| scope | (string) Scope. |
| bearerToken | (string) Bearer Token. |
| username | (string) Username. |
| password | (string) Password. |