Did you know that you can access Application Programming Interface (API) documents? This article explains how to use it.

Documentation Access

The link is based on your DocBoss login system: https://system[].docboss.com/documentation/api

i.e. for System1, the link is: https://system.docboss.com/documentation/api

i.e. for System5, the link is: https://system5.docboss.com/documentation/api

Note that user must have a (minimum of) VIEW license to access the page.

Layout

Queries are listed on the left, with data on the right.

Testing

Tests are available for every query. One example:

You can execute and view results within this window. Please note, the sample results execute on the live system.

Available Calls

Cards (Documents)

Card Data by Card ID

Cards Modified After Date

Get File

List by PO number

List by SO number

Unit Data by Card ID

Projects

Project Data by Project ID

Project Data Modified After Date

Incoming Files

Create Folder

Get Folder Content

Search Folders

Upload File

Project Units

Add Unit

Delete Unit

Download CSV with Unit Errors

Download CSV with Units

Get Status of last import operation

Import CSV with Units

Update Unit

Library

Add Library Card

Disable Library Card by ID

Get File Status

Get Library Card Status

Get Library Folders

Library Card Data by Card ID

Search Library Cards

Update Library Card by ID

Upload File