1. REST API for Oracle Fusion Cloud Student Management
  2. Tasks
  3. Academic Periods

Get all academic periods

get

/fscmRestApi/resources/11.13.18.05/hedAcademicPeriods

Request

Query Parameters
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • Used as a predefined finder to search the collection.

    Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables

    • ByAssociablePeriodFinder Finds academic periods that can be associated with another academic period.
      Finder Variables
      • EndDate; string; The end date of the academic period.
      • Keyword; string; The keyword of the academic period.
      • StartDate; string; The start date of the academic period.
    • ByKeywordFinder Finds the academic period that matches the keyword criteria specified.
      Finder Variables
      • Keyword; string; The keyword of the academic period.
    • PrimaryKey Finds the academic period that matches the primary key criteria specified.
      Finder Variables
      • AcademicPeriodId; integer; The unique identifier of the academic period.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • AcademicPeriodId; integer; The unique identifier of an academic period.
    • ActiveFlag; boolean; Indicates whether the academic period is active. The default value is N.
    • LastUpdateDate; string; The date and time when the academic period was last updated.
    • PeriodCategoryCode; string; The category code of an academic period.
    • PeriodCategoryMeaning; string; The category meaning of an academic period.
    • PeriodCode; string; The code of an academic period.
    • PeriodEndDate; string; The date when an academic period ends.
    • PeriodName; string; The name of an academic period.
    • PeriodStartDate; string; The date when an academic period starts.
    • WeeksOfInstruction; integer; The weeks of instructions of an academic period.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • 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".
  • 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.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : hedAcademicPeriods-item-response
Type: object
Show Source
Nested Schema : Associated Calendars
Type: array
Title: Associated Calendars
Associated calendars represent the calendars associated with academic periods.
Show Source
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
Nested Schema : Entity Assignments
Type: array
Title: Entity Assignments
The assignments resource provides a list of academic entities which have been assigned.
Show Source
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
Nested Schema : Academic Period Tags
Type: array
Title: Academic Period Tags
Tag assignments represent the tags assigned to academic periods.
Show Source
Nested Schema : hedAcademicPeriods-associatedCalendars-item-response
Type: object
Show Source
Nested Schema : hedAcademicPeriods-childPeriods-item-response
Type: object
Show Source
Nested Schema : hedAcademicPeriods-entityAssignments-item-response
Type: object
Show Source
Nested Schema : hedAcademicPeriods-periodDates-item-response
Type: object
Show Source
  • Title: Academic Period Date ID
    Read Only: true
    The unique identifier for an academic period date.
  • 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.
  • 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.
  • 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.
  • Title: Date Rounding Code
    Maximum Length: 30
    Indicates the date rounding code when calculating the period date's value.
  • Title: Date Rounding Meaning
    Read Only: true
    Maximum Length: 80
    Indicates the date rounding type when calculating the period date's value.
  • 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.
  • 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.
  • Title: End Date
    The date when the period attribute ends.
  • Links
  • Title: Period Attribute Code
    Maximum Length: 30
    The code of a period attribute.
  • Title: Period Attribute ID
    The identifier of a period attribute.
  • Title: Period Attribute Name
    Read Only: true
    Maximum Length: 50
    The name of a period attribute.
  • Title: Pivot Based
    Maximum Length: 1
    Default Value: false
    Indicates that this period date must be calculated. The default value is N.
  • Title: Start Date
    The date when the period attribute starts.
  • Title: Time Zone
    Maximum Length: 32
    Time zone code selected by a user when specifying a manual date time.
  • Title: Timezone Name
    Read Only: true
    Maximum Length: 80
    Time zone name selected by a user when specifying a manual date time.
Nested Schema : hedAcademicPeriods-tagAssignments-item-response
Type: object
Show Source
Links
calculatePivotDate
Creates pivot date based on specified parameters.
Back to Top