POST /public/v2/dsv/{document_id}/add-named-items

Adds one or more named items to the specified document by ID. These items define the document's structure and hierarchy (e.g., sections or headings) for display or navigation purposes within the Document Structure View (DSV).

Servers

Path parameters

Name Type Required Description
document_id String Yes

Unique identifier of the document to which the DSV named items will be added.

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
items[] Array Yes

List of named items representing structural elements of the document.

items[].name String Yes

The display name of the item (e.g., "Introduction", "Chapter 1").

items[].level Integer Yes

Hierarchical level of the item. Level 0 is the highest (top-level), with increasing numbers for nested structures.

items[].page_name String Yes

Internal reference or identifier for the page this item is associated with.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.