Sign in

v1

latestOpenAPI 3.0.02026-07-17132430.9 KB
Download

Initiate document selection and download flow

The client will call this endpoint to initiate the flow of selecting and downloading documents.

post/select-documents

Request body

server_contextstring nullable

A CDE controlled identifier recording the user's context on the CDE. For example which project and folder the user was on. If the client provides the server_context in subsequent calls then the CDE will attemp to load the UI at the same place.

supported_file_extensionsstring[]

The client may optionally provide an array of accepted file extensions that should be opened during this flow. The CDE server UI should make an attempt to only show files matching these extensions to the user for the download selection or help the user in selecting the desired files. However, the server does not have to guarantee that only files matching the extensions will be selected. The extensions here must contain the dot separator.

Example request

{
  "supported_file_extensions": [
    ".ifc",
    ".ifczip"
  ]
}

Response

The CDE returns a URL for the client to open in a local browser. The user will then be presented with the CDE UI to select and download documents

select_documents_urlstring required

A CDE UI URL for the client to open in a local browser. The user would search and select documents directly in the CDE

expires_ininteger required

select_documents_url expiry in seconds

All 13 operations