x QBOS REST API documentation for CALOCCATEGORY

QBOS REST API documentation (CALOCCATEGORY)

(return to Main Document)

Introduction

The CALOCCATEGORY API allows client applications to maintain CALOCCATEGORY data 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 at: pkajaani@qbos.com. We appreciate your help.

Getting Started

To place any request in a QBOS API application from a third party application you need to first authenticate your 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.

Custom resource vs. standard resource URI format

Custom resource (a.k.a applet) URI contains the resource vendor id in place of "/o/" in the standard object URI. Compare: .../v1/o/...with .../v1/{vendor_id}/...

CALOCCATEGORY 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 Default Description
_client_Id bigint Yes NULL This is the Data Org Id.
_owner_Id bigint Yes Yes NULL This is the user id of the record owner. Defaults to the creatorOpid.
_creator_Opid bigint Yes Yes NULL This is the user id of the original record submitter.
_create_Date datetime No {timestamp}   Not enterable upon Insert. System sets this date upon record creation.
status_id int Yes Yes 5775 The status id of the record. Taken from the Life Cycle statuses in ADS.
_status_Change_Date datetime No NULL Not enterable. System sets this date whenever the statusid is changed.
Category nvarchar 500 Yes NULL
SubCategory nvarchar 100 Yes NULL
Status nvarchar 20 Yes NULL
Frequency nvarchar 20 Yes NULL
Notes nvarchar 20 Yes NULL
LevelOfCare nvarchar 20 Yes NULL
PRN nvarchar 20 Yes NULL

CALOCCATEGORY Relationships

Parent and Child relations to CALOCCATEGORY.

Note that the only Required status on relationships that affect a POST of an object are on the parent relations. A Required status on a child relation is only meaningful when POSTing the child object.

Linking during POST: a custom object record can be linked to a parent or child record (custom or standard) during POST by including (in the payload) the realtion id paired with the parent or child object record being linked to. For example: { "REl_3159" : 1832 }      Multiple links may be created in the same POST.

Relation Id Cardinality
(Parent-to-Child)		 Required
For POST		 Links Up To Is Unary?*
REL_3159 1-Many Yes CA_Assessment
REL_3160 1-Many Yes CA_LevelofCare_SubCategory
Parent Relations
↑
CALOCCATEGORY
↓
Child Relations
Relation Id Cardinality
(Parent-to-Child)		 Required
**on POST of child		 Links Down To  
 



Read CALOCCATEGORY by id:

GET https:/.../v1/517090/CALOCCATEGORY/{id}

Response codes:

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

Response data: GET https:/.../v1/517090/CALOCCATEGORY/1690
Unauthorized request.

Read CALOCCATEGORY by parent id:

GET https:/.../v1/517090/{parent_relation_id}/{parent_id}/links/CALOCCATEGORY[?{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

Response data: GET https:/.../v1/517090/3159/610/links/CALOCCATEGORY
Unauthorized request.

Read CALOCCATEGORY by filter:

GET https:/.../v1/517090/CALOCCATEGORY[?{filter}]

Response codes:

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

Response data: GET https:/.../v1/517090/CALOCCATEGORY?id=1690
Unauthorized request.

Create CALOCCATEGORY:

POST https:/.../v1/517090/CALOCCATEGORY

Request data [See properties]:

Response codes:

Update CALOCCATEGORY:

PUT https:/.../v1/517090/CALOCCATEGORY/{id}

Request data [See properties]:

Response codes:

  • 200 - OK Content returned [See response data]
  • 204 - OK No content
  • 400 - Client error
  • 404 - Not found
  • 500 - Server error

Delete CALOCCATEGORY:

DELETE https:/.../v1/517090/CALOCCATEGORY/{id}

The "id" in JSON payload is required to match the {id} in the URI to ensure that deletion requests are intended and safe

Response codes:

  • 204 - OK
  • 400 - Client error
  • 404 - Not found
  • 500 - Server error

Create Link for CALOCCATEGORY:

POST https:/.../v1/517090/{relation_id}/{link_to_id}/links/CALOCCATEGORY/{id}


{relation_id} can indicate either a parent or a child relation.

Response codes:

  • 204 - OK
  • 400 - Client error
  • 404 - Not found
  • 500 - Server error

Delete Link for CALOCCATEGORY:

DELETE https:/.../v1/517090/{parent_relation_id}/{parent_id}/links/CALOCCATEGORY/{id}


Deleting a link from CALOCCATEGORY down to a child object must be explicitly indicated by negating the relation id:

DELETE https:/.../v1/517090/{-child_relation_id}/{child_id}/links/CALOCCATEGORY/{id}

Response codes:

  • 204 - OK
  • 400 - Client error
  • 404 - Not found
  • 500 - Server error