Get an academic period
get
/fscmRestApi/resources/11.13.18.05/academicPeriods/{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=
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
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).
-
fields: string
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 -
links: string
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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.
Root Schema : academicPeriods-item-response
Type:
Show Source
object
-
AcademicPeriodId: integer
(int64)
Title:
Academic Period ID
Read Only:true
The unique identifier for an academic period. -
academicPeriods: array
Academic Periods
Title:
Academic Periods
The academic periods resource provides a list of institutionally defined time periods. -
AcademicPeriodTypeId: integer
(int64)
Title:
Academic Period Type ID
Read Only:true
The unique identifier of the academic period type. -
EndDate: string
(date)
Title:
End Date
Read Only:true
The date when the academic period ends. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PeriodCategoryCode: string
Title:
Category
Read Only:true
Maximum Length:30
The category of the period profile, such as Academic. A list of accepted values is defined in the lookup type ORA_HER_PERIOD_CATEGORY_CODE. -
periodDates: array
Period Dates
Title:
Period Dates
The period dates resource is a child of the academic periods resource and provides a list of date definitions for an academic period. -
periodLevels: array
Period Levels
Title:
Period Levels
The period levels resource is a child of the academic periods resource and provides a list of period levels for a academic period. -
PeriodName: string
Title:
Name
Read Only:true
Maximum Length:50
The name of the academic period. -
periodTags: array
Period Tags
Title:
Period Tags
The period tags resource is a child of the academic periods resource and provides a list of curriculum tags for a reporting academic period. -
ReportingPeriodCategoryCode: string
Title:
Reporting Period Category Code
Read Only:true
Maximum Length:30
The category of the reporting period profile associated with the academic period. Category values are defined in the lookup type ORA_HER_PERIOD_CATEGORY_CODE. -
ReportingPeriodId: integer
(int64)
Title:
Reporting Period ID
Read Only:true
The unique identifier for a reporting academic period associated with the academic period. -
ReportingPeriodName: string
Title:
Reporting Period Name
Read Only:true
Maximum Length:50
The name of the reporting academic period associated with the academic period. -
StartDate: string
(date)
Title:
Start Date
Read Only:true
The date when the academic period starts.
Nested Schema : Academic Periods
Type:
array
Title:
Academic Periods
The academic periods resource provides a list of institutionally defined time periods.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Period Dates
Type:
array
Title:
Period Dates
The period dates resource is a child of the academic periods resource and provides a list of date definitions for an academic period.
Show Source
Nested Schema : Period Levels
Type:
array
Title:
Period Levels
The period levels resource is a child of the academic periods resource and provides a list of period levels for a academic period.
Show Source
Nested Schema : Period Tags
Type:
array
Title:
Period Tags
The period tags resource is a child of the academic periods resource and provides a list of curriculum tags for a reporting academic period.
Show Source
Nested Schema : academicPeriods-academicPeriods-item-response
Type:
Show Source
object
-
AcademicPeriodId: integer
(int64)
Title:
Academic Period ID
Read Only:true
The unique identifier for an academic period. -
AcademicPeriodTypeId: integer
(int64)
Title:
Academic Period Type ID
Read Only:true
The unique identifier of the academic period type. -
EndDate: string
(date)
Title:
End Date
Read Only:true
The date when the academic period ends. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PeriodCategoryCode: string
Title:
Category
Read Only:true
Maximum Length:30
The category of the period profile, such as Academic. A list of accepted values is defined in the lookup type ORA_HER_PERIOD_CATEGORY_CODE. -
PeriodName: string
Title:
Name
Read Only:true
Maximum Length:50
The name of the academic period. -
ReportingPeriodCategoryCode: string
Title:
Reporting Period Category Code
Read Only:true
Maximum Length:30
The category of the reporting period profile associated with the academic period. Category values are defined in the lookup type ORA_HER_PERIOD_CATEGORY_CODE. -
ReportingPeriodId: integer
(int64)
Title:
Reporting Period ID
Read Only:true
The unique identifier for a reporting academic period associated with the academic period. -
ReportingPeriodName: string
Title:
Reporting Period Name
Read Only:true
Maximum Length:50
The name of the reporting academic period associated with the academic period. -
StartDate: string
(date)
Title:
Start Date
Read Only:true
The date when the academic period starts.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : academicPeriods-periodDates-item-response
Type:
Show Source
object
-
AcademicPeriodDateId: integer
(int64)
Title:
Academic Period Date ID
Read Only:true
The unique identifier of an academic period date. -
DateTimeCode: string
Title:
Date Time Code
Read Only:true
Maximum Length:30
The unique code for a date attribute. -
DateTimeId: integer
(int64)
Title:
Period Attribute ID
Read Only:true
The unique identifier for a date attribute. -
DateTimeMeaning: string
Title:
Date Time Meaning
Read Only:true
Maximum Length:50
The meaning or description of the academic period date attribute. -
FirstDateTime: string
(date-time)
Title:
Date
Read Only:true
The start date and time of the academic period date attribute. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SecondDateTime: string
(date-time)
Title:
Date Range End
Read Only:true
That end date and time of the academic period date attribute.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : academicPeriods-periodLevels-item-response
Type:
Show Source
object
-
AcademicLevelId: integer
(int64)
The unique identifier of an academic level association on the academic period.
-
AcademicLevelName: string
Title:
Academic Level Name
Read Only:true
Maximum Length:100
The name of the academic level association on the academic period. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created a period level. -
CreationDate: string
(date-time)
Read Only:
true
The date when a period level was created. -
InstitutionId: integer
(int64)
The unique identifier of an institution association on the academic period.
-
InstitutionName: string
Title:
Institution
Read Only:true
Maximum Length:50
The name of the institution association on the academic period. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when a period level was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated a period level. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PeriodLevelId: integer
(int64)
Read Only:
true
The unique identifier for an period level.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : academicPeriods-periodTags-item-response
Type:
Show Source
object
-
CurriculumTagNameCode: string
Title:
Tag Code
Read Only:true
Maximum Length:30
A code for a curriculum tag associated with a reporting academic period. -
CurriculumTagValueCode: string
Title:
Tag Value Code
Read Only:true
Maximum Length:30
A code for a curriculum tag value associated with a reporting academic period. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PeriodTagAssociationId: integer
(int64)
Title:
Period Tag Association
Read Only:true
The unique identifier of a period tag association on the academic period.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- AcademicPeriodTypeLOV
-
The list of values for the type of the academic period.
- academicPeriods
-
Operation: /fscmRestApi/resources/11.13.18.05/academicPeriods/{AcademicPeriodId}/child/academicPeriodsParameters:
- AcademicPeriodId:
$request.path.AcademicPeriodId
The academic periods resource provides a list of institutionally defined time periods. - AcademicPeriodId:
- periodDates
-
Parameters:
- AcademicPeriodId:
$request.path.AcademicPeriodId
The period dates resource is a child of the academic periods resource and provides a list of date definitions for an academic period. - AcademicPeriodId:
- periodLevels
-
Parameters:
- AcademicPeriodId:
$request.path.AcademicPeriodId
The period levels resource is a child of the academic periods resource and provides a list of period levels for a academic period. - AcademicPeriodId:
- periodTags
-
Parameters:
- AcademicPeriodId:
$request.path.AcademicPeriodId
The period tags resource is a child of the academic periods resource and provides a list of curriculum tags for a reporting academic period. - AcademicPeriodId: