Integration Modules data models
getIntegrationModuleConfigurations — 200 response
Successful retrieval of integration module configurations.
Represents an integration module configuration created in a project.
An array of objects with the following shape:
| Property | Type | Required | Constraints | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
catalogType | string | Yes | Catalog type of the integration module. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
claims | object | No | Claims is the definition of the authentication method and credentials for the integration module. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
configId | string | Yes | read-only (server-generated) | Unique Integration Module ID. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
homeId | integer | Yes | Home that this integration module belongs to. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
projectId | integer | Yes | read-only (server-generated) | Project that this integration module belongs to. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
schedule | object | No | Schedule is the definition of the schedule for the integration module. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
getIntegrationModuleConfigurations — 401 response
Authorization is required to access this resource.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
getIntegrationModuleConfigurations — 403 response
Request failed because of denied permission.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
getIntegrationModuleConfigurations — 429 response
Request failed because of rate limit.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
getIntegrationModuleConfigurations — 500 response
An unexpected error has occurred.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
getIntegrationModuleConfigurations — 503 response
The service is temporarily unavailable.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |