Flow Documents

Retrieves a paginated list of flow documents for the specified flow.

get

Retrieves a paginated list of flow documents for the specified flow, optionally filtered and sorted.

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
flowIdentifierstring · uuidRequired

The unique identifier of the flow.

projectIdentifierstringRequired
Query parameters
pageNumberinteger · int32Optional

The page number to retrieve.

pageSizeinteger · int32Optional

The number of items per page.

searchTextstringOptional

Optional search text to filter flow documents.

sortinginteger · enumOptional

The sorting option for the results.

Possible values:
descbooleanOptional

Whether to sort in descending order.

Default: true
Responses
chevron-right
200

OK

No content

get
/projects/{projectIdentifier}/flows/{flowIdentifier}/flow-documents

No content

Adds a range of documents to the specified flow.

post

Adds a range of documents to the specified flow.

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
flowIdentifierstring · uuidRequired

The unique identifier of the flow.

projectIdentifierstringRequired
Bodystring · uuid[]
string · uuid[]Optional
Responses
chevron-right
200

OK

No content

post
/projects/{projectIdentifier}/flows/{flowIdentifier}/flow-documents

No content

Removes a range of documents from the specified flow.

delete

Removes a range of documents from the specified flow.

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
flowIdentifierstring · uuidRequired

The unique identifier of the flow.

projectIdentifierstringRequired
Query parameters
objectIdentifiersstring · uuid[]Optional

The collection of document object identifiers to remove.

Responses
delete
/projects/{projectIdentifier}/flows/{flowIdentifier}/flow-documents

No content

Searches for flow documents in the specified flow using filter criteria.

post

Searches for flow documents in the specified flow using filter criteria.

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
flowIdentifierstring · uuidRequired

The unique identifier of the flow.

projectIdentifierstringRequired
Body
searchTextstring · nullableOptional
pageNumberinteger · int32 · nullableOptional
pageSizeinteger · int32 · nullableOptional
sortBystring · nullableOptional
sortAscboolean · nullableOptional
documentsToSearchstring · uuid[] · nullableOptional
Responses
chevron-right
200

OK

No content

post
/projects/{projectIdentifier}/flows/{flowIdentifier}/flow-documents/search

No content

Retrieves a flow document by its document identifier.

get

Retrieves a flow document by its document identifier.

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
flowIdentifierstring · uuidRequired

The unique identifier of the flow.

documentIdentifierstring · uuidRequired

The unique identifier of the document.

projectIdentifierstringRequired
Responses
chevron-right
200

OK

No content

get
/projects/{projectIdentifier}/flows/{flowIdentifier}/flow-documents/{documentIdentifier}

No content

Moves documents within the specified flow to a different folder.

post

Moves documents within the specified flow to a different folder.

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
flowIdentifierstring · uuidRequired

The unique identifier of the flow.

projectIdentifierstringRequired
Body
folderIdentifierstring · uuidOptional
Responses
post
/projects/{projectIdentifier}/flows/{flowIdentifier}/flow-documents/move-documents

No content

Last updated