Appearance

Get integration mapping metadata for a unified-model resource method ​

Returns the merged JSON schema, default query/body, and documentation link for a single integration mapping (e.g. crm.contacts.list on salesforce). Useful for inspecting what a unified call will accept and return without touching a real integrated account.

Unlike most unified endpoints, this one does not require integrated_account_id — it operates against the integration mapping installed in the caller's environment, so it's safe to call during local mapping iteration. The response includes only the fields actually populated by response_mapping for the chosen integration (computed via getResponseFields).

Use this together with truto unified test-mapping (Truto CLI) or as the basis for client-side validation before patching environment-unified-model-resource-method.

Endpoint ​

http
GET /unified/{model_name}/{resource_name}/{integration_name}/meta/{method}
Integrations supported

Path parameters ​

model_name
string
REQUIRED · 

The name of the unified model (e.g. crm).

Example: crm
resource_name
string
REQUIRED · 

The name of the resource within the model (e.g. contacts).

Example: contacts
integration_name
string
REQUIRED · 

The name of the integration to inspect the mapping for (e.g. salesforce).

Example: salesforce
method
string
REQUIRED · 

The unified method (e.g. list, get, create, update, delete).

Example: list

Response Body ​

method
string

The unified method this metadata describes.

Example: list
schema
object
REQUIRED · 

The unified-model resource JSON schema.

type
string
All possible enum values:
  • object
$ref
string
properties
object

Map of property name → JsonSchemaObjectProperties.

description
string
required
boolean
default
additionalProperties
boolean
documentation_link
string

Vendor documentation URL for this method, if set on the integration mapping.

response_schema
object
REQUIRED · 

A subset of schema containing only the fields actually populated by response_mapping for this integration.

type
string
All possible enum values:
  • object
$ref
string
properties
object

Map of property name → JsonSchemaObjectProperties.

description
string
required
boolean
default
additionalProperties
boolean
query_schema
object
REQUIRED · 

JSON-schema-style description of the supported query parameters for this method.

type
string
All possible enum values:
  • object
$ref
string
properties
object

Map of property name → JsonSchemaObjectProperties.

description
string
required
boolean
default
additionalProperties
boolean
request_body_schema
object
REQUIRED · 

JSON-schema-style description of the supported request body for this method.

type
string
All possible enum values:
  • object
$ref
string
properties
object

Map of property name → JsonSchemaObjectProperties.

description
string
required
boolean
default
additionalProperties
boolean
default_query
object

Default query parameters always applied by the integration mapping. Values may be templated JSONata expressions.

default_body
object

Default request body always applied by the integration mapping. Values may be templated JSONata expressions. Object or null (arrays are allowed at runtime but rare).