Jump to

• Request
• Response

Get Text File Configurations

post

/content/sim/v2/setup/languages/getTextFileConfigurations

Gets all the Text File Configurations

Request

Supported Media Types

• application/json
• multipart/form-data

Body ()

Get Record Parameters.

Root Schema : schema

Type: object

Show Source

• orderBy: string
  Sorts the response by the specified field name and sort order.

  Example: fileType:asc
• searchCriteria: string
  If specified, returns records that match the criteria.

  Example: where equals(langId, 1)

{
    "type":"object",
    "properties":{
        "searchCriteria":{
            "type":"string",
            "example":"where equals(langId, 1)",
            "description":"If specified, returns records that match the criteria."
        },
        "orderBy":{
            "type":"string",
            "description":"Sorts the response by the specified field name and sort order.",
            "example":"fileType:asc"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

A collection of Text File Configurations.

Body ()

Root Schema : schema

Type: object

Show Source

• count: integer
  Current response record count.

  Example: 9
• hasMore: boolean
  Flag indicating if there are more objects to fetch.

  Example: true
• items: array items
  Array of Text File Configurations.
• limit: integer
  Server page size

  Example: 100
• offset: integer
  Starting resource record index

  Example: 0
• totalResults: integer
  Total number of rows (excluding the paging parameters)

  Example: 100

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "example":100,
            "description":"Total number of rows (excluding the paging parameters)"
        },
        "hasMore":{
            "type":"boolean",
            "example":true,
            "description":"Flag indicating if there are more objects to fetch."
        },
        "count":{
            "type":"integer",
            "example":9,
            "description":"Current response record count."
        },
        "items":{
            "type":"array",
            "description":"Array of Text File Configurations.",
            "items":{
                "$ref":"#/definitions/TextFileConfiguration"
            }
        },
        "offset":{
            "type":"integer",
            "example":0,
            "description":"Starting resource record index"
        },
        "limit":{
            "type":"integer",
            "example":100,
            "description":"Server page size"
        }
    }
}

Nested Schema : items

Type: array

Array of Text File Configurations.

Show Source

• Array of: object TextFileConfiguration
  Model for Text File Configuration Object

{
    "type":"array",
    "description":"Array of Text File Configurations.",
    "items":{
        "$ref":"#/definitions/TextFileConfiguration"
    }
}

Nested Schema : TextFileConfiguration

Type: object

Model for Text File Configuration Object

Show Source

• baseFileName: string
  Base File Name of the Text File Configuration.

  Example: Micros.Payment.Cash
• fileType: integer
  File Type of the Text File Configuration.

  Example: 3
• langId: integer
  Unique identifier of the language.

  Example: 1

{
    "description":"Model for Text File Configuration Object",
    "type":"object",
    "properties":{
        "langId":{
            "description":"Unique identifier of the language.",
            "type":"integer",
            "example":1
        },
        "baseFileName":{
            "description":"Base File Name of the Text File Configuration.",
            "type":"string",
            "example":"Micros.Payment.Cash"
        },
        "fileType":{
            "description":"File Type of the Text File Configuration.",
            "type":"integer",
            "example":3
        }
    }
}

Back to Top