# Data Layer

APIs for Data Layer - Pipelines, Dataflows, Lineage etc

 - [GET /platform-config/proxy/dl-platform/workflows/{workflowId}](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/getworkflowbyid.md): Returns a single Dataflow by their unique ID
 - [PUT /platform-config/proxy/dl-platform/workflows/{workflowId}](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/updateworkflow.md): Update a Dataflow with the provided information
 - [DELETE /platform-config/proxy/dl-platform/workflows/{workflowId}](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/deleteworkflow.md): Delete a Dataflow with given ID
 - [GET /platform-config/proxy/dl-platform/knowledge-clusters/{kcId}/hooks/{hookId}](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/get.md): Returns a single Job Hook by its unique ID
 - [PUT /platform-config/proxy/dl-platform/knowledge-clusters/{kcId}/hooks/{hookId}](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/update.md): Updates the given Job Hook and returns its ID. Send application/json to change fields only, or multipart/form-data with files_added and files_removed to apply a file delta in the same call; sending ne
 - [DELETE /platform-config/proxy/dl-platform/knowledge-clusters/{kcId}/hooks/{hookId}](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/delete.md): Delete a Job Hook with given ID
 - [GET /platform-config/proxy/dl-platform/compute-connectors/{computeConnectorId}](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/getcomputeconnectorbyid.md): Returns a single Compute connector by their unique ID
 - [PUT /platform-config/proxy/dl-platform/compute-connectors/{computeConnectorId}](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/updatecomputeconnector.md): Update a Compute connector with the provided information
 - [DELETE /platform-config/proxy/dl-platform/compute-connectors/{computeConnectorId}](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/deletecomputeconnector.md): Delete a Compute Connector with given ID
 - [GET /platform-config/proxy/dl-platform/compute-connectors/{computeConnectorId}/templates/{computeTemplateId}](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/getcomputetemplatebyid.md): Returns a single Compute template by their unique ID
 - [PUT /platform-config/proxy/dl-platform/compute-connectors/{computeConnectorId}/templates/{computeTemplateId}](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/updatecomputetemplate.md): Update a Compute template with the provided information
 - [DELETE /platform-config/proxy/dl-platform/compute-connectors/{computeConnectorId}/templates/{computeTemplateId}](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/deletecomputetemplate.md): Delete a Compute template
 - [GET /platform-config/proxy/dl-platform/workflows](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/getworkflow.md): Returns List of Dataflows by provided criteria
 - [POST /platform-config/proxy/dl-platform/workflows](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/createworkflow.md): Create a Dataflow with the provided information
 - [GET /platform-config/proxy/dl-platform/workflows/{workflowId}/versions](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/listversions.md): Returns List of Versions for the given Dataflow by provided criteria
 - [POST /platform-config/proxy/dl-platform/workflows/{workflowId}/versions](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/createversion.md): Creates a new Version for the given Dataflow and returns its ID
 - [POST /platform-config/proxy/dl-platform/workflows/{workflowId}/versions/{versionId}/tasks](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/createtask.md): Adds a task to the given Dataflow Version and returns its task id
 - [DELETE /platform-config/proxy/dl-platform/workflows/{workflowId}/versions/{versionId}/tasks](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/deletetasks.md): Deletes the given task ids from the dataflow version in a single transaction. Task ids not present in the version are ignored.
 - [POST /platform-config/proxy/dl-platform/workflows/{workflowId}/versions/{versionId}/tasks/{taskId}/script](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/uploadtaskscript.md): Uploads a bash script for a task in this dataflow version
 - [POST /platform-config/proxy/dl-platform/workflows/{workflowId}/versions/{versionId}/resume](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/resumeworkflowversion.md): Returns versionId if resumed
 - [POST /platform-config/proxy/dl-platform/workflows/{workflowId}/versions/{versionId}/pause](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/pauseworkflowversion.md): Returns versionId if paused
 - [POST /platform-config/proxy/dl-platform/workflows/{workflowId}/versions/{versionId}/clone](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/cloneversion.md): Creates a new Dataflow Version by copying the given Version and returns the new Version ID
 - [POST /platform-config/proxy/dl-platform/workflows/{workflowId}/versions/{versionId}/activate](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/activateversion.md): Marks the given Dataflow Version as the active Version for its Dataflow
 - [GET /platform-config/proxy/dl-platform/workflow_runs](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/getworkflowruns.md): Returns List of Dataflow Runs by provided criteria
 - [POST /platform-config/proxy/dl-platform/workflow_runs](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/submitworkflowrun.md): Returns id of submitted Dataflow Run
 - [POST /platform-config/proxy/dl-platform/query](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/submitasyncquery.md): Submits a query for asynchronous execution and returns the ID used to poll its status and results
 - [GET /platform-config/proxy/dl-platform/pipelines](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/listpipelines.md): Returns List of Pipelines by provided criteria. Set resolveRef to true to also resolve the referenced source and knowledge cluster details.
 - [POST /platform-config/proxy/dl-platform/pipelines](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/createpipeline.md): Create a Pipeline with the provided information
 - [GET /platform-config/proxy/dl-platform/pipelines/{pipelineId}/versions](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/listversions_1.md): Returns List of Versions for the given Pipeline by provided criteria
 - [POST /platform-config/proxy/dl-platform/pipelines/{pipelineId}/versions](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/createversion_1.md): Creates a new Version for the given Pipeline and returns its ID
 - [POST /platform-config/proxy/dl-platform/pipelines/{pipelineId}/versions/{versionId}/config](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/updateconfig.md): Replaces the configuration of the given Pipeline Version
 - [POST /platform-config/proxy/dl-platform/pipelines/{pipelineId}/versions/{versionId}/clone](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/cloneversion_1.md): Creates a new Pipeline Version by copying the given Version and returns the new Version ID
 - [POST /platform-config/proxy/dl-platform/pipelines/{pipelineId}/versions/{versionId}/activate](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/activateversion_1.md): Marks the given Pipeline Version as the active Version for its Pipeline
 - [GET /platform-config/proxy/dl-platform/knowledge-clusters/{kcId}/hooks](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/list_1.md): Returns List of Job Hooks for the given Knowledge Cluster by provided criteria
 - [POST /platform-config/proxy/dl-platform/knowledge-clusters/{kcId}/hooks](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/create_1.md): Creates a Job Hook for the given Knowledge Cluster and returns its ID. Send application/json for a Job Hook without files, or multipart/form-data with a hook part and repeated files parts to create th
 - [GET /platform-config/proxy/dl-platform/jobs](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/listjobs.md): Returns List of Ingestion Jobs by provided criteria
 - [POST /platform-config/proxy/dl-platform/jobs](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/submitbatchjob.md): Submit a batch job
 - [POST /platform-config/proxy/dl-platform/jobs/{jobId}/cancel](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/canceljobbyid.md): Will submit job cancellation request, job will be canclled in background so there will be slight delay.
 - [POST /platform-config/proxy/dl-platform/configPortability/import](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/doimport.md): Same as import, with the request JSON in a 'config' part and each file in a part named for the entity and file it belongs to
 - [POST /platform-config/proxy/dl-platform/configPortability/import/init](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/initimport.md): Parses an exported config file and returns the sub-entity mappings required for import (for a pipeline version, the source tables referenced by its SQL)
 - [GET /platform-config/proxy/dl-platform/compute-connectors](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/getcomputeconnectors.md): Returns List of Compute connectors by provided criteria
 - [POST /platform-config/proxy/dl-platform/compute-connectors](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/createcomputeconnector.md): Create a Compute connector with the provided information
 - [GET /platform-config/proxy/dl-platform/compute-connectors/{computeConnectorId}/templates](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/getcomputeconnectors_1.md): Returns List of Compute templates for a compute connector by criteria
 - [POST /platform-config/proxy/dl-platform/compute-connectors/{computeConnectorId}/templates](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/createcomputetemplate.md): Create a Compute template with the provided information
 - [POST /platform-config/proxy/dl-platform/compute-connectors/{computeConnectorId}/templates/{computeTemplateId}/action/{actionType}](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/triggercomputeaction.md)
 - [GET /platform-config/proxy/dl-platform/audit-logs](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/listauditlogs.md): Returns a paginated list of entity audit log entries
 - [POST /platform-config/proxy/dl-platform/audit-logs](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/createauditlog.md): Accepts an audit event from an external service and persists it
 - [GET /platform-config/proxy/dl-platform/workflows/{workflowId}/versions/{versionId}](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/getversion.md): Returns a single Dataflow Version by its unique ID, including its parameters, tasks and edges
 - [DELETE /platform-config/proxy/dl-platform/workflows/{workflowId}/versions/{versionId}](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/deleteversion.md): Delete a Dataflow Version with given ID
 - [PATCH /platform-config/proxy/dl-platform/workflows/{workflowId}/versions/{versionId}](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/updateversion.md): Applies a partial update to the given Dataflow Version
 - [GET /platform-config/proxy/dl-platform/workflows/{workflowId}/versions/{versionId}/tasks/{taskId}](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/gettask.md): Returns a single task from the given Dataflow Version by its task id
 - [PATCH /platform-config/proxy/dl-platform/workflows/{workflowId}/versions/{versionId}/tasks/{taskId}](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/updatetask.md): Applies a partial update to a task in the given Dataflow Version
 - [DELETE /platform-config/proxy/dl-platform/workflows/{workflowId}/versions/{versionId}/edges](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/removeedges.md): Removes dependency edges between tasks in the given Dataflow Version. Edges not present in the version are ignored.
 - [PATCH /platform-config/proxy/dl-platform/workflows/{workflowId}/versions/{versionId}/edges](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/addedges.md): Adds dependency edges between tasks in the given Dataflow Version. Each edge points from one task id to another.
 - [PATCH /platform-config/proxy/dl-platform/query/{id}/cancel](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/cancelquery.md): Requests cancellation of a Query that has not finished executing
 - [PATCH /platform-config/proxy/dl-platform/query/{id}/approve](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/approvequery.md): Approves a Query that is awaiting approval so that it can proceed to execution
 - [GET /platform-config/proxy/dl-platform/pipelines/{pipelineId}/versions/{versionId}](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/getversion_1.md): Returns a single Pipeline Version by its unique ID
 - [DELETE /platform-config/proxy/dl-platform/pipelines/{pipelineId}/versions/{versionId}](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/deleteversion_1.md): Delete a Pipeline Version with given ID
 - [PATCH /platform-config/proxy/dl-platform/pipelines/{pipelineId}/versions/{versionId}](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/updateversion_1.md): Applies a partial update to the given Pipeline Version. Set add_audit to true to record an audit entry for the change.
 - [GET /platform-config/proxy/dl-platform/pipelines/{id}](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/getpipeline.md): Returns a single Pipeline by its unique ID. Set resolveRef to true to also resolve the referenced source and knowledge cluster details.
 - [DELETE /platform-config/proxy/dl-platform/pipelines/{id}](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/deletepipeline.md): Delete a Pipeline with given ID
 - [PATCH /platform-config/proxy/dl-platform/pipelines/{id}](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/updatepipeline.md): Applies a partial update to the Pipeline with the given ID
 - [GET /platform-config/proxy/dl-platform/workflow_runs/{runId}](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/getworkflowrun.md): Returns Dataflow Run Details
 - [GET /platform-config/proxy/dl-platform/workflow_runs/{runId}/restart](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/restartworkflowrun.md): Restart runId
 - [GET /platform-config/proxy/dl-platform/workflow_runs/{runId}/logs/download](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/downloadworkflowrunlogs.md): Streams a zip aggregating dataflow run logs. With no filters, includes every retry attempt's task log for every task plus the job logs for the latest attempt of each job task. Pass ?taskId to scope to
 - [GET /platform-config/proxy/dl-platform/workflow_runs/{runId}/cancel](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/cancelworkflowrun.md): Returns runId if cancellation requested
 - [GET /platform-config/proxy/dl-platform/workflow_runs/logs](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/getworkflowruntasklogs.md): Returns Dataflow task Log
 - [GET /platform-config/proxy/dl-platform/query/{id}](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/getquerydetails.md): Returns the details and current status of a single Query by its unique ID
 - [GET /platform-config/proxy/dl-platform/query/{id}/output](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/queryoutput.md): Returns a single page of results for a Query. Use page to walk through the result set.
 - [GET /platform-config/proxy/dl-platform/query/{id}/output/stream](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/streamqueryoutput.md): Returns output of query as SSE, one page is one event. Emits a page event per page of results, with the page number as the event id, then a complete event carrying totalPages and rowCount. Rejected un
 - [GET /platform-config/proxy/dl-platform/pipelines_versions/by_session_id/{id}](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/getversionsbysessionid.md): Returns the Pipeline Versions whose active session matches the given session ID
 - [GET /platform-config/proxy/dl-platform/pipelines/{pipelineId}/versions/{versionId}/schema-suggestions](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/getschemasuggestions.md): Reads forge-tag's column mapping manifest for the version and falls back to deducing both from the pipeline SQL when there is none, as there is for a pipeline written by hand. Always 200: what could n
 - [GET /platform-config/proxy/dl-platform/lineage/tables/{tableId}](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/gettablelineage.md): Returns the lineage graph for an ingestion table by its ID. Resolves the table's fully-qualified name from its connection and target database, schema and table, then returns the same result as the ass
 - [GET /platform-config/proxy/dl-platform/lineage/processes/{processType}/{processEntityId}](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/getprocessrows.md): Returns the raw lineage edges recorded by a single process. processType is PIPELINE_RUN or INGESTION and processEntityId identifies that run.
 - [DELETE /platform-config/proxy/dl-platform/lineage/processes/{processType}/{processEntityId}](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/deleteprocess.md): Deletes every lineage edge recorded by the given process and returns the number of rows removed.
 - [GET /platform-config/proxy/dl-platform/lineage/assets/{fqn}](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/getassetlineage.md): Returns the lineage graph for the asset with the given fully-qualified name. Use direction to select upstream, downstream or both, transitive to walk the full chain instead of only direct edges, and a
 - [GET /platform-config/proxy/dl-platform/knowledge-clusters/{kcId}/hooks/{hookId}/usage](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/usage.md): Returns the pipelines that reference the given Job Hook, with the phase each one uses it in
 - [GET /platform-config/proxy/dl-platform/jobs/{jobId}](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/getjobbyid.md): Returns a single Job by their unique ID
 - [GET /platform-config/proxy/dl-platform/jobs/{jobId}/summaries](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/getjobsummaries.md): Returns execution summaries/logs for a job
 - [GET /platform-config/proxy/dl-platform/jobs/{jobId}/stats](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/getjobstats.md): Returns the per-statement row counts of a pipeline run, plus the run totals
 - [GET /platform-config/proxy/dl-platform/jobs/{jobId}/logs/download](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/downloadjoblogs.md): Streams a zip with the per-job application log (job_.log) and the concatenated job summaries (job_summaries_.txt) for a single run. Each artifact is omitted when absent.
 - [GET /platform-config/proxy/dl-platform/configPortability/export](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/export.md): Returns the entity configuration as a downloadable JSON file
 - [GET /platform-config/proxy/dl-platform/compute-connectors/{platform}/{computeType}/defaults](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/getdefaults.md): Get default configurations for compute
 - [GET /platform-config/proxy/dl-platform/applications](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/list_2.md): Returns details of all applications spawned by the given Job ID
 - [GET /platform-config/proxy/dl-platform/applications/{applicationId}](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/getbyid_1.md): Returns details of the given Application ID
 - [GET /platform-config/proxy/dl-platform/applications/{applicationId}/logs](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/getapplicationlogs.md): Fetches the logs for a given Application ID