kphung | 2020-07-30 19:40:42 UTC | #1
I'm using the PUT /api/v2/integrations/{integrationId}/config/current endpoint to update some properties for an integration. In the api description it says the properties is the "Key-value configuration settings described by the schema in the propertiesSchemaUri field". Where do I find the schema for an integration ? Where is the propertiesSchemaUri ?
Jason_Mathison | 2020-07-31 12:25:14 UTC | #2
Hi Kathie,
As far as I know most integrations do not make use of "properties". Is there a specific integration type you are working with so I can check on the details for you?
--Jason
Jerome.Saint-Marc | 2020-07-31 14:05:26 UTC | #3
Hello,
As Jason wrote, the schema for properties and advanced varies depending on the integration type. Some integration types, like AWS Lambda Data Actions, do not make use of properties (and have no properties schema).
When an integration type has some schemas defined (properties or advanced), you can find them using GET /api/v2/integrations/types/{typeId}/configschemas/{configType} Where {typeId} is the integration type And {configType} is properties or advanced
To find the integration type, if you don't know it, you can use a GET /api/v2/integrations/types
As an example, the integration type for Custom Client Application is "embedded-client-app" You can get the properties schema with GET /api/v2/integrations/types/embedded-client-app/configschemas/properties And the advanced schema with GET /api/v2/integrations/types/embedded-client-app/configschemas/advanced
If the integration type does not have a schema defined, I think the request will result in a 404.
Regards,
system | 2020-08-31 14:09:08 UTC | #4
This topic was automatically closed 31 days after the last reply. New replies are no longer allowed.
This post was migrated from the old Developer Forum.
ref: 8447