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:

PropertyTypeRequiredConstraintsDescription
catalogTypestringYesCatalog type of the integration module.
claimsobjectNoClaims is the definition of the authentication method and credentials for the integration module.
Properties of claims
PropertyTypeRequiredConstraintsDescription
credentialsobjectNoCredentials is the definition of the authentication credentials for the integration module. the properties of the credentials object are dependent on the authentication method.
methodstringNoone of: oauth2, httpBasicAuth, httpAPIKey, httpAPIKeyQueryParam, jwtAuth, customHeaderAuthentication method of the integration module.
configIdstringYesread-only (server-generated)Unique Integration Module ID.
homeIdintegerYesHome that this integration module belongs to.
projectIdintegerYesread-only (server-generated)Project that this integration module belongs to.
scheduleobjectNoSchedule is the definition of the schedule for the integration module.
Properties of schedule
PropertyTypeRequiredConstraintsDescription
cronSchedulestringNocron schedule for the integration module. The format is a standard unix crontab and some extended format such as @everyXs, @hourly, etc.
cronTimeZonestringNocron time zone for the integration module.
operationsarray<object>No
Properties of operations
PropertyTypeRequiredConstraintsDescription
appConfigsobjectNoappConfigs is the configuration for the post processing of the operation response.
operationNamestringNoName of the operation. The operation names are defined in the integration module catalog.
parametersarray<object>NoParameters for the operation defined in the integration module catalog.
Properties of parameters
PropertyTypeRequiredConstraintsDescription
namestringNoName of the parameter.
valuestringNoValue of the parameter.

getIntegrationModuleConfigurations — 401 response

Authorization is required to access this resource.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

getIntegrationModuleConfigurations — 403 response

Request failed because of denied permission.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

getIntegrationModuleConfigurations — 429 response

Request failed because of rate limit.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

getIntegrationModuleConfigurations — 500 response

An unexpected error has occurred.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

getIntegrationModuleConfigurations — 503 response

The service is temporarily unavailable.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.