Jump to

• Request
• Response

(Preview) Returns lineage for a given entity object.

post

/20260430/aiDataPlatforms/{aiDataPlatformId}/actions/fetchLineage

(Preview) Returns lineage for a given entity object.

Request

Path Parameters

• aiDataPlatformId(required): string
  Minimum Length: 1

  Maximum Length: 500

  The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the AI Data Platform (Data Lake) instance.

Query Parameters

• limit: integer
  Minimum Value: 1

  Maximum Value: 1000

  For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

  Default Value: 100
• page: string
  Maximum Length: 1024

  For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

Header Parameters

• if-match: string
  Maximum Length: 1000

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
• opc-request-id: string
  Maximum Length: 255

  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.
• opc-retry-token: string
  Maximum Length: 64

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of running that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and removed from the system, then a retry of the original creation request might be rejected.

Body ()

The information needed to obtain desired lineage.

Root Schema : FetchEntityLineageDetails

Type: object

The information needed to obtain desired lineage.

Match All

The information needed to obtain desired lineage.

Show Source

• object ObjectLineageRequestDetails
  Details needed by a lineage fetch request.

{
    "type":"object",
    "description":"The information needed to obtain desired lineage.",
    "allOf":[
        {
            "$ref":"#/definitions/ObjectLineageRequestDetails"
        }
    ]
}

Nested Schema : ObjectLineageRequestDetails

Type: object

Details needed by a lineage fetch request.

Show Source

• anchorNode(required): string
  Root entity node from with the lineage is to be fetched.
• direction(required): string
  Allowed Values: [ "UPSTREAM", "BOTH", "DOWNSTREAM" ]

  Direction of the lineage returned.
• level(required): string
  Allowed Values: [ "ENTITY", "COLUMN" ]

  Indicates the level for lineage fetch. It is one of ENTITY/COLUMN
• maxDepth(required): integer
  Maximum depth to traverse in lineage graph. Depth is measured as number of links from anchor node to matching nodes.
• nodeFilters: object NodeFilterObject
  Filtering parameter that lets users define which entities are included in the results, while still traversing the full lineage.
• pathFilters: object PathFilterObject
  Filtering parameter that lets the user control how far the lineage is traversed.
• shouldIncludeEdges: boolean
  Controls if the edges will be returned with vertices.

{
    "description":"Details needed by a lineage fetch request.",
    "type":"object",
    "required":[
        "anchorNode",
        "maxDepth",
        "level",
        "direction"
    ],
    "properties":{
        "anchorNode":{
            "description":"Root entity node from with the lineage is to be fetched.\n",
            "type":"string"
        },
        "maxDepth":{
            "description":"Maximum depth to traverse in lineage graph. Depth is measured as number of links from anchor node to matching nodes.\n",
            "type":"integer"
        },
        "level":{
            "description":"Indicates the level for lineage fetch. It is one of ENTITY/COLUMN\n",
            "type":"string",
            "x-obmcs-top-level-enum":"#/definitions/LineageLevel",
            "enum":[
                "ENTITY",
                "COLUMN"
            ]
        },
        "direction":{
            "description":"Direction of the lineage returned.",
            "type":"string",
            "x-obmcs-top-level-enum":"#/definitions/LineageDirection",
            "enum":[
                "UPSTREAM",
                "BOTH",
                "DOWNSTREAM"
            ]
        },
        "nodeFilters":{
            "$ref":"#/definitions/NodeFilterObject"
        },
        "pathFilters":{
            "$ref":"#/definitions/PathFilterObject"
        },
        "shouldIncludeEdges":{
            "description":"Controls if the edges will be returned with vertices.",
            "type":"boolean"
        }
    }
}

Nested Schema : NodeFilterObject

Type: object

Filtering parameter that lets users define which entities are included in the results, while still traversing the full lineage.

Show Source

• predicates(required): object NodeFilterPredicates
  List of conditions

{
    "type":"object",
    "description":"Filtering parameter that lets users define which entities are included in the results, while still traversing the full lineage.",
    "required":[
        "predicates"
    ],
    "properties":{
        "predicates":{
            "$ref":"#/definitions/NodeFilterPredicates"
        }
    }
}

Nested Schema : PathFilterObject

Type: object

Filtering parameter that lets the user control how far the lineage is traversed.

Show Source

• predicates(required): object PathFilterPredicates
  List of conditions

{
    "type":"object",
    "description":"Filtering parameter that lets the user control how far the lineage is traversed.",
    "required":[
        "predicates"
    ],
    "properties":{
        "predicates":{
            "$ref":"#/definitions/PathFilterPredicates"
        }
    }
}

Nested Schema : NodeFilterPredicates

Type: object

List of conditions

Show Source

• displayNameContains: string
  Filters nodes whose display name contains the specified value.
• typeEquals: string
  Filters nodes whose type exactly matches the specified value.

{
    "type":"object",
    "description":"List of conditions",
    "properties":{
        "displayNameContains":{
            "type":"string",
            "description":"Filters nodes whose display name contains the specified value."
        },
        "typeEquals":{
            "type":"string",
            "description":"Filters nodes whose type exactly matches the specified value."
        }
    }
}

Nested Schema : PathFilterPredicates

Type: object

List of conditions

Show Source

• anchorNodeColumnsIn: array anchorNodeColumnsIn
  Includes only lineage paths where the anchor node's column is one of the specified values, and column-level traversal starts only from these anchor columns.
• parentIdIn: array parentIdIn
  Includes only those lineage paths in which each node's parent ID is present in the specified list.
• passThroughNode: object PassThroughNodeFilterPredicate
  Includes only lineage paths that pass through the specified intermediate node.

{
    "type":"object",
    "description":"List of conditions",
    "properties":{
        "passThroughNode":{
            "$ref":"#/definitions/PassThroughNodeFilterPredicate"
        },
        "anchorNodeColumnsIn":{
            "type":"array",
            "items":{
                "type":"string"
            },
            "description":"Includes only lineage paths where the anchor node's column is one of the specified values, and column-level traversal starts only from these anchor columns."
        },
        "parentIdIn":{
            "type":"array",
            "items":{
                "type":"string"
            },
            "description":"Includes only those lineage paths in which each node's parent ID is present in the specified list."
        }
    }
}

Nested Schema : anchorNodeColumnsIn

Type: array

Includes only lineage paths where the anchor node's column is one of the specified values, and column-level traversal starts only from these anchor columns.

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    },
    "description":"Includes only lineage paths where the anchor node's column is one of the specified values, and column-level traversal starts only from these anchor columns."
}

Nested Schema : parentIdIn

Type: array

Includes only those lineage paths in which each node's parent ID is present in the specified list.

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    },
    "description":"Includes only those lineage paths in which each node's parent ID is present in the specified list."
}

Nested Schema : PassThroughNodeFilterPredicate

Type: object

Includes only lineage paths that pass through the specified intermediate node.

Show Source

• depth: integer
  Depth of the pass through node from anchor node.
• id: string
  ID of the pass through node.

{
    "type":"object",
    "description":"Includes only lineage paths that pass through the specified intermediate node.",
    "properties":{
        "id":{
            "type":"string",
            "description":"ID of the pass through node."
        },
        "depth":{
            "type":"integer",
            "description":"Depth of the pass through node from anchor node."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Retrieves the Lineage for the entity.

Headers

• opc-next-page: string
  For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.
• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : EntityLineage

Type: object

Lineage for a data entity.

Match All

Lineage for a data entity.

Show Source

• object ObjectLineage
  Lineage for an object.

{
    "type":"object",
    "description":"Lineage for a data entity.",
    "allOf":[
        {
            "$ref":"#/definitions/ObjectLineage"
        }
    ]
}

Nested Schema : ObjectLineage

Type: object

Lineage for an object.

Show Source

• links(required): array links
  Maximum Number of Items: 1000

  Set of links between the objects in the 'objects' set.
• nodes(required): array nodes
  Maximum Number of Items: 1000

  Set of links that are involved in the lineage.

{
    "type":"object",
    "description":"Lineage for an object.",
    "required":[
        "nodes",
        "links"
    ],
    "properties":{
        "nodes":{
            "description":"Set of links that are involved in the lineage.",
            "type":"array",
            "maxItems":1000,
            "items":{
                "$ref":"#/definitions/LineageObject"
            }
        },
        "links":{
            "description":"Set of links between the objects in the 'objects' set.",
            "type":"array",
            "maxItems":1000,
            "items":{
                "$ref":"#/definitions/LineageRelationship"
            }
        }
    }
}

Nested Schema : links

Type: array

Maximum Number of Items: 1000

Set of links between the objects in the 'objects' set.

Show Source

• Array of: object LineageRelationship
  Declares how two elements of object lineage are related.

{
    "description":"Set of links between the objects in the 'objects' set.",
    "type":"array",
    "maxItems":1000,
    "items":{
        "$ref":"#/definitions/LineageRelationship"
    }
}

Nested Schema : nodes

Type: array

Maximum Number of Items: 1000

Set of links that are involved in the lineage.

Show Source

• Array of: object LineageObject
  Object describing an individual element of object lineage.

{
    "description":"Set of links that are involved in the lineage.",
    "type":"array",
    "maxItems":1000,
    "items":{
        "$ref":"#/definitions/LineageObject"
    }
}

Nested Schema : LineageRelationship

Type: object

Declares how two elements of object lineage are related.

Show Source

• fromNodeId: string
  Minimum Length: 1

  Maximum Length: 255

  Object key of source lineage element.
• properties: object properties
  Maximum Number of Properties: 100

  Additional Properties Allowed: additionalProperties

  A map of maps that contains the properties which are specific to the entity type. Each entity type definition defines it's set of required and optional properties. The map keys are category names and the values are maps of property name to property value. Every property is contained inside of a category. Most data entities have required properties within the "default" category. Example: `{"properties": { "default": { "key1": "value1"}}}`
• providerType: string
  Minimum Length: 1

  Maximum Length: 255

  Type of the relationship.
• toNodeId: string
  Minimum Length: 1

  Maximum Length: 255

  Object key of target lineage element.
• type: string
  Minimum Length: 1

  Maximum Length: 255

  Type of the relationship.

{
    "type":"object",
    "description":"Declares how two elements of object lineage are related.",
    "properties":{
        "fromNodeId":{
            "description":"Object key of source lineage element.",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "toNodeId":{
            "description":"Object key of target lineage element.",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "type":{
            "description":"Type of the relationship.",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "providerType":{
            "description":"Type of the relationship.",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "properties":{
            "description":"A map of maps that contains the properties which are specific to the entity type. Each entity type\ndefinition defines it's set of required and optional properties. The map keys are category names and the\nvalues are maps of property name to property value. Every property is contained inside of a category. Most\ndata entities have required properties within the \"default\" category.\nExample: `{\"properties\": { \"default\": { \"key1\": \"value1\"}}}`\n",
            "type":"object",
            "maxProperties":100,
            "additionalProperties":{
                "description":"Key-value pair representing properties of a data entity scoped to a category.\nExample: `{\"key1\": \"value1\"}`\n",
                "type":"object",
                "additionalProperties":{
                    "description":"The string value of the data asset property.",
                    "type":"string"
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Maximum Number of Properties: 100

Additional Properties Allowed

Show Source

• object additionalProperties
  Additional Properties Allowed: additionalProperties

  Key-value pair representing properties of a data entity scoped to a category. Example: `{"key1": "value1"}`

{
    "description":"A map of maps that contains the properties which are specific to the entity type. Each entity type\ndefinition defines it's set of required and optional properties. The map keys are category names and the\nvalues are maps of property name to property value. Every property is contained inside of a category. Most\ndata entities have required properties within the \"default\" category.\nExample: `{\"properties\": { \"default\": { \"key1\": \"value1\"}}}`\n",
    "type":"object",
    "maxProperties":100,
    "additionalProperties":{
        "description":"Key-value pair representing properties of a data entity scoped to a category.\nExample: `{\"key1\": \"value1\"}`\n",
        "type":"object",
        "additionalProperties":{
            "description":"The string value of the data asset property.",
            "type":"string"
        }
    }
}

A map of maps that contains the properties which are specific to the entity type. Each entity type definition defines it's set of required and optional properties. The map keys are category names and the values are maps of property name to property value. Every property is contained inside of a category. Most data entities have required properties within the "default" category. Example: `{"properties": { "default": { "key1": "value1"}}}`

Nested Schema : additionalProperties

Type: object

Additional Properties Allowed

Show Source

• string
  The string value of the data asset property.

{
    "description":"Key-value pair representing properties of a data entity scoped to a category.\nExample: `{\"key1\": \"value1\"}`\n",
    "type":"object",
    "additionalProperties":{
        "description":"The string value of the data asset property.",
        "type":"string"
    }
}

Key-value pair representing properties of a data entity scoped to a category. Example: `{"key1": "value1"}`

Nested Schema : LineageObject

Type: object

Object describing an individual element of object lineage.

Show Source

• depth: integer
  Depth is measured as number of links from anchor node to matching nodes.
• direction: string
  Allowed Values: [ "UPSTREAM", "BOTH", "DOWNSTREAM" ]

  Direction of the lineage.
• displayName: string
  Minimum Length: 1

  Maximum Length: 255

  Display name of the object.
• id: string
  Minimum Length: 1

  Maximum Length: 255

  Key of the object, such as an entity, about which this lineage applies.
• parentId: string
  Minimum Length: 1

  Maximum Length: 255

  Key of the parent object for this object.
• properties: object properties
  Maximum Number of Properties: 100

  Additional Properties Allowed: additionalProperties

  A map of maps that contains the properties which are specific to the entity type. Each entity type definition defines it's set of required and optional properties. The map keys are category names and the values are maps of property name to property value. Every property is contained inside of a category. Most data entities have required properties within the "default" category. Example: `{"properties": { "default": { "key1": "value1"}}}`
• qualifiedName: string
  Minimum Length: 1

  Maximum Length: 255

  External source identifier name of the object.
• type: string
  Minimum Length: 1

  Maximum Length: 255

  Type name of the object.

{
    "type":"object",
    "description":"Object describing an individual element of object lineage.",
    "properties":{
        "id":{
            "description":"Key of the object, such as an entity, about which this lineage applies.",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "qualifiedName":{
            "description":"External source identifier name of the object.",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "displayName":{
            "description":"Display name of the object.",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "parentId":{
            "description":"Key of the parent object for this object.",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "type":{
            "description":"Type name of the object.",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "direction":{
            "description":"Direction of the lineage.",
            "type":"string",
            "x-obmcs-top-level-enum":"#/definitions/LineageDirection",
            "enum":[
                "UPSTREAM",
                "BOTH",
                "DOWNSTREAM"
            ]
        },
        "depth":{
            "description":"Depth is measured as number of links from anchor node to matching nodes.\n",
            "type":"integer"
        },
        "properties":{
            "description":"A map of maps that contains the properties which are specific to the entity type. Each entity type\ndefinition defines it's set of required and optional properties. The map keys are category names and the\nvalues are maps of property name to property value. Every property is contained inside of a category. Most\ndata entities have required properties within the \"default\" category.\nExample: `{\"properties\": { \"default\": { \"key1\": \"value1\"}}}`\n",
            "type":"object",
            "maxProperties":100,
            "additionalProperties":{
                "description":"Key-value pair representing properties of a data entity scoped to a category.\nExample: `{\"key1\": \"value1\"}`\n",
                "type":"object",
                "additionalProperties":{
                    "description":"The string value of the data asset property.",
                    "type":"string"
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Maximum Number of Properties: 100

Additional Properties Allowed

Show Source

• object additionalProperties
  Additional Properties Allowed: additionalProperties

  Key-value pair representing properties of a data entity scoped to a category. Example: `{"key1": "value1"}`

{
    "description":"A map of maps that contains the properties which are specific to the entity type. Each entity type\ndefinition defines it's set of required and optional properties. The map keys are category names and the\nvalues are maps of property name to property value. Every property is contained inside of a category. Most\ndata entities have required properties within the \"default\" category.\nExample: `{\"properties\": { \"default\": { \"key1\": \"value1\"}}}`\n",
    "type":"object",
    "maxProperties":100,
    "additionalProperties":{
        "description":"Key-value pair representing properties of a data entity scoped to a category.\nExample: `{\"key1\": \"value1\"}`\n",
        "type":"object",
        "additionalProperties":{
            "description":"The string value of the data asset property.",
            "type":"string"
        }
    }
}

A map of maps that contains the properties which are specific to the entity type. Each entity type definition defines it's set of required and optional properties. The map keys are category names and the values are maps of property name to property value. Every property is contained inside of a category. Most data entities have required properties within the "default" category. Example: `{"properties": { "default": { "key1": "value1"}}}`

Nested Schema : additionalProperties

Type: object

Additional Properties Allowed

Show Source

• string
  The string value of the data asset property.

{
    "description":"Key-value pair representing properties of a data entity scoped to a category.\nExample: `{\"key1\": \"value1\"}`\n",
    "type":"object",
    "additionalProperties":{
        "description":"The string value of the data asset property.",
        "type":"string"
    }
}

Key-value pair representing properties of a data entity scoped to a category. Example: `{"key1": "value1"}`

400 Response

Bad Request (invalid query parameters, malformed headers, and so on).

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

401 Response

Unauthorized (missing or expired credentials, and so on).

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

404 Response

Not Found. The requested resource was not found.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

409 Response

Conflict. Request conflicts with the current state of the resource.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

412 Response

Precondition Failed (One or more conditions in request failed).

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

429 Response

Too Many Requests. Too many requests sent to the server in a short period.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

500 Response

Internal Server Error. The server encountered an unexpected condition preventing fulfilment of the request.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

Default Response

Unknown Error. Error is not recognized by the system.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

Back to Top