Jump to

• Request
• Response

Get all course lists

get

/fscmRestApi/resources/11.13.18.05/courseLists

Request

Query Parameters

• effectiveDate: string
  This query parameter is used to fetch resources which are effective dated as of the specified start date. The value of this query parameter is a string having a date in yyyy-MM-dd format
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables
  
  

  • CurriculumHeaderIdFinder Finds all course lists that match the keyword specified.
    Finder Variables
    • bindCurriculumHeaderId; integer; Keyword for the course list.
  • EffectiveCurriculumHeaderIdFinder Finds all course lists that match the keyword specified.
    Finder Variables
    • CurriculumHeaderId; integer; Unique identifier for the course list.
    • SysEffectiveDate; object;
  • PrimaryKey Finds all course lists that match the primary key criteria specified.
    Finder Variables
    • CurriculumHeaderId; integer; Unique identifier for the course list.
    • EffectiveEndDate; string; The effective end date of the course list.
    • EffectiveStartDate; string; The effective start date of the course list.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • AcademicLevelId; integer; The unique identifier for an academic level.
  • AcademicLevelName; string; The name of an academic level, such as undergraduate or graduate, that's associated with a course list.
  • AcademicOrgId; integer; The unique identifier for an academic organization.
  • AcademicOrgName; string; The academic organization that owns the curriculum item.
  • CreatedBy; string; The user who created the row for the course list.
  • CreationDate; string; The date and time when the course list row was created.
  • CurriculumBuildStatusId; integer; The unique identifier for a curriculum build status.
  • CurriculumBuildStatusName; string; The name of a user defined build or lifecycle status code.
  • CurriculumHeaderId; integer; The generated primary key column for a curriculum record.
  • CurriculumId; integer; The unique identifier for a curriculum item such as a course list or program.
  • Description; string; The long or formal, detailed description of a curriculum item.
  • EffectiveEndDate; string; The effective end date of the course list.
  • EffectiveStartDate; string; The effective start date of the course list.
  • InstitutionId; integer; The unique identifier for an institution.
  • InstitutionName; string; The institution that owns the curriculum item.
  • LastUpdateDate; string; The date and time when the course list row was last updated.
  • LastUpdatedBy; string; The user who last updated the row for the course list.
  • Name; string; The name or short description of a curriculum item.
  • RequirementsDescription; string; A description of the course list requirements.
  • SystemStatusCode; string; The status of the curriculum build status in relation to a curriculum item. Values are ORA_ACTIVE or ORA_INACTIVE.
  • SystemStatusMeaning; string; The meaning of the status of the curriculum build status in relation to a curriculum item. Values are Active or Inactive.
  • Title; string; The formal title of a curriculum item.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

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.

There's no request body for this operation.

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

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/courseLists-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject",
        "group":"HED"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object courseLists-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/courseLists-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 : courseLists-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the course list row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "type":"string",
            "description":"The long or formal, detailed description of a curriculum item.",
            "nullable":true,
            "x-queryable":true
        },
        "CurriculumBuildStatusId":{
            "title":"Curriculum Build Status ID",
            "type":"integer",
            "description":"The unique identifier for a curriculum build status.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SystemStatusMeaning":{
            "title":"Curriculum Build Status",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of the status of the curriculum build status in relation to a curriculum item. Values are Active or Inactive.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":"150",
            "type":"string",
            "description":"The name or short description of a curriculum item.",
            "nullable":false,
            "x-queryable":true
        },
        "CurriculumBuildStatusName":{
            "title":"Build Status",
            "maxLength":"50",
            "type":"string",
            "description":"The name of a user defined build or lifecycle status code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AcademicLevelId":{
            "title":"Academic Level ID",
            "type":"integer",
            "description":"The unique identifier for an academic level.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AcademicLevelName":{
            "title":"Academic Level Name",
            "maxLength":"100",
            "type":"string",
            "description":"The name of an academic level, such as undergraduate or graduate, that's associated with a course list.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "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,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "results":{
            "title":"Results",
            "type":"array",
            "description":"The results resource is a child of the course lists resource and lists all the results associated with a course list.",
            "items":{
                "$ref":"#/components/schemas/courseLists-results-item-response"
            }
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the row for the course list.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the row for the course list.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EffectiveEndDate":{
            "title":"Effective End Date",
            "type":"string",
            "description":"The effective end date of the course list.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "InstitutionName":{
            "title":"Institution",
            "maxLength":"50",
            "type":"string",
            "description":"The institution that owns the curriculum item.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AcademicOrgId":{
            "title":"Academic Organization ID",
            "type":"integer",
            "description":"The unique identifier for an academic organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "InstitutionId":{
            "title":"Institution ID",
            "type":"integer",
            "description":"The unique identifier for an institution.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AcademicOrgName":{
            "title":"Academic Organization",
            "maxLength":"50",
            "type":"string",
            "description":"The academic organization that owns the curriculum item.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SystemStatusCode":{
            "title":"Build Status Code",
            "maxLength":"30",
            "type":"string",
            "description":"The status of the curriculum build status in relation to a curriculum item. Values are ORA_ACTIVE or ORA_INACTIVE.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Title":{
            "title":"Title",
            "maxLength":"100",
            "type":"string",
            "description":"The formal title of a curriculum item.",
            "nullable":true,
            "x-queryable":true
        },
        "groups":{
            "title":"Element Groups",
            "type":"array",
            "description":"The elements group resource is a child of the course lists resource and lists all the element groups associated with a course list.",
            "items":{
                "$ref":"#/components/schemas/courseLists-groups-item-response"
            }
        },
        "RequirementsDescription":{
            "title":"Course List Requirements",
            "type":"string",
            "description":"A description of the course list requirements.",
            "nullable":true,
            "x-queryable":true
        },
        "CurriculumId":{
            "title":"Curriculum ID",
            "type":"integer",
            "description":"The unique identifier for a curriculum item such as a course list or program.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "elements":{
            "title":"Elements",
            "type":"array",
            "description":"The elements resource is a child of the course lists resource and lists all the elements associated with a course list.",
            "items":{
                "$ref":"#/components/schemas/courseLists-elements-item-response"
            }
        },
        "EffectiveStartDate":{
            "title":"Effective Start Date",
            "type":"string",
            "description":"The effective start date of the course list.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "parameters":{
            "title":"Parameters",
            "type":"array",
            "description":"The parameters resource is a child of the course lists resource and lists all the parameters associated with a course list.",
            "items":{
                "$ref":"#/components/schemas/courseLists-parameters-item-response"
            }
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the course list row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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

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

{
    "title":"Elements",
    "type":"array",
    "description":"The elements resource is a child of the course lists resource and lists all the elements associated with a course list.",
    "items":{
        "$ref":"#/components/schemas/courseLists-elements-item-response"
    }
}

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

• Array of: object courseLists-groups-item-response

{
    "title":"Element Groups",
    "type":"array",
    "description":"The elements group resource is a child of the course lists resource and lists all the element groups associated with a course list.",
    "items":{
        "$ref":"#/components/schemas/courseLists-groups-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 : 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

• Array of: object courseLists-parameters-item-response

{
    "title":"Parameters",
    "type":"array",
    "description":"The parameters resource is a child of the course lists resource and lists all the parameters associated with a course list.",
    "items":{
        "$ref":"#/components/schemas/courseLists-parameters-item-response"
    }
}

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

• Array of: object courseLists-results-item-response

{
    "title":"Results",
    "type":"array",
    "description":"The results resource is a child of the course lists resource and lists all the results associated with a course list.",
    "items":{
        "$ref":"#/components/schemas/courseLists-results-item-response"
    }
}

Nested Schema : courseLists-elements-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated Date",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the row for the element.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "smartLists":{
            "title":"Smart Lists",
            "type":"array",
            "description":"The smart lists resource is a child of the elements resource and lists attributes of the smart list associated with the element.",
            "items":{
                "$ref":"#/components/schemas/courseLists-elements-smartLists-item-response"
            }
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the element row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the row for the element.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurriculumTypeId":{
            "title":"Curriculum Item Type ID",
            "type":"integer",
            "description":"The unique identifier for a type of curriculum item, such as a scheduled course.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CurriculumType":{
            "title":"Curriculum Item Type",
            "maxLength":"30",
            "type":"string",
            "description":"The code of the curriculum type of the requisite associated with the course.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurriculumTypeName":{
            "title":"Curriculum Type",
            "maxLength":"50",
            "type":"string",
            "description":"The curriculum type of curriculum item, such as a scheduled course.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ConnectorCode":{
            "title":"Connector Code",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RequirementCategoryId":{
            "title":"Requirement Category ID",
            "type":"integer",
            "description":"The unique identifier for a requirement category code.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "courseOfferings":{
            "title":"Course Offerings",
            "type":"array",
            "description":"The course offerings resource is a child of the elements resource and lists all the offerings for the associated course element.",
            "items":{
                "$ref":"#/components/schemas/courseLists-elements-courseOfferings-item-response"
            }
        },
        "RequirementCategoryName":{
            "title":"Requirement Category",
            "maxLength":"50",
            "type":"string",
            "description":"The type of requirement that this program element fulfills, such as required or elective.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RightParenthesesQuantity":{
            "title":"Right Parentheses Quantity",
            "type":"integer",
            "description":"The number of right parentheses included in a curriculum element row.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "CurriculumName":{
            "title":"Name",
            "maxLength":"150",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "GroupSequenceId":{
            "type":"integer",
            "description":"A sequence identifier used to identify and sort groups within a curriculum item.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "RequirementCategoryCode":{
            "title":"Requirement Category Code",
            "maxLength":"30",
            "type":"string",
            "description":"The user defined code for a requirement category, used for categorizing program requirements in the Curriculum Registry.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurriculumId":{
            "title":"Element Curriculum ID",
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SortNumber":{
            "title":"Sort Number",
            "type":"integer",
            "description":"Determines the order in which the curriculum item elements are sorted.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "LeftParenthesesQuantity":{
            "title":"Left Parentheses Quantity",
            "type":"integer",
            "description":"The number of left parentheses included in a curriculum element row.",
            "format":"int32",
            "nullable":true,
            "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"
            }
        },
        "ConnectorMeaning":{
            "title":"Connector",
            "maxLength":"80",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ElementId":{
            "title":"Curriculum Element ID",
            "type":"integer",
            "description":"The unique identifier for a child element of a curriculum item. A child element might be a course or course list.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated By",
            "type":"string",
            "description":"The date and time when the element row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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

• Array of: object courseLists-elements-courseOfferings-item-response

{
    "title":"Course Offerings",
    "type":"array",
    "description":"The course offerings resource is a child of the elements resource and lists all the offerings for the associated course element.",
    "items":{
        "$ref":"#/components/schemas/courseLists-elements-courseOfferings-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 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

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

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

Nested Schema : courseLists-elements-courseOfferings-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "CurriculumCatalogNumber":{
            "title":"Catalog Number",
            "maxLength":"10",
            "type":"string",
            "description":"The catalog number of the scheduled course.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "InstitutionName":{
            "title":"Institution",
            "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":{
            "title":"Minimum Units",
            "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":{
            "title":"Institution",
            "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
        },
        "CurriculumOfferingId":{
            "title":"Curriculum Offering ID",
            "type":"integer",
            "description":"The generated unique identifier of a course.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CreditTypeMeaning":{
            "title":"Type of Credit Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "OfferSequenceNumber":{
            "title":"Offer Number",
            "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":{
            "title":"Subject Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code for the scheduled course's academic subject.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CreditTypeCode":{
            "title":"Type of Credit",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "AcademicSubjectId":{
            "title":"Academic Subject ID",
            "type":"integer",
            "description":"The unique identifier for the course's academic subject.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "AcademicSubjectName":{
            "title":"Subject",
            "maxLength":"50",
            "type":"string",
            "description":"The name of the subject of the scheduled course.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "MaximumUnitsQuantity":{
            "title":"Maximum Units",
            "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
        }
    }
}

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-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 : 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"
    }
}

Nested Schema : courseLists-groups-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the element group row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the element group row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentSequenceId":{
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"9",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the element group row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "maxLength":"250",
            "type":"string",
            "description":"The description for a curriculum element group.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "StatementCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The code of the conditional operator, such as ORA_ANY or ORA_ALL for the related items and groups within a curriculum element group.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "StatementMeaning":{
            "maxLength":"50",
            "type":"string",
            "description":"The meaning of conditional operator, such as Any or All for the related items and groups within a curriculum element group.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "GroupId":{
            "type":"integer",
            "description":"The unique identifier for a curriculum element group.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "Name":{
            "maxLength":"50",
            "type":"string",
            "description":"The name for a curriculum element group.",
            "nullable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "DisplaySequenceNumber":{
            "type":"integer",
            "description":"The display sequence number of a curriculum group. The sequence number can be used to present element groups in a specific order.",
            "format":"int32",
            "nullable":true,
            "default":"1",
            "x-hints":{
                "precision":"9",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the element group row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SequenceId":{
            "type":"integer",
            "description":"A sequence identifier used to identify and sort groups within a curriculum item.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9",
                "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-parameters-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The date and time when the parameter row was last updated.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the parameter row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the parameter row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MinimumUnitsQuantity":{
            "title":"Minimum Units",
            "type":"integer",
            "description":"The minimum number of units of credit that must be completed to satisfy a curriculum item requirement.",
            "format":"int32",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "RequirementCategoryId":{
            "title":"Requirement Category ID",
            "type":"integer",
            "description":"The unique identifier for the requirement category.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RequirementCategoryName":{
            "title":"Name",
            "maxLength":"50",
            "type":"string",
            "description":"The type of requirement that this program element fulfills, such as required or elective.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParameterId":{
            "title":"Curriculum Parameter ID",
            "type":"integer",
            "description":"The unique identifier for a parameter associated with a curriculum item such as program.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "RequirementCategoryCode":{
            "title":"Requirement Category Code",
            "maxLength":"30",
            "type":"string",
            "description":"The user defined code for a requirement category, used for categorizing program requirements in the Curriculum Registry.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MaximumCoursesQuantity":{
            "title":"Maximum Number of Courses",
            "type":"integer",
            "description":"The maximum number of courses or course lists that must be completed to satisfy a curriculum item requirement.",
            "format":"int32",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "ParameterSequenceNumber":{
            "title":"Parameter Sequence Number",
            "type":"integer",
            "description":"The sequence number for a set of parameters defined for program requirements.",
            "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"
            }
        },
        "MinimumCoursesQuantity":{
            "title":"Minimum Number of Courses",
            "type":"integer",
            "description":"The minimum number of courses that must be completed to satisfy a curriculum item requirement.",
            "format":"int32",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "MaximumUnitsQuantity":{
            "title":"Maximum Units",
            "type":"integer",
            "description":"The maximum number of units of credit that can be completed or used to satisfy a curriculum item requirement.",
            "format":"int32",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The user who last updated the parameter row.",
            "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"
    }
}

Nested Schema : courseLists-results-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated Date",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the row for the result.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the result row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DefaultResultSetFlag":{
            "title":"Default Result Set Indicator",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates the default result set for a scheduled course or course offering. The default value is false.",
            "nullable":false,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the row for the result.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultId":{
            "title":"Curriculum Result ID",
            "type":"integer",
            "description":"The unique identifier for a curriculum result record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ResultSetCode":{
            "title":"Result Set Code",
            "maxLength":"30",
            "type":"string",
            "description":"The unique code for a result set.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultTypeCode":{
            "title":"Result Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The unique code for a result type.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ResultTypeName":{
            "title":"Result Type Name",
            "maxLength":"50",
            "type":"string",
            "description":"The name of a result type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultSetId":{
            "title":"Result Set ID",
            "type":"integer",
            "description":"The unique identifier for a result set.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ResultSetName":{
            "title":"Result Set Name",
            "maxLength":"50",
            "type":"string",
            "description":"The name of a result set.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ResultTypeId":{
            "title":"Result Type ID",
            "type":"integer",
            "description":"The unique identifier for a result type.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated By",
            "type":"string",
            "description":"The date and time when the result 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"
    }
}

Back to Top