Jump to

• Request
• Response

Update a holiday calendar event

patch

/fscmRestApi/resources/11.13.18.05/publicSectorCalWithDetails/{publicSectorCalWithDetailsUniqID}

Request

Supported Media Types

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

Path Parameters

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

Body ()

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

Root Schema : publicSectorCalWithDetails-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  The agency identifier of the public sector entity to which this holiday calendar event 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.
• 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.
• 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 event 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"
        },
        "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"
        },
        "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 : publicSectorCalWithDetails-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  The agency identifier of the public sector entity to which this holiday calendar event 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.
• 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.
• 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 event 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"
        },
        "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"
        },
        "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