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 Deployment Schedule objects of the organization.
• limit: integer
  Server page size

  Example: 10
• 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 Deployment Schedule objects of the organization.",
            "items":{
                "$ref":"#/definitions/CALDeploymentSchedulev2"
            }
        },
        "offset":{
            "type":"integer",
            "example":0,
            "description":"Starting resource record index"
        },
        "limit":{
            "type":"integer",
            "example":10,
            "description":"Server page size"
        }
    }
}

Show Source

• Array of: object CALDeploymentSchedulev2
  Model for CAL Deployment Schedule Object

{
    "type":"array",
    "description":"Array of Deployment Schedule objects of the organization.",
    "items":{
        "$ref":"#/definitions/CALDeploymentSchedulev2"
    }
}

Show Source

• actionToTake: integer
  Action to take while downloading the package Select 0 for installations to proceed, Select 1 to Skip to prevent downloading a package

  Example: 0
• deploymentId: integer
  Unique reference of the CAL deployment schedule.

  Example: 111
• deploymentType: integer
  The Type of the deployment 1 - Property / Enterprise 2 - Specific Service Host

  Example: 1
• effectiveFrom: string
  The start date when this package becomes active (also used to schedule upgrades).

  Example: 14-04-2022T13:00:00
• effectiveTo: string
  The end date when this package becomes inactive (also used to schedule upgrades).

  Example: 14-04-2022T13:00:00
• hierUnitId: integer
  Unique reference of hierarchy unit where the CAL package is to be downloaded. This could either the property where the package downloads or the Enterprise. Applicable only if the deploymentType = 1

  Example: 3588
• packageId: integer
  Unique reference of the CAL Package

  Example: 101
• packageName: string
  Name of the CAL deployment package

  Example: CAPSOnIIS.19.3.3
• svcHostObjNum: integer
  Object number of the service host or workstations where the package is downloaded. Applicable only if deploymentType = 2

  Example: 141
• version: string
  Version of the CAL deployment package

  Example: 19.3.3

{
    "description":"Model for CAL Deployment Schedule Object",
    "type":"object",
    "properties":{
        "deploymentId":{
            "description":"Unique reference of the CAL deployment schedule.",
            "type":"integer",
            "example":111
        },
        "packageId":{
            "description":"Unique reference of the CAL Package",
            "type":"integer",
            "example":101
        },
        "packageName":{
            "description":"Name of the CAL deployment package",
            "type":"string",
            "example":"CAPSOnIIS.19.3.3"
        },
        "version":{
            "description":"Version of the CAL deployment package",
            "type":"string",
            "example":"19.3.3"
        },
        "deploymentType":{
            "description":"The Type of the deployment 1 - Property / Enterprise 2 - Specific Service Host",
            "type":"integer",
            "example":1
        },
        "hierUnitId":{
            "description":"Unique reference of hierarchy unit where the CAL package is to be downloaded. This could either the property where the package downloads or the Enterprise. Applicable only if the deploymentType = 1",
            "type":"integer",
            "example":3588
        },
        "svcHostObjNum":{
            "description":"Object number of the service host or workstations where the package is downloaded. Applicable only if deploymentType = 2",
            "type":"integer",
            "example":141
        },
        "actionToTake":{
            "description":"Action to take while downloading the package Select 0 for installations to proceed, Select 1 to Skip to prevent downloading a package",
            "type":"integer",
            "example":0
        },
        "effectiveFrom":{
            "description":"The start date when this package becomes active (also used to schedule upgrades).",
            "type":"string",
            "example":"14-04-2022T13:00:00"
        },
        "effectiveTo":{
            "description":"The end date when this package becomes inactive (also used to schedule upgrades).",
            "type":"string",
            "example":"14-04-2022T13:00:00"
        }
    }
}