Jump to

• Request
• Response

Get CAL Packages

post

/config/sim/v1/setup/cal/getPackages

Gets a list of all CAL Packages in the specified organization

Request

Supported Media Types

• application/json
• multipart/form-data

Body ()

A request body

Root Schema : GetCALPackage

Type: object

The input body model that needs to be given to get CAL package.

Show Source

• include: string
  Objects included in response
• includeAll: string
  This can take 2 values: basic or detailed. If 'basic' is specified, The response contains all the properties of the object except Ext values. If 'detailed' is specified, The response contains all the properties of the object.

  Example: detailed
• languages: string
  If specified, limits translated strings returned
• limit: integer
  If using paging, number of results returned in this page.
• offset: integer
  Starting resource record index. Not required if paging parameters are not supported
• orderBy: integer
  Sorts the response by the specified field name and sort order.
• searchCriteria: string
  Search criteria to filter results based on field value

{
    "description":"The input body model that needs to be given to get CAL package.",
    "type":"object",
    "properties":{
        "searchCriteria":{
            "type":"string",
            "description":"Search criteria to filter results based on field value"
        },
        "include":{
            "type":"string",
            "description":"Objects included in response"
        },
        "includeAll":{
            "type":"string",
            "example":"detailed",
            "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except <options-string-name>Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object.\n"
        },
        "languages":{
            "type":"string",
            "description":"If specified, limits translated strings returned"
        },
        "offset":{
            "type":"integer",
            "description":"Starting resource record index. Not required if paging parameters are not supported"
        },
        "limit":{
            "type":"integer",
            "description":"If using paging, number of results returned in this page."
        },
        "orderBy":{
            "type":"integer",
            "description":"Sorts the response by the specified field name and sort order."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

A collection of CAL Packages in an organization.

Body ()

Root Schema : CalPackageGetResponse

Type: object

Model for an CAL Package Object

Show Source

• deploymentOrder(required): integer
  Deployment Order of the package. Enter a number that prioritizes the order of package downloads. CAL Packages with a value of 0 are loaded before packages with a value of 1.

  Example: 20
• limitOptions(required): string
  A string value of 0s & 1s of length 8 representing the deployment of the CAL package to service hosts. If no service host is specified, then the package gets deployed to all service hosts

  Example: 00000000
• limitOptionsExt(required): object limitOptionsExt
  An object containing the descriptive service hosts list where the package can be deployed
• packageId(required): integer
  Unique reference of the CAL package

  Example: 1
• packageName(required): string
  Name of the package

  Example: CAPSOnISS
• platformType(required): integer
  The type of platform that receives the CAL Package

  Example: 20
• version(required): string
  Version of the package

  Example: 19.3.3

{
    "description":"Model for an CAL Package Object",
    "type":"object",
    "required":[
        "packageId",
        "packageName",
        "version",
        "deploymentOrder",
        "platformType",
        "limitOptions",
        "limitOptionsExt"
    ],
    "properties":{
        "packageId":{
            "description":"Unique reference of the CAL package",
            "type":"integer",
            "example":1
        },
        "packageName":{
            "description":"Name of the package",
            "type":"string",
            "example":"CAPSOnISS"
        },
        "version":{
            "description":"Version of the package",
            "type":"string",
            "example":"19.3.3"
        },
        "deploymentOrder":{
            "description":"Deployment Order of the package. Enter a number that prioritizes the order of package downloads. CAL Packages with a value of 0 are loaded before packages with a value of 1.",
            "type":"integer",
            "example":20
        },
        "platformType":{
            "description":"The type of platform that receives the CAL Package",
            "type":"integer",
            "example":20
        },
        "limitOptions":{
            "description":"A string value of 0s & 1s of length 8 representing the deployment of the CAL package to service hosts. If no service host is specified, then the package gets deployed to all service hosts",
            "type":"string",
            "example":"00000000"
        },
        "limitOptionsExt":{
            "description":"An object containing the descriptive service hosts list where the package can be deployed",
            "type":"object",
            "properties":{
                "checkAndPosting":{
                    "description":"A Boolean flag indicating to deploy package to Check and Posting related service host",
                    "type":"boolean",
                    "example":false
                },
                "checkAndPostingBackup":{
                    "description":"A Boolean flag indicating to deploy package to Check and Posting Backup related service host",
                    "type":"boolean",
                    "example":false
                },
                "creditCard":{
                    "description":"A Boolean flag indicating to deploy package to Credit Card related service host",
                    "type":"boolean",
                    "example":false
                },
                "interfaces":{
                    "description":"A Boolean flag indicating to deploy package to interfaces related service host",
                    "type":"boolean",
                    "example":false
                },
                "kdsController":{
                    "description":"A Boolean flag indicating to deploy package to KDS Controller related service host",
                    "type":"boolean",
                    "example":false
                },
                "kdsControllerBackup":{
                    "description":"A Boolean flag indicating to deploy package to KDS Controller Backup related service host",
                    "type":"boolean",
                    "example":false
                },
                "sim":{
                    "description":"A Boolean flag indicating to deploy package to SIM related service host",
                    "type":"boolean",
                    "example":false
                },
                "workstation":{
                    "description":"A Boolean flag indicating to deploy package to Workstation related service host",
                    "type":"boolean",
                    "example":false
                }
            }
        }
    }
}

Nested Schema : limitOptionsExt

Type: object

An object containing the descriptive service hosts list where the package can be deployed

Show Source

• checkAndPosting: boolean
  A Boolean flag indicating to deploy package to Check and Posting related service host

  Example: false
• checkAndPostingBackup: boolean
  A Boolean flag indicating to deploy package to Check and Posting Backup related service host

  Example: false
• creditCard: boolean
  A Boolean flag indicating to deploy package to Credit Card related service host

  Example: false
• interfaces: boolean
  A Boolean flag indicating to deploy package to interfaces related service host

  Example: false
• kdsController: boolean
  A Boolean flag indicating to deploy package to KDS Controller related service host

  Example: false
• kdsControllerBackup: boolean
  A Boolean flag indicating to deploy package to KDS Controller Backup related service host

  Example: false
• sim: boolean
  A Boolean flag indicating to deploy package to SIM related service host

  Example: false
• workstation: boolean
  A Boolean flag indicating to deploy package to Workstation related service host

  Example: false

{
    "description":"An object containing the descriptive service hosts list where the package can be deployed",
    "type":"object",
    "properties":{
        "checkAndPosting":{
            "description":"A Boolean flag indicating to deploy package to Check and Posting related service host",
            "type":"boolean",
            "example":false
        },
        "checkAndPostingBackup":{
            "description":"A Boolean flag indicating to deploy package to Check and Posting Backup related service host",
            "type":"boolean",
            "example":false
        },
        "creditCard":{
            "description":"A Boolean flag indicating to deploy package to Credit Card related service host",
            "type":"boolean",
            "example":false
        },
        "interfaces":{
            "description":"A Boolean flag indicating to deploy package to interfaces related service host",
            "type":"boolean",
            "example":false
        },
        "kdsController":{
            "description":"A Boolean flag indicating to deploy package to KDS Controller related service host",
            "type":"boolean",
            "example":false
        },
        "kdsControllerBackup":{
            "description":"A Boolean flag indicating to deploy package to KDS Controller Backup related service host",
            "type":"boolean",
            "example":false
        },
        "sim":{
            "description":"A Boolean flag indicating to deploy package to SIM related service host",
            "type":"boolean",
            "example":false
        },
        "workstation":{
            "description":"A Boolean flag indicating to deploy package to Workstation related service host",
            "type":"boolean",
            "example":false
        }
    }
}

400 Response

400 Bad Request

Body ()

Root Schema : ErrorDetails

Type: object

Response body when the request returns an error.

Show Source

• detail(required): string
  A short, human-readable summary of the problem.

  Example: Specified Data is invalid
• errorDetails(required): string
  A human-readable explanation specific to this occurrence of the problem.

  Example: Entity Does Not Exist
• o:errorCode(required): integer
  Error code of the problem

  Example: 55223
• status(required): integer
  HTTP status code.

  Example: 400
• title(required): string
  A short, human-readable summary of the problem type.

  Example: VALIDATION ERROR
• type(required): string
  A URI reference that identifies the problem type. When this member is not present, its value is assumed to be "about:blank".

  Example: http://www.abc.org/xyz.html

{
    "description":"Response body when the request returns an error.\n",
    "type":"object",
    "required":[
        "o:errorCode",
        "detail",
        "status",
        "type",
        "title",
        "errorDetails"
    ],
    "properties":{
        "o:errorCode":{
            "description":"Error code of the problem",
            "type":"integer",
            "example":55223
        },
        "detail":{
            "description":"A short, human-readable summary of the problem.",
            "type":"string",
            "example":"Specified Data is invalid"
        },
        "status":{
            "description":"HTTP status code.",
            "type":"integer",
            "example":400
        },
        "type":{
            "description":"A URI reference that identifies the problem type. When this member is not present, its value is assumed to be \"about:blank\".",
            "type":"string",
            "example":"http://www.abc.org/xyz.html"
        },
        "title":{
            "description":"A short, human-readable summary of the problem type.",
            "type":"string",
            "example":"VALIDATION ERROR"
        },
        "errorDetails":{
            "description":"A human-readable explanation specific to this occurrence of the problem.",
            "type":"string",
            "example":"Entity Does Not Exist"
        }
    }
}

Back to Top