REST API

HomeKnowledge BaseAPI

Get_Object

26 views /  0 like /  // admin/

OVERVIEW

The Get_Object API allows you to retrieve all visible details of a specific work item exactly as shown on the Orcanos web interface.

Method: GET

Input

Authentication

You can access the API in two ways:

  1. API Key – If the user has a valid API key, it can be used directly for authentication in the request headers. For more information, please refer to our Orcanos REST API article.

    Header Key Description
    OrcanosAPIkey Your API key in the format: <API_KEY>

    Example:
    headers: {

    "OrcanosAPIKey": "abc123xyz456"

    }

  2. Username & Password – Include your API credentials in the request headers.

    Header Description
    Authorization Basic authentication header. Format: Basic <BASE64_ENCODED_CREDENTIALS>
    Username Your Orcanos username
    Password Your Orcanos password

    Example:
    john_doe:mypassword123 Base64 encoded
    Authorization: Basic am9obl9kb2U6bXlwYXNzd29yZDEyMw==

 

Request Parameters

Parameter Type Required Description
ID Integer Yes The unique identifier of the work item. Example: 12122

 

Request Example

JSON

GET /api/Get_Object?ID=12122
Host: your-orcanos-domain.com
Authorization: Bearer YOUR_API_KEY
username: your_username
password: your_password

 

Output 

Response Format

JSON

{
"IsSuccess": true,
"Data": {
"Id": "12122",
"Field": [ 
{
"Name": "Revision",
"Text": "A"
},
{
"Name": "Change no#",
"Text": "1"
},
{
"Name": "Routing State",
"Text": "Draft"
},
{
"Name": "File Name",
"Text": "aa.docx"
},
{
"Name": "Key",
"Text": "DMS-12122"
},
{
"Name": "Next Assignee List",
"Text": ""
},
{
"Name": "Signers List",
"Text": ""
},
{
"Name": "Created By",
"Text": "Orcanos.Tech"
},
{
"Name": "Created Date",
"Text": "08-Apr-2026 11:30:27"
},
{
"Name": "Updated By",
"Text": "Orcanos.Tech"
},
{
"Name": "Updated Date",
"Text": "08-Apr-2026 11:30:39"
},
{
"Name": "Name",
"Text": "test a"
},
{
"Name": "Status",
"Text": "In Progress"
},
{
"Name": "Assigned To",
"Text": "Not Assigned"
},
{
"Name": "Priority",
"Text": "Not Set"
},
{
"Name": "Category",
"Text": "Not Set"
},
{
"Name": "Start Date",
"Text": ""
},
{
"Name": "Training Records List",
"Text": "TRN-5966-Read and Understand Record"
},
{
"Name": "Owner",
"Text": "Not Assigned"
},
{
"Name": "Trainees",
"Text": ""
},
{
"Name": "Roles",
"Text": ""
},
{
"Name": "Acceptable?",
"Text": "0"
},
{
"Name": "Audit Topics",
"Text": "Not Set"
},
{
"Name": "Address",
"Text": ""
},
{
"Name": "Legacy File ID",
"Text": ""
},
{
"Name": "Legacy Approved Date",
"Text": ""
},
{
"Name": "Legacy Rev. ID",
"Text": ""
},
{
"Name": "Administrative Review (Every x Months)",
"Text": "0"
},
{
"Name": "Approver",
"Text": "Not Assigned"
},
{
"Name": "ISO 13485 Sec.",
"Text": ""
},
{
"Name": "Effective Date",
"Text": ""
},
{
"Name": "Sprint",
"Text": "Not Set"
},
{
"Name": "Description",
"Text": ""
}
]
},
"Message": "Success",
"HttpCode": 200
}

 

Response Fields

IsSuccess – true if the request succeeded.

Data – Contains all fields visible on the web screen of the work item. Each field has:

  • Name: Field name as shown on the web screen.
  • Text: Value of the field (can be null if empty).

Message – Error message in case IsSuccess is false

HttpCode – HTTP status code.

 

 

 

 

 

 

Related Articles