Update a smart list
patch
/fscmRestApi/resources/11.13.18.05/courseLists/{courseListsUniqID}/child/elements/{ElementId}/child/smartLists/{CurriculumSmartlistId}
Request
Path Parameters
-
CurriculumSmartlistId(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=
-
ElementId(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=
-
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
-
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
-
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.
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-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 : 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-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
Links
- courses
-
Parameters:
- CurriculumSmartlistId:
$request.path.CurriculumSmartlistId
- ElementId:
$request.path.ElementId
- courseListsUniqID:
$request.path.courseListsUniqID
The courses resource is a child resource of the smart list resource and lists the courses matching the smart list criteria. - CurriculumSmartlistId:
- smartListCriteria
-
Parameters:
- CurriculumSmartlistId:
$request.path.CurriculumSmartlistId
- ElementId:
$request.path.ElementId
- courseListsUniqID:
$request.path.courseListsUniqID
The smart list criteria values resource is a child resource of the smart lists resource and lists the criteria associated with the smart list. - CurriculumSmartlistId: