Jump to

• Request
• Response

Get all program elements

get

/fscmRestApi/resources/11.13.18.05/programs/{programsUniqID}/child/programElements

Request

Path Parameters

• programsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Programs resource and used to uniquely identify an instance of Programs. The client should not generate the hash key value. Instead, the client should query on the Programs collection resource in order to navigate to a specific instance of Programs to get the hash key.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• 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
  
  

  • PrimaryKey Finds all program element rows that match the primary key criteria specified.
    Finder Variables
    • ElementId; integer; Unique identifier for the program element.
• 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:
  

  • ConnectorCode; string; The hierarchical level at which the current element appears from the program.
  • CurriculumFormatCode; string; The code of the curriculum format used by the program element. Valid values include ORA_BLD, ORA_ONL, or ORA_ONP. A list of accepted values is defined in the lookup type ORA_HER_CURRICULUM_FORMAT_CODE.
  • CurriculumFormatMeaning; string; The meaning of the curriculum format used by the program element. Valid values include Blended, Online, or On site. A list of accepted values is defined in the lookup type ORA_HER_CURRICULUM_FORMAT_CODE.
  • CurriculumId; integer; The generated primary key column for a course or course list which is associated with the program.
  • CurriculumLongDescription; string; The long description for a program element.
  • CurriculumName; string; The name of the course or course list program element.
  • CurriculumType; string; The curriculum type of the program element such as course or course list.
  • ElementId; integer; The generated primary key column for a curriculum element record.
  • HierarchyLevel; number; A concatenated list of curriculum ID values representing the hierarchical path of current element from the program.
  • HierarchyPath; string; The unique identifier for a requirement category code assigned to a program parameter.
  • LeftParenthesesQuantity; integer; The number of left parentheses included in a curriculum element row.
  • MaximumUnitsQuantity; number; The maximum number of units of credit that must be completed to satisfy a curriculum item requirement.
  • MinimumUnitsQuantity; number; The minimum number of units of credit that can be completed or used to satisfy a curriculum item requirement.
  • ParentCurriculumId; integer; 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.
  • RequirementCategoryCode; string; The generated primary key column for a parent course or course list which is associated with the program.
  • RequirementCategoryId; integer; A code that categorizes program course requirements.
  • RequirementCategoryName; string; The name of the requirement category code.
  • RequirementsText; string; The long description of requirements for a program element.
  • RequisiteExistsFlag; boolean; Indicates if requisite courses exist for a program element.
  • RightParenthesesQuantity; integer; The number of right parentheses included in a curriculum element row.
  • SortNumber; integer; A sequence number that overrides the default sort order for a program's elements.
• 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

• 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(required):
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version(required):
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : programs-programElements

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/programs-programElements-item-response"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object programs-programElements-item-response

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

Type: object

Show Source

• additionalInformation: array Additional Information
  Title: Additional Information

  The additional information resource is a child of the courses resource and provides a list of messages associated with a course.
• ConnectorCode: string
  Title: Connector Code

  Read Only: true

  Maximum Length: 30

  The hierarchical level at which the current element appears from the program.
• courseOfferings: array Course Offerings
  Title: Course Offerings

  The course offering resource is a child of the program elements resource and provides a list of offerings associated with a course.
• CurriculumFormatCode: string
  Title: Format

  Read Only: true

  Maximum Length: 30

  The code of the curriculum format used by the program element. Valid values include ORA_BLD, ORA_ONL, or ORA_ONP. A list of accepted values is defined in the lookup type ORA_HER_CURRICULUM_FORMAT_CODE.
• CurriculumFormatMeaning: string
  Title: Curriculum Format Meaning

  Read Only: true

  Maximum Length: 80

  The meaning of the curriculum format used by the program element. Valid values include Blended, Online, or On site. A list of accepted values is defined in the lookup type ORA_HER_CURRICULUM_FORMAT_CODE.
• CurriculumId: integer (int64)
  Title: Curriculum ID

  Read Only: true

  The generated primary key column for a course or course list which is associated with the program.
• CurriculumLongDescription: string
  Title: Description

  Read Only: true

  The long description for a program element.
• CurriculumName: string
  Title: Curriculum Name

  Read Only: true

  Maximum Length: 50

  The name of the course or course list program element.
• CurriculumType: string
  Title: Curriculum Type

  Read Only: true

  Maximum Length: 30

  The curriculum type of the program element such as course or course list.
• ElementId: integer
  Title: Curriculum Element ID

  Read Only: true

  The generated primary key column for a curriculum element record.
• HierarchyLevel: number
  Title: Hierarchy Level

  Read Only: true

  A concatenated list of curriculum ID values representing the hierarchical path of current element from the program.
• HierarchyPath: string
  Title: Hierarchy Path

  Read Only: true

  Maximum Length: 4000

  The unique identifier for a requirement category code assigned to a program parameter.
• LeftParenthesesQuantity: integer (int32)
  Title: Left Parentheses Quantity

  Read Only: true

  The number of left parentheses included in a curriculum element row.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MaximumUnitsQuantity: number
  Title: Maximum Units

  Read Only: true

  The maximum number of units of credit that must be completed to satisfy a curriculum item requirement.
• MinimumUnitsQuantity: number
  Title: Minimum Units

  Read Only: true

  The minimum number of units of credit that can be completed or used to satisfy a curriculum item requirement.
• offeringCampuses: array Offering Campuses
  Title: Offering Campuses

  The offering campuses resource is a child of the programs resource and provides a list of campuses where a program is offered.
• parameters: array Parameters
  Title: Parameters

  The parameters resource is a child of the programs resource and provides a list of program parameters for a program.
• ParentCurriculumId: integer (int64)
  Title: Parent Curriculum ID

  Read Only: true

  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.
• RequirementCategoryCode: string
  Title: Requirement Category Code

  Read Only: true

  Maximum Length: 30

  The generated primary key column for a parent course or course list which is associated with the program.
• RequirementCategoryId: integer (int64)
  Title: Requirement Category ID

  Read Only: true

  A code that categorizes program course requirements.
• RequirementCategoryName: string
  Title: Requirement Category

  Read Only: true

  Maximum Length: 50

  The name of the requirement category code.
• RequirementsText: string
  Title: Requirements

  Read Only: true

  The long description of requirements for a program element.
• RequisiteExistsFlag: boolean
  Title: Requisite Exists

  Read Only: true

  Indicates if requisite courses exist for a program element.
• requisites: array Requisites
  Title: Requisites

  The requisites resource is a child of the program elements resource and provides a list of prerequisite or corequisite courses for a course.
• RightParenthesesQuantity: integer (int32)
  Title: Right Parentheses Quantity

  Read Only: true

  The number of right parentheses included in a curriculum element row.
• SortNumber: integer (int32)
  Title: Sort Number

  Read Only: true

  A sequence number that overrides the default sort order for a program's elements.
• staffSummary: array Staff Summaries
  Title: Staff Summaries

  The staff summary resource is a child of the program elements resource and provides a unique list of all associated staff.
• tags: array Tags
  Title: Tags

  The tags resource is a child of the courses resource and provides a list of tags associated with a course.

{
    "type":"object",
    "properties":{
        "courseOfferings":{
            "title":"Course Offerings",
            "type":"array",
            "description":"The course offering resource is a child of the program elements resource and provides a list of offerings associated with a course.",
            "items":{
                "$ref":"#/components/schemas/programs-programElements-courseOfferings-item-response"
            },
            "x-cardinality":"1"
        },
        "RightParenthesesQuantity":{
            "title":"Right Parentheses Quantity",
            "type":"integer",
            "description":"The number of right parentheses included in a curriculum element row.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "CurriculumName":{
            "title":"Curriculum Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the course or course list program element.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequisiteExistsFlag":{
            "title":"Requisite Exists",
            "type":"boolean",
            "description":"Indicates if requisite courses exist for a program element.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequirementCategoryCode":{
            "title":"Requirement Category Code",
            "maxLength":30,
            "type":"string",
            "description":"The generated primary key column for a parent course or course list which is associated with the program.",
            "nullable":true,
            "readOnly":true,
            "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,
            "readOnly":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"
            }
        },
        "staffSummary":{
            "title":"Staff Summaries",
            "type":"array",
            "description":"The staff summary resource is a child of the program elements resource and provides a unique list of all associated staff.",
            "items":{
                "$ref":"#/components/schemas/programs-programElements-staffSummary-item-response"
            }
        },
        "ElementId":{
            "title":"Curriculum Element ID",
            "type":"integer",
            "description":"The generated primary key column for a curriculum element record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "requisites":{
            "title":"Requisites",
            "type":"array",
            "description":"The requisites resource is a child of the program elements resource and provides a list of prerequisite or corequisite courses for a course.",
            "items":{
                "$ref":"#/components/schemas/programs-programElements-requisites-item-response"
            }
        },
        "HierarchyLevel":{
            "title":"Hierarchy Level",
            "type":"number",
            "description":"A concatenated list of curriculum ID values representing the hierarchical path of current element from the program.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "additionalInformation":{
            "title":"Additional Information",
            "type":"array",
            "description":"The additional information resource is a child of the courses resource and provides a list of messages associated with a course.",
            "items":{
                "$ref":"#/components/schemas/programs-programElements-additionalInformation-item-response"
            }
        },
        "CurriculumFormatMeaning":{
            "title":"Curriculum Format Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the curriculum format used by the program element. Valid values include Blended, Online, or On site. A list of accepted values is defined in the lookup type ORA_HER_CURRICULUM_FORMAT_CODE.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MinimumUnitsQuantity":{
            "title":"Minimum Units",
            "type":"number",
            "description":"The minimum number of units of credit that can be completed or used to satisfy a curriculum item requirement.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":11,
                "scale":2
            },
            "x-queryable":true
        },
        "CurriculumType":{
            "title":"Curriculum Type",
            "maxLength":30,
            "type":"string",
            "description":"The curriculum type of the program element such as course or course list.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ConnectorCode":{
            "title":"Connector Code",
            "maxLength":30,
            "type":"string",
            "description":"The hierarchical level at which the current element appears from the program.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequirementCategoryId":{
            "title":"Requirement Category ID",
            "type":"integer",
            "description":"A code that categorizes program course requirements.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RequirementsText":{
            "title":"Requirements",
            "type":"string",
            "description":"The long description of requirements for a program element.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentCurriculumId":{
            "title":"Parent Curriculum ID",
            "type":"integer",
            "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.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RequirementCategoryName":{
            "title":"Requirement Category",
            "maxLength":50,
            "type":"string",
            "description":"The name of the requirement category code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurriculumLongDescription":{
            "title":"Description",
            "type":"string",
            "description":"The long description for a program element.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "tags":{
            "title":"Tags",
            "type":"array",
            "description":"The tags resource is a child of the courses resource and provides a list of tags associated with a course.",
            "items":{
                "$ref":"#/components/schemas/programs-programElements-tags-item-response"
            }
        },
        "CurriculumFormatCode":{
            "title":"Format",
            "maxLength":30,
            "type":"string",
            "description":"The code of the curriculum format used by the program element. Valid values include ORA_BLD, ORA_ONL, or ORA_ONP. A list of accepted values is defined in the lookup type ORA_HER_CURRICULUM_FORMAT_CODE.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurriculumId":{
            "title":"Curriculum ID",
            "type":"integer",
            "description":"The generated primary key column for a course or course list which is associated with the program.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "HierarchyPath":{
            "title":"Hierarchy Path",
            "maxLength":4000,
            "type":"string",
            "description":"The unique identifier for a requirement category code assigned to a program parameter.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SortNumber":{
            "title":"Sort Number",
            "type":"integer",
            "description":"A sequence number that overrides the default sort order for a program's elements.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "offeringCampuses":{
            "title":"Offering Campuses",
            "type":"array",
            "description":"The offering campuses resource is a child of the programs resource and provides a list of campuses where a program is offered.",
            "items":{
                "$ref":"#/components/schemas/programs-programElements-offeringCampuses-item-response"
            }
        },
        "MaximumUnitsQuantity":{
            "title":"Maximum Units",
            "type":"number",
            "description":"The maximum number of units of credit that must be completed to satisfy a curriculum item requirement.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":11,
                "scale":2
            },
            "x-queryable":true
        },
        "parameters":{
            "title":"Parameters",
            "type":"array",
            "description":"The parameters resource is a child of the programs resource and provides a list of program parameters for a program.",
            "items":{
                "$ref":"#/components/schemas/programs-programElements-parameters-item-response"
            }
        }
    }
}

Nested Schema : Additional Information

Type: array

Title: Additional Information

The additional information resource is a child of the courses resource and provides a list of messages associated with a course.

Show Source

• Array of: object programs-programElements-additionalInformation-item-response

{
    "title":"Additional Information",
    "type":"array",
    "description":"The additional information resource is a child of the courses resource and provides a list of messages associated with a course.",
    "items":{
        "$ref":"#/components/schemas/programs-programElements-additionalInformation-item-response"
    }
}

Nested Schema : Course Offerings

Type: array

Title: Course Offerings

The course offering resource is a child of the program elements resource and provides a list of offerings associated with a course.

Show Source

• Array of: object programs-programElements-courseOfferings-item-response

{
    "title":"Course Offerings",
    "type":"array",
    "description":"The course offering resource is a child of the program elements resource and provides a list of offerings associated with a course.",
    "items":{
        "$ref":"#/components/schemas/programs-programElements-courseOfferings-item-response"
    },
    "x-cardinality":"1"
}

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 : Offering Campuses

Type: array

Title: Offering Campuses

The offering campuses resource is a child of the programs resource and provides a list of campuses where a program is offered.

Show Source

• Array of: object programs-programElements-offeringCampuses-item-response

{
    "title":"Offering Campuses",
    "type":"array",
    "description":"The offering campuses resource is a child of the programs resource and provides a list of campuses where a program is offered.",
    "items":{
        "$ref":"#/components/schemas/programs-programElements-offeringCampuses-item-response"
    }
}

Nested Schema : Parameters

Type: array

Title: Parameters

The parameters resource is a child of the programs resource and provides a list of program parameters for a program.

Show Source

• Array of: object programs-programElements-parameters-item-response

{
    "title":"Parameters",
    "type":"array",
    "description":"The parameters resource is a child of the programs resource and provides a list of program parameters for a program.",
    "items":{
        "$ref":"#/components/schemas/programs-programElements-parameters-item-response"
    }
}

Nested Schema : Requisites

Type: array

Title: Requisites

The requisites resource is a child of the program elements resource and provides a list of prerequisite or corequisite courses for a course.

Show Source

• Array of: object programs-programElements-requisites-item-response

{
    "title":"Requisites",
    "type":"array",
    "description":"The requisites resource is a child of the program elements resource and provides a list of prerequisite or corequisite courses for a course.",
    "items":{
        "$ref":"#/components/schemas/programs-programElements-requisites-item-response"
    }
}

Nested Schema : Staff Summaries

Type: array

Title: Staff Summaries

The staff summary resource is a child of the program elements resource and provides a unique list of all associated staff.

Show Source

• Array of: object programs-programElements-staffSummary-item-response

{
    "title":"Staff Summaries",
    "type":"array",
    "description":"The staff summary resource is a child of the program elements resource and provides a unique list of all associated staff.",
    "items":{
        "$ref":"#/components/schemas/programs-programElements-staffSummary-item-response"
    }
}

Nested Schema : Tags

Type: array

Title: Tags

The tags resource is a child of the courses resource and provides a list of tags associated with a course.

Show Source

• Array of: object programs-programElements-tags-item-response

{
    "title":"Tags",
    "type":"array",
    "description":"The tags resource is a child of the courses resource and provides a list of tags associated with a course.",
    "items":{
        "$ref":"#/components/schemas/programs-programElements-tags-item-response"
    }
}

Nested Schema : programs-programElements-additionalInformation-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MessageSequenceNumber: integer
  Title: Message Sequence Number

  Read Only: true

  The unique identifier for the additional information of the course.
• MessageSortNumber: integer (int32)
  Title: Sort Number

  Read Only: true

  The unique sort identifier for the additional information of the course.
• MessageText: string
  Title: Text

  Read Only: true

  The text for the additional information of the course.
• MessageTypeCode: string
  Title: Type

  Read Only: true

  Maximum Length: 30

  Default Value: GEN

  The message type of the additional information of the course.
• MessageTypeMeaning: string
  Title: Message Type Meaning

  Read Only: true

  Maximum Length: 80

  The description of the additional information type of the course.

{
    "type":"object",
    "properties":{
        "MessageTypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The message type of the additional information of the course.",
            "nullable":false,
            "readOnly":true,
            "default":"GEN",
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "MessageText":{
            "title":"Text",
            "type":"string",
            "description":"The text for the additional information of the course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageSortNumber":{
            "title":"Sort Number",
            "type":"integer",
            "description":"The unique sort identifier for the additional information of the course.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "MessageTypeMeaning":{
            "title":"Message Type Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The description of the additional information type of the course.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageSequenceNumber":{
            "title":"Message Sequence Number",
            "type":"integer",
            "description":"The unique identifier for the additional information of the course.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

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 : programs-programElements-courseOfferings-item-response

Type: object

Show Source

• AcademicLevelId: integer (int64)
  Title: Academic Level ID

  Read Only: true

  The unique identifier of the academic level associated with the offering.
• AcademicLevelName: string
  Title: Academic Level

  Read Only: true

  Maximum Length: 100

  The name of the academic level associated with the offering.
• AcademicSubjectCode: string
  Title: Subject Code

  Read Only: true

  Maximum Length: 30

  The code for the 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 course's academic subject.
• ClosestScheduledCourseId: integer
  Title: Closest Scheduled ID

  Read Only: true

  The curriculum identifier for the scheduled instance of a course that has a start date closest to today's date.
• ConsentTypeCode: string
  Title: Permission Type

  Read Only: true

  Maximum Length: 30

  Default Value: ORA_NOT_REQUIRED

  The type of enrollment consent required by the student. A list of accepted values is defined in the lookup type ORA_HER_CONSENT_TYPE. Examples include course instructor, department chair and registrar.
• ConsentTypeMeaning: string
  Title: Consent Type Meaning

  Read Only: true

  Maximum Length: 80

  The meaning of consent type code. A list of accepted values is defined in the lookup type ORA_HER_CONSENT_TYPE.
• CredentialId: integer (int64)
  Title: Course Offering Credential ID

  Read Only: true

  The unique identifier of the credential associated with the offering.
• CredentialName: string
  Title: Name

  Read Only: true

  Maximum Length: 50

  The name of the credential associated with the course.
• CreditTypeCode: string
  Title: Type of Credit

  Read Only: true

  Maximum Length: 30

  The code for the type of credit assigned to a 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 assigned to a 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 associated with the course.
• 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 course.
• EnrollConsentRequiredFlag: boolean
  Title: Permission required to enroll

  Read Only: true

  Maximum Length: 1

  Default Value: false

  Indicates that a student must obtain consent to enroll in the curriculum item. The default value is false.
• InstitutionId: integer (int64)
  Title: Institution

  Read Only: true

  The unique identifier for the institution that owns the course.
• InstitutionName: string
  Title: Institution

  Read Only: true

  Maximum Length: 50

  The name of the institution to which the course offering belongs.
• IsWishableFlag: boolean
  Title: Wish List Enabled

  Read Only: true

  Indicates whether the course can be added to the wish list. The default value is true.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• offeringAcademicOrganizations: array Offering Academic Organizations
  Title: Offering Academic Organizations

  The offering academic organizations resource is a child of the programs resource and provides a list of academic organizations associated with a program.
• offeringCampuses: array Offering Campuses
  Title: Offering Campuses

  The offering campuses resource is a child of the programs resource and provides a list of campuses where a program is offered.
• OfferSequenceNumber: integer (int32)
  Title: Offer Number

  Read Only: true

  The unique sort identifier for the offering of the course.
• RepeatAllowedFlag: boolean
  Title: Repeatable

  Read Only: true

  Maximum Length: 1

  Default Value: false

  Indicates whether a course can be repeated. The default value is false.
• RepeatAllowedTotal: integer (int32)
  Title: Total Completions Allowed

  Read Only: true

  The total number of times a student can complete a course that's repeatable.
• RepeatInPeriodFlag: boolean
  Title: Allow multiple enrollment

  Read Only: true

  Maximum Length: 1

  Default Value: false

  Indicates whether a student can enroll in multiple instances of the same course in the same enrollment period. The default value is false.
• RepeatUnitsTotal: number
  Title: Total Units Allowed

  Read Only: true

  The maximum number of credits that a student can receive for multiple completions of a repeatable course.
• ScheduledCourseCount: integer
  Title: Scheduled Course Count

  Read Only: true

  The number of scheduled instances of a course that are available for enrollment as of the current date.
• StudentRequestConsentFlag: boolean
  Title: Allow permission request

  Read Only: true

  Maximum Length: 1

  Default Value: false

  Indicates that a student can initiate a request for consent or exception in relation to enrollment. The default value is false.
• TypicallyOfferedCode: string
  Title: Typically Offered

  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
  Title: Typically Offered Meaning

  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":{
            "title":"Catalog Number",
            "maxLength":10,
            "type":"string",
            "description":"The catalog number associated with the course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ConsentTypeMeaning":{
            "title":"Consent Type Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The meaning of consent type code. A list of accepted values is defined in the lookup type ORA_HER_CONSENT_TYPE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CredentialId":{
            "title":"Course Offering Credential ID",
            "type":"integer",
            "description":"The unique identifier of the credential associated with the offering.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RepeatInPeriodFlag":{
            "title":"Allow multiple enrollment",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether a student can enroll in multiple instances of the same course in the same enrollment period. The default value is false.",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "x-queryable":true
        },
        "CreditTypeMeaning":{
            "title":"Type of Credit Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the type of credit assigned to a 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-queryable":true
        },
        "RepeatUnitsTotal":{
            "title":"Total Units Allowed",
            "type":"number",
            "description":"The maximum number of credits that a student can receive for multiple completions of a repeatable course.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":5,
                "scale":2
            },
            "x-queryable":true
        },
        "TypicallyOfferedMeaning":{
            "title":"Typically Offered Meaning",
            "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-queryable":true
        },
        "RepeatAllowedFlag":{
            "title":"Repeatable",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether a course can be repeated. The default value is false.",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "x-queryable":true
        },
        "AcademicLevelId":{
            "title":"Academic Level ID",
            "type":"integer",
            "description":"The unique identifier of the academic level associated with the offering.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RepeatAllowedTotal":{
            "title":"Total Completions Allowed",
            "type":"integer",
            "description":"The total number of times a student can complete a course that's repeatable.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "AcademicSubjectName":{
            "title":"Subject",
            "maxLength":50,
            "type":"string",
            "description":"The name of the course's academic subject.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AcademicLevelName":{
            "title":"Academic Level",
            "maxLength":100,
            "type":"string",
            "description":"The name of the academic level associated with the offering.",
            "nullable":false,
            "readOnly":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,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ConsentTypeCode":{
            "title":"Permission Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of enrollment consent required by the student. A list of accepted values is defined in the lookup type ORA_HER_CONSENT_TYPE. Examples include course instructor, department chair and registrar.",
            "nullable":true,
            "readOnly":true,
            "default":"ORA_NOT_REQUIRED",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ScheduledCourseCount":{
            "title":"Scheduled Course Count",
            "type":"integer",
            "description":"The number of scheduled instances of a course that are available for enrollment as of the current date.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StudentRequestConsentFlag":{
            "title":"Allow permission request",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates that a student can initiate a request for consent or exception in relation to enrollment. The default value is false.",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "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-queryable":true
        },
        "InstitutionId":{
            "title":"Institution",
            "type":"integer",
            "description":"The unique identifier for the institution that owns the course.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TypicallyOfferedCode":{
            "title":"Typically Offered",
            "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":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EnrollConsentRequiredFlag":{
            "title":"Permission required to enroll",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates that a student must obtain consent to enroll in the curriculum item. The default value is false.",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "x-queryable":true
        },
        "CredentialName":{
            "title":"Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the credential associated with the course.",
            "nullable":false,
            "readOnly":true,
            "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
            },
            "x-queryable":true
        },
        "AcademicSubjectCode":{
            "title":"Subject Code",
            "maxLength":30,
            "type":"string",
            "description":"The code for the course's academic subject.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurriculumId":{
            "title":"Curriculum ID",
            "type":"integer",
            "description":"The unique identifier for a curriculum item such as a course.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "ClosestScheduledCourseId":{
            "title":"Closest Scheduled ID",
            "type":"integer",
            "description":"The curriculum identifier for the scheduled instance of a course that has a start date closest to today's date.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreditTypeCode":{
            "title":"Type of Credit",
            "maxLength":30,
            "type":"string",
            "description":"The code for the type of credit assigned to a 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-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
            },
            "x-queryable":true
        },
        "IsWishableFlag":{
            "title":"Wish List Enabled",
            "type":"boolean",
            "description":"Indicates whether the course can be added to the wish list. The default value is true.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "offeringCampuses":{
            "title":"Offering Campuses",
            "type":"array",
            "description":"The offering campuses resource is a child of the programs resource and provides a list of campuses where a program is offered.",
            "items":{
                "$ref":"#/components/schemas/programs-programElements-courseOfferings-offeringCampuses-item-response"
            }
        },
        "offeringAcademicOrganizations":{
            "title":"Offering Academic Organizations",
            "type":"array",
            "description":"The offering academic organizations resource is a child of the programs resource and provides a list of academic organizations associated with a program.",
            "items":{
                "$ref":"#/components/schemas/programs-programElements-courseOfferings-offeringAcademicOrganizations-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 : Offering Academic Organizations

Type: array

Title: Offering Academic Organizations

The offering academic organizations resource is a child of the programs resource and provides a list of academic organizations associated with a program.

Show Source

• Array of: object programs-programElements-courseOfferings-offeringAcademicOrganizations-item-response

{
    "title":"Offering Academic Organizations",
    "type":"array",
    "description":"The offering academic organizations resource is a child of the programs resource and provides a list of academic organizations associated with a program.",
    "items":{
        "$ref":"#/components/schemas/programs-programElements-courseOfferings-offeringAcademicOrganizations-item-response"
    }
}

Nested Schema : Offering Campuses

Type: array

Title: Offering Campuses

The offering campuses resource is a child of the programs resource and provides a list of campuses where a program is offered.

Show Source

• Array of: object programs-programElements-courseOfferings-offeringCampuses-item-response

{
    "title":"Offering Campuses",
    "type":"array",
    "description":"The offering campuses resource is a child of the programs resource and provides a list of campuses where a program is offered.",
    "items":{
        "$ref":"#/components/schemas/programs-programElements-courseOfferings-offeringCampuses-item-response"
    }
}

Nested Schema : programs-programElements-courseOfferings-offeringAcademicOrganizations-item-response

Type: object

Show Source

• AcademicOrgId: integer (int64)
  Title: Academic Organization ID

  Read Only: true

  The generated primary key column for an offering academic organization.
• AcademicOrgName: string
  Title: Academic Organization

  Read Only: true

  Maximum Length: 50

  The name of the academic organization associated with the offering.
• CurriculumOrgId: integer (int64)
  Title: Curriculum Organization ID

  Read Only: true

  The identifier of the academic organization that owns the program.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• offeringOrganizationStaff: array Offering Organization Staff
  Title: Offering Organization Staff

  The offering organization staff resource is a child of the offering academic organizations resource and provides a list of staff associated with a program.

{
    "type":"object",
    "properties":{
        "offeringOrganizationStaff":{
            "title":"Offering Organization Staff",
            "type":"array",
            "description":"The offering organization staff resource is a child of the offering academic organizations resource and provides a list of staff associated with a program.",
            "items":{
                "$ref":"#/components/schemas/programs-programElements-courseOfferings-offeringAcademicOrganizations-offeringOrganizationStaff-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CurriculumOrgId":{
            "title":"Curriculum Organization ID",
            "type":"integer",
            "description":"The identifier of the academic organization that owns the program.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "AcademicOrgId":{
            "title":"Academic Organization ID",
            "type":"integer",
            "description":"The generated primary key column for an offering academic organization.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AcademicOrgName":{
            "title":"Academic Organization",
            "maxLength":50,
            "type":"string",
            "description":"The name of the academic organization associated with the offering.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "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 : Offering Organization Staff

Type: array

Title: Offering Organization Staff

The offering organization staff resource is a child of the offering academic organizations resource and provides a list of staff associated with a program.

Show Source

• Array of: object programs-programElements-courseOfferings-offeringAcademicOrganizations-offeringOrganizationStaff-item-response

{
    "title":"Offering Organization Staff",
    "type":"array",
    "description":"The offering organization staff resource is a child of the offering academic organizations resource and provides a list of staff associated with a program.",
    "items":{
        "$ref":"#/components/schemas/programs-programElements-courseOfferings-offeringAcademicOrganizations-offeringOrganizationStaff-item-response"
    }
}

Nested Schema : programs-programElements-courseOfferings-offeringAcademicOrganizations-offeringOrganizationStaff-item-response

Type: object

Show Source

• CurriculumStaffId: integer (int64)
  Title: Curriculum Staff ID

  Read Only: true

  The generated primary key column for a curriculum staff record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PersonAcademicTitle: string
  Title: Academic Title

  Read Only: true

  Maximum Length: 30

  The academic title of the program staff person.
• PersonImageContent: string (byte)
  Title: Staff Image

  Read Only: true

  The content of a staff attachment such as an image file.
• PersonImageId: integer (int64)
  Title: Attachment ID

  Read Only: true

  A unique identifier for an attachment associated with a program.
• PersonName: string
  Title: Name

  Read Only: true

  Maximum Length: 450

  The name of a program staff person.
• PersonTitle: string
  Title: Title

  Read Only: true

  Maximum Length: 60

  The title of the program staff person.
• StaffBiography: string
  Title: Biography

  Read Only: true

  The text providing biographical or background information on a staff member.
• StaffPrimaryFlag: boolean
  Title: Primary

  Read Only: true

  Maximum Length: 1

  Identifies the primary staff member for a program. When yes, the staff row is considered the primary staff resource for the program. The default value is false. If only one record exists, the default value is true.
• StaffRoleTypeCode: string
  Title: Role Type

  Read Only: true

  Maximum Length: 30

  A code identifying the role of a program staff member. A list of accepted values is defined in the lookup type ORA_HER_STAFF_ROLE_TYPE_CODE.
• StaffRoleTypeMeaning: string
  Title: Role Meaning

  Read Only: true

  Maximum Length: 80

  The meaning of the role code of the program staff member. A list of accepted values is defined in the lookup type ORA_HER_STAFF_ROLE_TYPE_CODE.
• StaffSequenceNumber: integer (int32)
  Title: Staff Sequence Number

  Read Only: true

  The sequence number of a staff row associated with a program.

{
    "type":"object",
    "properties":{
        "PersonImageContent":{
            "title":"Staff Image",
            "type":"string",
            "description":"The content of a staff attachment such as an image file.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonName":{
            "title":"Name",
            "maxLength":450,
            "type":"string",
            "description":"The name of a program staff person.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Name",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "StaffPrimaryFlag":{
            "title":"Primary",
            "maxLength":1,
            "type":"boolean",
            "description":"Identifies the primary staff member for a program. When yes, the staff row is considered the primary staff resource for the program. The default value is false. If only one record exists, the default value is true.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StaffRoleTypeMeaning":{
            "title":"Role Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the role code of the program staff member. A list of accepted values is defined in the lookup type ORA_HER_STAFF_ROLE_TYPE_CODE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StaffBiography":{
            "title":"Biography",
            "type":"string",
            "description":"The text providing biographical or background information on a staff member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StaffSequenceNumber":{
            "title":"Staff Sequence Number",
            "type":"integer",
            "description":"The sequence number of a staff row associated with a program.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "PersonImageId":{
            "title":"Attachment ID",
            "type":"integer",
            "description":"A unique identifier for an attachment associated with a program.",
            "format":"int64",
            "nullable":true,
            "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"
            }
        },
        "PersonAcademicTitle":{
            "title":"Academic Title",
            "maxLength":30,
            "type":"string",
            "description":"The academic title of the program staff person.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StaffRoleTypeCode":{
            "title":"Role Type",
            "maxLength":30,
            "type":"string",
            "description":"A code identifying the role of a program staff member. A list of accepted values is defined in the lookup type ORA_HER_STAFF_ROLE_TYPE_CODE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurriculumStaffId":{
            "title":"Curriculum Staff ID",
            "type":"integer",
            "description":"The generated primary key column for a curriculum staff record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "PersonTitle":{
            "title":"Title",
            "maxLength":60,
            "type":"string",
            "description":"The title of the program staff person.",
            "nullable":true,
            "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 : programs-programElements-courseOfferings-offeringCampuses-item-response

Type: object

Show Source

• CampusId: integer (int64)
  Title: Campus

  Read Only: true

  A unique identifier for the campus where the program is offered.
• CampusName: string
  Title: Name

  Read Only: true

  Maximum Length: 50

  The name of the campus where the program is offered.
• 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"
            }
        },
        "CampusId":{
            "title":"Campus",
            "type":"integer",
            "description":"A unique identifier for the campus where the program is offered.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "queryAttribute":"CampusIds",
                "controlType":"choice",
                "precision":18,
                "sortNumber":"100",
                "facetControl":"multiSelect",
                "title":"Campus",
                "queryType":"finder"
            },
            "x-queryable":true
        },
        "CampusName":{
            "title":"Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the campus where the program is offered.",
            "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 : programs-programElements-offeringCampuses-item-response

Type: object

Show Source

• CampusId: integer (int64)
  Title: Campus

  Read Only: true

  A unique identifier for the campus where the program is offered.
• CampusName: string
  Title: Name

  Read Only: true

  Maximum Length: 50

  The name of the campus where the program is offered.
• 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"
            }
        },
        "CampusId":{
            "title":"Campus",
            "type":"integer",
            "description":"A unique identifier for the campus where the program is offered.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "queryAttribute":"CampusIds",
                "controlType":"choice",
                "precision":18,
                "sortNumber":"100",
                "facetControl":"multiSelect",
                "title":"Campus",
                "queryType":"finder"
            },
            "x-queryable":true
        },
        "CampusName":{
            "title":"Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the campus where the program is offered.",
            "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 : programs-programElements-parameters-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MaximumCoursesQuantity: integer (int32)
  Title: Maximum Number of Courses

  Read Only: true

  Default Value: 0

  The maximum number of courses that can be taken toward satisfying a program parameter.
• MaximumUnitsQuantity: integer (int32)
  Title: Maximum Units

  Read Only: true

  Default Value: 0

  The maximum number of credits available for a program.
• MinimumCoursesQuantity: integer (int32)
  Title: Minimum Number of Courses

  Read Only: true

  Default Value: 0

  The minimum number of courses that must be taken toward satisfying a program parameter.
• MinimumUnitsQuantity: integer (int32)
  Title: Minimum Units

  Read Only: true

  Default Value: 0

  The minimum number of credits available for a program.
• ParameterId: integer (int64)
  Title: Curriculum Parameter ID

  Read Only: true

  The unique identifier for a parameter that's associated with a program element.
• ParameterSequenceNumber: integer (int32)
  Title: Parameter Sequence Number

  Read Only: true

  The sequence number for a program parameter row.
• RequirementCategoryCode: string
  Title: Requirement Category Code

  Read Only: true

  Maximum Length: 30

  A code that categorizes program course requirements.
• RequirementCategoryId: integer (int64)
  Title: Requirement Category ID

  Read Only: true

  The unique identifier for a requirement category code assigned to a program parameter.
• RequirementCategoryName: string
  Title: Name

  Read Only: true

  Maximum Length: 50

  The name of the requirement category code.

{
    "type":"object",
    "properties":{
        "MaximumCoursesQuantity":{
            "title":"Maximum Number of Courses",
            "type":"integer",
            "description":"The maximum number of courses that can be taken toward satisfying a program parameter.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "default":0,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "ParameterSequenceNumber":{
            "title":"Parameter Sequence Number",
            "type":"integer",
            "description":"The sequence number for a program parameter row.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "MinimumUnitsQuantity":{
            "title":"Minimum Units",
            "type":"integer",
            "description":"The minimum number of credits available for a program.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "default":0,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "RequirementCategoryId":{
            "title":"Requirement Category ID",
            "type":"integer",
            "description":"The unique identifier for a requirement category code assigned to a program parameter.",
            "format":"int64",
            "nullable":true,
            "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"
            }
        },
        "RequirementCategoryName":{
            "title":"Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the requirement category code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MinimumCoursesQuantity":{
            "title":"Minimum Number of Courses",
            "type":"integer",
            "description":"The minimum number of courses that must be taken toward satisfying a program parameter.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "default":0,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "MaximumUnitsQuantity":{
            "title":"Maximum Units",
            "type":"integer",
            "description":"The maximum number of credits available for a program.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "default":0,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "ParameterId":{
            "title":"Curriculum Parameter ID",
            "type":"integer",
            "description":"The unique identifier for a parameter that's associated with a program element.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "RequirementCategoryCode":{
            "title":"Requirement Category Code",
            "maxLength":30,
            "type":"string",
            "description":"A code that categorizes program course requirements.",
            "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 : programs-programElements-requisites-item-response

Type: object

Show Source

• CurriculumId: integer (int64)
  Title: Requisite Curriculum ID

  Read Only: true

  The unique identifier for a course which is a requisite for the program element.
• CurriculumName: string
  Title: Name

  Read Only: true

  Maximum Length: 150

  The name of the course which is a requisite for the program element.
• CurriculumRequisiteId: integer (int64)
  Title: Curriculum Requisite ID

  Read Only: true

  The generated primary key column for a requisite.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RequisiteSchemeId: integer (int64)
  Title: Requisite Scheme ID

  Read Only: true

  The unique identifier for the scheme associated with the requisite.
• RequisiteTypeCode: string
  Title: Requisite Type Code

  Read Only: true

  Maximum Length: 30

  A code that indicates the type of requisite. Valid values include ORA_CO or ORA_PRE. A list of accepted values is defined in the lookup type ORA_HER_REQUISITE_TYPE_CODE.
• RequisiteTypeMeaning: string
  Title: Requisite Type

  Read Only: true

  Maximum Length: 80

  The meaning of the requisite type. Valid values include Corequisite or Prerequisite. A list of accepted values is defined in the lookup type ORA_HER_REQUISITE_TYPE_CODE.
• SchemeName: string
  Title: Requisite Scheme

  Read Only: true

  Maximum Length: 50

  The name of the scheme associated with the requisite.
• SortSequenceNumber: integer (int32)
  Title: Sort Sequence Number

  Read Only: true

  A sequence number that overrides the default sort order for the requisite.

{
    "type":"object",
    "properties":{
        "CurriculumRequisiteId":{
            "title":"Curriculum Requisite ID",
            "type":"integer",
            "description":"The generated primary key column for a requisite.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CurriculumId":{
            "title":"Requisite Curriculum ID",
            "type":"integer",
            "description":"The unique identifier for a course which is a requisite for the program element.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RequisiteSchemeId":{
            "title":"Requisite Scheme ID",
            "type":"integer",
            "description":"The unique identifier for the scheme associated with the requisite.",
            "format":"int64",
            "nullable":true,
            "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"
            }
        },
        "SchemeName":{
            "title":"Requisite Scheme",
            "maxLength":50,
            "type":"string",
            "description":"The name of the scheme associated with the requisite.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurriculumName":{
            "title":"Name",
            "maxLength":150,
            "type":"string",
            "description":"The name of the course which is a requisite for the program element.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RequisiteTypeCode":{
            "title":"Requisite Type Code",
            "maxLength":30,
            "type":"string",
            "description":"A code that indicates the type of requisite. Valid values include ORA_CO or ORA_PRE. A list of accepted values is defined in the lookup type ORA_HER_REQUISITE_TYPE_CODE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RequisiteTypeMeaning":{
            "title":"Requisite Type",
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the requisite type. Valid values include Corequisite or Prerequisite. A list of accepted values is defined in the lookup type ORA_HER_REQUISITE_TYPE_CODE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SortSequenceNumber":{
            "title":"Sort Sequence Number",
            "type":"integer",
            "description":"A sequence number that overrides the default sort order for the requisite.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "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 : programs-programElements-staffSummary-item-response

Type: object

Show Source

• AcademicPeriodId: integer (int64)
  Title: Academic Period ID

  Read Only: true

  The unique identifier for an academic period.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PeriodName: string
  Title: Period Name

  Read Only: true

  Maximum Length: 50

  The name of the academic period.
• PersonName: string
  Title: Name

  Read Only: true

  Maximum Length: 450

  The name of the staff member associated with the course.
• PrimaryFlag: boolean
  Title: Primary

  Read Only: true

  Maximum Length: 1

  Identifies the primary staff member for a program or course. When yes, the staff row is considered the primary staff resource. The default value is false. If only one record exists, the default value is true.
• ReportingPeriodId: integer (int64)
  Title: Reporting Period ID

  Read Only: true

  The unique identifier for a reporting period.
• ReportingPeriodName: string
  Title: Reporting Period Name

  Read Only: true

  Maximum Length: 50

  The name of the reporting period.
• RoleAccessCode: string
  Title: Role Access

  Read Only: true

  Maximum Length: 30

  The code for the role access of the staff member in relation to a curriculum item. Valid values include ORA_GRADE and ORA_POC. A list of accepted values is defined in the lookup type ORA_HER_STAFF_ROLE_ACCESS_CODE.
• RoleAccessMeaning: string
  Title: Role Access Code Meaning

  Read Only: true

  Maximum Length: 80

  The meaning of a staff role access value. Valid values include Grader or Point of contact. A list of accepted values is defined in the lookup type ORA_HER_STAFF_ROLE_ACCESS_CODE.
• RoleTypeCode: string
  Title: Role Type

  Read Only: true

  Maximum Length: 30

  The role type of the staff member in relation to a curriculum item. A list of accepted values is defined in the lookup type ORA_HER_STAFF_ROLE_TYPE_CODE.
• RoleTypeMeaning: string
  Title: Role Type Code Meaning

  Read Only: true

  Maximum Length: 80

  The meaning of a staff role type value. A list of accepted values is defined in the lookup type ORA_HER_STAFF_ROLE_TYPE_CODE.

{
    "type":"object",
    "properties":{
        "PersonName":{
            "title":"Name",
            "maxLength":450,
            "type":"string",
            "description":"The name of the staff member associated with the course.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Name",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "PrimaryFlag":{
            "title":"Primary",
            "maxLength":1,
            "type":"boolean",
            "description":"Identifies the primary staff member for a program or course. When yes, the staff row is considered the primary staff resource. The default value is false. If only one record exists, the default value is true.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RoleTypeCode":{
            "title":"Role Type",
            "maxLength":30,
            "type":"string",
            "description":"The role type of the staff member in relation to a curriculum item. A list of accepted values is defined in the lookup type ORA_HER_STAFF_ROLE_TYPE_CODE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RoleTypeMeaning":{
            "title":"Role Type Code Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The meaning of a staff role type value. A list of accepted values is defined in the lookup type ORA_HER_STAFF_ROLE_TYPE_CODE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RoleAccessMeaning":{
            "title":"Role Access Code Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The meaning of a staff role access value. Valid values include Grader or Point of contact. A list of accepted values is defined in the lookup type ORA_HER_STAFF_ROLE_ACCESS_CODE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RoleAccessCode":{
            "title":"Role Access",
            "maxLength":30,
            "type":"string",
            "description":"The code for the role access of the staff member in relation to a curriculum item. Valid values include ORA_GRADE and ORA_POC. A list of accepted values is defined in the lookup type ORA_HER_STAFF_ROLE_ACCESS_CODE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ReportingPeriodId":{
            "title":"Reporting Period ID",
            "type":"integer",
            "description":"The unique identifier for a reporting period.",
            "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"
            }
        },
        "PeriodName":{
            "title":"Period Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the academic period.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AcademicPeriodId":{
            "title":"Academic Period ID",
            "type":"integer",
            "description":"The unique identifier for an academic period.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ReportingPeriodName":{
            "title":"Reporting Period Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the reporting period.",
            "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 : programs-programElements-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.
• CurriculumTagId: integer (int64)
  Title: Curriculum Tag ID

  Read Only: true

  The generated primary key column for a curriculum tag.
• 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)
  Title: Curriculum Tag Name ID

  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 curriculum tag value.
• CurriculumTagValueCode: string
  Title: Tag Value Code

  Read Only: true

  Maximum Length: 30

  The code of the curriculum tag value.
• CurriculumTagValueId: integer (int64)
  Title: Curriculum Tag Value ID

  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-queryable":true
        },
        "CurriculumTagValueId":{
            "title":"Curriculum Tag Value ID",
            "type":"integer",
            "description":"The unique identifier of a tag value for a course.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "queryAttribute":"CurriculumTagValueIds",
                "controlType":"choice",
                "precision":18,
                "sortNumber":"20",
                "facetControl":"multiSelect",
                "title":"Area of Study",
                "queryType":"finder"
            },
            "x-queryable":true
        },
        "CurriculumTagId":{
            "title":"Curriculum Tag ID",
            "type":"integer",
            "description":"The generated primary key column for a curriculum tag.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "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-queryable":true
        },
        "CurriculumTagName":{
            "title":"Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the tag for a course.",
            "nullable":false,
            "readOnly":true,
            "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-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 curriculum tag value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurriculumTagNameId":{
            "title":"Curriculum Tag Name ID",
            "type":"integer",
            "description":"The unique identifier of a tag name for a course.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "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