Documentation Flow
List documentation flow configurations
List the available documentation flow configurations.
Use this endpoint to find the configuration URN needed to start a documentation flow.
Paging is forward-only.
get/catalog/v1/documentation-flow/configurations
Request
- Base URLhttps://your-environment.ataccama.one/api
- AuthHTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
afterstring
Cursor for forward pagination. Use the value from meta.next in the previous response. Starts at the beginning when omitted.
sizeinteger
Number of documentation flow configurations to return.
searchstring
Full-text query matched against all string properties of the documentation flow configuration, such as name and description.
namestring
Filter documentation flow configurations by exact match on the name.
Response
Paginated list of documentation flow configurations.
Example response
{
"meta": {
"next": "MjA=",
"total": 150
},
"data": [
{
"urn": "urn:ata:acme-corp:catalog:documentation-flow-configuration:123e4567-e89b-12d3-a456-426614174000"
}
]
}Changes
No recorded changes to this operation across all 1 revision of this API.