Jump to

• Request
• Response

Create a calendar

post

/fscmRestApi/resources/11.13.18.05/hedCalendars

Request

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.
• Upsert-Mode:
  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

• ActiveFlag(required): boolean
  Title: Active

  Maximum Length: 1

  Indicates whether the calendar is active. The default value is N.
• CalendarCode(required): string
  Title: Calendar Code

  Maximum Length: 32

  The code of a calendar.
• CalendarEndDate(required): string (date)
  Title: End Date

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

  Maximum Length: 240

  The name of a calendar.
• CalendarStartDate(required): string (date)
  Title: Start Date

  The date when a calendar starts.
• Description: string
  Title: Description

  Maximum Length: 1000

  The description of a calendar.
• tagAssignments: array Calendar Tags
  Title: Calendar Tags

  Tag assignments of calendars, for example, an undergraduate tag assigned to a calendar.

{
    "required":[
        "ActiveFlag",
        "CalendarCode",
        "CalendarEndDate",
        "CalendarName",
        "CalendarStartDate"
    ],
    "type":"object",
    "properties":{
        "tagAssignments":{
            "title":"Calendar Tags",
            "type":"array",
            "description":"Tag assignments of calendars, for example, an undergraduate tag assigned to a calendar.",
            "items":{
                "$ref":"#/components/schemas/hedCalendars-tagAssignments-item-post-request"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":"1000",
            "type":"string",
            "description":"The description of a calendar.",
            "nullable":true,
            "x-queryable":false
        },
        "CalendarCode":{
            "title":"Calendar Code",
            "maxLength":"32",
            "type":"string",
            "description":"The code of a calendar.",
            "nullable":false
        },
        "CalendarName":{
            "title":"Calendar Name",
            "maxLength":"240",
            "type":"string",
            "description":"The name of a calendar.",
            "nullable":false
        },
        "CalendarStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when a calendar starts.",
            "format":"date",
            "nullable":false
        },
        "CalendarEndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when a calendar ends.",
            "format":"date",
            "nullable":false
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the calendar is active. The default value is N.",
            "nullable":false
        }
    }
}

Nested Schema : Calendar Tags

Type: array

Title: Calendar Tags

Tag assignments of calendars, for example, an undergraduate tag assigned to a calendar.

Show Source

• Array of: object schema

{
    "title":"Calendar Tags",
    "type":"array",
    "description":"Tag assignments of calendars, for example, an undergraduate tag assigned to a calendar.",
    "items":{
        "$ref":"#/components/schemas/hedCalendars-tagAssignments-item-post-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• 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"
            }
        },
        "TagCode":{
            "title":"Tag Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code of the tag.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

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

Type: object

Show Source

• ActiveFlag: boolean
  Title: Active

  Maximum Length: 1

  Indicates whether the calendar is active. The default value is N.
• 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

  Default Value: false

  Indicates whether calendar code is editable.
• CalendarEndDate: string (date)
  Title: End Date

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

  Read Only: true

  The unique identifier of a calendar.
• CalendarName: string
  Title: Calendar Name

  Maximum Length: 240

  The name of a calendar.
• CalendarStartDate: string (date)
  Title: Start Date

  The date when a calendar starts.
• Description: string
  Title: Description

  Maximum Length: 1000

  The description of a calendar.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

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

  The link relations associated with the resource instance.
• tagAssignments: array Calendar Tags
  Title: Calendar Tags

  Tag assignments of calendars, for example, an undergraduate tag assigned to a calendar.
• TimezoneCode: 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.
• TimezoneName: string
  Title: Time Zone Name

  Read Only: true

  Maximum Length: 80

  Time zone name selected by a user when specifying a date time.

{
    "type":"object",
    "properties":{
        "tagAssignments":{
            "title":"Calendar Tags",
            "type":"array",
            "description":"Tag assignments of calendars, for example, an undergraduate tag assigned to a calendar.",
            "items":{
                "$ref":"#/components/schemas/hedCalendars-tagAssignments-item-response"
            }
        },
        "TimezoneCode":{
            "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-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"1000",
            "type":"string",
            "description":"The description of a calendar.",
            "nullable":true,
            "x-queryable":false
        },
        "CalendarId":{
            "title":"Calendar ID",
            "type":"integer",
            "description":"The unique identifier of a calendar.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CalendarName":{
            "title":"Calendar Name",
            "maxLength":"240",
            "type":"string",
            "description":"The name of a calendar.",
            "nullable":false,
            "x-queryable":true
        },
        "CalendarStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when a calendar starts.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "CalendarEndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when a calendar ends.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "TimezoneName":{
            "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
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the calendar is active. The default value is N.",
            "nullable":false,
            "x-queryable":true
        },
        "CalendarCode":{
            "title":"Calendar Code",
            "maxLength":"32",
            "type":"string",
            "description":"The code of a calendar.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CalendarCodeLockFlag":{
            "title":"Calendar Code Lock Indicator",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether calendar code is editable.",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the calendar was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":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 Tags

Type: array

Title: Calendar Tags

Tag assignments of calendars, for example, an undergraduate tag assigned to a calendar.

Show Source

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

{
    "title":"Calendar Tags",
    "type":"array",
    "description":"Tag assignments of calendars, for example, an undergraduate tag assigned to a calendar.",
    "items":{
        "$ref":"#/components/schemas/hedCalendars-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 : hedCalendars-tagAssignments-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• TagAssignmentId: integer (int64)
  Title: Tag Assignment ID

  Read Only: true

  The 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"
            },
            "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":"The 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
        }
    }
}

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

tagAssignments

Operation: /fscmRestApi/resources/11.13.18.05/hedCalendars/{CalendarId}/child/tagAssignments

Parameters:

• CalendarId: $request.path.CalendarId

Tag assignments of calendars, for example, an undergraduate tag assigned to a calendar.

timezoneCodesLOV

Operation: /fscmRestApi/resources/11.13.18.05/hedTimezones

The following properties are defined on the LOV link relation:

• Source Attribute: TimezoneCode; Target Attribute: TimezoneCode
• Display Attribute: Name

Back to Top