Jump to

• Request
• Response

Read GlobalProfile

get

/globalProfile

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

Type: array

Title: List<GlobalProfile>

Show Source

• Array of: object GlobalProfile
  Title: GlobalProfile

  GlobalProfile Entity

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

Nested Schema : GlobalProfile

Type: object

Title: GlobalProfile

GlobalProfile Entity

Show Source

• CreateDate: string (date-time)
  The date this Global Profile was created.
• CreateUser: string
  The name of the user that created this Global Profile.
• IsDefault: boolean
  The flag that indicates this security profile is assigned to new users by default. When a GlobalProfile object is deleted from the database, all users assigned to that profile are reassigned to the default profile. You cannot not delete the default profile.
• IsSuperUser: boolean
  The flag that identifies the superuser profile. Superuser profiles are automatically granted all privileges.
• LastUpdateDate: string (date-time)
  The date this Global Profile was last updated.
• LastUpdateUser: string
  The name of the user that last updated this Global Profile.
• Name: string
  The privileges that are turned on.
• ObjectId: integer (int32)
  The unique ID generated by the system.
• Privilege: array Privilege

{
    "title":"GlobalProfile",
    "type":"object",
    "properties":{
        "CreateDate":{
            "type":"string",
            "description":"The date this Global Profile was created.",
            "format":"date-time"
        },
        "CreateUser":{
            "type":"string",
            "description":"The name of the user that created this Global Profile."
        },
        "IsDefault":{
            "type":"boolean",
            "description":"The flag that indicates this security profile is assigned to new users by default. When a GlobalProfile object is deleted from the database, all users assigned to that profile are reassigned to the default profile. You cannot not delete the default profile."
        },
        "IsSuperUser":{
            "type":"boolean",
            "description":"The flag that identifies the superuser profile. Superuser profiles are automatically granted all privileges."
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date this Global Profile was last updated.",
            "format":"date-time"
        },
        "LastUpdateUser":{
            "type":"string",
            "description":"The name of the user that last updated this Global Profile."
        },
        "Name":{
            "type":"string",
            "description":"The privileges that are turned on."
        },
        "ObjectId":{
            "type":"integer",
            "description":"The unique ID generated by the system.",
            "format":"int32"
        },
        "Privilege":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Privilege"
            }
        }
    },
    "description":"GlobalProfile Entity"
}

Nested Schema : Privilege

Type: array

Show Source

• Array of: object Privilege
  Privilege

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Privilege"
    }
}

Nested Schema : Privilege

Type: object

Privilege

Show Source

• Has: boolean
• Name: string

{
    "type":"object",
    "properties":{
        "Has":{
            "type":"boolean"
        },
        "Name":{
            "type":"string"
        }
    },
    "description":"Privilege"
}

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