Jump to

• Request
• Response

Create a calendar event series

post

/fscmRestApi/resources/11.13.18.05/hedCalendarEventSeries

Request

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.
• Upsert-Mode: string
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AllDayFlag: boolean
  Title: All Day

  Maximum Length: 1

  Default Value: false

  Indicates an all-day calendar event.
• CalendarCode(required): string
  Title: Calendar Code

  Maximum Length: 32

  The code of a calendar.
• CalendarEventCode(required): string
  Title: Calendar Event Code

  Maximum Length: 30

  The code of the calendar event.
• CalendarEventDescription: string (byte)
  Title: Calendar Event Description

  The description of a calendar event.
• CalendarEventEndDate: string (date-time)
  Title: End Date

  The date when a calendar event ends.
• CalendarEventName(required): string
  Title: Calendar Event Name

  Maximum Length: 240

  The name of a calendar event.
• CalendarEventStartDate(required): string (date-time)
  Title: Start Date

  The date when a calendar event starts.
• CalendarId(required): integer (int64)
  Title: Calendar ID

  The unique identifier of a calendar.
• Location: string
  Title: Location

  Maximum Length: 1000

  The location of the calendar event.
• RecurrenceRule: string
  Title: Recurrence Rule

  Maximum Length: 256

  The recurrence rule of the calendar event series. This attribute is mandatory and the format follows RFC5545.
• tagAssignments: array Calendar Event Tags
  Title: Calendar Event Tags

  Tag assignments of calendar events, such as an undergraduate tag assigned to a calendar event.

{
    "required":[
        "CalendarCode",
        "CalendarEventCode",
        "CalendarEventName",
        "CalendarEventStartDate",
        "CalendarId"
    ],
    "type":"object",
    "properties":{
        "CalendarEventName":{
            "title":"Calendar Event Name",
            "maxLength":240,
            "type":"string",
            "description":"The name of a calendar event.",
            "nullable":false
        },
        "RecurrenceRule":{
            "title":"Recurrence Rule",
            "maxLength":256,
            "type":"string",
            "description":"The recurrence rule of the calendar event series. This attribute is mandatory and the format follows RFC5545.",
            "nullable":true
        },
        "tagAssignments":{
            "title":"Calendar Event Tags",
            "type":"array",
            "description":"Tag assignments of calendar events, such as an undergraduate tag assigned to a calendar event.",
            "items":{
                "$ref":"#/components/schemas/hedCalendarEventSeries-tagAssignments-item-post-request"
            }
        },
        "CalendarEventStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when a calendar event starts.",
            "format":"date-time",
            "nullable":false
        },
        "CalendarEventEndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when a calendar event ends.",
            "format":"date-time",
            "nullable":true
        },
        "CalendarCode":{
            "title":"Calendar Code",
            "maxLength":32,
            "type":"string",
            "description":"The code of a calendar.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CalendarId":{
            "title":"Calendar ID",
            "type":"integer",
            "description":"The unique identifier of a calendar.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "CalendarCode"
                ]
            }
        },
        "CalendarEventDescription":{
            "title":"Calendar Event Description",
            "type":"string",
            "description":"The description of a calendar event.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "CalendarEventCode":{
            "title":"Calendar Event Code",
            "maxLength":30,
            "type":"string",
            "description":"The code of the calendar event.",
            "nullable":false
        },
        "AllDayFlag":{
            "title":"All Day",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates an all-day calendar event.",
            "nullable":false,
            "default":false
        },
        "Location":{
            "title":"Location",
            "maxLength":1000,
            "type":"string",
            "description":"The location of the calendar event.",
            "nullable":true
        }
    }
}

Nested Schema : Calendar Event Tags

Type: array

Title: Calendar Event Tags

Tag assignments of calendar events, such as an undergraduate tag assigned to a calendar event.

Show Source

• Array of: object hedCalendarEventSeries-tagAssignments-item-post-request

{
    "title":"Calendar Event Tags",
    "type":"array",
    "description":"Tag assignments of calendar events, such as an undergraduate tag assigned to a calendar event.",
    "items":{
        "$ref":"#/components/schemas/hedCalendarEventSeries-tagAssignments-item-post-request"
    }
}

Nested Schema : hedCalendarEventSeries-tagAssignments-item-post-request

Type: object

Show Source

• RequestAction: string
  Title: Request Action

  Maximum Length: 80

  The request action that's performed by the resource when passed by the client during an update. When set to DELETE, the record is deleted. The only accepted value for request action is DELETE.
• TagCode: string
  Title: Tag Code

  Maximum Length: 30

  The code of the tag.
• TagId: integer (int64)
  Title: Tag ID

  The identifier of the tag.

{
    "type":"object",
    "properties":{
        "TagId":{
            "title":"Tag ID",
            "type":"integer",
            "description":"The identifier of the tag.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "TagCode"
                ]
            }
        },
        "TagCode":{
            "title":"Tag Code",
            "maxLength":30,
            "type":"string",
            "description":"The code of the tag.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RequestAction":{
            "title":"Request Action",
            "maxLength":80,
            "type":"string",
            "description":"The request action that's performed by the resource when passed by the client during an update. When set to DELETE, the record is deleted. The only accepted value for request action is DELETE.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

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 : hedCalendarEventSeries-item-response

Type: object

Show Source

• AllDayFlag: boolean
  Title: All Day

  Maximum Length: 1

  Default Value: false

  Indicates an all-day calendar event.
• CalendarCode: string
  Title: Calendar Code

  Maximum Length: 32

  The code of a calendar.
• CalendarCodeLockFlag: boolean
  Title: Calendar Code Lock Indicator

  Read Only: true

  Maximum Length: 1

  Indicates whether calendar event code is editable.
• CalendarEventCode: string
  Title: Calendar Event Code

  Maximum Length: 30

  The code of the calendar event.
• CalendarEventDescription: string (byte)
  Title: Calendar Event Description

  The description of a calendar event.
• CalendarEventEndDate: string (date-time)
  Title: End Date

  The date when a calendar event ends.
• CalendarEventId: integer (int64)
  Title: Calendar Event ID

  Read Only: true

  The unique identifier of a calendar event.
• CalendarEventName: string
  Title: Calendar Event Name

  Maximum Length: 240

  The name of a calendar event.
• CalendarEventStartDate: string (date-time)
  Title: Start Date

  The date when a calendar event starts.
• CalendarId: integer (int64)
  Title: Calendar ID

  The unique identifier of a calendar.
• DisplayTimezoneCode: string
  Title: Time Zone Code

  Read Only: true

  Maximum Length: 50

  Default Value: UTC

  Time zone code selected by a user when specifying calendar start and end dates.
• DisplayTimezoneName: string
  Title: Time Zone Name

  Read Only: true

  Maximum Length: 80

  Time zone name selected by a user when specifying a date time.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the calendar event was last updated.
• links: array Links
  Title: Links

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

  Maximum Length: 1000

  The location of the calendar event.
• RecurrenceRule: string
  Title: Recurrence Rule

  Maximum Length: 256

  The recurrence rule of the calendar event series. This attribute is mandatory and the format follows RFC5545.
• tagAssignments: array Calendar Event Tags
  Title: Calendar Event Tags

  Tag assignments of calendar events, such as an undergraduate tag assigned to a calendar event.

{
    "type":"object",
    "properties":{
        "CalendarEventName":{
            "title":"Calendar Event Name",
            "maxLength":240,
            "type":"string",
            "description":"The name of a calendar event.",
            "nullable":false,
            "x-queryable":true
        },
        "RecurrenceRule":{
            "title":"Recurrence Rule",
            "maxLength":256,
            "type":"string",
            "description":"The recurrence rule of the calendar event series. This attribute is mandatory and the format follows RFC5545.",
            "nullable":true,
            "x-queryable":true
        },
        "tagAssignments":{
            "title":"Calendar Event Tags",
            "type":"array",
            "description":"Tag assignments of calendar events, such as an undergraduate tag assigned to a calendar event.",
            "items":{
                "$ref":"#/components/schemas/hedCalendarEventSeries-tagAssignments-item-response"
            }
        },
        "CalendarId":{
            "title":"Calendar ID",
            "type":"integer",
            "description":"The unique identifier of a calendar.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "CalendarCode"
                ]
            },
            "x-queryable":true
        },
        "DisplayTimezoneCode":{
            "title":"Time Zone Code",
            "maxLength":50,
            "type":"string",
            "description":"Time zone code selected by a user when specifying calendar start and end dates.",
            "nullable":false,
            "readOnly":true,
            "default":"UTC",
            "x-queryable":true
        },
        "CalendarEventCode":{
            "title":"Calendar Event Code",
            "maxLength":30,
            "type":"string",
            "description":"The code of the calendar event.",
            "nullable":false,
            "x-queryable":true
        },
        "DisplayTimezoneName":{
            "title":"Time Zone Name",
            "maxLength":80,
            "type":"string",
            "description":"Time zone name selected by a user when specifying a date time.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CalendarEventStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when a calendar event starts.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "CalendarEventEndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when a calendar event ends.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "CalendarCode":{
            "title":"Calendar Code",
            "maxLength":32,
            "type":"string",
            "description":"The code of a calendar.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CalendarEventDescription":{
            "title":"Calendar Event Description",
            "type":"string",
            "description":"The description of a calendar event.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "CalendarCodeLockFlag":{
            "title":"Calendar Code Lock Indicator",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether calendar event code is editable.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AllDayFlag":{
            "title":"All Day",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates an all-day calendar event.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "CalendarEventId":{
            "title":"Calendar Event ID",
            "type":"integer",
            "description":"The unique identifier of a calendar event.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the calendar event was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Location":{
            "title":"Location",
            "maxLength":1000,
            "type":"string",
            "description":"The location of the calendar event.",
            "nullable":true,
            "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 : Calendar Event Tags

Type: array

Title: Calendar Event Tags

Tag assignments of calendar events, such as an undergraduate tag assigned to a calendar event.

Show Source

• Array of: object hedCalendarEventSeries-tagAssignments-item-response

{
    "title":"Calendar Event Tags",
    "type":"array",
    "description":"Tag assignments of calendar events, such as an undergraduate tag assigned to a calendar event.",
    "items":{
        "$ref":"#/components/schemas/hedCalendarEventSeries-tagAssignments-item-response"
    }
}

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."
        }
    }
}

Nested Schema : hedCalendarEventSeries-tagAssignments-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RequestAction: string
  Title: Request Action

  Maximum Length: 80

  The request action that's performed by the resource when passed by the client during an update. When set to DELETE, the record is deleted. The only accepted value for request action is DELETE.
• TagAssignmentId: integer (int64)
  Title: Tag Assignment ID

  Read Only: true

  Unique identifier of the tag assignment.
• TagCode: string
  Title: Tag Code

  Maximum Length: 30

  The code of the tag.
• TagId: integer (int64)
  Title: Tag ID

  The identifier of the tag.
• TagName: string
  Title: Tag Name

  Read Only: true

  Maximum Length: 64

  The name of the tag.

{
    "type":"object",
    "properties":{
        "TagId":{
            "title":"Tag ID",
            "type":"integer",
            "description":"The identifier of the tag.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "TagCode"
                ]
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TagAssignmentId":{
            "title":"Tag Assignment ID",
            "type":"integer",
            "description":"Unique identifier of the tag assignment.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "TagCode":{
            "title":"Tag Code",
            "maxLength":30,
            "type":"string",
            "description":"The code of the tag.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TagName":{
            "title":"Tag Name",
            "maxLength":64,
            "type":"string",
            "description":"The name of the tag.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RequestAction":{
            "title":"Request Action",
            "maxLength":80,
            "type":"string",
            "description":"The request action that's performed by the resource when passed by the client during an update. When set to DELETE, the record is deleted. The only accepted value for request action is DELETE.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

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"
    }
}

Links

calendarCodesLOV

Operation: /fscmRestApi/resources/11.13.18.05/hedCalendarsLOV

The following properties are defined on the LOV link relation:

• Source Attribute: CalendarCode; Target Attribute: CalendarCode
• Display Attribute: CalendarName

tagAssignments

Operation: /fscmRestApi/resources/11.13.18.05/hedCalendarEventSeries/{CalendarEventId}/child/tagAssignments

Parameters:

• CalendarEventId: $request.path.CalendarEventId

Tag assignments of calendar events, such as an undergraduate tag assigned to a calendar event.

Back to Top