Gudu SQLFlow Product Docs
  • 1. Introduction
    • What is Gudu SQLFlow?
      • What SQLFlow can do
      • Architecture Overview
    • Getting Started
      • Sign up a new account
        • Team Management
        • Delete My Account
        • Activate by entering a coupon
      • How to use SQLFlow
      • Different modes in Gudu SQLFlow
        • Query mode
        • Job mode
      • Basic Usage
      • Convert SQL to E-R Diagram
      • Colors in SQLFlow Diagram
      • Show call relationship
    • Installation
      • Version and Users
        • Cloud and On-Premise version
        • SQLFlow before Version 6
          • For older version SQLFlow under Linux
          • For older version SQLFlow under MacOS
          • For older version SQLFlow under Windows
      • Linux
      • MacOS
      • Windows
      • Docker
      • Clickhouse Installation
        • Clickhouse For CentOs
        • Clickhouse For Ubuntu/Debian/RHEL
      • Troubleshooting
      • Upgrade
      • Third Party Components
      • Renew License File
    • UI
      • SQLText Editor
      • Schema Explorer
      • Diagram Panel
      • Settings
      • Job Management
        • Job Sources
    • Dlineage Tool
      • Overview
      • Usage
        • Analyze data linege from SQL files
        • Analyze data linege from a database
        • Resolve the ambiguous columns in SQL query
        • Map the DataFlowAnalyzer and the settings on SQLFlow UI
        • Settings
      • Dataflow.xml structure
      • FAQ
  • 2. CONCEPTS
    • Data Lineage Basics
      • Dataflow
        • Relations generated by SQLFlow
      • Direct Dataflow
      • Indirect Dataflow
      • Aggregate function and Dataflow
      • Dataflow chain
    • Data Lineage Format Reference
  • 3. API Docs
    • Prerequisites
    • Using the Rest API
    • SQLFlow Rest API reference
      • User Interface
      • Generation Interface
        • /sqlflow
        • /sqlflow/selectedgraph/table_level_lineage
        • /sqlflow/selectedgraph/image
        • /sqlflow/graph
        • /sqlflow/graph/table_level_lineage
        • /sqlflow/graph/image
        • /sqlflow/downstreamGraph
        • /sqlflow/upstreamGraph
        • /sqlflow/erdiagramSelectGraph
        • /sqlflow/leftMostSourceTableGraph
      • Job Interface
        • /submitUserJob
        • /displayUserJobSummary
        • /displayUserJobsSummary
        • /exportLineageAsJson
        • /exportFullLineageAsJson
        • /exportLineageAsGraphml
        • /submitPersistJob
        • /displayUserLatestJobTableLevelLineage
      • Export Image
      • Export CSV
        • /sqlflow/exportFullLineageAsCsv
        • /job/exportFullLineageAsCsv
    • Swagger UI
    • Export the data lineage result
    • Python
      • Basic Usage
      • Advanced Usage
    • SQL Parser API
      • checkSyntax
  • 4. SQLFlow Widget
    • Widget Get started
    • Usages
    • Widget API Reference
  • 5. Databases
    • Database Objects
      • Azure
      • DB2
  • 6. SQLFlow-ingester
    • Introduction
      • SQLFlow-Exporter
      • SQLFlow-Extractor
      • SQLFlow-Submitter
    • Get Started
      • SQL Server
    • SQLFlow-Ingester Java API Usage
    • Understand the format of exported data
      • Oracle
      • Microsoft SQL Server
      • MySQL
      • PostgreSQL
    • List of Supported dbVendors
    • Git Repo
    • Third Party Components
  • 7. Reference
    • Lineage Model
      • Json Format Lineage Model
      • XML Format Lineage Model
      • Data Lineage Elements
    • Database Model
  • 8. other
    • FAQ
      • Handling Internal Database
      • Delete Your Account
      • Table Form Data Without Intermediates
      • Not all schema exported from Oracle
      • Lineage Customization
    • Roadmap
    • SQL Samples
      • Exchange table partition
      • Generate relationship for renamed table
      • Snowflake table function lineage detection
    • Change Logs
    • SQLFlow with Oracle XML functions
    • Major Organizations Utilizing SQLFlow
Powered by GitBook
On this page
  1. 3. API Docs
  2. SQLFlow Rest API reference
  3. Job Interface

/displayUserLatestJobTableLevelLineage

Previous/submitPersistJobNextExport Image

Last updated 2 years ago

Sample response:

{
  "jobId": "939fdbbaf52b45139b86c0761d6036b0",
  "code": 200,
  "data": {
    "mode": "global",
    "summary": {
      "schema": 0,
      "process": 1,
      "database": 0,
      "view": 0,
      "mostRelationTables": [],
      "column": 3,
      "relationship": 0,
      "table": 1
    },
    "sqlflow": {
      "dbvendor": "dbvoracle",
      "relationships": [],
      "dbobjs": [
        {
          "queryHashId": "04ebc5aec1a07e1db80b0bc798742875",
          "name": "QUERY INSERT-1",
          "coordinates": [
            {
              "hashCode": "0",
              "x": 1,
              "y": 1
            },
            {
              "hashCode": "0",
              "x": 1,
              "y": 73
            }
          ],
          "id": "8",
          "type": "process"
        },
        {
          "columns": [
            {
              "name": "ID",
              "coordinates": [
                {
                  "hashCode": "0",
                  "x": 1,
                  "y": 28
                },
                {
                  "hashCode": "0",
                  "x": 1,
                  "y": 30
                }
              ],
              "id": "5"
            },
            {
              "name": "FIRST_NAME",
              "coordinates": [
                {
                  "hashCode": "0",
                  "x": 1,
                  "y": 32
                },
                {
                  "hashCode": "0",
                  "x": 1,
                  "y": 42
                }
              ],
              "id": "6"
            },
            {
              "name": "LAST_NAME",
              "coordinates": [
                {
                  "hashCode": "0",
                  "x": 1,
                  "y": 44
                },
                {
                  "hashCode": "0",
                  "x": 1,
                  "y": 53
                }
              ],
              "id": "7"
            }
          ],
          "name": "RAW_CUSTOMERS",
          "coordinates": [
            {
              "hashCode": "0",
              "x": 1,
              "y": 13
            },
            {
              "hashCode": "0",
              "x": 1,
              "y": 26
            }
          ],
          "id": "4",
          "type": "table"
        }
      ]
    },
    "graph": {
      "relationshipIdMap": {},
      "elements": {
        "tables": [],
        "edges": []
      },
      "tooltip": {},
      "listIdMap": {}
    }
  },
  "sessionId": "24a4455c71fa35c0393d5747f9c23a9d99f32fa4c130a6b8da8d6a7db8d157ae_1664880305725",
  "job": {
    "ignoreFunction": true,
    "lastExecuteTime": "2022-10-04 10:45:05",
    "schedulable": false,
    "parallel": false,
    "ignoreRecordSet": true,
    "userEmail": "guyuanhao@foxmail.com",
    "persist": false,
    "executeTimeMillis": 0,
    "jobName": "yuanhao1",
    "dataflowOfAggregateFunction": "direct",
    "showTransform": false,
    "sessionId": "24a4455c71fa35c0393d5747f9c23a9d99f32fa4c130a6b8da8d6a7db8d157ae_1664880305725",
    "incremental": false,
    "showConstantTable": false,
    "userId": "auth0|6326be4047c1dfdd3bf553d0",
    "showRelationType": "fdd",
    "subJobs": [],
    "version": "5.2.0",
    "jobId": "939fdbbaf52b45139b86c0761d6036b0",
    "createTime": "2022-10-04 10:45:04",
    "onTop": false,
    "cancelSchedule": false,
    "dbVendor": "dbvoracle",
    "fileNames": [
      "test.sql"
    ],
    "status": "success",
    "executeTime": "0min 1sec"
  }
}

display user latest job table level lineage

post

display user latest job table level lineage

Query parameters
ignoreSelfLineagebooleanOptional

whether ingore self lineage

Default: true
tokenstringRequired

The token is generated from userid and usersecret. It is used in every Api invocation.

userIdstringRequired

user id

Responses
ResponsestringExample: {"jobId":"939fdbbaf52b45139b86c0761d6036b0","code":200,"data":{"mode":"global","summary":{"schema":0,"process":1,"database":0,"view":0,"mostRelationTables":[],"column":3,"relationship":0,"table":1},"sqlflow":{"dbvendor":"dbvoracle","relationships":[],"dbobjs":[{"queryHashId":"04ebc5aec1a07e1db80b0bc798742875","name":"QUERY INSERT-1","coordinates":[{"hashCode":"0","x":1,"y":1},{"hashCode":"0","x":1,"y":73}],"id":"8","type":"process"},{"columns":[{"name":"ID","coordinates":[{"hashCode":"0","x":1,"y":28},{"hashCode":"0","x":1,"y":30}],"id":"5"},{"name":"FIRST_NAME","coordinates":[{"hashCode":"0","x":1,"y":32},{"hashCode":"0","x":1,"y":42}],"id":"6"},{"name":"LAST_NAME","coordinates":[{"hashCode":"0","x":1,"y":44},{"hashCode":"0","x":1,"y":53}],"id":"7"}],"name":"RAW_CUSTOMERS","coordinates":[{"hashCode":"0","x":1,"y":13},{"hashCode":"0","x":1,"y":26}],"id":"4","type":"table"}]},"graph":{"relationshipIdMap":{},"elements":{"tables":[],"edges":[]},"tooltip":{},"listIdMap":{}}},"sessionId":"24a4455c71fa35c0393d5747f9c23a9d99f32fa4c130a6b8da8d6a7db8d157ae_1664880305725","job":{"ignoreFunction":true,"lastExecuteTime":"2022-10-04 10:45:05","schedulable":false,"parallel":false,"ignoreRecordSet":true,"userEmail":"guyuanhao@foxmail.com","persist":false,"executeTimeMillis":0,"jobName":"yuanhao1","dataflowOfAggregateFunction":"direct","showTransform":false,"sessionId":"24a4455c71fa35c0393d5747f9c23a9d99f32fa4c130a6b8da8d6a7db8d157ae_1664880305725","incremental":false,"showConstantTable":false,"userId":"auth0|6326be4047c1dfdd3bf553d0","showRelationType":"fdd","subJobs":[],"version":"5.2.0","jobId":"939fdbbaf52b45139b86c0761d6036b0","createTime":"2022-10-04 10:45:04","onTop":false,"cancelSchedule":false,"dbVendor":"dbvoracle","fileNames":["test.sql"],"status":"success","executeTime":"0min 1sec"}}
post
POST /api/gspLive_backend/sqlflow/job/displayUserLatestJobTableLevelLineage HTTP/1.1
Host: api.gudusoft.com
Accept: */*

{
  "jobId": "939fdbbaf52b45139b86c0761d6036b0",
  "code": 200,
  "data": {
    "mode": "global",
    "summary": {
      "schema": 0,
      "process": 1,
      "database": 0,
      "view": 0,
      "mostRelationTables": [],
      "column": 3,
      "relationship": 0,
      "table": 1
    },
    "sqlflow": {
      "dbvendor": "dbvoracle",
      "relationships": [],
      "dbobjs": [
        {
          "queryHashId": "04ebc5aec1a07e1db80b0bc798742875",
          "name": "QUERY INSERT-1",
          "coordinates": [
            {
              "hashCode": "0",
              "x": 1,
              "y": 1
            },
            {
              "hashCode": "0",
              "x": 1,
              "y": 73
            }
          ],
          "id": "8",
          "type": "process"
        },
        {
          "columns": [
            {
              "name": "ID",
              "coordinates": [
                {
                  "hashCode": "0",
                  "x": 1,
                  "y": 28
                },
                {
                  "hashCode": "0",
                  "x": 1,
                  "y": 30
                }
              ],
              "id": "5"
            },
            {
              "name": "FIRST_NAME",
              "coordinates": [
                {
                  "hashCode": "0",
                  "x": 1,
                  "y": 32
                },
                {
                  "hashCode": "0",
                  "x": 1,
                  "y": 42
                }
              ],
              "id": "6"
            },
            {
              "name": "LAST_NAME",
              "coordinates": [
                {
                  "hashCode": "0",
                  "x": 1,
                  "y": 44
                },
                {
                  "hashCode": "0",
                  "x": 1,
                  "y": 53
                }
              ],
              "id": "7"
            }
          ],
          "name": "RAW_CUSTOMERS",
          "coordinates": [
            {
              "hashCode": "0",
              "x": 1,
              "y": 13
            },
            {
              "hashCode": "0",
              "x": 1,
              "y": 26
            }
          ],
          "id": "4",
          "type": "table"
        }
      ]
    },
    "graph": {
      "relationshipIdMap": {},
      "elements": {
        "tables": [],
        "edges": []
      },
      "tooltip": {},
      "listIdMap": {}
    }
  },
  "sessionId": "24a4455c71fa35c0393d5747f9c23a9d99f32fa4c130a6b8da8d6a7db8d157ae_1664880305725",
  "job": {
    "ignoreFunction": true,
    "lastExecuteTime": "2022-10-04 10:45:05",
    "schedulable": false,
    "parallel": false,
    "ignoreRecordSet": true,
    "userEmail": "guyuanhao@foxmail.com",
    "persist": false,
    "executeTimeMillis": 0,
    "jobName": "yuanhao1",
    "dataflowOfAggregateFunction": "direct",
    "showTransform": false,
    "sessionId": "24a4455c71fa35c0393d5747f9c23a9d99f32fa4c130a6b8da8d6a7db8d157ae_1664880305725",
    "incremental": false,
    "showConstantTable": false,
    "userId": "auth0|6326be4047c1dfdd3bf553d0",
    "showRelationType": "fdd",
    "subJobs": [],
    "version": "5.2.0",
    "jobId": "939fdbbaf52b45139b86c0761d6036b0",
    "createTime": "2022-10-04 10:45:04",
    "onTop": false,
    "cancelSchedule": false,
    "dbVendor": "dbvoracle",
    "fileNames": [
      "test.sql"
    ],
    "status": "success",
    "executeTime": "0min 1sec"
  }
}