ApiIntegration config sandbox
Get the integration's sandbox schema.
Lists the entity types a SIMULATED config of this integration holds, for seeding one through `sandbox:import`: each type's id template, identity and scope params, and payload template (whose fields are the payload an imported entity carries), with the tools that list, read, create, update or delete it. Tools classified as ACTION touch no entity and are listed separately. Classifications include this workspace's overrides. An integration with no simulator answers with empty lists.
Authorization
Bearer AuthorizationBearer <token>
JWT Authorization header using the Bearer scheme. Enter 'Bearer' [space] and then your token.
In: header
Path Parameters
integration*string
The integration whose simulator schema to read.
tenant*string
The tenant identifier
Response Body
curl -X GET "https://api.fruxon.com/v1/tenants/string/integrations/string/sandbox/schema"{
"integrationId": "string",
"entityTypes": [
{
"entityType": "string",
"idTemplate": "string",
"identityParams": [
"string"
],
"scopeParams": [
"string"
],
"payloadTemplate": "string",
"missBehavior": "SYNTHESIZE",
"listTools": [
"string"
],
"readTools": [
"string"
],
"createTools": [
"string"
],
"updateTools": [
"string"
],
"deleteTools": [
"string"
]
}
],
"actionTools": [
"string"
]
}Empty
Empty
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": null,
"property2": null
}