Jump to

• Request
• Response

Get CAL Deployment Schedules

post

/config/sim/v1/setup/cal/getDeploymentSchedules

Gets all the CAL Deployment Schedules configured

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 ()

Get request body

Root Schema : GetDepScheduleRequestBody

Type: object

The input Body model that needs to be given for get request.

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 for get request.",
    "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 Deployment Schedules of the organization

Body ()

Root Schema : DeploymentSchedule

Type: object

Model for CAL Deployment Schedule Object

Show Source

• actionToTake(optional): 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(optional): integer
  Unique reference of the CAL deployment schedule.

  Example: 111
• deploymentType(optional): integer
  The Type of the deployment 1 ??? Property / Enterprise 2 ??? Specific Service Host

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

  Example: 14-04-2022T13:00:00
• effectiveTo(optional): 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(optional): string
  Name of the CAL deployment package

  Example: CAPSOnIIS.19.3.3
• svcHostName(optional): object SvcHostNameTranslatedString
  A group of strings representing the name of the service host or workstations in configured languages where the package is downloaded. Applicable only if deploymentType = 2
• svcHostObjNum(optional): integer
  Object number of the service host or workstations where the package is downloaded. Applicable only if deploymentType = 2

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

  Example: 19.3.3

{
    "description":"Model for CAL Deployment Schedule Object",
    "type":"object",
    "required":[
        "hierUnitId",
        "packageId"
    ],
    "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
        },
        "svcHostName":{
            "$ref":"#/definitions/SvcHostNameTranslatedString"
        },
        "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"
        }
    }
}

Nested Schema : SvcHostNameTranslatedString

Type: object

A group of strings representing the name of the service host or workstations in configured languages where the package is downloaded. Applicable only if deploymentType = 2

Example:

{
    "en-US":"SVC Host 1",
    "sp-SP":"Host de servicio 1"
}

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