Create all owners
post
/fscmRestApi/resources/11.13.18.05/academicPlanTemplates/{academicPlanTemplatesUniqID}/child/owners
Request
Path Parameters
-
academicPlanTemplatesUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Academic Plan Templates resource and used to uniquely identify an instance of Academic Plan Templates. The client should not generate the hash key value. Instead, the client should query on the Academic Plan Templates collection resource in order to navigate to a specific instance of Academic Plan Templates to get the hash key.
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.
-
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
-
CurriculumId: integer
(int64)
Title:
Curriculum ID
The unique identifier for the curriculum owner of the plan template. -
CurriculumTypeId: integer
(int64)
Title:
Curriculum Type ID
The unique identifier for the curriculum type of the owning curriculum item. -
OwningItemFlag: boolean
Title:
Primary Plan Item
Maximum Length:1
Identifies the primary owning curriculum item. -
ProgramTypeId: integer
(int64)
Title:
Program Type ID
The unique identifier for the program type of the program ownership items. -
SequenceNumber: integer
(int32)
Title:
Owning Item Sequence
Used to sequence the order of the ownership records. -
TemplateOwnerId: integer
(int64)
Title:
Template Owner ID
The unique identifier for the plan template ownership record.
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 : academicPlanTemplates-owners-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
Who column: indicates the user who created the row of the owning curriculum item. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Who column: indicates the date and time of the creation of the row of the owning curriculum item. -
CurriculumHeaderId: integer
Title:
Curriculum Header ID
Read Only:true
The unique identifier for the curriculum header of the owning curriculum item. -
CurriculumId: integer
(int64)
Title:
Curriculum ID
The unique identifier for the curriculum owner of the plan template. -
CurriculumName: string
Title:
Curriculum Name
Read Only:true
The curriculum name of the owning curriculum item. -
CurriculumType: string
Title:
Curriculum Type
Read Only:true
Maximum Length:30
The curriculum type of the owning curriculum item. -
CurriculumTypeId: integer
(int64)
Title:
Curriculum Type ID
The unique identifier for the curriculum type of the owning curriculum item. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
Who column: indicates the date and time of the last update of the row of the owning curriculum item. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
Who column: indicates the user who last updated the row of the owning curriculum item. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MainProgramFlag: boolean
Title:
Main Program
Read Only:true
Maximum Length:1
Indicates whether the program is a main program. -
OwningItemFlag: boolean
Title:
Primary Plan Item
Maximum Length:1
Identifies the primary owning curriculum item. -
ProgramTypeCode: string
Title:
Program Type Code
Read Only:true
Maximum Length:30
The program type code indicating the type of program. -
ProgramTypeId: integer
(int64)
Title:
Program Type ID
The unique identifier for the program type of the program ownership items. -
ProgramTypeName: string
Title:
Program Type
Read Only:true
Maximum Length:50
The program type of the program ownership items. -
SequenceNumber: integer
(int32)
Title:
Owning Item Sequence
Used to sequence the order of the ownership records. -
TemplateOwnerId: integer
(int64)
Title:
Template Owner ID
The unique identifier for the plan template ownership record.
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
- ProgramLOV
-
Operation: /fscmRestApi/resources/11.13.18.05/programsThe following properties are defined on the LOV link relation:
- Source Attribute: CurriculumId; Target Attribute: CurriculumId
- Display Attribute: CurriculumName