Jump to

• Request
• Response

Read UserOBS

get

/userOBS

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

Type: array

Title: List<UserOBS>

Show Source

• Array of: object UserOBS
  Title: UserOBS

  UserOBS Entity

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

Nested Schema : UserOBS

Type: object

Title: UserOBS

UserOBS Entity

Show Source

• CreateDate: string (date-time)
  The date this association was created.
• CreateUser: string
  The name of the user that created this association.
• LastUpdateDate: string (date-time)
  The date this association was last updated.
• LastUpdateUser: string
  The name of the user that last updated this association.
• OBSName: string
  The name of the person/role in the organization, sometimes referred to as the "responsible manager".
• OBSObjectId: integer (int32)
  The unique ID of the OBS to which the user is granted access.
• ProfileName: string
  The name of security profile.
• ProjectProfileObjectId: integer (int32)
  The unique ID of the project profile with which the user is granted access to the project and OBS. See the ProjectProfile class for a constant defining the fixed profile of Project Superuser.
• UserName: string
  The user's login name.
• UserObjectId: integer (int32)
  The unique ID of the user who is assigned to the project OBS.

{
    "title":"UserOBS",
    "type":"object",
    "properties":{
        "CreateDate":{
            "type":"string",
            "description":"The date this association was created.",
            "format":"date-time"
        },
        "CreateUser":{
            "type":"string",
            "description":"The name of the user that created this association."
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date this association was last updated.",
            "format":"date-time"
        },
        "LastUpdateUser":{
            "type":"string",
            "description":"The name of the user that last updated this association."
        },
        "ProfileName":{
            "type":"string",
            "description":"The name of security profile."
        },
        "ProjectProfileObjectId":{
            "type":"integer",
            "description":"The unique ID of the project profile with which the user is granted access to the project and OBS. See the ProjectProfile class for a constant defining the fixed profile of Project Superuser.",
            "format":"int32"
        },
        "UserName":{
            "type":"string",
            "description":"The user's login name."
        },
        "UserObjectId":{
            "type":"integer",
            "description":"The unique ID of the user who is assigned to the project OBS.",
            "format":"int32"
        },
        "OBSName":{
            "type":"string",
            "description":"The name of the person/role in the organization, sometimes referred to as the \"responsible manager\"."
        },
        "OBSObjectId":{
            "type":"integer",
            "description":"The unique ID of the OBS to which the user is granted access.",
            "format":"int32"
        }
    },
    "description":"UserOBS 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