Update a calendar
patch
/fscmRestApi/resources/11.13.18.05/hedCalendars/{CalendarId}
Request
Path Parameters
-
CalendarId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
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
-
ActiveFlag(required): boolean
Title:
Active
Maximum Length:1
Indicates whether the calendar is active. The default value is N. -
CalendarCode(required): string
Title:
Calendar Code
Maximum Length:32
The code of a calendar. -
CalendarEndDate(required): string
(date)
Title:
End Date
The date when a calendar ends. -
CalendarName(required): string
Title:
Calendar Name
Maximum Length:240
The name of a calendar. -
CalendarStartDate(required): string
(date)
Title:
Start Date
The date when a calendar starts. -
Description: string
Title:
Description
Maximum Length:1000
The description of a calendar. -
tagAssignments: array
Calendar Tags
Title:
Calendar Tags
Tag assignments of calendars, for example, an undergraduate tag assigned to a calendar.
Nested Schema : Calendar Tags
Type:
array
Title:
Calendar Tags
Tag assignments of calendars, for example, an undergraduate tag assigned to a calendar.
Show Source
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 : hedCalendars-item-response
Type:
Show Source
object
-
ActiveFlag: boolean
Title:
Active
Maximum Length:1
Indicates whether the calendar is active. The default value is N. -
CalendarCode: string
Title:
Calendar Code
Maximum Length:32
The code of a calendar. -
CalendarCodeLockFlag: boolean
Title:
Calendar Code Lock Indicator
Read Only:true
Maximum Length:1
Default Value:false
Indicates whether calendar code is editable. -
CalendarEndDate: string
(date)
Title:
End Date
The date when a calendar ends. -
CalendarId: integer
(int64)
Title:
Calendar ID
Read Only:true
The unique identifier of a calendar. -
CalendarName: string
Title:
Calendar Name
Maximum Length:240
The name of a calendar. -
CalendarStartDate: string
(date)
Title:
Start Date
The date when a calendar starts. -
Description: string
Title:
Description
Maximum Length:1000
The description of a calendar. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the calendar was last updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
tagAssignments: array
Calendar Tags
Title:
Calendar Tags
Tag assignments of calendars, for example, an undergraduate tag assigned to a calendar. -
TimezoneCode: string
Title:
Time Zone Code
Read Only:true
Maximum Length:50
Default Value:UTC
Time zone code selected by a user when specifying calendar start and end dates. -
TimezoneName: string
Title:
Time Zone Name
Read Only:true
Maximum Length:80
Time zone name selected by a user when specifying a date time.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Calendar Tags
Type:
array
Title:
Calendar Tags
Tag assignments of calendars, for example, an undergraduate tag assigned to a calendar.
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.
Nested Schema : hedCalendars-tagAssignments-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
TagAssignmentId: integer
(int64)
Title:
Tag Assignment ID
Read Only:true
The identifier of the tag assignment. -
TagCode: string
Title:
Tag Code
Maximum Length:30
The code of the tag. -
TagId: integer
(int64)
Title:
Tag ID
The identifier of the tag. -
TagName: string
Title:
Tag Name
Read Only:true
Maximum Length:64
The name of the tag.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- tagAssignments
-
Parameters:
- CalendarId:
$request.path.CalendarId
Tag assignments of calendars, for example, an undergraduate tag assigned to a calendar. - CalendarId:
- timezoneCodesLOV
-
The following properties are defined on the LOV link relation:
- Source Attribute: TimezoneCode; Target Attribute: TimezoneCode
- Display Attribute: Name