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:
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
-
AllDayFlag: boolean
Title:
All Day
Maximum Length:1
Indicates whether the event is an All Day event. -
DurationHours: number
Title:
Calendar Event Duration
Length of the calendar event in hours. -
EndDate: string
(date)
Title:
End Date
Finish date of the calendar event. -
EventCategory: string
Title:
Event Category
Maximum Length:80
Category of the resource calendar event. Possible values for resources are PTO, training, or others. -
EventCategoryCode: string
Title:
Event Category Code
Maximum Length:30
Code that indicates the category of the resource calendar event. -
EventDescription: string
Title:
Calendar Event Description
Maximum Length:2000
Description of the calendar event. -
EventName: string
Title:
Event Name
Maximum Length:240
Name of the calendar event. -
ResourceEmail: string
Title:
Email
Maximum Length:240
Email of the resource for whom the event is created. -
ResourceEventId: integer
(int64)
Title:
Resource Event ID
Identifier of the resource event. -
ResourceId: integer
(int64)
Title:
Labor Resource ID
Identifier of the resource for which the event is created. -
ResourceName: string
Title:
Labor Resource Name
Maximum Length:240
Name of the resource for whom the event is created. -
StartDate: string
(date)
Title:
Start Date
Start 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(required):
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(required):
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 Day
Maximum Length:1
Indicates whether the event is an All Day event. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
Indicates the resource who created the row of data. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date when the row of data was created. -
DurationHours: number
Title:
Calendar Event Duration
Length of the calendar event in hours. -
EndDate: string
(date)
Title:
End Date
Finish date of the calendar event. -
EventCategory: string
Title:
Event Category
Maximum Length:80
Category of the resource calendar event. Possible values for resources are PTO, training, or others. -
EventCategoryCode: string
Title:
Event Category Code
Maximum Length:30
Code that indicates the category of the resource calendar event. -
EventDescription: string
Title:
Calendar Event Description
Maximum Length:2000
Description of the calendar event. -
EventName: string
Title:
Event Name
Maximum Length:240
Name of the calendar event. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
Date when the record was last edited. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
Indicates who last edited the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ResourceCalendarName: string
Title:
Calendar
Read Only:true
Maximum Length:240
Name of the calendar that defines the work schedule for the resource. -
ResourceEmail: string
Title:
Email
Maximum Length:240
Email of the resource for whom the event is created. -
ResourceEventId: integer
(int64)
Title:
Resource Event ID
Identifier of the resource event. -
ResourceId: integer
(int64)
Title:
Labor Resource ID
Identifier of the resource for which the event is created. -
ResourceName: string
Title:
Labor Resource Name
Maximum Length:240
Name of the resource for whom the event is created. -
StartDate: string
(date)
Title:
Start Date
Start date of the calendar event.
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.