x QBOS REST API documentation for ASSESSISSUE

QBOS REST API documentation (ASSESSISSUE)

(return to Main Document)

Introduction

The ASSESSISSUE API allows client applications to maintain ASSESSISSUE 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}/...

ASSESSISSUE 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 5560 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.
Assessment_issue nvarchar 100 Yes NULL
Problem nvarchar 255 Yes NULL
Category nvarchar 255 Yes NULL
SectionName nvarchar 255 Yes NULL
IssueTitle nvarchar 1000 Yes NULL
IssueStatus nvarchar 100 Yes NULL
AssessmentID integer Yes Yes NULL

ASSESSISSUE Relationships

Parent and Child relations to ASSESSISSUE.

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_3264" : 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_2918 1-Many CA_Neuro
REL_3276 1-Many CA_Assessment
REL_3275 1-Many Patient_Chart
REL_2924 1-Many CA_Genitourinary
REL_2925 1-Many CA_NutritionMetabolic
REL_2926 1-Many CA_SkinMusculoskeletal
REL_2927 1-Many CA_ADL_SpecialNeeds
REL_2928 1-Many CA_DMESupplies
REL_2929 1-Many CA_LevelofCare
REL_2930 1-Many CA_SafetyTeachings
REL_2931 1-Many CA_Spiritual
REL_2932 1-Many CA_Bereavement
REL_2923 1-Many CA_Gastrointestinal
REL_2922 1-Many CA_Cardiovascular
REL_2921 1-Many CA_Pain
REL_2919 1-Many CA_SocialWork
REL_2920 1-Many CA_Respiratory
Parent Relations
↑
ASSESSISSUE
↓
Child Relations
Relation Id Cardinality
(Parent-to-Child)		 Required
**on POST of child		 Links Down To  
REL_3264 1-Many POC_Issue  
REL_3273 1-Many POC_History  
 



Read ASSESSISSUE by id:

GET https:/.../v1/517090/ASSESSISSUE/{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/ASSESSISSUE/2
Unauthorized request.

Read ASSESSISSUE by parent id:

GET https:/.../v1/517090/{parent_relation_id}/{parent_id}/links/ASSESSISSUE[?{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/2924/2/links/ASSESSISSUE
Unauthorized request.

Read ASSESSISSUE by filter:

GET https:/.../v1/517090/ASSESSISSUE[?{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/ASSESSISSUE?id=2
Unauthorized request.

Create ASSESSISSUE:

POST https:/.../v1/517090/ASSESSISSUE

Request data [See properties]:

Response codes:

Update ASSESSISSUE:

PUT https:/.../v1/517090/ASSESSISSUE/{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 ASSESSISSUE:

DELETE https:/.../v1/517090/ASSESSISSUE/{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 ASSESSISSUE:

POST https:/.../v1/517090/{relation_id}/{link_to_id}/links/ASSESSISSUE/{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 ASSESSISSUE:

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


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

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

Response codes:

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