Jump to

• Request
• Response
• Examples

Update a holiday

patch

/services/rest/connect/v1.4/holidays/{id}

Request

Path Parameters

• id(required): integer
  The unique identifier of the holiday.

Body ()

The list of holidays in your organization.

Root Schema : holidays

Type: object

The list of holidays in your organization.

Show Source

• adminVisibleInterfaces: object namedIDs-holidays-adminVisibleInterfaces
  The named ID that can be included in a list.
• createdTime: string
  The date and time when the holiday was created. This attribute is read-only.
• displayOrder: integer
  Minimum Value: 1

  Maximum Value: 2147483647

  The display position relative to other holidays.
• holidayDate: string
  The date the holiday falls on. The maximum allowed value of the date is 12/31/2032.
• id: integer
  Minimum Value: 1

  Maximum Value: 9223372036854776000

  The unique identifier of the holiday.
• lookupName: string
  Maximum Length: 255

  The name used to look up the holiday.
• name: string
  Maximum Length: 40

  Pattern: ^[^ ]*$

  The name of the holiday.
• updatedTime: string
  The date and time when the holiday was last updated. This attribute is read-only.

{
    "type":"object",
    "description":"The list of holidays in your organization.",
    "properties":{
        "updatedTime":{
            "type":"string",
            "description":"The date and time when the holiday was last updated. This attribute is read-only."
        },
        "name":{
            "pattern":"^[^\t\n]*$",
            "type":"string",
            "description":"The name of the holiday.",
            "maxLength":"40"
        },
        "lookupName":{
            "type":"string",
            "description":"The name used to look up the holiday.",
            "maxLength":"255"
        },
        "createdTime":{
            "type":"string",
            "description":"The date and time when the holiday was created. This attribute is read-only."
        },
        "holidayDate":{
            "type":"string",
            "description":"The date the holiday falls on. The maximum allowed value of the date is 12/31/2032."
        },
        "id":{
            "minimum":"1",
            "type":"integer",
            "description":"The unique identifier of the holiday.",
            "maximum":"9223372036854776000"
        },
        "displayOrder":{
            "minimum":"1",
            "type":"integer",
            "description":"The display position relative to other holidays.",
            "maximum":"2147483647"
        },
        "adminVisibleInterfaces":{
            "items":{
                "type":"object"
            },
            "type":[
                "array",
                "null"
            ],
            "description":"The list of interfaces on which the holiday is available for administration use.",
            "$ref":"#/definitions/namedIDs-holidays-adminVisibleInterfaces"
        }
    }
}

Nested Schema : namedIDs-holidays-adminVisibleInterfaces

Type: object

The named ID that can be included in a list.

Show Source

• id: integer
  Minimum Value: 1

  Maximum Value: 9223372036854776000

  The unique identifier of the object. This is the key for the list entry.
• lookupName: string
  Maximum Length: 255

  The name used to look up the object.

{
    "type":"object",
    "description":"The named ID that can be included in a list.",
    "properties":{
        "id":{
            "minimum":"1",
            "type":"integer",
            "description":"The unique identifier of the object. This is the key for the list entry.",
            "maximum":"9223372036854776000"
        },
        "lookupName":{
            "type":"string",
            "description":"The name used to look up the object.",
            "maxLength":"255"
        }
    }
}

Back to Top

Response

Default Response

Back to Top

Examples

Use the PATCH operation with the following syntax to partially update a holiday object:

https://your_site_interface/services/rest/connect/version/holidays/holiday_id

Include the data to be updated in the request body. Only the fields present in the request JSON data are updated. All other fields remain the same.

Request URI example

https://mysite.example.com/services/rest/connect/v1.4/holidays/5

Request body example

{
"name": "Labour Day"
}

Response example

The status 200 OK is returned. Then getting the data for holiday 5 returns the following:

{
  "id": 5,
  "lookupName": "Labour Day",
  "adminVisibleInterfaces": {
    "links": [
      {
        "rel": "self",
        "href": "https://mysite.example.com/services/rest/connect/v1.4/holidays/5/adminVisibleInterfaces"
      }
    ]
  },
  "displayOrder": 3,
  "holidayDate": "2016-09-05",
  "name": "Labour Day",

...

}

Note:

Labour Day is now spelled correctly for Canada.

Back to Top