Configuration and Content API Guide

Get Install Status

post

/config/sim/v2/setup/cal/getInstallStatus

Get Installation Status of CAL Packages

Request

Supported Media Types

application/json
multipart/form-data

Root Schema : schema

Type: object

Show Source

include: string

If specificied, limits the data returned to these fields.

Example: hierUnitId, objectNum, name
limit: integer

If using paging, number of results returned in this page.

Example: 100
offset: integer

Starting resource record index. Not required if paging parameters are not supported

Example: 0
orderBy: string

Sorts the response by the specified field name and sort order.

Example: installStatusId:asc
searchCriteria: string

If specified, returns records that match the criteria.

Example: where equals(hierUnitId, 1792)

{
    "type":"object",
    "properties":{
        "searchCriteria":{
            "type":"string",
            "example":"where equals(hierUnitId, 1792)",
            "description":"If specified, returns records that match the criteria."
        },
        "include":{
            "type":"string",
            "example":"hierUnitId, objectNum, name",
            "description":"If specificied, limits the data returned to these fields."
        },
        "offset":{
            "type":"integer",
            "description":"Starting resource record index. Not required if paging parameters are not supported",
            "example":"0"
        },
        "limit":{
            "type":"integer",
            "description":"If using paging, number of results returned in this page.",
            "example":"100"
        },
        "orderBy":{
            "type":"string",
            "description":"Sorts the response by the specified field name and sort order.",
            "example":"installStatusId:asc"
        }
    }
}

Response

Supported Media Types

application/json

200 Response

Success

Root Schema : schema

Type: object

Show Source

count: integer

Number of records returned on this page

Example: 10
hasMore: boolean

Indicates whether there are additional pages of records

Example: true
items: array items

CAL Package Install Status records
limit: integer

The maximum number of records returned on a page

Example: 10
offset: integer

The page number of this data. Starts at 0.

Example: 0
totalResults: integer

Total number of records in the data set

Example: 100

{
    "type":"object",
    "properties":{
        "totalResults":{
            "description":"Total number of records in the data set",
            "type":"integer",
            "example":"100"
        },
        "hasMore":{
            "description":"Indicates whether there are additional pages of records",
            "type":"boolean",
            "example":true
        },
        "count":{
            "description":"Number of records returned on this page",
            "type":"integer",
            "example":"10"
        },
        "offset":{
            "description":"The page number of this data.  Starts at 0.",
            "type":"integer",
            "example":"0"
        },
        "limit":{
            "description":"The maximum number of records returned on a page",
            "type":"integer",
            "example":"10"
        },
        "items":{
            "description":"CAL Package Install Status records",
            "type":"array",
            "items":{
                "$ref":"#/definitions/CALPackageInstallStatus"
            }
        }
    }
}

Nested Schema : items

Type: array

CAL Package Install Status records

Show Source

Array of: object CALPackageInstallStatus

A model for the CAL Packages Install Status objects

{
    "description":"CAL Package Install Status records",
    "type":"array",
    "items":{
        "$ref":"#/definitions/CALPackageInstallStatus"
    }
}

Nested Schema : CALPackageInstallStatus

Type: object

A model for the CAL Packages Install Status objects

Show Source

actionParam: integer

The offset from the beginning of the Setup.dat file in the package where the installation stopped.

Example: 20
actionStatus: string

CAL package installation status - either "Succeeded" or "Failed"

Example: Failed
actionTime: string

The record timestamp

Example: 2022-01-23T09:21:00
actionType: string

CAL package installation stage - either "Begin" or "End"

Example: Begin
calPackageName: string

CAL package name

Example: McrsCAL
calPackageVersion: string

CAL package version

Example: 108.1.4.16
dcalServiceId: integer

Distributed CAL service ID.

Example: 540
installClientId: integer

Client ID. Postive values are service hosts and workstation. Negative values are Kitchen Display Clients.

Example: -244
installStatusId: integer

Installation status record ID

Example: 7000
sendStatus: integer

Indicates if the package installation status has been sent to the Enterprise. It is either 1 (package status has been sent) or 0 (package status hasn't been sent)

Example: 0
workstationPlatform: string

Workstation platform

Example: WIN32

{
    "description":"A model for the CAL Packages Install Status objects",
    "type":"object",
    "properties":{
        "installStatusId":{
            "description":"Installation status record ID",
            "type":"integer",
            "example":"7000"
        },
        "installClientId":{
            "description":"Client ID.  Postive values are service hosts and workstation.  Negative values are Kitchen Display Clients.",
            "type":"integer",
            "example":"-244"
        },
        "workstationPlatform":{
            "type":"string",
            "description":"Workstation platform",
            "example":"WIN32"
        },
        "calPackageName":{
            "type":"string",
            "description":"CAL package name",
            "example":"McrsCAL"
        },
        "calPackageVersion":{
            "type":"string",
            "description":"CAL package version",
            "example":"108.1.4.16"
        },
        "actionTime":{
            "type":"string",
            "description":"The record timestamp",
            "example":"2022-01-23T09:21:00"
        },
        "actionType":{
            "type":"string",
            "description":"CAL package installation stage - either \"Begin\" or \"End\"",
            "example":"Begin"
        },
        "actionStatus":{
            "type":"string",
            "description":"CAL package installation status - either \"Succeeded\" or \"Failed\"",
            "example":"Failed"
        },
        "actionParam":{
            "type":"integer",
            "description":"The offset from the beginning of the Setup.dat file in the package where the installation stopped.",
            "example":"20"
        },
        "dcalServiceId":{
            "type":"integer",
            "description":"Distributed CAL service ID.",
            "example":"540"
        },
        "sendStatus":{
            "type":"integer",
            "description":"Indicates if the package installation status has been sent to the Enterprise. It is either 1 (package status has been sent) or 0 (package status hasn't been sent)",
            "example":"0"
        }
    }
}