QBOS REST API documentation (document_content)

(return to Main Document)

Introduction

The document_content API allows client applications to maintain document_content data including any part of its demographic record sets.

Audience

This developer's guide is intended for software developers needing a technical reference for using the QBOS REST API. The information you find in this guide is written by software engineering, and is authoritative on how the API behaves.

Additional resources, information about this guide

Occasionally, we make a mistake in this documentation, or unknowingly break a feature that you depend on. If this has happened to you, we apologize! You can help us fix the issue by contacting us. We appreciate your help.

Getting Started

To place any request in QBOS API application from third party application you need to authenticate user account and set/calculate values for the following request headers: x-qbos-id, x-qbos-nonce, x-qbos-date-utc, x-qbos-hash-version, x-qbos-auth

See details in Authentication Documentation.

document_content properties

Properties prefixed with '_' (underscore) are read-only properties. i.e. POST and PUT processing will ignore these properties.

Name Type Max length Numeric Required
For POST
Filterable Description

id

bigint

 

 

 

Required for GET(by id),PUT,DELETE

parent_id

bigint

 

yes

 

parent_type

nvarchar

50

 

yes

 

type

nvarchar

50

 

 

 

Value is "document_content"

_current_version_sw

bit

 

 

 

_create_date

datetime

 

 

 

_size_bytes

bigint

 

 

 

_version_number

smallint

 

 

 

title

varchar

128

 

 

 

_dos_extension

varchar

7

 

 

 

href

varchar

43

 

 

 

_org_id

bigint

 

 

 

Read document_content from parent:

GET https:/.../v1/o/{parent_type}/{parent_id}/links/document_content[?{filter}]

Response codes:

  • 400 - Client error
  • 500 - Server error
  • 404 - Not found or user does not have permission to access resources of this type.
  • 200 - OK

GET https:/.../v1/o/document/1075400/links/document_content
Response example is shown in XML format here even though REST API returns JSON format:
<document_content><document_content parent_type="document" parent_id="1075400" type="document_content" id="00005067647f00014d43" sub_type=" " _title="Payroll Hours approved on 04/11/2024" _version_number="1" href="/v1/o/document_content/00005067647f00014d43"/></document_content>

Create document_content:

See example