Jump to

• Request
• Response

Update an academic period

patch

/fscmRestApi/resources/11.13.18.05/hedAcademicPeriods/{AcademicPeriodId}

Request

Path Parameters

• AcademicPeriodId(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

• ActiveFlag: boolean
  Title: Active

  Maximum Length: 1

  Default Value: false

  Indicates whether the academic period is active. The default value is N.
• associatedCalendars: array Associated Calendars
  Title: Associated Calendars

  Associated calendars represent the calendars associated with academic periods.
• childPeriods: array Child Academic Periods
  Title: Child Academic Periods

  The child periods resource provides a list of child academic periods associated with an academic period.
• Description: string
  Title: Description

  Maximum Length: 1000

  The description of an academic period.
• entityAssignments: array Entity Assignments
  Title: Entity Assignments

  The assignments resource provides a list of academic entities which have been assigned.
• periodDates: array Academic Period Dates
  Title: Academic Period Dates

  The academic period dates resource is used to manage academic period dates.
• PeriodEndDate: string (date)
  Title: End Date

  The date when an academic period ends.
• PeriodName: string
  Title: Name

  Maximum Length: 50

  The name of an academic period.
• PeriodStartDate: string (date)
  Title: Start Date

  The date when an academic period starts.
• tagAssignments: array Academic Period Tags
  Title: Academic Period Tags

  Tag assignments represent the tags assigned to academic periods.
• WeeksOfInstruction: integer (int32)
  Title: Weeks of Instruction

  Default Value: 1

  The weeks of instructions of an academic period.

{
    "type":"object",
    "properties":{
        "tagAssignments":{
            "title":"Academic Period Tags",
            "type":"array",
            "description":"Tag assignments represent the tags assigned to academic periods.",
            "items":{
                "$ref":"#/components/schemas/hedAcademicPeriods-tagAssignments-item-patch-request"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":1000,
            "type":"string",
            "description":"The description of an academic period.",
            "nullable":true,
            "x-queryable":false
        },
        "childPeriods":{
            "title":"Child Academic Periods",
            "type":"array",
            "description":"The child periods resource provides a list of child academic periods associated with an academic period.",
            "items":{
                "$ref":"#/components/schemas/hedAcademicPeriods-childPeriods-item-patch-request"
            }
        },
        "periodDates":{
            "title":"Academic Period Dates",
            "type":"array",
            "description":"The academic period dates resource is used to manage academic period dates.",
            "items":{
                "$ref":"#/components/schemas/hedAcademicPeriods-periodDates-item-patch-request"
            }
        },
        "associatedCalendars":{
            "title":"Associated Calendars",
            "type":"array",
            "description":"Associated calendars represent the calendars associated with academic periods.",
            "items":{
                "$ref":"#/components/schemas/hedAcademicPeriods-associatedCalendars-item-patch-request"
            }
        },
        "entityAssignments":{
            "title":"Entity Assignments",
            "type":"array",
            "description":"The assignments resource provides a list of academic entities which have been assigned.",
            "items":{
                "$ref":"#/components/schemas/hedAcademicPeriods-entityAssignments-item-patch-request"
            }
        },
        "PeriodName":{
            "title":"Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of an academic period.",
            "nullable":false
        },
        "WeeksOfInstruction":{
            "title":"Weeks of Instruction",
            "type":"integer",
            "description":"The weeks of instructions of an academic period.",
            "format":"int32",
            "nullable":true,
            "default":1,
            "x-hints":{
                "precision":9
            }
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the academic period is active. The default value is N.",
            "nullable":false,
            "default":false
        },
        "PeriodEndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when an academic period ends.",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "dependencies":[
                    "CalendarItemId",
                    "EndDate"
                ]
            }
        },
        "PeriodStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when an academic period starts.",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "dependencies":[
                    "CalendarItemId",
                    "StartDate"
                ]
            }
        }
    }
}

Nested Schema : Associated Calendars

Type: array

Title: Associated Calendars

Associated calendars represent the calendars associated with academic periods.

Show Source

• Array of: object hedAcademicPeriods-associatedCalendars-item-patch-request

{
    "title":"Associated Calendars",
    "type":"array",
    "description":"Associated calendars represent the calendars associated with academic periods.",
    "items":{
        "$ref":"#/components/schemas/hedAcademicPeriods-associatedCalendars-item-patch-request"
    }
}

Nested Schema : Child Academic Periods

Type: array

Title: Child Academic Periods

The child periods resource provides a list of child academic periods associated with an academic period.

Show Source

• Array of: object hedAcademicPeriods-childPeriods-item-patch-request

{
    "title":"Child Academic Periods",
    "type":"array",
    "description":"The child periods resource provides a list of child academic periods associated with an academic period.",
    "items":{
        "$ref":"#/components/schemas/hedAcademicPeriods-childPeriods-item-patch-request"
    }
}

Nested Schema : Entity Assignments

Type: array

Title: Entity Assignments

The assignments resource provides a list of academic entities which have been assigned.

Show Source

• Array of: object schema

{
    "title":"Entity Assignments",
    "type":"array",
    "description":"The assignments resource provides a list of academic entities which have been assigned.",
    "items":{
        "$ref":"#/components/schemas/hedAcademicPeriods-entityAssignments-item-patch-request"
    }
}

Nested Schema : Academic Period Dates

Type: array

Title: Academic Period Dates

The academic period dates resource is used to manage academic period dates.

Show Source

• Array of: object schema

{
    "title":"Academic Period Dates",
    "type":"array",
    "description":"The academic period dates resource is used to manage academic period dates.",
    "items":{
        "$ref":"#/components/schemas/hedAcademicPeriods-periodDates-item-patch-request"
    }
}

Nested Schema : Academic Period Tags

Type: array

Title: Academic Period Tags

Tag assignments represent the tags assigned to academic periods.

Show Source

• Array of: object schema

{
    "title":"Academic Period Tags",
    "type":"array",
    "description":"Tag assignments represent the tags assigned to academic periods.",
    "items":{
        "$ref":"#/components/schemas/hedAcademicPeriods-tagAssignments-item-patch-request"
    }
}

Nested Schema : hedAcademicPeriods-associatedCalendars-item-patch-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Nested Schema : hedAcademicPeriods-childPeriods-item-patch-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Nested Schema : schema

Type: object

Show Source

• AssignedEntityTypeCode: string
  Title: Entity Type Code

  Maximum Length: 30

  A list of accepted values is defined in the lookup type ORA_HER_ASSOCIATED_OBJECT_TYPE.
• AssignmentEndDate: string (date)
  Title: Assignment End Date

  The end or expiration date of the entity assignment.
• AssignmentStartDate: string (date)
  Title: Assignment Start Date

  The start date of the entity assignment.

{
    "type":"object",
    "properties":{
        "AssignedEntityTypeCode":{
            "title":"Entity Type Code",
            "maxLength":30,
            "type":"string",
            "description":"A list of accepted values is defined in the lookup type ORA_HER_ASSOCIATED_OBJECT_TYPE.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AssignmentStartDate":{
            "title":"Assignment Start Date",
            "type":"string",
            "description":"The start date of the entity assignment.",
            "format":"date",
            "nullable":false
        },
        "AssignmentEndDate":{
            "title":"Assignment End Date",
            "type":"string",
            "description":"The end or expiration date of the entity assignment.",
            "format":"date",
            "nullable":false
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• DateCalculationSchemeCode: string
  Title: Date Calculation Scheme Code

  Maximum Length: 30

  Indicates the period date calculation scheme code. The scheme identifies the pivot date that's used when the date attribute is calculated.
• DateFactorNumber: integer (int32)
  Title: Date Factor

  Default Value: 0

  Indicates the required number of days to adjustment before or after the pivot date. Before the date is a negative number and after is a positive number.
• DateRoundingCode: string
  Title: Date Rounding Code

  Maximum Length: 30

  Indicates the date rounding code when calculating the period date's value.
• DateTypeCode: string
  Title: Date Type Code

  Maximum Length: 30

  Default Value: ORA_DATE

  The date type code for an academic period date, such as date, date and time.
• EndDate: string (date-time)
  Title: End Date

  The date when the period attribute ends.
• PivotBasedFlag: boolean
  Title: Pivot Based

  Maximum Length: 1

  Default Value: false

  Indicates that this period date must be calculated. The default value is N.
• StartDate: string (date-time)
  Title: Start Date

  The date when the period attribute starts.
• TimezoneCode: string
  Title: Time Zone

  Maximum Length: 32

  Time zone code selected by a user when specifying a manual date time.

{
    "type":"object",
    "properties":{
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the period attribute starts.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "CalendarStartDate"
                ]
            }
        },
        "TimezoneCode":{
            "title":"Time Zone",
            "maxLength":32,
            "type":"string",
            "description":"Time zone code selected by a user when specifying a manual date time.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PivotBasedFlag":{
            "title":"Pivot Based",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates that this period date must be calculated. The default value is N.",
            "nullable":false,
            "default":false
        },
        "DateTypeCode":{
            "title":"Date Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The date type code for an academic period date, such as date, date and time.",
            "nullable":false,
            "default":"ORA_DATE",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "DateCalculationSchemeCode":{
            "title":"Date Calculation Scheme Code",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the period date calculation scheme code. The scheme identifies the pivot date that's used when the date attribute is calculated.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "DateFactorNumber":{
            "title":"Date Factor",
            "type":"integer",
            "description":"Indicates the required number of days to adjustment before or after the pivot date. Before the date is a negative number and after is a positive number.",
            "format":"int32",
            "nullable":true,
            "default":0,
            "x-hints":{
                "precision":3
            }
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the period attribute ends.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "CalendarEndDate"
                ]
            }
        },
        "DateRoundingCode":{
            "title":"Date Rounding Code",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the date rounding code when calculating the period date's value.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

Nested Schema : schema

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

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

Type: object

Show Source

• AcademicPeriodId: integer (int64)
  Title: Academic Period ID

  Read Only: true

  The unique identifier of an academic period.
• ActiveFlag: boolean
  Title: Active

  Maximum Length: 1

  Default Value: false

  Indicates whether the academic period is active. The default value is N.
• associatedCalendars: array Associated Calendars
  Title: Associated Calendars

  Associated calendars represent the calendars associated with academic periods.
• childPeriods: array Child Academic Periods
  Title: Child Academic Periods

  The child periods resource provides a list of child academic periods associated with an academic period.
• Description: string
  Title: Description

  Maximum Length: 1000

  The description of an academic period.
• entityAssignments: array Entity Assignments
  Title: Entity Assignments

  The assignments resource provides a list of academic entities which have been assigned.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

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

  The link relations associated with the resource instance.
• PeriodCategoryCode: string
  Title: Category Code

  Maximum Length: 30

  The category code of an academic period.
• PeriodCategoryMeaning: string
  Title: Category Meaning

  Read Only: true

  Maximum Length: 80

  The category meaning of an academic period.
• PeriodCode: string
  Title: Period Code

  Maximum Length: 50

  The code of an academic period.
• periodDates: array Academic Period Dates
  Title: Academic Period Dates

  The academic period dates resource is used to manage academic period dates.
• PeriodEndDate: string (date)
  Title: End Date

  The date when an academic period ends.
• PeriodName: string
  Title: Name

  Maximum Length: 50

  The name of an academic period.
• PeriodStartDate: string (date)
  Title: Start Date

  The date when an academic period starts.
• tagAssignments: array Academic Period Tags
  Title: Academic Period Tags

  Tag assignments represent the tags assigned to academic periods.
• WeeksOfInstruction: integer (int32)
  Title: Weeks of Instruction

  Default Value: 1

  The weeks of instructions of an academic period.

{
    "type":"object",
    "properties":{
        "tagAssignments":{
            "title":"Academic Period Tags",
            "type":"array",
            "description":"Tag assignments represent the tags assigned to academic periods.",
            "items":{
                "$ref":"#/components/schemas/hedAcademicPeriods-tagAssignments-item-response"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":1000,
            "type":"string",
            "description":"The description of an academic period.",
            "nullable":true,
            "x-queryable":false
        },
        "childPeriods":{
            "title":"Child Academic Periods",
            "type":"array",
            "description":"The child periods resource provides a list of child academic periods associated with an academic period.",
            "items":{
                "$ref":"#/components/schemas/hedAcademicPeriods-childPeriods-item-response"
            }
        },
        "periodDates":{
            "title":"Academic Period Dates",
            "type":"array",
            "description":"The academic period dates resource is used to manage academic period dates.",
            "items":{
                "$ref":"#/components/schemas/hedAcademicPeriods-periodDates-item-response"
            }
        },
        "WeeksOfInstruction":{
            "title":"Weeks of Instruction",
            "type":"integer",
            "description":"The weeks of instructions of an academic period.",
            "format":"int32",
            "nullable":true,
            "default":1,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the academic period is active. The default value is N.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "PeriodEndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when an academic period ends.",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "dependencies":[
                    "CalendarItemId",
                    "EndDate"
                ]
            },
            "x-queryable":true
        },
        "PeriodCategoryMeaning":{
            "title":"Category Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The category meaning of an academic period.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PeriodStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when an academic period starts.",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "dependencies":[
                    "CalendarItemId",
                    "StartDate"
                ]
            },
            "x-queryable":true
        },
        "associatedCalendars":{
            "title":"Associated Calendars",
            "type":"array",
            "description":"Associated calendars represent the calendars associated with academic periods.",
            "items":{
                "$ref":"#/components/schemas/hedAcademicPeriods-associatedCalendars-item-response"
            }
        },
        "entityAssignments":{
            "title":"Entity Assignments",
            "type":"array",
            "description":"The assignments resource provides a list of academic entities which have been assigned.",
            "items":{
                "$ref":"#/components/schemas/hedAcademicPeriods-entityAssignments-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PeriodName":{
            "title":"Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of an academic period.",
            "nullable":false,
            "x-queryable":true
        },
        "AcademicPeriodId":{
            "title":"Academic Period ID",
            "type":"integer",
            "description":"The unique identifier of an academic period.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "PeriodCode":{
            "title":"Period Code",
            "maxLength":50,
            "type":"string",
            "description":"The code of an academic period.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date and time when the academic period was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "PeriodCategoryCode":{
            "title":"Category Code",
            "maxLength":30,
            "type":"string",
            "description":"The category code of an academic period.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Associated Calendars

Type: array

Title: Associated Calendars

Associated calendars represent the calendars associated with academic periods.

Show Source

• Array of: object hedAcademicPeriods-associatedCalendars-item-response

{
    "title":"Associated Calendars",
    "type":"array",
    "description":"Associated calendars represent the calendars associated with academic periods.",
    "items":{
        "$ref":"#/components/schemas/hedAcademicPeriods-associatedCalendars-item-response"
    }
}

Nested Schema : Child Academic Periods

Type: array

Title: Child Academic Periods

The child periods resource provides a list of child academic periods associated with an academic period.

Show Source

• Array of: object hedAcademicPeriods-childPeriods-item-response

{
    "title":"Child Academic Periods",
    "type":"array",
    "description":"The child periods resource provides a list of child academic periods associated with an academic period.",
    "items":{
        "$ref":"#/components/schemas/hedAcademicPeriods-childPeriods-item-response"
    }
}

Nested Schema : Entity Assignments

Type: array

Title: Entity Assignments

The assignments resource provides a list of academic entities which have been assigned.

Show Source

• Array of: object hedAcademicPeriods-entityAssignments-item-response

{
    "title":"Entity Assignments",
    "type":"array",
    "description":"The assignments resource provides a list of academic entities which have been assigned.",
    "items":{
        "$ref":"#/components/schemas/hedAcademicPeriods-entityAssignments-item-response"
    }
}

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 : Academic Period Dates

Type: array

Title: Academic Period Dates

The academic period dates resource is used to manage academic period dates.

Show Source

• Array of: object hedAcademicPeriods-periodDates-item-response

{
    "title":"Academic Period Dates",
    "type":"array",
    "description":"The academic period dates resource is used to manage academic period dates.",
    "items":{
        "$ref":"#/components/schemas/hedAcademicPeriods-periodDates-item-response"
    }
}

Nested Schema : Academic Period Tags

Type: array

Title: Academic Period Tags

Tag assignments represent the tags assigned to academic periods.

Show Source

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

{
    "title":"Academic Period Tags",
    "type":"array",
    "description":"Tag assignments represent the tags assigned to academic periods.",
    "items":{
        "$ref":"#/components/schemas/hedAcademicPeriods-tagAssignments-item-response"
    }
}

Nested Schema : hedAcademicPeriods-associatedCalendars-item-response

Type: object

Show Source

• CalendarCode: string
  Title: Calendar Code

  Read Only: true

  Maximum Length: 32

  The code of a calendar.
• CalendarId: integer (int64)
  Title: Calendar ID

  Read Only: true

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

  Read Only: true

  Maximum Length: 240

  The name of a calendar.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CalendarName":{
            "title":"Calendar Name",
            "maxLength":240,
            "type":"string",
            "description":"The name of a calendar.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CalendarCode":{
            "title":"Calendar Code",
            "maxLength":32,
            "type":"string",
            "description":"The code of a calendar.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CalendarId":{
            "title":"Calendar ID",
            "type":"integer",
            "description":"The unique identifier of a calendar.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "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 : 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 : hedAcademicPeriods-childPeriods-item-response

Type: object

Show Source

• AcademicPeriodId: integer (int64)
  Title: Academic Period ID

  The identifier of the child academic period.
• Description: string
  Title: Description

  Read Only: true

  Maximum Length: 1000

  The description of an academic period.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PeriodAssociationId: integer (int64)
  Title: Academic Period Association ID

  Read Only: true

  The unique identifier of an academic period association.
• PeriodCategoryCode: string
  Title: Category Code

  Read Only: true

  Maximum Length: 30

  The category code of an academic period.
• PeriodCategoryMeaning: string
  Title: Category Meaning

  Read Only: true

  Maximum Length: 80

  The category meaning of an academic period.
• PeriodCode: string
  Title: Period Code

  Read Only: true

  Maximum Length: 50

  The code of an academic period.
• PeriodEndDate: string (date-time)
  Title: End Date

  Read Only: true

  The date when an academic period ends.
• PeriodName: string
  Title: Name

  Read Only: true

  Maximum Length: 50

  The name of an academic period.
• PeriodStartDate: string (date-time)
  Title: Start Date

  Read Only: true

  The date when an academic period starts.
• WeeksOfInstruction: integer (int32)
  Title: Weeks of Instruction

  Read Only: true

  Default Value: 1

  The weeks of instructions of an academic period.

{
    "type":"object",
    "properties":{
        "Description":{
            "title":"Description",
            "maxLength":1000,
            "type":"string",
            "description":"The description of an academic period.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PeriodAssociationId":{
            "title":"Academic Period Association ID",
            "type":"integer",
            "description":"The unique identifier of an academic period association.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PeriodName":{
            "title":"Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of an academic period.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PeriodCode":{
            "title":"Period Code",
            "maxLength":50,
            "type":"string",
            "description":"The code of an academic period.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AcademicPeriodId":{
            "title":"Academic Period ID",
            "type":"integer",
            "description":"The identifier of the child academic period.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "WeeksOfInstruction":{
            "title":"Weeks of Instruction",
            "type":"integer",
            "description":"The weeks of instructions of an academic period.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "default":1,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "PeriodEndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when an academic period ends.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PeriodCategoryMeaning":{
            "title":"Category Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The category meaning of an academic period.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PeriodStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when an academic period starts.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PeriodCategoryCode":{
            "title":"Category Code",
            "maxLength":30,
            "type":"string",
            "description":"The category code of an academic period.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "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 : hedAcademicPeriods-entityAssignments-item-response

Type: object

Show Source

• AssignedEntityCode: string
  Title: Entity Code

  Maximum Length: 100

  The user defined identifier of the associated entity.
• AssignedEntityId: integer (int64)
  Title: Entity ID

  The unique identifier of the associated entity.
• AssignedEntityName: string
  Title: Entity Name

  Read Only: true

  Maximum Length: 100

  The name of the associated entity.
• AssignedEntityStatusCode: string
  Title: Entity Status Code

  Read Only: true

  Maximum Length: 30

  The status code of the entity. This controls the availability of the entity for assignments to settings.
• AssignedEntityStatusMeaning: string
  Title: Status

  Read Only: true

  Maximum Length: 80

  The status of the entity.
• AssignedEntityTypeCode: string
  Title: Entity Type Code

  Maximum Length: 30

  A list of accepted values is defined in the lookup type ORA_HER_ASSOCIATED_OBJECT_TYPE.
• AssignedEntityTypeMeaning: string
  Title: Entity Type

  Read Only: true

  Maximum Length: 80

  The entity type of the associated entity.
• AssignmentEndDate: string (date)
  Title: Assignment End Date

  The end or expiration date of the entity assignment.
• AssignmentStartDate: string (date)
  Title: Assignment Start Date

  The start date of the entity assignment.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  The date the row was created.
• Description: string
  Title: Description

  Read Only: true

  Maximum Length: 1000

  The description of the associated entity.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date the row was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the row.
• links: array Links
  Title: Links

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

  Read Only: true

  The unique identifier for the setup association record.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignedEntityName":{
            "title":"Entity Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of the associated entity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SettingsAssignmentId":{
            "title":"Settings Assignment ID",
            "type":"integer",
            "description":"The unique identifier for the setup association record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":1000,
            "type":"string",
            "description":"The description of the associated entity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignedEntityCode":{
            "title":"Entity Code",
            "maxLength":100,
            "type":"string",
            "description":"The user defined identifier of the associated entity.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AssignedEntityStatusCode":{
            "title":"Entity Status Code",
            "maxLength":30,
            "type":"string",
            "description":"The status code of the entity. This controls the availability of the entity for assignments to settings.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignedEntityTypeMeaning":{
            "title":"Entity Type",
            "maxLength":80,
            "type":"string",
            "description":"The entity type of the associated entity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignedEntityTypeCode":{
            "title":"Entity Type Code",
            "maxLength":30,
            "type":"string",
            "description":"A list of accepted values is defined in the lookup type ORA_HER_ASSOCIATED_OBJECT_TYPE.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AssignmentStartDate":{
            "title":"Assignment Start Date",
            "type":"string",
            "description":"The start date of the entity assignment.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "AssignedEntityStatusMeaning":{
            "title":"Status",
            "maxLength":80,
            "type":"string",
            "description":"The status of the entity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignedEntityId":{
            "title":"Entity ID",
            "type":"integer",
            "description":"The unique identifier of the associated entity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "AssignedEntityCode"
                ]
            },
            "x-queryable":true
        },
        "AssignmentEndDate":{
            "title":"Assignment End Date",
            "type":"string",
            "description":"The end or expiration date of the entity assignment.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date the row 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 : hedAcademicPeriods-periodDates-item-response

Type: object

Show Source

• AcademicPeriodDateId: integer (int64)
  Title: Academic Period Date ID

  Read Only: true

  The unique identifier for an academic period date.
• DateCalculationSchemeCode: string
  Title: Date Calculation Scheme Code

  Maximum Length: 30

  Indicates the period date calculation scheme code. The scheme identifies the pivot date that's used when the date attribute is calculated.
• DateCalculationSchemeMeaning: string
  Title: Date Calculation Scheme Meaning

  Read Only: true

  Maximum Length: 80

  Indicates the period date calculation scheme meaning. The scheme identifies the pivot date that's used when the date attribute is calculated.
• DateFactorNumber: integer (int32)
  Title: Date Factor

  Default Value: 0

  Indicates the required number of days to adjustment before or after the pivot date. Before the date is a negative number and after is a positive number.
• DateRoundingCode: string
  Title: Date Rounding Code

  Maximum Length: 30

  Indicates the date rounding code when calculating the period date's value.
• DateRoundingMeaning: string
  Title: Date Rounding Meaning

  Read Only: true

  Maximum Length: 80

  Indicates the date rounding type when calculating the period date's value.
• DateTypeCode: string
  Title: Date Type Code

  Maximum Length: 30

  Default Value: ORA_DATE

  The date type code for an academic period date, such as date, date and time.
• DateTypeMeaning: string
  Title: Date Type Meaning

  Read Only: true

  Maximum Length: 80

  The date type meaning for an academic period date, such as date, date and time.
• EndDate: string (date-time)
  Title: End Date

  The date when the period attribute ends.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PeriodAttributeCode: string
  Title: Period Attribute Code

  Maximum Length: 30

  The code of a period attribute.
• PeriodAttributeId: integer (int64)
  Title: Period Attribute ID

  The identifier of a period attribute.
• PeriodAttributeName: string
  Title: Period Attribute Name

  Read Only: true

  Maximum Length: 50

  The name of a period attribute.
• PivotBasedFlag: boolean
  Title: Pivot Based

  Maximum Length: 1

  Default Value: false

  Indicates that this period date must be calculated. The default value is N.
• StartDate: string (date-time)
  Title: Start Date

  The date when the period attribute starts.
• TimezoneCode: string
  Title: Time Zone

  Maximum Length: 32

  Time zone code selected by a user when specifying a manual date time.
• TimezoneName: string
  Title: Timezone Name

  Read Only: true

  Maximum Length: 80

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

{
    "type":"object",
    "properties":{
        "PeriodAttributeId":{
            "title":"Period Attribute ID",
            "type":"integer",
            "description":"The identifier of a period attribute.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "PeriodAttributeCode"
                ]
            },
            "x-queryable":true
        },
        "TimezoneCode":{
            "title":"Time Zone",
            "maxLength":32,
            "type":"string",
            "description":"Time zone code selected by a user when specifying a manual date time.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PivotBasedFlag":{
            "title":"Pivot Based",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates that this period date must be calculated. The default value is N.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "DateCalculationSchemeCode":{
            "title":"Date Calculation Scheme Code",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the period date calculation scheme code. The scheme identifies the pivot date that's used when the date attribute is calculated.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DateTypeMeaning":{
            "title":"Date Type Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The date type meaning for an academic period date, such as date, date and time.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DateRoundingMeaning":{
            "title":"Date Rounding Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Indicates the date rounding type when calculating the period date's value.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PeriodAttributeCode":{
            "title":"Period Attribute Code",
            "maxLength":30,
            "type":"string",
            "description":"The code of a period attribute.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TimezoneName":{
            "title":"Timezone Name",
            "maxLength":80,
            "type":"string",
            "description":"Time zone name selected by a user when specifying a manual date time.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the period attribute ends.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "CalendarEndDate"
                ]
            },
            "x-queryable":true
        },
        "DateCalculationSchemeMeaning":{
            "title":"Date Calculation Scheme Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Indicates the period date calculation scheme meaning. The scheme identifies the pivot date that's used when the date attribute is calculated.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PeriodAttributeName":{
            "title":"Period Attribute Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of a period attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DateRoundingCode":{
            "title":"Date Rounding Code",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the date rounding code when calculating the period date's value.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the period attribute starts.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "CalendarStartDate"
                ]
            },
            "x-queryable":true
        },
        "AcademicPeriodDateId":{
            "title":"Academic Period Date ID",
            "type":"integer",
            "description":"The unique identifier for an academic period date.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "DateTypeCode":{
            "title":"Date Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The date type code for an academic period date, such as date, date and time.",
            "nullable":false,
            "default":"ORA_DATE",
            "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"
            }
        },
        "DateFactorNumber":{
            "title":"Date Factor",
            "type":"integer",
            "description":"Indicates the required number of days to adjustment before or after the pivot date. Before the date is a negative number and after is a positive number.",
            "format":"int32",
            "nullable":true,
            "default":0,
            "x-hints":{
                "precision":3
            },
            "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 : hedAcademicPeriods-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

associatedCalendars

Operation: /fscmRestApi/resources/11.13.18.05/hedAcademicPeriods/{AcademicPeriodId}/child/associatedCalendars

Parameters:

• AcademicPeriodId: $request.path.AcademicPeriodId

Associated calendars represent the calendars associated with academic periods.

childPeriods

Operation: /fscmRestApi/resources/11.13.18.05/hedAcademicPeriods/{AcademicPeriodId}/child/childPeriods

Parameters:

• AcademicPeriodId: $request.path.AcademicPeriodId

The child periods resource provides a list of child academic periods associated with an academic period.

entityAssignments

Operation: /fscmRestApi/resources/11.13.18.05/hedAcademicPeriods/{AcademicPeriodId}/child/entityAssignments

Parameters:

• AcademicPeriodId: $request.path.AcademicPeriodId

The assignments resource provides a list of academic entities which have been assigned.

periodCategoryLOV

Operation: /fscmRestApi/resources/11.13.18.05/herLookups

Parameters:

• finder: ByLookupTypeFinder%3BLookupType%3DORA_HER_PERIOD_CATEGORY_CODE%2CLookupCode%3D{PeriodCategoryCode}

List of values for period categories

periodDates

Operation: /fscmRestApi/resources/11.13.18.05/hedAcademicPeriods/{AcademicPeriodId}/child/periodDates

Parameters:

• AcademicPeriodId: $request.path.AcademicPeriodId

The academic period dates resource is used to manage academic period dates.

tagAssignments

Operation: /fscmRestApi/resources/11.13.18.05/hedAcademicPeriods/{AcademicPeriodId}/child/tagAssignments

Parameters:

• AcademicPeriodId: $request.path.AcademicPeriodId

Tag assignments represent the tags assigned to academic periods.

Back to Top