Jump to

• Request
• Response

Read ImportOptionsTemplate

get

/importOptionsTemplate

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

Type: array

Title: List<ImportOptionsTemplate>

Show Source

• Array of: object ImportOptionsTemplate
  Title: ImportOptionsTemplate

  ImportOptionsTemplate Entity

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

Nested Schema : ImportOptionsTemplate

Type: object

Title: ImportOptionsTemplate

ImportOptionsTemplate Entity

Show Source

• ImportOptionsTemplateType: string
  The content of the template.
• Name: string
  The name of the template.
• ObjectId: integer (int32)
  The unique ID generated by the system.
• ViewData: string
  The content of the template.

{
    "title":"ImportOptionsTemplate",
    "type":"object",
    "properties":{
        "ImportOptionsTemplateType":{
            "type":"string",
            "description":"The content of the template."
        },
        "Name":{
            "type":"string",
            "description":"The name of the template."
        },
        "ObjectId":{
            "type":"integer",
            "description":"The unique ID generated by the system.",
            "format":"int32"
        },
        "ViewData":{
            "type":"string",
            "description":"The content of the template."
        }
    },
    "description":"ImportOptionsTemplate 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