Jump to

• Request
• Response

Update an organizational calendar event

patch

/hcmRestApi/resources/11.13.18.05/absenceCalendars/{CalendarId}/child/AbsenceCalendarEvent/{CalendarCalEventId}

Request

Path Parameters

• CalendarCalEventId(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=
• 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: 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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• CalendarEventId: integer (int64)
  Unique identifier for the organizational calendar event.
• CalendarId: integer (int64)
  Unique identifier for the organizational calendar event.
• EventCategoryCode: string
  Maximum Length: 64

  Event category code for the organizational calendar event.
• EventType: string
  Maximum Length: 64

  Event type for the organizational calendar event.

{
    "type":"object",
    "properties":{
        "CalendarEventId":{
            "type":"integer",
            "description":"Unique identifier for the organizational calendar event.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "CalendarId":{
            "type":"integer",
            "description":"Unique identifier for the organizational calendar event.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "EventCategoryCode":{
            "maxLength":64,
            "type":"string",
            "description":"Event category code for the organizational calendar event.",
            "nullable":true
        },
        "EventType":{
            "maxLength":64,
            "type":"string",
            "description":"Event type for the organizational calendar event.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "CalendarEventId",
                    "EventCategoryCode"
                ]
            }
        }
    }
}

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 : absenceCalendars-AbsenceCalendarEvent-item-response

Type: object

Show Source

• AllDayFlag: boolean
  Read Only: true

  Maximum Length: 1

  Default Value: false

  Indicates whether an organizational calendar event is for a full day.
• CalendarCalEventId: integer (int64)
  Unique identifier for an organizational calendar's event.
• CalendarEventId: integer (int64)
  Unique identifier for the organizational calendar event.
• CalendarId: integer (int64)
  Unique identifier for the organizational calendar event.
• Category: string
  Read Only: true

  Maximum Length: 255

  Organizational calendar event category.
• CategoryCode: string
  Title: Category

  Read Only: true

  Maximum Length: 30

  Code for the organizational calendar event category.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  Person who created the organizational calendar event.
• CreationDate: string (date-time)
  Read Only: true

  Date when the organizational calendar event was created.
• Description: string
  Title: Description

  Read Only: true

  Maximum Length: 240

  Description for the organizational calendar event.
• EndDateTime: string (date-time)
  Title: End Date

  Read Only: true

  End date and time for the organizational calendar event.
• EventCategoryCode: string
  Maximum Length: 64

  Event category code for the organizational calendar event.
• EventType: string
  Maximum Length: 64

  Event type for the organizational calendar event.
• HalfDayForElapsed: string
  Title: Half day for elapsed work schedules

  Read Only: true

  Maximum Length: 1

  Default Value: N

  Organizational calendar event option to enable half day for elapsed schedules.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the organizational calendar event was most recently updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Person who updated the organizational calendar event.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Name: string
  Title: Name

  Read Only: true

  Maximum Length: 80

  Name of the organizational calendar event.
• ShortCode: string
  Title: Short Code

  Read Only: true

  Maximum Length: 48

  Short code for the organizational calendar event.
• StartDateTime: string (date-time)
  Title: Start Date

  Read Only: true

  Start date and time for the organizational calendar event.

{
    "type":"object",
    "properties":{
        "AllDayFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether an organizational calendar event is for a full day.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-queryable":true
        },
        "CalendarCalEventId":{
            "type":"integer",
            "description":"Unique identifier for an organizational calendar's event.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CalendarEventId":{
            "type":"integer",
            "description":"Unique identifier for the organizational calendar event.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CalendarId":{
            "type":"integer",
            "description":"Unique identifier for the organizational calendar event.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Category":{
            "maxLength":255,
            "type":"string",
            "description":"Organizational calendar event category.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CategoryCode":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"Code for the organizational calendar event category.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Person who created the organizational calendar event.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the organizational calendar event was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"Description for the organizational calendar event.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "EndDateTime":{
            "title":"End Date",
            "type":"string",
            "description":"End date and time for the organizational calendar event.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EventCategoryCode":{
            "maxLength":64,
            "type":"string",
            "description":"Event category code for the organizational calendar event.",
            "nullable":true,
            "x-queryable":true
        },
        "EventType":{
            "maxLength":64,
            "type":"string",
            "description":"Event type for the organizational calendar event.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "CalendarEventId",
                    "EventCategoryCode"
                ]
            },
            "x-queryable":true
        },
        "HalfDayForElapsed":{
            "title":"Half day for elapsed work schedules",
            "maxLength":1,
            "type":"string",
            "description":"Organizational calendar event option to enable half day for elapsed schedules.",
            "nullable":true,
            "readOnly":true,
            "default":"N",
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the organizational calendar event was most recently updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Person who updated the organizational calendar event.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":80,
            "type":"string",
            "description":"Name of the organizational calendar event.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"edit",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "ShortCode":{
            "title":"Short Code",
            "maxLength":48,
            "type":"string",
            "description":"Short code for the organizational calendar event.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StartDateTime":{
            "title":"Start Date",
            "type":"string",
            "description":"Start date and time for the organizational calendar event.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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