Create all elements
post
/fscmRestApi/resources/11.13.18.05/studentAcademicPlans/{studentAcademicPlansUniqID}/child/periods/{PlanPeriodId}/child/elements
Request
Path Parameters
-
PlanPeriodId(required): integer(int64)
The unique identifier for the plan period.
-
studentAcademicPlansUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Student Academic Plans resource and used to uniquely identify an instance of Student Academic Plans. The client should not generate the hash key value. Instead, the client should query on the Student Academic Plans collection resource in order to navigate to a specific instance of Student Academic Plans to get the hash key.
Header Parameters
-
Effective-Of:
This header accepts a string value. The string is a semi-colon separated list of
= . It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers. -
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
ContactHoursQuantity: integer
(int32)
Title:
Contact Hours
The number of contact hours required for the period element. -
DeleteActionFlag: boolean
Title:
Delete Action
Indicates whether the delete action flag for curriculum course element is active or inactive. -
ElementCurriculumId: integer
(int64)
Title:
Element Curriculum ID
The curriculum item identifier for the curriculum course element. -
LockElementFlag: boolean
Title:
Lock Element
Maximum Length:1
Default Value:false
Locks the plan template element, preventing changes or removal of the element. -
MinimumRequiredUnitsQuantity: integer
(int32)
Title:
Minimum Required Units
The minimum units required for the period element. -
NumberOfUnitsTakenQuantity: integer
(int32)
Title:
Number of Units Taken
The number of units taken for the period element. -
PeriodElementId: integer
(int64)
Title:
Plan Period Element ID
The unique identifier for the plan period element. -
PeriodElementSequence(required): integer
(int32)
Title:
Period Element Sequence
The sequence of the plan elements within a plan period. - relatedElements: array Related Elements
-
SourceCurriculumId: integer
(int64)
Title:
Source Curriculum ID
Unique identifier for the requirement source curriculum item.
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 : studentAcademicPlans-periods-elements-item-response
Type:
Show Source
object
-
ContactHoursQuantity: integer
(int32)
Title:
Contact Hours
The number of contact hours required for the period element. -
DeleteActionFlag: boolean
Title:
Delete Action
Indicates whether the delete action flag for curriculum course element is active or inactive. -
ElementCurriculumId: integer
(int64)
Title:
Element Curriculum ID
The curriculum item identifier for the curriculum course element. -
ElementCurriculumName: string
Title:
Element Curriculum Name
Read Only:true
Maximum Length:50
The curriculum item name of the curriculum course element. -
ElementCurriculumType: string
Title:
Element Curriculum Type
Read Only:true
Maximum Length:30
The curriculum item type of the curriculum course element. -
ElementCurriculumTypeId: integer
(int64)
Title:
Element Curriculum Type ID
Read Only:true
The curriculum item type identifier for the curriculum course element. -
ElementCurriculumTypeName: string
Title:
Element Curriculum Type Name
Read Only:true
Maximum Length:50
The curriculum item type name of the curriculum course element. -
ElementSubjectCode: string
Title:
Element Subject Code
Read Only:true
Maximum Length:30
The curriculum item subject code of the curriculum course element. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LockElementFlag: boolean
Title:
Lock Element
Maximum Length:1
Default Value:false
Locks the plan template element, preventing changes or removal of the element. -
MinimumRequiredUnitsQuantity: integer
(int32)
Title:
Minimum Required Units
The minimum units required for the period element. -
NumberOfUnitsTakenQuantity: integer
(int32)
Title:
Number of Units Taken
The number of units taken for the period element. -
PeriodElementId: integer
(int64)
Title:
Plan Period Element ID
The unique identifier for the plan period element. -
PeriodElementSequence: integer
(int32)
Title:
Period Element Sequence
The sequence of the plan elements within a plan period. - relatedElements: array Related Elements
-
SourceCurriculumId: integer
(int64)
Title:
Source Curriculum ID
Unique identifier for the requirement source curriculum item. -
SourceCurriculumName: string
Title:
Source Curriculum Name
Read Only:true
Maximum Length:50
The curriculum item name of the requirement source curriculum item. -
SourceCurriculumType: string
Title:
Source Curriculum Type
Read Only:true
Maximum Length:30
The curriculum item type of the requirement source curriculum item. -
SourceCurriculumTypeId: integer
(int64)
Title:
Source Curriculum Type ID
Read Only:true
Unique identifier for the requirement source curriculum type. -
SourceCurriculumTypeName: string
Title:
Source Curriculum Type Name
Read Only:true
Maximum Length:50
The curriculum item type name of the requirement source curriculum item.
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
- relatedElements
-
Parameters:
- PlanPeriodId:
$request.path.PlanPeriodId
- elementsUniqID:
$request.path.elementsUniqID
- studentAcademicPlansUniqID:
$request.path.studentAcademicPlansUniqID
The related elements resource is a child of the elements resource and provides a list of related elements associated with a student academic plan. - PlanPeriodId: