Jump to

• Request
• Response

Read OBS

get

/obs

Reads OBS objects from the database.

Request

Query Parameters

• Fields(required): string
  Fields to load

  Example:

  Name,ObjectId

• Filter(required): string
  Supported Filter Operators - :gt:, :lt:, :eq:, :gte:, :lte:, :and:, :or:

  Example:

  ObjectId IN(1,2) :and: CreateDate:gte:'2021-04-20' :and: LastUpdateDate:lt:'2022-04-20' :and: Name :like: 'abc%'

• OrderBy(required): string
  OrderBy condition

  Example:

  ObjectId desc

Header Parameters

• Authorization(required):
  OAuth token

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK.

Body ()

Root Schema : List<OBS>

Type: array

Title: List<OBS>

Show Source

• Array of: object OBS
  Title: OBS

  OBS Entity

{
    "title":"List<OBS>",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/OBS"
    }
}

Nested Schema : OBS

Type: object

Title: OBS

OBS Entity

Show Source

• CreateDate: string (date-time)
  The date this OBS was created.
• CreateUser: string
  The name of the user that created this OBS.
• Description: string
  The description of the person/role in the organization.
• GUID: string
  The globally unique ID generated by the system.
• LastUpdateDate: string (date-time)
  The date this OBS was last updated.
• LastUpdateUser: string
  The name of the user that last updated this OBS.
• Name: string
  The name of the person/role in the organization, sometimes referred to elsewhere as the "responsible manager".
• ObjectId: integer (int32)
  The unique ID generated by the system.
• ParentObjectId: integer (int32)
  The unique ID of the parent OBS of this OBS in the hierarchy.
• SequenceNumber: integer (int32)
  The sequence number for sorting.

{
    "title":"OBS",
    "type":"object",
    "properties":{
        "CreateDate":{
            "type":"string",
            "description":"The date this OBS was created.",
            "format":"date-time"
        },
        "CreateUser":{
            "type":"string",
            "description":"The name of the user that created this OBS."
        },
        "Description":{
            "type":"string",
            "description":"The description of the person/role in the organization."
        },
        "GUID":{
            "type":"string",
            "description":"The globally unique ID generated by the system."
        },
        "Name":{
            "type":"string",
            "description":"The name of the person/role in the organization, sometimes referred to elsewhere as the \"responsible manager\"."
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date this OBS was last updated.",
            "format":"date-time"
        },
        "LastUpdateUser":{
            "type":"string",
            "description":"The name of the user that last updated this OBS."
        },
        "ObjectId":{
            "type":"integer",
            "description":"The unique ID generated by the system.",
            "format":"int32"
        },
        "ParentObjectId":{
            "type":"integer",
            "description":"The unique ID of the parent OBS of this OBS in the hierarchy.",
            "format":"int32"
        },
        "SequenceNumber":{
            "type":"integer",
            "description":"The sequence number for sorting.",
            "format":"int32"
        }
    },
    "description":"OBS Entity"
}

400 Response

Bad Request.

401 Response

Unauthorized.

403 Response

Forbidden.

404 Response

Not Found.

405 Response

Invalid Input.

500 Response

Internal Server Error.

Back to Top