Create an external course
post
/fscmRestApi/resources/11.13.18.05/externalOrganizations/{PartyId}/child/externalCourses
Request
Path Parameters
-
PartyId(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.
-
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
-
ActiveFlag: boolean
Maximum Length:
1
Indicates whether the subject is active or inactive. -
CourseIdentifier: string
Maximum Length:
50
Alternate unique identifier for the course defined for an external organization. -
CourseLevelCode: string
Maximum Length:
30
The course level code. A list of accepted values is defined in the lookup type ORA_HER_EXT_COURSE_LEVEL. -
CourseName: string
Maximum Length:
50
The name for the external course. -
CourseTypeCode: string
Maximum Length:
30
The course type code. A list of accepted values is defined in the lookup type ORA_HER_EXT_COURSE_TYPE. -
CourseUnits: number
The number of units earned in the course.
-
Description: string
Description for the external course.
-
EffectiveEndDate: string
(date)
Date Effective Entity: indicates the date at the beginning of the date range within which the row is effective.
-
EffectiveStartDate: string
(date)
Date Effective Entity: indicates the date at the end of the date range within which the row is effective.
-
ExternalAcademicLevelCode: string
Maximum Length:
30
The external academic level code. A list of accepted values is defined in the lookup type ORA_HER_EXT_ACAD_LEVEL. -
ExternalCourseId: integer
(int64)
External subject unique identifier.
-
ExternalCourseRowId: integer
(int64)
External subject unique identifier.
-
ExternalSubjectId: integer
(int64)
External subject unique identifier.
-
OrganizationId: integer
(int64)
External organization unique identifier that owns this subject.
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 : externalOrganizations-externalCourses-item-response
Type:
Show Source
object
-
ActiveFlag: boolean
Maximum Length:
1
Indicates whether the subject is active or inactive. -
CourseIdentifier: string
Maximum Length:
50
Alternate unique identifier for the course defined for an external organization. -
CourseLevelCode: string
Maximum Length:
30
The course level code. A list of accepted values is defined in the lookup type ORA_HER_EXT_COURSE_LEVEL. -
CourseLevelMeaning: string
Read Only:
true
Maximum Length:80
The course level meaning. A list of accepted values is defined in the lookup type ORA_HER_EXT_COURSE_LEVEL. -
CourseName: string
Maximum Length:
50
The name for the external course. -
CourseTypeCode: string
Maximum Length:
30
The course type code. A list of accepted values is defined in the lookup type ORA_HER_EXT_COURSE_TYPE. -
CourseTypeMeaning: string
Read Only:
true
Maximum Length:80
The course type meaning. A list of accepted values is defined in the lookup type ORA_HER_EXT_COURSE_TYPE. -
CourseUnits: number
The number of units earned in the course.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who first created the row for the identifier. -
CreationDate: string
(date-time)
Read Only:
true
The date and time of the creation of the row for the identifier. -
Description: string
Description for the external course.
-
EffectiveEndDate: string
(date)
Date Effective Entity: indicates the date at the beginning of the date range within which the row is effective.
-
EffectiveStartDate: string
(date)
Date Effective Entity: indicates the date at the end of the date range within which the row is effective.
-
ExternalAcademicLevelCode: string
Maximum Length:
30
The external academic level code. A list of accepted values is defined in the lookup type ORA_HER_EXT_ACAD_LEVEL. -
ExternalAcademicLevelMeaning: string
Read Only:
true
Maximum Length:80
The external academic level meaning. A list of accepted values is defined in the lookup type ORA_HER_EXT_ACAD_LEVEL. -
ExternalCourseId: integer
(int64)
External subject unique identifier.
-
ExternalCourseRowId: integer
(int64)
External subject unique identifier.
-
ExternalSubjectId: integer
(int64)
External subject unique identifier.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrganizationId: integer
(int64)
External organization unique identifier that owns this subject.
-
SubjectCode: string
Read Only:
true
Maximum Length:50
The external subject defined for an external organization associated with the external course.
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
- CourseLevelCodeHerLookup
-
The following properties are defined on the LOV link relation:
- Source Attribute: CourseLevelCode; Target Attribute: LookupCode
- Display Attribute: DisplayedField
- CourseTypeCodeHerLookup
-
The following properties are defined on the LOV link relation:
- Source Attribute: CourseTypeCode; Target Attribute: LookupCode
- Display Attribute: DisplayedField
- ExternalAcademicLevelCodeHerLookup
-
The following properties are defined on the LOV link relation:
- Source Attribute: ExternalAcademicLevelCode; Target Attribute: LookupCode
- Display Attribute: DisplayedField