Jump to

• Request
• Response

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "AutoExecuteFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":false
        },
        "smartListCriteria":{
            "title":"Smart List Criteria Values",
            "type":"array",
            "description":"The smart list criteria values resource is a child resource of the smart lists resource and lists the criteria associated with the smart list.",
            "items":{
                "$ref":"#/components/schemas/courseLists-elements-smartLists-smartListCriteria-item-patch-request"
            }
        },
        "courses":{
            "title":"Smart List Courses",
            "type":"array",
            "description":"The courses resource is a child resource of the smart list resource and lists the courses matching the smart list criteria.",
            "items":{
                "$ref":"#/components/schemas/courseLists-elements-smartLists-courses-item-patch-request"
            }
        },
        "Description":{
            "type":"string",
            "description":"The long or formal, detailed description of a curriculum item.",
            "nullable":true
        },
        "CurriculumSmartlistId":{
            "type":"integer",
            "description":"The generated primary key column for a smart list curriculum record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true",
                "PAYLOADHINT":"Show"
            }
        },
        "Name":{
            "type":"string",
            "description":"The name or short description of a curriculum item.",
            "nullable":true
        }
    }
}

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

• Array of: object courseLists-elements-smartLists-courses-item-patch-request

{
    "title":"Smart List Courses",
    "type":"array",
    "description":"The courses resource is a child resource of the smart list resource and lists the courses matching the smart list criteria.",
    "items":{
        "$ref":"#/components/schemas/courseLists-elements-smartLists-courses-item-patch-request"
    }
}

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

• Array of: object courseLists-elements-smartLists-smartListCriteria-item-patch-request

{
    "title":"Smart List Criteria Values",
    "type":"array",
    "description":"The smart list criteria values resource is a child resource of the smart lists resource and lists the criteria associated with the smart list.",
    "items":{
        "$ref":"#/components/schemas/courseLists-elements-smartLists-smartListCriteria-item-patch-request"
    }
}

Nested Schema : courseLists-elements-smartLists-courses-item-patch-request

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "courseOrganizations":{
            "title":"Smart List Course Organizations",
            "type":"array",
            "description":"The course organizations resource is a child resource of the smart list course resource and lists the organizations matching the smart list course.",
            "items":{
                "$ref":"#/components/schemas/courseLists-elements-smartLists-courses-courseOrganizations-item-patch-request"
            }
        },
        "courseCampuses":{
            "title":"Smart List Course Campuses",
            "type":"array",
            "description":"The course campuses resource is a child resource of the smart list course resource and lists the campuses matching the smart list course.",
            "items":{
                "$ref":"#/components/schemas/courseLists-elements-smartLists-courses-courseCampuses-item-patch-request"
            }
        },
        "tags":{
            "title":"Smart List Course Curriculum Tags",
            "type":"array",
            "description":"The course tags resource is a child resource of the smart list course resource and lists the tags matching the smart list course.",
            "items":{
                "$ref":"#/components/schemas/courseLists-elements-smartLists-courses-tags-item-patch-request"
            }
        }
    }
}

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

• Array of: object courseLists-elements-smartLists-courses-courseCampuses-item-patch-request

{
    "title":"Smart List Course Campuses",
    "type":"array",
    "description":"The course campuses resource is a child resource of the smart list course resource and lists the campuses matching the smart list course.",
    "items":{
        "$ref":"#/components/schemas/courseLists-elements-smartLists-courses-courseCampuses-item-patch-request"
    }
}

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

• Array of: object courseLists-elements-smartLists-courses-courseOrganizations-item-patch-request

{
    "title":"Smart List Course Organizations",
    "type":"array",
    "description":"The course organizations resource is a child resource of the smart list course resource and lists the organizations matching the smart list course.",
    "items":{
        "$ref":"#/components/schemas/courseLists-elements-smartLists-courses-courseOrganizations-item-patch-request"
    }
}

Nested Schema : Smart List Course Curriculum Tags

Type: array

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.

Show Source

• Array of: object courseLists-elements-smartLists-courses-tags-item-patch-request

{
    "title":"Smart List Course Curriculum Tags",
    "type":"array",
    "description":"The course tags resource is a child resource of the smart list course resource and lists the tags matching the smart list course.",
    "items":{
        "$ref":"#/components/schemas/courseLists-elements-smartLists-courses-tags-item-patch-request"
    }
}

Nested Schema : courseLists-elements-smartLists-courses-courseCampuses-item-patch-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Nested Schema : courseLists-elements-smartLists-courses-courseOrganizations-item-patch-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Nested Schema : courseLists-elements-smartLists-courses-tags-item-patch-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Nested Schema : courseLists-elements-smartLists-smartListCriteria-item-patch-request

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "CriteriaTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CriteriaColumnValue":{
            "maxLength":"240",
            "type":"string",
            "description":"The value that should be used with the criteria column to identify courses for the smart list.",
            "nullable":false
        },
        "CriteriaSortSequence":{
            "type":"integer",
            "description":"The sort sequence of the smart list criteria.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            }
        },
        "CriteriaColumnCode":{
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• 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.

Body ()

Root Schema : courseLists-elements-smartLists-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the row for the smart list.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the smart list row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "courses":{
            "title":"Smart List Courses",
            "type":"array",
            "description":"The courses resource is a child resource of the smart list resource and lists the courses matching the smart list criteria.",
            "items":{
                "$ref":"#/components/schemas/courseLists-elements-smartLists-courses-item-response"
            }
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the row for the smart list.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "type":"string",
            "description":"The long or formal, detailed description of a curriculum item.",
            "nullable":true,
            "x-queryable":true
        },
        "EffectiveEndDate":{
            "type":"string",
            "description":"The effective end date of the smart list.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurriculumSmartlistId":{
            "type":"integer",
            "description":"The generated primary key column for a smart list curriculum record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "AutoExecuteFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":false,
            "x-queryable":true
        },
        "smartListCriteria":{
            "title":"Smart List Criteria Values",
            "type":"array",
            "description":"The smart list criteria values resource is a child resource of the smart lists resource and lists the criteria associated with the smart list.",
            "items":{
                "$ref":"#/components/schemas/courseLists-elements-smartLists-smartListCriteria-item-response"
            }
        },
        "Name":{
            "type":"string",
            "description":"The name or short description of a curriculum item.",
            "nullable":true,
            "x-queryable":true
        },
        "CurriculumId":{
            "title":"Curriculum ID",
            "type":"integer",
            "description":"The unique identifier for a curriculum item such as a smart list, course list or program.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CurriculumHeaderId":{
            "title":"Curriculum Header ID",
            "type":"integer",
            "description":"The generated primary key column for a curriculum record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "EffectiveStartDate":{
            "type":"string",
            "description":"The effective start date of the smart list.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the smart list row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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

• Array of: object courseLists-elements-smartLists-courses-item-response

{
    "title":"Smart List Courses",
    "type":"array",
    "description":"The courses resource is a child resource of the smart list resource and lists the courses matching the smart list criteria.",
    "items":{
        "$ref":"#/components/schemas/courseLists-elements-smartLists-courses-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

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

• Array of: object courseLists-elements-smartLists-smartListCriteria-item-response

{
    "title":"Smart List Criteria Values",
    "type":"array",
    "description":"The smart list criteria values resource is a child resource of the smart lists resource and lists the criteria associated with the smart list.",
    "items":{
        "$ref":"#/components/schemas/courseLists-elements-smartLists-smartListCriteria-item-response"
    }
}

Nested Schema : courseLists-elements-smartLists-courses-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "CurriculumCatalogNumber":{
            "maxLength":"10",
            "type":"string",
            "description":"The catalog number of the curriculum item.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "courseOrganizations":{
            "title":"Smart List Course Organizations",
            "type":"array",
            "description":"The course organizations resource is a child resource of the smart list course resource and lists the organizations matching the smart list course.",
            "items":{
                "$ref":"#/components/schemas/courseLists-elements-smartLists-courses-courseOrganizations-item-response"
            }
        },
        "InstitutionName":{
            "maxLength":"50",
            "type":"string",
            "description":"The name of the institution to which the course offering belongs.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "MinimumUnitsQuantity":{
            "type":"number",
            "description":"A numeric value indicating the minimum units of the course.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"11",
                "scale":"2",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "InstitutionId":{
            "type":"integer",
            "description":"The unique identifier for the institution on the offering of the course.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "TypicallyOfferedCode":{
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CurriculumName":{
            "maxLength":"50",
            "type":"string",
            "description":"The name or short description of a curriculum item.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CurriculumOfferingId":{
            "type":"integer",
            "description":"The generated unique identifier of a course offering.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CreditTypeMeaning":{
            "maxLength":"80",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "TypicallyOfferedMeaning":{
            "maxLength":"80",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "courseCampuses":{
            "title":"Smart List Course Campuses",
            "type":"array",
            "description":"The course campuses resource is a child resource of the smart list course resource and lists the campuses matching the smart list course.",
            "items":{
                "$ref":"#/components/schemas/courseLists-elements-smartLists-courses-courseCampuses-item-response"
            }
        },
        "tags":{
            "title":"Smart List Course Curriculum Tags",
            "type":"array",
            "description":"The course tags resource is a child resource of the smart list course resource and lists the tags matching the smart list course.",
            "items":{
                "$ref":"#/components/schemas/courseLists-elements-smartLists-courses-tags-item-response"
            }
        },
        "OfferSequenceNumber":{
            "type":"integer",
            "description":"The unique sort identifier for the offering of the course.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"9",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "AcademicSubjectCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The code for the course's academic subject.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CurriculumId":{
            "type":"integer",
            "description":"The unique identifier for a curriculum item such as a course.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CreditTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "AcademicSubjectName":{
            "maxLength":"50",
            "type":"string",
            "description":"The name of the subject of the course.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "AcademicLevelName":{
            "title":"Academic Level Name",
            "maxLength":"100",
            "type":"string",
            "description":"The name of the academic level associated with course offering.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CurriculumHeaderId":{
            "type":"integer",
            "description":"The unique identifier for a curriculum header record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "MaximumUnitsQuantity":{
            "type":"number",
            "description":"A numeric value indicating the maximum units of the course.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"11",
                "scale":"2",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CurriculumTitle":{
            "maxLength":"100",
            "type":"string",
            "description":"The formal title of a curriculum item.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        }
    }
}

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

• Array of: object courseLists-elements-smartLists-courses-courseCampuses-item-response

{
    "title":"Smart List Course Campuses",
    "type":"array",
    "description":"The course campuses resource is a child resource of the smart list course resource and lists the campuses matching the smart list course.",
    "items":{
        "$ref":"#/components/schemas/courseLists-elements-smartLists-courses-courseCampuses-item-response"
    }
}

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

• Array of: object courseLists-elements-smartLists-courses-courseOrganizations-item-response

{
    "title":"Smart List Course Organizations",
    "type":"array",
    "description":"The course organizations resource is a child resource of the smart list course resource and lists the organizations matching the smart list course.",
    "items":{
        "$ref":"#/components/schemas/courseLists-elements-smartLists-courses-courseOrganizations-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Smart List Course Curriculum Tags

Type: array

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.

Show Source

• Array of: object courseLists-elements-smartLists-courses-tags-item-response

{
    "title":"Smart List Course Curriculum Tags",
    "type":"array",
    "description":"The course tags resource is a child resource of the smart list course resource and lists the tags matching the smart list course.",
    "items":{
        "$ref":"#/components/schemas/courseLists-elements-smartLists-courses-tags-item-response"
    }
}

Nested Schema : courseLists-elements-smartLists-courses-courseCampuses-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CampusName":{
            "title":"Name",
            "maxLength":"50",
            "type":"string",
            "description":"The name of the campus where a course is offered.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "OfferingCampusId":{
            "type":"integer",
            "description":"The unique identifier for the campus where a course is offered.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CampusId":{
            "type":"integer",
            "description":"The unique identifier for the campus where a course is offered.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : courseLists-elements-smartLists-courses-courseOrganizations-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CurriculumOrgId":{
            "type":"integer",
            "description":"The generated primary key column for an offering academic organization.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "AcademicOrgId":{
            "type":"integer",
            "description":"The academic organization that owns the curriculum item.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "AcademicOrgName":{
            "maxLength":"50",
            "type":"string",
            "description":"The name of the academic organization associated with the offering.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : courseLists-elements-smartLists-courses-tags-item-response

Type: object

Show Source

• CurriculumTagContextCode: string
  Title: Tag Code

  Read Only: true

  Maximum Length: 30

  The context code of the curriculum tag. A list of accepted values is defined in the lookup type ORA_HER_TAG_CONTEXT_CODE.
• CurriculumTagName: string
  Title: Name

  Read Only: true

  Maximum Length: 50

  The name of the tag for a course.
• CurriculumTagNameCode: string
  Title: Tag Code

  Read Only: true

  Maximum Length: 30

  The code of the curriculum tag.
• CurriculumTagNameId: integer (int64)
  Read Only: true

  The unique identifier of a tag name for a course.
• CurriculumTagValue: string
  Title: Tag Value

  Read Only: true

  Maximum Length: 50

  The name of the tag value for a course.
• CurriculumTagValueCode: string
  Title: Tag Value Code

  Read Only: true

  Maximum Length: 30

  The code of the curriculum tag value.
• CurriculumTagValueId: integer (int64)
  Read Only: true

  The unique identifier of a tag value for a course.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "CurriculumTagNameCode":{
            "title":"Tag Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code of the curriculum tag.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CurriculumTagValueId":{
            "type":"integer",
            "description":"The unique identifier of a tag value for a course.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CurriculumTagContextCode":{
            "title":"Tag Code",
            "maxLength":"30",
            "type":"string",
            "description":"The context code of the curriculum tag. A list of accepted values is defined in the lookup type ORA_HER_TAG_CONTEXT_CODE.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CurriculumTagName":{
            "title":"Name",
            "maxLength":"50",
            "type":"string",
            "description":"The name of the tag for a course.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CurriculumTagValueCode":{
            "title":"Tag Value Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code of the curriculum tag value.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CurriculumTagValue":{
            "title":"Tag Value",
            "maxLength":"50",
            "type":"string",
            "description":"The name of the tag value for a course.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CurriculumTagNameId":{
            "type":"integer",
            "description":"The unique identifier of a tag name for a course.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : courseLists-elements-smartLists-smartListCriteria-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the row for the smart list criteria.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CriteriaColumnName":{
            "maxLength":"80",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the smart list criteria row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CriteriaColumnDataType":{
            "type":"string",
            "description":"The data type of the criteria column attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the row for the smart list criteria.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CriteriaTypeMeaning":{
            "maxLength":"80",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SmartlistCriteriaId":{
            "type":"integer",
            "description":"The unique identifier for the smart list criteria.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CriteriaColumnValue":{
            "maxLength":"240",
            "type":"string",
            "description":"The value that should be used with the criteria column to identify courses for the smart list.",
            "nullable":false,
            "x-queryable":true
        },
        "CriteriaTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CriteriaSortSequence":{
            "type":"integer",
            "description":"The sort sequence of the smart list criteria.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CriteriaColumnCode":{
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the smart list criteria row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

courses

Operation: /fscmRestApi/resources/11.13.18.05/courseLists/{courseListsUniqID}/child/elements/{ElementId}/child/smartLists/{CurriculumSmartlistId}/child/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.

smartListCriteria

Operation: /fscmRestApi/resources/11.13.18.05/courseLists/{courseListsUniqID}/child/elements/{ElementId}/child/smartLists/{CurriculumSmartlistId}/child/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.

Back to Top