backend_mcp_api

Showing 25 of 32 from the live probe.

• Retrieve Products

  When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. Retrieves a product by its unique identifier. # Response Schema ```json { $ref: '#/$defs/product', $defs: { product: { type: 'object', properties: { id: { type: 'string', description: 'The id of the entity.' }, clientId: { type: 'string', description:

• Update Products

  When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. Updates a product with the provided details. # Response Schema ```json { $ref: '#/$defs/product', $defs: { product: { type: 'object', properties: { id: { type: 'string', description: 'The id of the entity.' }, clientId: { type: 'string', description:

• List Products

  When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. Lists all products # Response Schema ```json { type: 'array', items: { $ref: '#/$defs/product' }, $defs: { product: { type: 'object', properties: { id: { type: 'string', description: 'The id of the entity.' }, clientId: { type: 'string', descr

• Retrieve Data Sources

  When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. Get a data source by ID. # Response Schema ```json { $ref: '#/$defs/data_source', $defs: { data_source: { type: 'object', properties: { id: { type: 'string', description: 'The id of the entity.' }, clientId: { type: 'string', description: 'The id of t

• Update Data Sources

  When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. Update a data source. # Response Schema ```json { $ref: '#/$defs/data_source', $defs: { data_source: { type: 'object', properties: { id: { type: 'string', description: 'The id of the entity.' }, clientId: { type: 'string', description: 'The id of the

• List Data Sources

  When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. List all data sources. # Response Schema ```json { type: 'array', items: { $ref: '#/$defs/data_source' }, $defs: { data_source: { type: 'object', properties: { id: { type: 'string', description: 'The id of the entity.' }, clientId: { type: 'string',

• List Latest Data Data Sources

  When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. List the latest data for all data sources. # Response Schema ```json { type: 'array', items: { $ref: '#/$defs/data_source_data' }, $defs: { data_source_data: { type: 'object', properties: { time: { type: 'string', description: 'The time of the reading' }, value:

• Refresh Data Sources

  When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. Adds any missing data sources. # Response Schema ```json { type: 'array', items: { $ref: '#/$defs/data_source' }, $defs: { data_source: { type: 'object', properties: { id: { type: 'string', description: 'The id of the entity.' }, clientId: { type: 'stri

• List Beta Data Data Sources Data

  When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. List data source data. # Response Schema ```json { type: 'array', items: { $ref: '#/$defs/data_source_data' }, $defs: { data_source_data: { type: 'object', properties: { time: { type: 'string', description: 'The time of the reading' }, value: { type: 'o

• Retrieve Assets

  When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. # Response Schema ```json { $ref: '#/$defs/asset', $defs: { asset: { type: 'object', properties: { id: { type: 'string', description: 'The id of the asset' }, clientId: { type: 'string', description: 'The id of the client that owns the asset.'

• Update Assets

  When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. # Response Schema ```json { $ref: '#/$defs/asset', $defs: { asset: { type: 'object', properties: { id: { type: 'string', description: 'The id of the asset' }, clientId: { type: 'string', description: 'The id of the client that owns the asset.'

• List Assets

  When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. # Response Schema ```json { type: 'array', items: { $ref: '#/$defs/asset' }, $defs: { asset: { type: 'object', properties: { id: { type: 'string', description: 'The id of the asset' }, clientId: { type: 'string', description: 'The id of the c

• Update Assets Data Source Groups

  When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. # Response Schema ```json { $ref: '#/$defs/data_source_group', $defs: { data_source_group: { type: 'object', properties: { id: { type: 'string', description: 'The id of the data source group.' }, dataSourceIds: { type: 'array', description: 'The ids

• Create Edge Batches

  When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. Creates a new batch with the provided details and optional, recipeId, productId. # Response Schema ```json { $ref: '#/$defs/edge_batch', $defs: { edge_batch: { type: 'object', properties: { id: { type: 'string', description: 'The id of the batch' }, clientId: {

• Retrieve Edge Batches

  When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. Retrieves details of a specific batch. # Response Schema ```json { $ref: '#/$defs/edge_batch', $defs: { edge_batch: { type: 'object', properties: { id: { type: 'string', description: 'The id of the batch' }, clientId: { type: 'string', description: 'T

• Update Edge Batches

  When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. Updates the metadata of an existing batch. # Response Schema ```json { $ref: '#/$defs/edge_batch', $defs: { edge_batch: { type: 'object', properties: { id: { type: 'string', description: 'The id of the batch' }, clientId: { type: 'string', description

• List Edge Batches

  When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. Retrieves all batches belonging to the authenticated client. # Response Schema ```json { type: 'array', items: { $ref: '#/$defs/edge_batch' }, $defs: { edge_batch: { type: 'object', properties: { id: { type: 'string', description: 'The id of the batch' }, clientI

• Create Edge Batches Occupancies

  When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. Creates and adds a new occupancy to an existing batch. The occupancy will be associated with the specified asset. # Response Schema ```json { $ref: '#/$defs/edge_batch_stage', $defs: { edge_batch_stage: { type: 'object', properties: { id: { type: 'string', description: 'The id of the ba

• Retrieve Edge Batches Occupancies

  When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. Retrieves details of a specific occupancy within a batch. # Response Schema ```json { $ref: '#/$defs/batch_occupancy', $defs: { batch_occupancy: { type: 'object', properties: { id: { type: 'string', description: 'The id of the occupancy.' }, assetId: { type: 's

• Update Edge Batches Occupancies

  When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. Updates an existing occupancy within a batch. Can be used to modify start and end times. # Response Schema ```json { $ref: '#/$defs/batch_occupancy', $defs: { batch_occupancy: { type: 'object', properties: { id: { type: 'string', description: 'The id of the occupancy.' },

• List Edge Batches Occupancies

  When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. Retrieves all occupancies associated with a specific batch. # Response Schema ```json { type: 'array', items: { $ref: '#/$defs/batch_occupancy' }, $defs: { batch_occupancy: { type: 'object', properties: { id: { type: 'string', description: 'The id of the occupancy.' },

• Calculate Asset Oee

  Calculates the Overall Equipment Efficiency (OEE) for one or more assets across multiple time periods. OEE = (active time / total time) × 100. Supports comparing multiple periods in a single call.

• Current Batch In Asset

  Returns the batch currently in a given asset. Searches for active batches that have an occupancy on the specified asset where the occupancy is currently active (started but not ended, or end time is in the future). An asset can only have one current batch at a time. If no current batch is found, returns null. # Response Schema ```json { type: 'object', properties: { assetId: { type: 'string', description: 'The ID of the asset that was queried' }, assetName: { t

• List Metric Field Catalog

  Retrieves the canonical metric-field catalog for this client. This catalog is the source of truth for metric builder field selection and includes: - builtin fields - related_builtin fields - custom fields (scalar custom property definitions) - custom_table fields (table custom property axes and cell columns) custom_table entries have source="custom_table" and include tableFieldKind ("axis" or "cell") and columnKey (for cell fields). Use this before building metric documents to avoid stale/har

• Filter Batches By End Date

  Filters batches based on their end date. Returns all batches that either have an end date after the specified date OR do not have a defined end date (ongoing batches). Returns the same complete batch information as the list_edge_batches tool, including all batch details, occupancies, stages, and associated data. # Response Schema ```json { type: 'array', items: { $ref: '#/$defs/edge_batch' }, $defs: { edge_batch: { type: 'object', properties: { id: {