Jump to

• Request
• Response

Read CBSs

get

/cbs

Reads CBS 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<CBS>

Type: array

Title: List<CBS>

Show Source

• Array of: object CBS
  Title: CBS

  CBS Entity

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

Nested Schema : CBS

Type: object

Title: CBS

CBS Entity

Show Source

• CBSCode(required): string
  The unique name of the Unifier CBS Code. Assign CBS codes to activities so that you can filter which activities you will send to Unifier.
• CBSDescription: string
  The description of the associated CBS.
• CBSStatus: string
  Specifies the status of the CBS.
• CreateDate: string (date-time)
  The date this activity was created.
• CreateUser: string
  The name of the user that created this activity.
• LastUpdateDate: string (date-time)
  The date this activity was last updated.
• LastUpdateUser: string
  The name of the user that last updated this activity.
• ObjectId: integer (int32)
  The unique ID generated by the system.
• ParentObjectId: integer (int32)
  The unique ID of the parent CBS for this CBS in the hierarchy.
• ProjectObjectId(required): integer (int32)
  The unique ID of the associated project.

{
    "title":"CBS",
    "required":[
        "CBSCode",
        "ProjectObjectId"
    ],
    "type":"object",
    "properties":{
        "CBSCode":{
            "type":"string",
            "description":"The unique name of the Unifier CBS Code. Assign CBS codes to activities so that you can filter which activities you will send to Unifier."
        },
        "CBSDescription":{
            "type":"string",
            "description":"The description of the associated CBS."
        },
        "CBSStatus":{
            "type":"string",
            "description":"Specifies the status of the CBS."
        },
        "CreateDate":{
            "type":"string",
            "description":"The date this activity was created.",
            "format":"date-time"
        },
        "CreateUser":{
            "type":"string",
            "description":"The name of the user that created this activity."
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date this activity was last updated.",
            "format":"date-time"
        },
        "LastUpdateUser":{
            "type":"string",
            "description":"The name of the user that last updated this activity."
        },
        "ObjectId":{
            "type":"integer",
            "description":"The unique ID generated by the system.",
            "format":"int32"
        },
        "ParentObjectId":{
            "type":"integer",
            "description":"The unique ID of the parent CBS for this CBS in the hierarchy.",
            "format":"int32"
        },
        "ProjectObjectId":{
            "type":"integer",
            "description":"The unique ID of the associated project.",
            "format":"int32"
        }
    },
    "description":"CBS 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