ATataccama
Documentation Flow

Start documentation flow

Start a documentation flow asynchronously with a given configuration on a connection.

The request is accepted for processing and returns a link that identifies the running flow.

To run the flow on part of the connection only, use the paths field.

Returns 404 Not Found when the configuration or connection doesn't exist.

post/catalog/v1/documentation-flow/start

Request

Request body

configurationUrnstring uri required

A URN identifying a documentation flow configuration resource in the Catalog API.

Format: urn:ata:{tenant}:catalog:documentation-flow-configuration:{uuid}

Example: urn:ata:acme-corp:catalog:documentation-flow-configuration:123e4567-e89b-12d3-a456-426614174000.

connectionUrnstring uri required

A URN identifying a resource in any realm of the Public API. URNs follow RFC 8141.

Format: urn:ata:{tenant}:{realm}:{resource-type}:{uuid}

Components:

  • urn — fixed scheme
  • ata — Ataccama namespace
  • {tenant} — tenant identifier from the authentication context
  • {realm} — API realm, for example catalog or reference-data
  • {resource-type} — resource type within the realm, for example catalog-item or table
  • {uuid} — UUID (v4 or v7) of the resource

Example: urn:ata:acme-corp:reference-data:table:123e4567-e89b-12d3-a456-426614174000.

pathsstring[]

List of paths to run the documentation flow on. When omitted, the flow runs on the whole connection.

Example request

{
  "configurationUrn": "urn:ata:acme-corp:catalog:documentation-flow-configuration:123e4567-e89b-12d3-a456-426614174000",
  "connectionUrn": "urn:ata:acme-corp:reference-data:table:123e4567-e89b-12d3-a456-426614174000"
}

Response

Documentation flow accepted for asynchronous processing. Poll the link from the Location header or response body (polling.href) for the state of the documentation flow workflow in the Processing Center.

Changes

No recorded changes to this operation across all 1 revision of this API.