View file processing lineage¶

View its associated workflow processes, build artifacts, and process topology from the Catalog file.

HTTP
GET $CLOUDSIGMA_API_BASE/lineage/catalog-files/{file_id}/overview

Before you call this API¶

Configure the regional API endpoint and authentication, and select the target workspace.

First query the file product, and then call this interface only when the data.has_artifact in the response is true.

file_id must be a Catalog file that has been processed by the workflow and registered with the DataAsset. Raw files that are simply uploaded or mounted to a Volume but have not been processed will not automatically generate a processing link.

Request¶

Input examples

Shell
curl "$CLOUDSIGMA_API_BASE/lineage/catalog-files/$FILE_ID/overview" \
  -H "X-API-Key: $CLOUDSIGMA_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID"

Parameter reference

Request parameters

Parameter	Type	Required	Description
`file_id`	string	Required	Catalog file ID.

Successful response¶

data returns file entry, associated products, workflow calls and processing topology. Save the artifact_id and node_id within; the file name or node display name cannot replace these IDs.

The response fields are as follows.

In field paths, [] denotes each item in an array. For example, items[].name is the name field of each item in the items array.

Response example

JSON
{
  "code": "OK",
  "msg": "OK",
  "data": {
    "artifact": {
      "artifact_id": "art-001",
      "root_asset_id": "asset-001",
      "case_id": "case-001",
      "parsed_file_available": true
    },
    "workflow": {
      "workflow_id": "wf-001",
      "workflow_version_id": "ver-001"
    },
    "workflow_invocation": {
      "input": {},
      "vars": {}
    },
    "topology": {
      "nodes": [
        {
          "node_id": "node-001",
          "label": "解析文件"
        }
      ],
      "edges": [],
      "producer_node_id": "node-001"
    },
    "entry": {
      "catalog_file_id": "file-001"
    }
  }
}

Field reference

Field	Type	Description
`code`	string	OK when successful.
`msg`	string	OK when successful.
`data.artifact.artifact_id`	string	Product ID.
`data.artifact.root_asset_id`	string	Root data asset ID.
`data.artifact.case_id`	string	Association case ID.
`data.artifact.raw_file_id`	string	Raw file ID; returned only if present.
`data.artifact.parsed_file_id`	string	Parsed file ID; returned only if present.
`data.artifact.parsed_file_available`	boolean	Whether the parsed file is available.
`data.workflow.workflow_id`	string	Workflow ID; only returned if there is a value.
`data.workflow.workflow_version_id`	string	Workflow version ID; returned only if there is a value.
`data.workflow_invocation.input`	object	Workflow call input; only returned if there is a value.
`data.workflow_invocation.vars`	object	Workflow call variables; only returned if there is a value.
`data.topology.nodes[]`	array	Processing nodes in the topology.
`data.topology.edges[]`	array	Processing edges in the topology.
`data.topology.producer_node_id`	string	The node ID that produced the current product; only returned if there is a value.
`data.entry.catalog_file_id`	string	Catalog file ID; returned only if there is a value.

Error response¶

Response example

JSON
{
  "code": "ErrNotFound",
  "msg": "资源不存在",
  "data": null
}

Field reference

Field	Type	Description
`code`	string	Error code.
`msg`	string	Readable error message.
`data`	null	`null` in an error response.

Follow-up operations¶

View processing result lineage.

Last updated on Sep 15, 2026