Get an academic period sequence
get
/fscmRestApi/resources/11.13.18.05/academicPeriodSequences/{PeriodSequenceHeaderId}
Request
Path Parameters
-
PeriodSequenceHeaderId(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 : academicPeriodSequences-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created an academic period sequence. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when an academic period sequence was created. -
Description: string
Title:
Description
Maximum Length:240
The description of an academic period sequence. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date when an academic period sequence was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated an academic period sequence. -
levelOnePeriods: array
Level One Academic Periods
Title:
Level One Academic Periods
The level one academic periods resource is a child resource of the academic period sequence resource and provides an ordered sequence of academic periods in the first level of the hierarchy. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PeriodSequenceHeaderId: integer
(int64)
Title:
Sequence Header ID
The unique identifier for an academic period sequence. -
periodSequenceOwners: array
Academic Period Sequence Owners
Title:
Academic Period Sequence Owners
The academic period sequence owners resource is a child resource of the academic period sequence resource and identifies the institution and academic level for the academic period sequence. -
SequenceCode: string
Maximum Length:
50
The code of an academic period sequence. -
SequenceName: string
Maximum Length:
50
The name of an academic period sequence. -
StatusCode: string
Title:
Status Code
Maximum Length:30
The code for an academic period sequence status. A list of accepted values is defined in the lookup type ORA_HER_SYSTEM_STATUS_CODE. -
StatusMeaning: string
Maximum Length:
80
The status for an academic period sequence, such as active or inactive. A list of accepted values is defined in the lookup type ORA_HER_SYSTEM_STATUS_CODE.
Nested Schema : Level One Academic Periods
Type:
array
Title:
Level One Academic Periods
The level one academic periods resource is a child resource of the academic period sequence resource and provides an ordered sequence of academic periods in the first level of the hierarchy.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Academic Period Sequence Owners
Type:
array
Title:
Academic Period Sequence Owners
The academic period sequence owners resource is a child resource of the academic period sequence resource and identifies the institution and academic level for the academic period sequence.
Show Source
Nested Schema : academicPeriodSequences-levelOnePeriods-item-response
Type:
Show Source
object
-
AcademicPeriodId: integer
(int64)
Title:
Academic Period ID
The unique identifier for an academic period associated with a level one period. -
AcademicPeriodName: string
Title:
Academic Period Name
Maximum Length:50
The academic period for a level one period. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created a level one period. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when a level one period was created. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date when a level one period was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated a level one period. -
LatestLastDateToEnroll: string
(date-time)
Title:
Latest Last Date to Enroll
Read Only:true
The latest last date to enroll for a level one period. -
levelTwoPeriods: array
Level Two Academic Periods
Title:
Level Two Academic Periods
The level two academic periods resource is a child resource of the academic period sequence resource and provides an ordered sequence of academic periods in the second level of the hierarchy. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OptionalFlag: boolean
Title:
Optional
Maximum Length:1
Default Value:false
Indicates whether a level one period is the optional level one period. The default value is false. -
ParentAcademicPeriodId: integer
(int64)
Title:
Parent Academic Period ID
The unique identifier for a parent academic period associated with a level one period. -
ParentAcademicPeriodName: string
Title:
Parent Academic Period Name
Maximum Length:50
The parent academic period for a level one period. -
PeriodCategoryCode: string
Title:
Category Code
Read Only:true
Maximum Length:30
The period category code for a level one period. A list of accepted values is defined in the lookup type ORA_HER_PERIOD_CATEGORY_CODE. -
PeriodCategoryMeaning: string
Title:
Category
Read Only:true
Maximum Length:80
The period category code for a level one period, such as Academic, Holiday, Academic reporting, and Academic self-paced. A list of accepted values is defined in the lookup type ORA_HER_PERIOD_CATEGORY_CODE. -
PeriodEndDate: string
(date)
Title:
Period End Date
Read Only:true
The date when the level one period ends. -
PeriodSequenceDetailId: integer
(int64)
Title:
Sequence Detail ID
The unique identifier for a level one period. -
PeriodStartDate: string
(date)
Title:
Period Start Date
Read Only:true
The date when the level one period starts. -
SequenceNumber: integer
(int32)
Title:
Sequence Number
The number that identifies the sequence of a level one period. -
WeeksOfInstruction: integer
(int32)
Title:
Weeks of Instruction
Read Only:true
Default Value:1
The week of instruction of a level one period.
Nested Schema : Level Two Academic Periods
Type:
array
Title:
Level Two Academic Periods
The level two academic periods resource is a child resource of the academic period sequence resource and provides an ordered sequence of academic periods in the second level of the hierarchy.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : academicPeriodSequences-levelOnePeriods-levelTwoPeriods-item-response
Type:
Show Source
object
-
AcademicPeriodId: integer
(int64)
Title:
Academic Period ID
Read Only:true
The unique identifier for an academic period associated with a level two period. -
AcademicPeriodName: string
Title:
Academic Period Name
Read Only:true
Maximum Length:50
The academic period for a level two period. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PeriodCategoryCode: string
Title:
Category Code
Read Only:true
Maximum Length:30
The period category code for a level two period. A list of accepted values is defined in the lookup type ORA_HER_PERIOD_CATEGORY_CODE. -
PeriodCategoryMeaning: string
Title:
Category
Read Only:true
Maximum Length:80
The period category code for a level two period, such as Academic, Holiday, Academic reporting, and Academic self-paced. A list of accepted values is defined in the lookup type ORA_HER_PERIOD_CATEGORY_CODE. -
PeriodEndDate: string
(date)
Title:
Period End Date
Read Only:true
The date when the level two period ends. -
PeriodStartDate: string
(date)
Title:
Period Start Date
Read Only:true
The date when the level two period starts. -
WeeksOfInstruction: integer
(int32)
Title:
Weeks of Instruction
Read Only:true
Default Value:1
The week of instruction of a level two period.
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 : academicPeriodSequences-periodSequenceOwners-item-response
Type:
Show Source
object
-
AcademicLevelId: integer
(int64)
Title:
Academic Level ID
The unique identifier for an academic level associated with a period sequence owner. -
AcademicLevelName: string
Title:
Academic Level Name
Maximum Length:100
The academic level for a period sequence owner. -
InstitutionId: integer
(int64)
Title:
Institution ID
The unique identifier for an institution associated with a period sequence owner. -
InstitutionName: string
Title:
Institution
Maximum Length:50
The institution for a period sequence owner. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PeriodSequenceOwnerId: integer
(int64)
Title:
Period Sequence Owner ID
The unique identifier for a period sequence owner.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- levelOnePeriods
-
Parameters:
- PeriodSequenceHeaderId:
$request.path.PeriodSequenceHeaderId
The level one academic periods resource is a child resource of the academic period sequence resource and provides an ordered sequence of academic periods in the first level of the hierarchy. - PeriodSequenceHeaderId:
- periodSequenceOwners
-
Parameters:
- PeriodSequenceHeaderId:
$request.path.PeriodSequenceHeaderId
The academic period sequence owners resource is a child resource of the academic period sequence resource and identifies the institution and academic level for the academic period sequence. - PeriodSequenceHeaderId:
- statusCodeLOV
-
Parameters:
- finder:
LookupTypeFinder
The following properties are defined on the LOV link relation:- Source Attribute: StatusMeaning; Target Attribute: DisplayedField
- Display Attribute: DisplayedField
- finder: