Update a resource calendar event
patch
/fscmRestApi/resources/11.13.18.05/resourceEvents/{ResourceEventId}
Request
Path Parameters
- ResourceEventId(required): integer(int64) Identifier of the resource event.
Header Parameters
- Metadata-Context: string 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: string 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- AllDayFlag: boolean Title:
All DayMaximum Length:1Indicates whether the event is an All Day event. - DurationHours: number Title:
Calendar Event DurationLength of the calendar event in hours. - EndDate: string (date) Title:
End DateFinish date of the calendar event. - EventCategory: string Title:
Event CategoryMaximum Length:80Category of the resource calendar event. Possible values for resources are PTO, training, or others. - EventCategoryCode: string Title:
Event Category CodeMaximum Length:30Code that indicates the category of the resource calendar event. - EventDescription: string Title:
Calendar Event DescriptionMaximum Length:2000Description of the calendar event. - EventName: string Title:
Event NameMaximum Length:240Name of the calendar event. - ResourceEmail: string Title:
EmailMaximum Length:240Email of the resource for whom the event is created. - ResourceEventId: integer (int64) Title:
Resource Event IDIdentifier of the resource event. - ResourceId: integer (int64) Title:
Labor Resource IDIdentifier of the resource for which the event is created. - ResourceName: string Title:
Labor Resource NameMaximum Length:240Name of the resource for whom the event is created. - StartDate: string (date) Title:
Start DateStart date of the 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 : resourceEvents-item-response
Type:
Show Source object- AllDayFlag: boolean Title:
All DayMaximum Length:1Indicates whether the event is an All Day event. - CreatedBy: string Title:
Created ByRead Only:trueMaximum Length:64Indicates the resource who created the row of data. - CreationDate: string (date-time) Title:
Creation DateRead Only:trueDate when the row of data was created. - DurationHours: number Title:
Calendar Event DurationLength of the calendar event in hours. - EndDate: string (date) Title:
End DateFinish date of the calendar event. - EventCategory: string Title:
Event CategoryMaximum Length:80Category of the resource calendar event. Possible values for resources are PTO, training, or others. - EventCategoryCode: string Title:
Event Category CodeMaximum Length:30Code that indicates the category of the resource calendar event. - EventDescription: string Title:
Calendar Event DescriptionMaximum Length:2000Description of the calendar event. - EventName: string Title:
Event NameMaximum Length:240Name of the calendar event. - LastUpdateDate: string (date-time) Title:
Last Updated DateRead Only:trueDate when the record was last edited. - LastUpdatedBy: string Title:
Last Updated ByRead Only:trueMaximum Length:64Indicates who last edited the record. - links: array Links Title:
LinksThe link relations associated with the resource instance. - ResourceCalendarName: string Title:
CalendarRead Only:trueMaximum Length:240Name of the calendar that defines the work schedule for the resource. - ResourceEmail: string Title:
EmailMaximum Length:240Email of the resource for whom the event is created. - ResourceEventId: integer (int64) Title:
Resource Event IDIdentifier of the resource event. - ResourceId: integer (int64) Title:
Labor Resource IDIdentifier of the resource for which the event is created. - ResourceName: string Title:
Labor Resource NameMaximum Length:240Name of the resource for whom the event is created. - StartDate: string (date) Title:
Start DateStart date of the calendar event.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source Nested Schema : link
Type:
Show Source object- href: string Title:
hyperlink referenceThe URI to the related resource. - kind: string Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. - name: string Title:
nameThe name of the link to the related resource. - properties: object properties
- rel: string Title:
relationAllowed 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.