Update a set of holiday calendar events
patch
/fscmRestApi/resources/11.13.18.05/publicSectorHolidayCalendars/{publicSectorHolidayCalendarsUniqID}/child/HolidayCalendarDetail/{HolidayCalendarDetailUniqID}
Request
Path Parameters
-
HolidayCalendarDetailUniqID(required): string
This is the hash key of the attributes which make up the composite key--- AgencyId, CalendarId and EventId ---for the Holiday Calendar Events resource and used to uniquely identify an instance of Holiday Calendar Events. The client should not generate the hash key value. Instead, the client should query on the Holiday Calendar Events collection resource with a filter on the primary key values in order to navigate to a specific instance of Holiday Calendar Events.
For example: HolidayCalendarDetail?q=AgencyId=<value1>;CalendarId=<value2>;EventId=<value3> -
publicSectorHolidayCalendarsUniqID(required): string
This is the hash key of the attributes which make up the composite key--- AgencyId and CalendarId ---for the Holiday Calendars resource and used to uniquely identify an instance of Holiday Calendars. The client should not generate the hash key value. Instead, the client should query on the Holiday Calendars collection resource with a filter on the primary key values in order to navigate to a specific instance of Holiday Calendars.
For example: publicSectorHolidayCalendars?q=AgencyId=<value1>;CalendarId=<value2>
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
Comments: string
Title:
Description
Maximum Length:100
The description of the holiday calendar event. -
EventDate: string
(date)
Title:
Event Date
The date of the holiday calendar event.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : publicSectorHolidayCalendars-HolidayCalendarDetail-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Default Value:
1
The agency identifier of the public sector entity to which this holiday calendar applies. -
CalendarId: string
Title:
Calendar ID
Maximum Length:30
The unique identifier for the holiday calendar. -
Comments: string
Title:
Description
Maximum Length:100
The description of the holiday calendar event. -
EventDate: string
(date)
Title:
Event Date
The date of the holiday calendar event. -
EventId: string
Title:
Event ID
Maximum Length:30
The unique identifier for the holiday calendar event. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.