API Documentation

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.

2022-02-08_08-36-06.png

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

  • 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

  • Create project
  • Instance Template List
  • Project Data by Project Fields
  • Project Data Modified After Date

Incoming Files

  • Create Incoming Submittal
  • Get Incoming Submittal File List
  • Search Incoming Submittal
  • Update Incoming Submittal
  • Upload File

Project Units

  • Add Unit
  • Delete Unit
  • Download CSV with Unit Errors
  • Download CSV with Units
  • Get Status of last import operation
  • Get Unit details
  • Import CSV with Units
  • Update Unit

Project Document Code

  • Add Doc Code to Project
  • Delete Doc Code from Project
  • Project Doc Code List
  • Update Doc Code in Project

Library

  • Add Library Card
  • Create Duplicate Card
  • Disable Library Card by ID
  • Get File Status
  • Get Library Card Status
  • Get Library Document Types
  • Library Card Data by Card ID
  • Search Library Cards
  • Update Library Card by ID
  • Upload file to card (check status)
  • Upload file to card (log by date)
  • Upload file to card
  • Upload File

Companies

  • Company Details
  • Create company
  • Document Codes Lists
  • Status Lists

Contacts

  • Contacts List
  • Create Contact

Relationships

  • Create Relationship
  • Relationship List