Jump to

• Request
• Response

Read GlobalReplace

get

/globalReplace

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

Type: array

Title: List<GlobalReplace>

Show Source

• Array of: object GlobalReplace
  Title: GlobalReplace

  GlobalReplace Entity

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

Nested Schema : GlobalReplace

Type: object

Title: GlobalReplace

GlobalReplace Entity

Show Source

• AllProjects: boolean
  The option used to set all of projects to which a user has access.
• GlobalReplaceData: string
  The Global Replace template.
• GlobalReplaceName: string
  The Global Replace template name.
• GreplaceObjectId: integer (int32)
  The unique id of the Global Replace template.
• ProjectIdName: string
  Project ids and names that are separated by commas.
• ProjectIds: string
  TProject ids that are separated by commas.
• ReplaceFieldNameOne: string
  First field name the user has selected to replace.
• SearchCriteria: string
  The criteria that is used to search and load business objects.
• SubjectAreaType: string
  The name of the object to be updated.
• UserObjectId: integer (int32)
  The unique id of the associated user.

{
    "title":"GlobalReplace",
    "type":"object",
    "properties":{
        "AllProjects":{
            "type":"boolean",
            "description":"The option used to set all of projects to which a user has access."
        },
        "GlobalReplaceData":{
            "type":"string",
            "description":"The Global Replace template."
        },
        "GlobalReplaceName":{
            "type":"string",
            "description":"The Global Replace template name."
        },
        "GreplaceObjectId":{
            "type":"integer",
            "description":"The unique id of the Global Replace template.",
            "format":"int32"
        },
        "ProjectIdName":{
            "type":"string",
            "description":"Project ids and names that are separated by commas."
        },
        "ProjectIds":{
            "type":"string",
            "description":"TProject ids that are separated by commas."
        },
        "ReplaceFieldNameOne":{
            "type":"string",
            "description":"First field name the user has selected to replace."
        },
        "SearchCriteria":{
            "type":"string",
            "description":"The criteria that is used to search and load business objects."
        },
        "SubjectAreaType":{
            "type":"string",
            "description":"The name of the object to be updated."
        },
        "UserObjectId":{
            "type":"integer",
            "description":"The unique id of the associated user.",
            "format":"int32"
        }
    },
    "description":"GlobalReplace 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