← API reference
CANONICAL TYPE REFERENCE

IntegrationExportedActionDescription

An API operation an integration definition exports as an Action. Its schemas are generated from the operation's compiled contract and describe it for discovery only.

nameString!

The Action's name, client.operation, as callers pass it to runIntegrationAction.

labelString!

The HTTP method and path the operation calls on the instance's bound device.

JSON Schema of the Action's input: the operation's request (path, query, headers, body).

JSON Schema of the Action's result: the operation's response, its status and body.

View exact SDL
"""
An API operation an integration definition exports as an Action. Its schemas are generated from the operation's compiled contract and describe it for discovery only.
"""
type IntegrationExportedActionDescription {
  """
  The Action's name, `client.operation`, as callers pass it to runIntegrationAction.
  """
  name: String!
  """
  The HTTP method and path the operation calls on the instance's bound device.
  """
  label: String!
  """
  JSON Schema of the Action's input: the operation's request (path, query, headers, body).
  """
  inputSchema: String!
  """
  JSON Schema of the Action's result: the operation's response, its status and body.
  """
  outputSchema: String!
}

One stable address across all schema views. Follow a field’s type to explore connections between domains.