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

Header Parameters

• Simphony-AuditTrailRef(optional): string(string)
  Detail that Identifies that who made the change
• Simphony-OrgShortName: string(string)
  Org Identifier

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(optional): string
  Objects included in response
• languages(optional): string
  If specified, limits translated strings returned
• limit(optional): integer
  If using paging, number of results returned in this page.
• offset(optional): integer
  Starting resource record index. Not required if paging parameters are not supported
• orderBy(optional): integer
  Sorts the response by the specified field name and sort order.
• searchCriteria(optional): 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"
        },
        "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 : CalPackage

Type: object

Model for an CAL Package Object

Show Source

• deploymentOrder(optional): 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(optional): string
  A string value of 0???s & 1???s 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: 0
• limitOptionsExt(optional): object limitOptionsExt
  An object containing the descriptive service hosts list where the package can be deployed
• packageId(optional): integer
  Unique reference of the CAL package

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

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

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

  Example: 19.3.3

{
    "description":"Model for an CAL Package Object",
    "type":"object",
    "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 0???s & 1???s 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":0
        },
        "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(optional): boolean
  A Boolean flag indicating to deploy package to Check and Posting related service host

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

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

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

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

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

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

  Example: false
• workstation(optional): 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(optional): string
  A short, human-readable summary of the problem.

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

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

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

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

  Example: VALIDATION ERROR
• type(optional): 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",
    "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