Update a level one period
patch
/fscmRestApi/resources/11.13.18.05/academicPeriodSequences/{PeriodSequenceHeaderId}/child/levelOnePeriods/{PeriodSequenceDetailId}
Request
Path Parameters
-
PeriodSequenceDetailId(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=
-
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=
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AcademicPeriodId(required): 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. -
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. -
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. -
PeriodSequenceDetailId: integer
(int64)
Title:
Sequence Detail ID
The unique identifier for a level one period. -
SequenceNumber(required): integer
(int32)
Title:
Sequence Number
The number that identifies the sequence 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 : academicPeriodSequences-levelOnePeriods-levelTwoPeriods-item-patch-request
Type:
Show Source
object
Response
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-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.
Links
- academicPeriodsLOV
-
The following properties are defined on the LOV link relation:
- Source Attribute: AcademicPeriodName; Target Attribute: PeriodName
- Display Attribute: PeriodName
- levelTwoPeriods
-
Parameters:
- PeriodSequenceDetailId:
$request.path.PeriodSequenceDetailId
- PeriodSequenceHeaderId:
$request.path.PeriodSequenceHeaderId
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. - PeriodSequenceDetailId:
- parentAcademicPeriodsLOV
-
The following properties are defined on the LOV link relation:
- Source Attribute: ParentAcademicPeriodName; Target Attribute: PeriodName
- Display Attribute: PeriodName
- periodCategoryCodeLOV
-
Parameters:
- finder:
LookupTypeFinder
The following properties are defined on the LOV link relation:- Source Attribute: PeriodCategoryMeaning; Target Attribute: DisplayedField
- Display Attribute: DisplayedField
- finder: