Jump to

• Request
• Response

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "DurationHours":{
            "title":"Calendar Event Duration",
            "type":"number",
            "description":"Length of the calendar event in hours.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "EventCategory":{
            "title":"Event Category",
            "maxLength":"80",
            "type":"string",
            "description":"Category of the resource calendar event. Possible values for resources are PTO, training, or others.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            }
        },
        "ResourceName":{
            "title":"Labor Resource Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the resource for whom the event is created.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "ResourceId"
                ]
            }
        },
        "EventCategoryCode":{
            "title":"Event Category Code",
            "maxLength":"30",
            "type":"string",
            "description":"Code that indicates the category of the resource calendar event.",
            "nullable":true
        },
        "EventName":{
            "title":"Event Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the calendar event.",
            "nullable":false
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"Finish date of the calendar event.",
            "format":"date",
            "nullable":false
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Start date of the calendar event.",
            "format":"date",
            "nullable":false
        },
        "ResourceId":{
            "title":"Labor Resource ID",
            "type":"integer",
            "description":"Identifier of the resource for which the event is created.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ResourceEventId":{
            "title":"Resource Event ID",
            "type":"integer",
            "description":"Identifier of the resource event.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "AllDayFlag":{
            "title":"All Day",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the event is an All Day event.",
            "nullable":true
        },
        "EventDescription":{
            "title":"Calendar Event Description",
            "maxLength":"2000",
            "type":"string",
            "description":"Description of the calendar event.",
            "nullable":true
        },
        "ResourceEmail":{
            "title":"Email",
            "maxLength":"240",
            "type":"string",
            "description":"Email of the resource for whom the event is created.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        }
    }
}

Back to Top

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.

Body ()

Root Schema : resourceEvents-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"Indicates who last edited the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DurationHours":{
            "title":"Calendar Event Duration",
            "type":"number",
            "description":"Length of the calendar event in hours.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date when the row of data was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"Indicates the resource who created the row of data.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EventCategory":{
            "title":"Event Category",
            "maxLength":"80",
            "type":"string",
            "description":"Category of the resource calendar event. Possible values for resources are PTO, training, or others.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ResourceName":{
            "title":"Labor Resource Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the resource for whom the event is created.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "ResourceId"
                ]
            },
            "x-queryable":true
        },
        "EventCategoryCode":{
            "title":"Event Category Code",
            "maxLength":"30",
            "type":"string",
            "description":"Code that indicates the category of the resource calendar event.",
            "nullable":true,
            "x-queryable":true
        },
        "EventName":{
            "title":"Event Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the calendar event.",
            "nullable":false,
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"Finish date of the calendar event.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "ResourceCalendarName":{
            "title":"Calendar",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the calendar that defines the work schedule for the resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Start date of the calendar event.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "ResourceId":{
            "title":"Labor Resource ID",
            "type":"integer",
            "description":"Identifier of the resource for which the event is created.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ResourceEventId":{
            "title":"Resource Event ID",
            "type":"integer",
            "description":"Identifier of the resource event.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AllDayFlag":{
            "title":"All Day",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the event is an All Day event.",
            "nullable":true,
            "x-queryable":true
        },
        "EventDescription":{
            "title":"Calendar Event Description",
            "maxLength":"2000",
            "type":"string",
            "description":"Description of the calendar event.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Date when the record was last edited.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceEmail":{
            "title":"Email",
            "maxLength":"240",
            "type":"string",
            "description":"Email of the resource for whom the event is created.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top