Update a course list
patch
/fscmRestApi/resources/11.13.18.05/courseLists/{courseListsUniqID}
Request
Path Parameters
-
courseListsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Course Lists resource and used to uniquely identify an instance of Course Lists. The client should not generate the hash key value. Instead, the client should query on the Course Lists collection resource in order to navigate to a specific instance of Course Lists 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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AcademicLevelId: integer
(int64)
Title:
Academic Level ID
The unique identifier for an academic level. -
AcademicLevelName: string
Title:
Academic Level Name
Maximum Length:100
The name of an academic level, such as undergraduate or graduate, that's associated with a course list. -
AcademicOrgId: integer
(int64)
Title:
Academic Organization ID
The unique identifier for an academic organization. -
AcademicOrgName: string
Title:
Academic Organization
Maximum Length:50
The academic organization that owns the curriculum item. -
CurriculumBuildStatusId: integer
(int64)
Title:
Curriculum Build Status ID
The unique identifier for a curriculum build status. -
CurriculumHeaderId: integer
(int64)
Title:
Curriculum Header ID
The generated primary key column for a curriculum record. -
Description: string
Title:
Description
The long or formal, detailed description of a curriculum item. -
EffectiveEndDate: string
(date)
Title:
Effective End Date
The effective end date of the course list. -
EffectiveStartDate: string
(date)
Title:
Effective Start Date
The effective start date of the course list. -
elements: array
Elements
Title:
Elements
The elements resource is a child of the course lists resource and lists all the elements associated with a course list. -
groups: array
Element Groups
Title:
Element Groups
The elements group resource is a child of the course lists resource and lists all the element groups associated with a course list. -
InstitutionId: integer
(int64)
Title:
Institution ID
The unique identifier for an institution. -
InstitutionName: string
Title:
Institution
Maximum Length:50
The institution that owns the curriculum item. -
Name: string
Title:
Name
Maximum Length:150
The name or short description of a curriculum item. -
parameters: array
Parameters
Title:
Parameters
The parameters resource is a child of the course lists resource and lists all the parameters associated with a course list. -
RequirementsDescription: string
Title:
Course List Requirements
A description of the course list requirements. -
results: array
Results
Title:
Results
The results resource is a child of the course lists resource and lists all the results associated with a course list. -
SystemStatusCode: string
Title:
Build Status Code
Maximum Length:30
The status of the curriculum build status in relation to a curriculum item. Values are ORA_ACTIVE or ORA_INACTIVE. -
Title: string
Title:
Title
Maximum Length:100
The formal title of a curriculum item.
Nested Schema : Elements
Type:
array
Title:
Elements
The elements resource is a child of the course lists resource and lists all the elements associated with a course list.
Show Source
Nested Schema : Element Groups
Type:
array
Title:
Element Groups
The elements group resource is a child of the course lists resource and lists all the element groups associated with a course list.
Show Source
Nested Schema : Parameters
Type:
array
Title:
Parameters
The parameters resource is a child of the course lists resource and lists all the parameters associated with a course list.
Show Source
Nested Schema : Results
Type:
array
Title:
Results
The results resource is a child of the course lists resource and lists all the results associated with a course list.
Show Source
Nested Schema : courseLists-elements-item-patch-request
Type:
Show Source
object
-
ConnectorCode: string
Title:
Connector Code
Maximum Length:30
The code for the connectors between the elements of a curriculum item. Valid values include ORA_AND or ORA_OR. A list of accepted values is defined in the lookup type ORA_HER__ELEMENT_CONNECTOR_CODE. -
courseOfferings: array
Course Offerings
Title:
Course Offerings
The course offerings resource is a child of the elements resource and lists all the offerings for the associated course element. -
CurriculumId(required): integer
(int64)
Title:
Element Curriculum ID
The curriculum ID for an item that's child element of another curriculum item. For example, a program is comprised of various curriculum items, typically courses, each of which have their own curriculum ID. -
ElementId: integer
(int64)
Title:
Curriculum Element ID
The unique identifier for a child element of a curriculum item. A child element might be a course or course list. -
GroupSequenceId: integer
(int32)
A sequence identifier used to identify and sort groups within a curriculum item.
-
LeftParenthesesQuantity: integer
(int32)
Title:
Left Parentheses Quantity
The number of left parentheses included in a curriculum element row. -
RequirementCategoryId: integer
(int64)
Title:
Requirement Category ID
The unique identifier for a requirement category code. -
RightParenthesesQuantity: integer
(int32)
Title:
Right Parentheses Quantity
The number of right parentheses included in a curriculum element row. -
smartLists: array
Smart Lists
Title:
Smart Lists
The smart lists resource is a child of the elements resource and lists attributes of the smart list associated with the element. -
SortNumber: integer
(int32)
Title:
Sort Number
Determines the order in which the curriculum item elements are sorted.
Nested Schema : Course Offerings
Type:
array
Title:
Course Offerings
The course offerings resource is a child of the elements resource and lists all the offerings for the associated course element.
Show Source
Nested Schema : Smart Lists
Type:
array
Title:
Smart Lists
The smart lists resource is a child of the elements resource and lists attributes of the smart list associated with the element.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
AutoExecuteFlag: boolean
Maximum Length:
1
Indicates the smart list can return all courses when called without the need for the user to enter additional filter criteria on the courses in the smart list. -
courses: array
Smart List Courses
Title:
Smart List Courses
The courses resource is a child resource of the smart list resource and lists the courses matching the smart list criteria. -
CurriculumSmartlistId: integer
(int64)
The generated primary key column for a smart list curriculum record.
-
Description: string
The long or formal, detailed description of a curriculum item.
-
Name: string
The name or short description of a curriculum item.
-
smartListCriteria: array
Smart List Criteria Values
Title:
Smart List Criteria Values
The smart list criteria values resource is a child resource of the smart lists resource and lists the criteria associated with the smart list.
Nested Schema : Smart List Courses
Type:
array
Title:
Smart List Courses
The courses resource is a child resource of the smart list resource and lists the courses matching the smart list criteria.
Show Source
Nested Schema : Smart List Criteria Values
Type:
array
Title:
Smart List Criteria Values
The smart list criteria values resource is a child resource of the smart lists resource and lists the criteria associated with the smart list.
Show Source
Nested Schema : courseLists-elements-smartLists-courses-item-patch-request
Type:
Show Source
object
-
courseCampuses: array
Smart List Course Campuses
Title:
Smart List Course Campuses
The course campuses resource is a child resource of the smart list course resource and lists the campuses matching the smart list course. -
courseOrganizations: array
Smart List Course Organizations
Title:
Smart List Course Organizations
The course organizations resource is a child resource of the smart list course resource and lists the organizations matching the smart list course. -
tags: array
Smart List Course Curriculum Tags
Title:
Smart List Course Curriculum Tags
The course tags resource is a child resource of the smart list course resource and lists the tags matching the smart list course.
Nested Schema : Smart List Course Campuses
Type:
array
Title:
Smart List Course Campuses
The course campuses resource is a child resource of the smart list course resource and lists the campuses matching the smart list course.
Show Source
Nested Schema : Smart List Course Organizations
Type:
array
Title:
Smart List Course Organizations
The course organizations resource is a child resource of the smart list course resource and lists the organizations matching the smart list course.
Show Source
Nested Schema : courseLists-elements-smartLists-courses-courseCampuses-item-patch-request
Type:
Show Source
object
Nested Schema : courseLists-elements-smartLists-courses-courseOrganizations-item-patch-request
Type:
Show Source
object
Nested Schema : courseLists-elements-smartLists-smartListCriteria-item-patch-request
Type:
Show Source
object
-
CriteriaColumnCode: string
Maximum Length:
30
The code used to identify the column or attribute that should be included in the smart list criteria. A list of accepted values is defined in the lookup type ORA_HER_COLUMN_CODE. -
CriteriaColumnValue: string
Maximum Length:
240
The value that should be used with the criteria column to identify courses for the smart list. -
CriteriaSortSequence: integer
(int32)
The sort sequence of the smart list criteria.
-
CriteriaTypeCode: string
Maximum Length:
30
The code used to indicate that the given criteria should be used to include or exclude courses from the smart list. A list of accepted values is defined in the lookup type ORA_HER_CRITERIA_TYPE.
Nested Schema : courseLists-groups-item-patch-request
Type:
Show Source
object
-
Description: string
Maximum Length:
250
The description for a curriculum element group. -
DisplaySequenceNumber: integer
(int32)
Default Value:
1
The display sequence number of a curriculum group. The sequence number can be used to present element groups in a specific order. -
Name: string
Maximum Length:
50
The name for a curriculum element group. -
ParentSequenceId: integer
(int32)
The sequence identifier for the parent of a curriculum element group. If a user creates group ten as a group within group one, the parent ID for group ten would be the ID for group one.
-
SequenceId: integer
(int32)
A sequence identifier used to identify and sort groups within a curriculum item.
-
StatementCode: string
Maximum Length:
30
The code of the conditional operator, such as ORA_ANY or ORA_ALL for the related items and groups within a curriculum element group.
Nested Schema : schema
Type:
Show Source
object
-
MaximumCoursesQuantity: integer
(int32)
Title:
Maximum Number of Courses
Default Value:0
The maximum number of courses or course lists that must be completed to satisfy a curriculum item requirement. -
MaximumUnitsQuantity: integer
(int32)
Title:
Maximum Units
Default Value:0
The maximum number of units of credit that can be completed or used to satisfy a curriculum item requirement. -
MinimumCoursesQuantity: integer
(int32)
Title:
Minimum Number of Courses
Default Value:0
The minimum number of courses that must be completed to satisfy a curriculum item requirement. -
MinimumUnitsQuantity: integer
(int32)
Title:
Minimum Units
Default Value:0
The minimum number of units of credit that must be completed to satisfy a curriculum item requirement. -
ParameterId: integer
(int64)
Title:
Curriculum Parameter ID
The unique identifier for a parameter associated with a curriculum item such as program. -
ParameterSequenceNumber: integer
(int32)
Title:
Parameter Sequence Number
The sequence number for a set of parameters defined for program requirements. -
RequirementCategoryId: integer
(int64)
Title:
Requirement Category ID
The unique identifier for the requirement category.
Nested Schema : schema
Type:
Show Source
object
-
DefaultResultSetFlag: boolean
Title:
Default Result Set Indicator
Maximum Length:1
Indicates the default result set for a scheduled course or course offering. The default value is false. -
ResultId: integer
(int64)
Title:
Curriculum Result ID
The unique identifier for a curriculum result record. -
ResultSetId: integer
(int64)
Title:
Result Set ID
The unique identifier for a result set. -
ResultTypeId: integer
(int64)
Title:
Result Type ID
The unique identifier for a result type.
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 : courseLists-item-response
Type:
Show Source
object
-
AcademicLevelId: integer
(int64)
Title:
Academic Level ID
The unique identifier for an academic level. -
AcademicLevelName: string
Title:
Academic Level Name
Maximum Length:100
The name of an academic level, such as undergraduate or graduate, that's associated with a course list. -
AcademicOrgId: integer
(int64)
Title:
Academic Organization ID
The unique identifier for an academic organization. -
AcademicOrgName: string
Title:
Academic Organization
Maximum Length:50
The academic organization that owns the curriculum item. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the row for the course list. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the course list row was created. -
CurriculumBuildStatusId: integer
(int64)
Title:
Curriculum Build Status ID
The unique identifier for a curriculum build status. -
CurriculumBuildStatusName: string
Title:
Build Status
Read Only:true
Maximum Length:50
The name of a user defined build or lifecycle status code. -
CurriculumHeaderId: integer
(int64)
Title:
Curriculum Header ID
The generated primary key column for a curriculum record. -
CurriculumId: integer
(int64)
Title:
Curriculum ID
The unique identifier for a curriculum item such as a course list or program. -
Description: string
Title:
Description
The long or formal, detailed description of a curriculum item. -
EffectiveEndDate: string
(date)
Title:
Effective End Date
The effective end date of the course list. -
EffectiveStartDate: string
(date)
Title:
Effective Start Date
The effective start date of the course list. -
elements: array
Elements
Title:
Elements
The elements resource is a child of the course lists resource and lists all the elements associated with a course list. -
groups: array
Element Groups
Title:
Element Groups
The elements group resource is a child of the course lists resource and lists all the element groups associated with a course list. -
InstitutionId: integer
(int64)
Title:
Institution ID
The unique identifier for an institution. -
InstitutionName: string
Title:
Institution
Maximum Length:50
The institution that owns the curriculum item. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the course list row was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the row for the course list. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Title:
Name
Maximum Length:150
The name or short description of a curriculum item. -
parameters: array
Parameters
Title:
Parameters
The parameters resource is a child of the course lists resource and lists all the parameters associated with a course list. -
RequirementsDescription: string
Title:
Course List Requirements
A description of the course list requirements. -
results: array
Results
Title:
Results
The results resource is a child of the course lists resource and lists all the results associated with a course list. -
SystemStatusCode: string
Title:
Build Status Code
Maximum Length:30
The status of the curriculum build status in relation to a curriculum item. Values are ORA_ACTIVE or ORA_INACTIVE. -
SystemStatusMeaning: string
Title:
Curriculum Build Status
Read Only:true
Maximum Length:80
The meaning of the status of the curriculum build status in relation to a curriculum item. Values are Active or Inactive. -
Title: string
Title:
Title
Maximum Length:100
The formal title of a curriculum item.
Nested Schema : Elements
Type:
array
Title:
Elements
The elements resource is a child of the course lists resource and lists all the elements associated with a course list.
Show Source
Nested Schema : Element Groups
Type:
array
Title:
Element Groups
The elements group resource is a child of the course lists resource and lists all the element groups associated with a course list.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Parameters
Type:
array
Title:
Parameters
The parameters resource is a child of the course lists resource and lists all the parameters associated with a course list.
Show Source
Nested Schema : Results
Type:
array
Title:
Results
The results resource is a child of the course lists resource and lists all the results associated with a course list.
Show Source
Nested Schema : courseLists-elements-item-response
Type:
Show Source
object
-
ConnectorCode: string
Title:
Connector Code
Maximum Length:30
The code for the connectors between the elements of a curriculum item. Valid values include ORA_AND or ORA_OR. A list of accepted values is defined in the lookup type ORA_HER__ELEMENT_CONNECTOR_CODE. -
ConnectorMeaning: string
Title:
Connector
Read Only:true
Maximum Length:80
The name for a logical connector used to connect curriculum item child elements. A list of accepted values is defined in the lookup type ORA_HER__ELEMENT_CONNECTOR_CODE. -
courseOfferings: array
Course Offerings
Title:
Course Offerings
The course offerings resource is a child of the elements resource and lists all the offerings for the associated course element. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the row for the element. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the element row was created. -
CurriculumId: integer
(int64)
Title:
Element Curriculum ID
The curriculum ID for an item that's child element of another curriculum item. For example, a program is comprised of various curriculum items, typically courses, each of which have their own curriculum ID. -
CurriculumName: string
Title:
Name
Read Only:true
Maximum Length:150
The name or short description for a curriculum item that's the child element of another curriculum item. For example, a program is comprised of various curriculum items, typically courses, each of which have their own curriculum ID. -
CurriculumType: string
Title:
Curriculum Item Type
Read Only:true
Maximum Length:30
The code of the curriculum type of the requisite associated with the course. -
CurriculumTypeId: integer
(int64)
Title:
Curriculum Item Type ID
Read Only:true
The unique identifier for a type of curriculum item, such as a scheduled course. -
CurriculumTypeName: string
Title:
Curriculum Type
Read Only:true
Maximum Length:50
The curriculum type of curriculum item, such as a scheduled course. -
ElementId: integer
(int64)
Title:
Curriculum Element ID
The unique identifier for a child element of a curriculum item. A child element might be a course or course list. -
GroupSequenceId: integer
(int32)
A sequence identifier used to identify and sort groups within a curriculum item.
-
LastUpdateDate: string
(date-time)
Title:
Last Updated By
Read Only:true
The date and time when the element row was last updated. -
LastUpdatedBy: string
Title:
Last Updated Date
Read Only:true
Maximum Length:64
The user who last updated the row for the element. -
LeftParenthesesQuantity: integer
(int32)
Title:
Left Parentheses Quantity
The number of left parentheses included in a curriculum element row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
RequirementCategoryCode: string
Title:
Requirement Category Code
Read Only:true
Maximum Length:30
The user defined code for a requirement category, used for categorizing program requirements in the Curriculum Registry. -
RequirementCategoryId: integer
(int64)
Title:
Requirement Category ID
The unique identifier for a requirement category code. -
RequirementCategoryName: string
Title:
Requirement Category
Read Only:true
Maximum Length:50
The type of requirement that this program element fulfills, such as required or elective. -
RightParenthesesQuantity: integer
(int32)
Title:
Right Parentheses Quantity
The number of right parentheses included in a curriculum element row. -
smartLists: array
Smart Lists
Title:
Smart Lists
The smart lists resource is a child of the elements resource and lists attributes of the smart list associated with the element. -
SortNumber: integer
(int32)
Title:
Sort Number
Determines the order in which the curriculum item elements are sorted.
Nested Schema : Course Offerings
Type:
array
Title:
Course Offerings
The course offerings resource is a child of the elements resource and lists all the offerings for the associated course element.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Smart Lists
Type:
array
Title:
Smart Lists
The smart lists resource is a child of the elements resource and lists attributes of the smart list associated with the element.
Show Source
Nested Schema : courseLists-elements-courseOfferings-item-response
Type:
Show Source
object
-
AcademicSubjectCode: string
Title:
Subject Code
Read Only:true
Maximum Length:30
The code for the scheduled course's academic subject. -
AcademicSubjectId: integer
(int64)
Title:
Academic Subject ID
Read Only:true
The unique identifier for the course's academic subject. -
AcademicSubjectName: string
Title:
Subject
Read Only:true
Maximum Length:50
The name of the subject of the scheduled course. -
CreditTypeCode: string
Title:
Type of Credit
Read Only:true
Maximum Length:30
The unique identifier of the credit type associated with the scheduled course. Valid values include ORA_CEU, ORA_CRH, or ORA_NONE. A list of accepted values is defined in the lookup type ORA_HER_CREDIT_TYPE_CODE. -
CreditTypeMeaning: string
Title:
Type of Credit Meaning
Read Only:true
Maximum Length:80
The meaning of the type of credit of the scheduled course. Valid values include Continuing education units, Credit hours, or No credit type. A list of accepted values is defined in the lookup type ORA_HER_CREDIT_TYPE_CODE. -
CurriculumCatalogNumber: string
Title:
Catalog Number
Read Only:true
Maximum Length:10
The catalog number of the scheduled course. -
CurriculumOfferingId: integer
(int64)
Title:
Curriculum Offering ID
Read Only:true
The generated unique identifier of a course. -
InstitutionId: integer
(int64)
Title:
Institution
Read Only:true
The unique identifier for the institution on the offering of the course. -
InstitutionName: string
Title:
Institution
Read Only:true
Maximum Length:50
The name of the institution to which the course offering belongs. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MaximumUnitsQuantity: number
Title:
Maximum Units
Read Only:true
A numeric value indicating the maximum units of the course. -
MinimumUnitsQuantity: number
Title:
Minimum Units
Read Only:true
A numeric value indicating the minimum units of the course. -
OfferSequenceNumber: integer
(int32)
Title:
Offer Number
Read Only:true
The unique sort identifier for the offering of the 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.
Nested Schema : courseLists-elements-smartLists-item-response
Type:
Show Source
object
-
AutoExecuteFlag: boolean
Maximum Length:
1
Indicates the smart list can return all courses when called without the need for the user to enter additional filter criteria on the courses in the smart list. -
courses: array
Smart List Courses
Title:
Smart List Courses
The courses resource is a child resource of the smart list resource and lists the courses matching the smart list criteria. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the row for the smart list. -
CreationDate: string
(date-time)
Read Only:
true
The date and time when the smart list row was created. -
CurriculumHeaderId: integer
(int64)
Title:
Curriculum Header ID
Read Only:true
The generated primary key column for a curriculum record. -
CurriculumId: integer
(int64)
Title:
Curriculum ID
Read Only:true
The unique identifier for a curriculum item such as a smart list, course list or program. -
CurriculumSmartlistId: integer
(int64)
The generated primary key column for a smart list curriculum record.
-
Description: string
The long or formal, detailed description of a curriculum item.
-
EffectiveEndDate: string
(date)
Read Only:
true
The effective end date of the smart list. -
EffectiveStartDate: string
(date)
Read Only:
true
The effective start date of the smart list. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time when the smart list row was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the row for the smart list. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
The name or short description of a curriculum item.
-
smartListCriteria: array
Smart List Criteria Values
Title:
Smart List Criteria Values
The smart list criteria values resource is a child resource of the smart lists resource and lists the criteria associated with the smart list.
Nested Schema : Smart List Courses
Type:
array
Title:
Smart List Courses
The courses resource is a child resource of the smart list resource and lists the courses matching the smart list criteria.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Smart List Criteria Values
Type:
array
Title:
Smart List Criteria Values
The smart list criteria values resource is a child resource of the smart lists resource and lists the criteria associated with the smart list.
Show Source
Nested Schema : courseLists-elements-smartLists-courses-item-response
Type:
Show Source
object
-
AcademicLevelName: string
Title:
Academic Level Name
Read Only:true
Maximum Length:100
The name of the academic level associated with course offering. -
AcademicSubjectCode: string
Read Only:
true
Maximum Length:30
The code for the course's academic subject. -
AcademicSubjectName: string
Read Only:
true
Maximum Length:50
The name of the subject of the course. -
courseCampuses: array
Smart List Course Campuses
Title:
Smart List Course Campuses
The course campuses resource is a child resource of the smart list course resource and lists the campuses matching the smart list course. -
courseOrganizations: array
Smart List Course Organizations
Title:
Smart List Course Organizations
The course organizations resource is a child resource of the smart list course resource and lists the organizations matching the smart list course. -
CreditTypeCode: string
Read Only:
true
Maximum Length:30
The unique identifier of the credit type associated with the course. Valid values include ORA_CEU, ORA_CRH, or ORA_NONE. A list of accepted values is defined in the lookup type ORA_HER_CREDIT_TYPE_CODE. -
CreditTypeMeaning: string
Read Only:
true
Maximum Length:80
The meaning of the type of credit of the course. Valid values include Continuing education units, Credit hours, or No credit type. A list of accepted values is defined in the lookup type ORA_HER_CREDIT_TYPE_CODE. -
CurriculumCatalogNumber: string
Read Only:
true
Maximum Length:10
The catalog number of the curriculum item. -
CurriculumHeaderId: integer
(int64)
Read Only:
true
The unique identifier for a curriculum header record. -
CurriculumId: integer
(int64)
Read Only:
true
The unique identifier for a curriculum item such as a course. -
CurriculumName: string
Read Only:
true
Maximum Length:50
The name or short description of a curriculum item. -
CurriculumOfferingId: integer
(int64)
Read Only:
true
The generated unique identifier of a course offering. -
CurriculumTitle: string
Read Only:
true
Maximum Length:100
The formal title of a curriculum item. -
InstitutionId: integer
(int64)
Read Only:
true
The unique identifier for the institution on the offering of the course. -
InstitutionName: string
Read Only:
true
Maximum Length:50
The name of the institution to which the course offering belongs. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MaximumUnitsQuantity: number
Read Only:
true
A numeric value indicating the maximum units of the course. -
MinimumUnitsQuantity: number
Read Only:
true
A numeric value indicating the minimum units of the course. -
OfferSequenceNumber: integer
(int32)
Read Only:
true
The unique sort identifier for the offering of the course. -
tags: array
Smart List Course Curriculum Tags
Title:
Smart List Course Curriculum Tags
The course tags resource is a child resource of the smart list course resource and lists the tags matching the smart list course. -
TypicallyOfferedCode: string
Read Only:
true
Maximum Length:30
The code of the typically offered value of the course. A list of accepted values is defined in the lookup type ORA_HER_TYPICALLY_OFFERED_CODE. -
TypicallyOfferedMeaning: string
Read Only:
true
Maximum Length:80
The meaning of the typically offered value of the course. A list of accepted values is defined in the lookup type ORA_HER_TYPICALLY_OFFERED_CODE.
Nested Schema : Smart List Course Campuses
Type:
array
Title:
Smart List Course Campuses
The course campuses resource is a child resource of the smart list course resource and lists the campuses matching the smart list course.
Show Source
Nested Schema : Smart List Course Organizations
Type:
array
Title:
Smart List Course Organizations
The course organizations resource is a child resource of the smart list course resource and lists the organizations matching the smart list course.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : courseLists-elements-smartLists-courses-courseCampuses-item-response
Type:
Show Source
object
-
CampusId: integer
(int64)
Read Only:
true
The unique identifier for the campus where a course is offered. -
CampusName: string
Title:
Name
Read Only:true
Maximum Length:50
The name of the campus where a course is offered. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OfferingCampusId: integer
(int64)
Read Only:
true
The unique identifier for the campus where a course is offered.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : courseLists-elements-smartLists-courses-courseOrganizations-item-response
Type:
Show Source
object
-
AcademicOrgId: integer
(int64)
Read Only:
true
The academic organization that owns the curriculum item. -
AcademicOrgName: string
Read Only:
true
Maximum Length:50
The name of the academic organization associated with the offering. -
CurriculumOrgId: integer
(int64)
Read Only:
true
The generated primary key column for an offering academic organization. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : courseLists-elements-smartLists-smartListCriteria-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the row for the smart list criteria. -
CreationDate: string
(date-time)
Read Only:
true
The date and time when the smart list criteria row was created. -
CriteriaColumnCode: string
Maximum Length:
30
The code used to identify the column or attribute that should be included in the smart list criteria. A list of accepted values is defined in the lookup type ORA_HER_COLUMN_CODE. -
CriteriaColumnDataType: string
Read Only:
true
The data type of the criteria column attribute. -
CriteriaColumnName: string
Read Only:
true
Maximum Length:80
The name of the code that's used to identify the column or attribute that should be included in the smart list criteria. A list of accepted values is defined in the lookup type ORA_HER_COLUMN_CODE. -
CriteriaColumnValue: string
Maximum Length:
240
The value that should be used with the criteria column to identify courses for the smart list. -
CriteriaSortSequence: integer
(int32)
The sort sequence of the smart list criteria.
-
CriteriaTypeCode: string
Maximum Length:
30
The code used to indicate that the given criteria should be used to include or exclude courses from the smart list. A list of accepted values is defined in the lookup type ORA_HER_CRITERIA_TYPE. -
CriteriaTypeMeaning: string
Read Only:
true
Maximum Length:80
The meaning of the code that's used to indicate if the given criteria should be used to include or exclude courses from the smart list. A list of accepted values is defined in the lookup type ORA_HER_CRITERIA_TYPE. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time when the smart list criteria row was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the row for the smart list criteria. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SmartlistCriteriaId: integer
(int64)
The unique identifier for the smart list criteria.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : courseLists-groups-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the element group row. -
CreationDate: string
(date-time)
Read Only:
true
The date and time when the element group row was created. -
Description: string
Maximum Length:
250
The description for a curriculum element group. -
DisplaySequenceNumber: integer
(int32)
Default Value:
1
The display sequence number of a curriculum group. The sequence number can be used to present element groups in a specific order. -
GroupId: integer
(int64)
Read Only:
true
The unique identifier for a curriculum element group. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time when the element group row was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the element group row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Maximum Length:
50
The name for a curriculum element group. -
ParentSequenceId: integer
(int32)
The sequence identifier for the parent of a curriculum element group. If a user creates group ten as a group within group one, the parent ID for group ten would be the ID for group one.
-
SequenceId: integer
(int32)
A sequence identifier used to identify and sort groups within a curriculum item.
-
StatementCode: string
Maximum Length:
30
The code of the conditional operator, such as ORA_ANY or ORA_ALL for the related items and groups within a curriculum element group. -
StatementMeaning: string
Read Only:
true
Maximum Length:50
The meaning of conditional operator, such as Any or All for the related items and groups within a curriculum element group.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : courseLists-parameters-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the parameter row. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the parameter row was created. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The user who last updated the parameter row. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The date and time when the parameter row was last updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MaximumCoursesQuantity: integer
(int32)
Title:
Maximum Number of Courses
Default Value:0
The maximum number of courses or course lists that must be completed to satisfy a curriculum item requirement. -
MaximumUnitsQuantity: integer
(int32)
Title:
Maximum Units
Default Value:0
The maximum number of units of credit that can be completed or used to satisfy a curriculum item requirement. -
MinimumCoursesQuantity: integer
(int32)
Title:
Minimum Number of Courses
Default Value:0
The minimum number of courses that must be completed to satisfy a curriculum item requirement. -
MinimumUnitsQuantity: integer
(int32)
Title:
Minimum Units
Default Value:0
The minimum number of units of credit that must be completed to satisfy a curriculum item requirement. -
ParameterId: integer
(int64)
Title:
Curriculum Parameter ID
The unique identifier for a parameter associated with a curriculum item such as program. -
ParameterSequenceNumber: integer
(int32)
Title:
Parameter Sequence Number
The sequence number for a set of parameters defined for program requirements. -
RequirementCategoryCode: string
Title:
Requirement Category Code
Read Only:true
Maximum Length:30
The user defined code for a requirement category, used for categorizing program requirements in the Curriculum Registry. -
RequirementCategoryId: integer
(int64)
Title:
Requirement Category ID
The unique identifier for the requirement category. -
RequirementCategoryName: string
Title:
Name
Read Only:true
Maximum Length:50
The type of requirement that this program element fulfills, such as required or elective.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : courseLists-results-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the row for the result. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the result row was created. -
DefaultResultSetFlag: boolean
Title:
Default Result Set Indicator
Maximum Length:1
Indicates the default result set for a scheduled course or course offering. The default value is false. -
LastUpdateDate: string
(date-time)
Title:
Last Updated By
Read Only:true
The date and time when the result row was last updated. -
LastUpdatedBy: string
Title:
Last Updated Date
Read Only:true
Maximum Length:64
The user who last updated the row for the result. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ResultId: integer
(int64)
Title:
Curriculum Result ID
The unique identifier for a curriculum result record. -
ResultSetCode: string
Title:
Result Set Code
Read Only:true
Maximum Length:30
The unique code for a result set. -
ResultSetId: integer
(int64)
Title:
Result Set ID
The unique identifier for a result set. -
ResultSetName: string
Title:
Result Set Name
Read Only:true
Maximum Length:50
The name of a result set. -
ResultTypeCode: string
Title:
Result Type Code
Read Only:true
Maximum Length:30
The unique code for a result type. -
ResultTypeId: integer
(int64)
Title:
Result Type ID
The unique identifier for a result type. -
ResultTypeName: string
Title:
Result Type Name
Read Only:true
Maximum Length:50
The name of a result type.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- academicInstitutionsLOV
-
The following properties are defined on the LOV link relation:
- Source Attribute: InstitutionName; Target Attribute: InstitutionName
- Display Attribute: InstitutionName
- academicLevelsLOV
-
The following properties are defined on the LOV link relation:
- Source Attribute: AcademicLevelName; Target Attribute: LevelName
- Display Attribute: LevelName
- academicOrganizationsLOV
-
Parameters:
- finder:
ByInstitutionNameFinder%3BbindInstitutionName%3D{InstitutionName}
The following properties are defined on the LOV link relation:- Source Attribute: AcademicOrgName; Target Attribute: AcademicOrgName
- Display Attribute: AcademicOrgName
- finder:
- elements
-
Parameters:
- courseListsUniqID:
$request.path.courseListsUniqID
The elements resource is a child of the course lists resource and lists all the elements associated with a course list. - courseListsUniqID:
- groups
-
Parameters:
- courseListsUniqID:
$request.path.courseListsUniqID
The elements group resource is a child of the course lists resource and lists all the element groups associated with a course list. - courseListsUniqID:
- parameters
-
Parameters:
- courseListsUniqID:
$request.path.courseListsUniqID
The parameters resource is a child of the course lists resource and lists all the parameters associated with a course list. - courseListsUniqID:
- results
-
Parameters:
- courseListsUniqID:
$request.path.courseListsUniqID
The results resource is a child of the course lists resource and lists all the results associated with a course list. - courseListsUniqID:
- systemStatusCodesLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_HER_SYSTEM_STATUS_CODE
The following properties are defined on the LOV link relation:- Source Attribute: SystemStatusCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder: