Jump to

• Request
• Response

Update a holiday calendar

patch

/fscmRestApi/resources/11.13.18.05/publicSectorHolidayCalendars/{publicSectorHolidayCalendarsUniqID}

Request

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Path Parameters

• publicSectorHolidayCalendarsUniqID: integer
  This is the hash key of the attributes which make up the composite key--- AgencyId and CalendarId ---for the Holiday Calendars resource and used to uniquely identify an instance of Holiday Calendars. The client should not generate the hash key value. Instead, the client should query on the Holiday Calendars collection resource with a filter on the primary key values in order to navigate to a specific instance of Holiday Calendars.
  
  For example: publicSectorHolidayCalendars?q=AgencyId=<value1>;CalendarId=<value2>

Body ()

The following table describes the body parameters in the request for this task.

Root Schema : publicSectorHolidayCalendars-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  The agency identifier of the public sector entity to which this holiday calendar applies.
• CalendarId(optional): string
  Title: Calendar ID

  Maximum Length: 30

  The unique identifier for the holiday calendar.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

  The user who created the holiday calendar.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date and time that the holiday calendar was created.
• Description(optional): string
  Title: Description

  Maximum Length: 100

  The description of the holiday calendar.
• HolidayCalendarDetail(optional): array Holiday Calendar Events
  Title: Holiday Calendar Events

  The holiday calendar events resource is used to view, create, or modify holiday calendar events.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date and time that the holiday calendar was last modified.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The user who last modified the holiday calendar.
• links(optional): array Items
  Title: Items

  Link Relations
• ValidFromDate(optional): string(date)
  Title: Valid from Date

  The start date on which the holiday calendar becomes effective.
• ValidToDate(optional): string(date)
  Title: Valid to Date

  The end date after which the holiday calendar is no longer effective.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The agency identifier of the public sector entity to which this holiday calendar applies."
        },
        "CalendarId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for the holiday calendar.",
            "title":"Calendar ID"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the holiday calendar.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time that the holiday calendar was created.",
            "title":"Creation Date"
        },
        "Description":{
            "maxLength":100,
            "type":"string",
            "description":"The description of the holiday calendar.",
            "title":"Description"
        },
        "HolidayCalendarDetail":{
            "items":{
                "$ref":"#/definitions/publicSectorHolidayCalendars-HolidayCalendarDetail-item"
            },
            "type":"array",
            "description":"The holiday calendar events resource is used to view, create, or modify holiday calendar events.",
            "title":"Holiday Calendar Events"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time that the holiday calendar was last modified.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last modified the holiday calendar.",
            "title":"Last Updated By"
        },
        "ValidFromDate":{
            "format":"date",
            "type":"string",
            "description":"The start date on which the holiday calendar becomes effective.",
            "title":"Valid from Date"
        },
        "ValidToDate":{
            "format":"date",
            "type":"string",
            "description":"The end date after which the holiday calendar is no longer effective.",
            "title":"Valid to Date"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Holiday Calendar Events

Type: array

Title: Holiday Calendar Events

The holiday calendar events resource is used to view, create, or modify holiday calendar events.

Show Source

• Array of: object publicSectorHolidayCalendars-HolidayCalendarDetail-item

{
    "items":{
        "$ref":"#/definitions/publicSectorHolidayCalendars-HolidayCalendarDetail-item"
    },
    "type":"array",
    "description":"The holiday calendar events resource is used to view, create, or modify holiday calendar events.",
    "title":"Holiday Calendar Events"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : publicSectorHolidayCalendars-HolidayCalendarDetail-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  The agency identifier of the public sector entity to which this holiday calendar applies.
• CalendarId(optional): string
  Title: Calendar ID

  Maximum Length: 30

  The unique identifier for the holiday calendar.
• Comments(optional): string
  Title: Description

  Maximum Length: 100

  The description of the holiday calendar event.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

  The user who created the holiday calendar event.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date and time that the holiday calendar event was created.
• EventDate(optional): string(date)
  Title: Event Date

  The date of the holiday calendar event.
• EventId(optional): string
  Title: Event ID

  Maximum Length: 30

  The unique identifier for the holiday calendar event.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date and time that the holiday calendar event was last modified.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The user who last modified the holiday calendar event.
• links(optional): array Items
  Title: Items

  Link Relations

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The agency identifier of the public sector entity to which this holiday calendar applies."
        },
        "CalendarId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for the holiday calendar.",
            "title":"Calendar ID"
        },
        "Comments":{
            "maxLength":100,
            "type":"string",
            "description":"The description of the holiday calendar event.",
            "title":"Description"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the holiday calendar event.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time that the holiday calendar event was created.",
            "title":"Creation Date"
        },
        "EventDate":{
            "format":"date",
            "type":"string",
            "description":"The date of the holiday calendar event.",
            "title":"Event Date"
        },
        "EventId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for the holiday calendar event.",
            "title":"Event ID"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time that the holiday calendar event was last modified.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last modified the holiday calendar event.",
            "title":"Last Updated By"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

  The name of the relation to the resource instance. Example: self.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorHolidayCalendars-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  The agency identifier of the public sector entity to which this holiday calendar applies.
• CalendarId(optional): string
  Title: Calendar ID

  Maximum Length: 30

  The unique identifier for the holiday calendar.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

  The user who created the holiday calendar.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date and time that the holiday calendar was created.
• Description(optional): string
  Title: Description

  Maximum Length: 100

  The description of the holiday calendar.
• HolidayCalendarDetail(optional): array Holiday Calendar Events
  Title: Holiday Calendar Events

  The holiday calendar events resource is used to view, create, or modify holiday calendar events.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date and time that the holiday calendar was last modified.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The user who last modified the holiday calendar.
• links(optional): array Items
  Title: Items

  Link Relations
• ValidFromDate(optional): string(date)
  Title: Valid from Date

  The start date on which the holiday calendar becomes effective.
• ValidToDate(optional): string(date)
  Title: Valid to Date

  The end date after which the holiday calendar is no longer effective.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The agency identifier of the public sector entity to which this holiday calendar applies."
        },
        "CalendarId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for the holiday calendar.",
            "title":"Calendar ID"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the holiday calendar.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time that the holiday calendar was created.",
            "title":"Creation Date"
        },
        "Description":{
            "maxLength":100,
            "type":"string",
            "description":"The description of the holiday calendar.",
            "title":"Description"
        },
        "HolidayCalendarDetail":{
            "items":{
                "$ref":"#/definitions/publicSectorHolidayCalendars-HolidayCalendarDetail-item"
            },
            "type":"array",
            "description":"The holiday calendar events resource is used to view, create, or modify holiday calendar events.",
            "title":"Holiday Calendar Events"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time that the holiday calendar was last modified.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last modified the holiday calendar.",
            "title":"Last Updated By"
        },
        "ValidFromDate":{
            "format":"date",
            "type":"string",
            "description":"The start date on which the holiday calendar becomes effective.",
            "title":"Valid from Date"
        },
        "ValidToDate":{
            "format":"date",
            "type":"string",
            "description":"The end date after which the holiday calendar is no longer effective.",
            "title":"Valid to Date"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Holiday Calendar Events

Type: array

Title: Holiday Calendar Events

The holiday calendar events resource is used to view, create, or modify holiday calendar events.

Show Source

• Array of: object publicSectorHolidayCalendars-HolidayCalendarDetail-item

{
    "items":{
        "$ref":"#/definitions/publicSectorHolidayCalendars-HolidayCalendarDetail-item"
    },
    "type":"array",
    "description":"The holiday calendar events resource is used to view, create, or modify holiday calendar events.",
    "title":"Holiday Calendar Events"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : publicSectorHolidayCalendars-HolidayCalendarDetail-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  The agency identifier of the public sector entity to which this holiday calendar applies.
• CalendarId(optional): string
  Title: Calendar ID

  Maximum Length: 30

  The unique identifier for the holiday calendar.
• Comments(optional): string
  Title: Description

  Maximum Length: 100

  The description of the holiday calendar event.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

  The user who created the holiday calendar event.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date and time that the holiday calendar event was created.
• EventDate(optional): string(date)
  Title: Event Date

  The date of the holiday calendar event.
• EventId(optional): string
  Title: Event ID

  Maximum Length: 30

  The unique identifier for the holiday calendar event.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date and time that the holiday calendar event was last modified.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The user who last modified the holiday calendar event.
• links(optional): array Items
  Title: Items

  Link Relations

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The agency identifier of the public sector entity to which this holiday calendar applies."
        },
        "CalendarId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for the holiday calendar.",
            "title":"Calendar ID"
        },
        "Comments":{
            "maxLength":100,
            "type":"string",
            "description":"The description of the holiday calendar event.",
            "title":"Description"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the holiday calendar event.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time that the holiday calendar event was created.",
            "title":"Creation Date"
        },
        "EventDate":{
            "format":"date",
            "type":"string",
            "description":"The date of the holiday calendar event.",
            "title":"Event Date"
        },
        "EventId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for the holiday calendar event.",
            "title":"Event ID"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time that the holiday calendar event was last modified.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last modified the holiday calendar event.",
            "title":"Last Updated By"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

  The name of the relation to the resource instance. Example: self.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top