Create an instance
const url = 'https://api.adversarial.com/api/v1/integrations/example/connections/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/instances';const options = { method: 'POST', headers: {'Content-Type': 'application/json'}, body: '{"capability":"RISK_REGISTER","config":{},"display_name":"example","enabled":true}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://api.adversarial.com/api/v1/integrations/example/connections/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/instances \ --header 'Content-Type: application/json' \ --data '{ "capability": "RISK_REGISTER", "config": {}, "display_name": "example", "enabled": true }'Adds a named configuration of one capability under the connection. Two configurations of one capability under one connection cannot have the same name.
Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Provider slug
Connection identifier
Request Bodyrequired
Section titled “Request Bodyrequired”A new instance under a connection.
object
Capability selected from the provider catalog.
Complete configuration value. Omitted means an empty configuration.
object
Instance name shown wherever this configuration appears. Unique among the capability’s configurations under one connection.
Whether this configuration can execute.
Responses
Section titled “Responses”Instance created
One instance under a connection.
object
Capability identifier.
Complete validated configuration value.
object
Connection whose credential this configuration runs with.
Creation time.
Instance name, unique across the organization ignoring case; the two halves of a ticket card share one. The instance’s integration user carries it, so it is what Opened by shows for imported records.
Whether the platform can execute this configuration.
Configuration identifier.
Service account this configuration acts as, named as the configuration. Both halves of a ticket card share one.
Last update time.
Example
{ "capability": "RISK_REGISTER"}Unsupported capability or invalid configuration
Unknown provider or connection
Configuration name is already in use