Jump to

• Request
• Response

Get a program

get

/fscmRestApi/resources/11.13.18.05/curriculumItems/{curriculumItemsUniqID}/child/program/{programUniqID}

Request

Path Parameters

• curriculumItemsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Curriculum Items resource and used to uniquely identify an instance of Curriculum Items. The client should not generate the hash key value. Instead, the client should query on the Curriculum Items collection resource in order to navigate to a specific instance of Curriculum Items to get the hash key.
• programUniqID(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
• 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
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Header Parameters

• Effective-Of:
  This header accepts a string value. The string is a semi-colon separated list of =. It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers.
• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

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

Body ()

Root Schema : curriculumItems-program-item-response

Type: object

Show Source

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

  Read Only: true

  The unique identifier for an academic level value that's associated with a program.
• AcademicLevelName: string
  Title: Academic Level Name

  Read Only: true

  Maximum Length: 100

  The name of an academic level value that's associated with a program.
• AdmissionRequiredFlag: boolean
  Title: Admission Required

  Read Only: true

  Maximum Length: 1

  Default Value: true

  Indicates if a person must be formally admitted to a program. If yes, admission is required. If no, a person can join the program without requesting admission.
• CampusId: integer
  Title: Campus ID

  Read Only: true

  The unique identifier for a campus that's associated with a program.
• CampusName: string
  Title: Name

  Read Only: true

  The name of the campus where this program is offered.
• CredentialId: integer
  Title: Program Credential ID

  Read Only: true

  The credential associated with the program.
• CredentialName: string
  Title: Name

  Read Only: true

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

  Read Only: true

  Maximum Length: 30

  A code for the type of credit used in a program. 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 credit type code for a program. 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.
• CurriculumFormatCode: string
  Title: Format

  Read Only: true

  Maximum Length: 30

  A code for the format, such as online, in which a program is offered. 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 a program format code. 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 program.
• CurriculumLongDescription: string
  Title: Long Description

  Read Only: true

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

  Read Only: true

  Maximum Length: 150

  The name of the program or academic group associated with this student curriculum item.
• CurriculumStatusCode: string
  Title: Status

  Read Only: true

  Maximum Length: 30

  The status code for a program.
• CurriculumTitle: string
  Title: Title

  Read Only: true

  Maximum Length: 100

  The title or formal description of a program.
• EnforceRequirementSequenceFlag: boolean
  Title: List by Sequence

  Read Only: true

  Maximum Length: 1

  Default Value: false

  Determines the sort order of child courses for a program. If yes, courses are sorted by sequence number. If no, courses are sorted by requirement category and sequence number.
• FirstAdmitDate: string (date)
  Title: First Admit Date

  Read Only: true

  The first date when a program is available for admission.
• images: array Images
  Title: Images

  The images resource is a child of the courses resource and provides a list of image attachments associated with a course.
• InstitutionId: integer (int64)
  Title: Institution

  Read Only: true

  The identifier for the institution to which the program belongs.
• IsCartableFlag: boolean
  Title: Shopping Cart Enabled

  Read Only: true

  Maximum Length: 255

  Indicates whether a program is available for the shopping cart. If yes, a user can add the program to their shopping cart. If no, the add to shopping cart option isn't available. The default value is yes.
• IsWishableFlag: boolean
  Title: Wish List Enabled

  Read Only: true

  Maximum Length: 255

  Indicates whether a program can be added to a user's wish list. If yes, a user can add the program to their wish list. If no, the add to wish list option isn't available. The default value is yes.
• LastAdmitDate: string (date)
  Title: Last Admit Date

  Read Only: true

  The last date when a program is available for admission.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MaximumTimespanMeasure: string
  Title: Maximum Duration

  Read Only: true

  Maximum Length: 30

  A unit of measure for the maximum length of time allowed to complete the program. A list of accepted values is defined in the lookup type ORA_HER_TIMESPAN_MEASURE.
• MaximumTimespanMeasureMeaning: string
  Title: Maximum Duration Meaning

  Read Only: true

  Maximum Length: 80

  The meaning of the unit of measure for the maximum length of time allowed to complete the program. A list of accepted values is defined in the lookup type ORA_HER_TIMESPAN_MEASURE.
• MaximumTimespanQuantity: integer
  Title: Maximum Duration Quantity

  Read Only: true

  Along with the unit of measure, this defines the maximum length of time allowed to complete the program.
• offeringCampuses: array Offering Campuses
  Title: Offering Campuses

  The offering campuses resource is a child of the course offerings resource and provides a list of campuses associated with a course offering.
• offeringCredentials: array Offering Credentials
  Title: Offering Credentials

  The offering credentials resource is a child of the programs resource and provides a list of credentials available for a program.
• 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.
• ProgramTypeId: integer (int64)
  Title: Program Type ID

  Read Only: true

  The unique identifier for a program type that's associated with a program.
• ProgramTypeMainFlag: boolean
  Title: Main Program

  Read Only: true

  Maximum Length: 1

  Indicates whether a program is a main program.
• ProgramTypeName: string
  Title: Program Type

  Read Only: true

  Maximum Length: 50

  The meaning of a program type that's associated with a program.
• 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.
• TypicalTimespanMeasure: string
  Title: Duration Measurement

  Read Only: true

  Maximum Length: 30

  A code that indicates the type of units used to express the typical time duration for a program. A list of accepted values is defined in the lookup type ORA_HER_TIMESPAN_MEASURE.
• TypicalTimespanMeasureMeaning: string
  Title: Typical Time Span

  Read Only: true

  Maximum Length: 80

  The meaning of the unit of measurement code for the typical duration of program, such as months or years. A list of accepted values is defined in the lookup type ORA_HER_TIMESPAN_MEASURE.
• TypicalTimespanQuantity: integer
  Title: Typical Duration

  Read Only: true

  The number of time span units used to express the typical duration of a program, such as 4 years.
• URLAddress: string
  Title: URL Address

  Read Only: true

  The URL for a web page associated with a program.

{
    "type":"object",
    "properties":{
        "CredentialId":{
            "title":"Program Credential ID",
            "type":"integer",
            "description":"The credential associated with the program.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "offeringCredentials":{
            "title":"Offering Credentials",
            "type":"array",
            "description":"The offering credentials resource is a child of the programs resource and provides a list of credentials available for a program.",
            "items":{
                "$ref":"#/components/schemas/curriculumItems-program-offeringCredentials-item-response"
            }
        },
        "LastAdmitDate":{
            "title":"Last Admit Date",
            "type":"string",
            "description":"The last date when a program is available for admission.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurriculumName":{
            "title":"Name",
            "maxLength":"150",
            "type":"string",
            "description":"The name of the program or academic group associated with this student curriculum item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CampusName":{
            "title":"Name",
            "type":"string",
            "description":"The name of the campus where this program is offered.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreditTypeMeaning":{
            "title":"Type of Credit Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of the credit type code for a program. 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
        },
        "TypicalTimespanMeasure":{
            "title":"Duration Measurement",
            "maxLength":"30",
            "type":"string",
            "description":"A code that indicates the type of units used to express the typical time duration for a program. A list of accepted values is defined in the lookup type ORA_HER_TIMESPAN_MEASURE.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProgramTypeMainFlag":{
            "title":"Main Program",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether a program is a main program.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EnforceRequirementSequenceFlag":{
            "title":"List by Sequence",
            "maxLength":"1",
            "type":"boolean",
            "description":"Determines the sort order of child courses for a program. If yes, courses are sorted by sequence number. If no, courses are sorted by requirement category and sequence number.",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "x-queryable":true
        },
        "URLAddress":{
            "title":"URL Address",
            "type":"string",
            "description":"The URL for a web page associated with a program.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AcademicLevelId":{
            "title":"Academic Level ID",
            "type":"integer",
            "description":"The unique identifier for an academic level value that's associated with a program.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "IsCartableFlag":{
            "title":"Shopping Cart Enabled",
            "maxLength":"255",
            "type":"boolean",
            "description":"Indicates whether a program is available for the shopping cart. If yes, a user can add the program to their shopping cart. If no, the add to shopping cart option isn't available. The default value is yes.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AcademicLevelName":{
            "title":"Academic Level Name",
            "maxLength":"100",
            "type":"string",
            "description":"The name of an academic level value that's associated with a program.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ProgramTypeName":{
            "title":"Program Type",
            "maxLength":"50",
            "type":"string",
            "description":"The meaning of a program type that's associated with a program.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AdmissionRequiredFlag":{
            "title":"Admission Required",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if a person must be formally admitted to a program. If yes, admission is required. If no, a person can join the program without requesting admission.",
            "nullable":false,
            "readOnly":true,
            "default":true,
            "x-queryable":true
        },
        "images":{
            "title":"Images",
            "type":"array",
            "description":"The images resource is a child of the courses resource and provides a list of image attachments associated with a course.",
            "items":{
                "$ref":"#/components/schemas/curriculumItems-program-images-item-response"
            }
        },
        "CurriculumFormatMeaning":{
            "title":"Curriculum Format Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of a program format code. 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":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TypicalTimespanQuantity":{
            "title":"Typical Duration",
            "type":"integer",
            "description":"The number of time span units used to express the typical duration of a program, such as 4 years.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InstitutionId":{
            "title":"Institution",
            "type":"integer",
            "description":"The identifier for the institution to which the program belongs.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CredentialName":{
            "title":"Name",
            "type":"string",
            "description":"The name of the credential associated with the program.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MaximumTimespanQuantity":{
            "title":"Maximum Duration Quantity",
            "type":"integer",
            "description":"Along with the unit of measure, this defines the maximum length of time allowed to complete the program.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TypicalTimespanMeasureMeaning":{
            "title":"Typical Time Span",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of the unit of measurement code for the typical duration of program, such as months or years. A list of accepted values is defined in the lookup type ORA_HER_TIMESPAN_MEASURE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurriculumLongDescription":{
            "title":"Long Description",
            "type":"string",
            "description":"The long description for a program.",
            "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/curriculumItems-program-tags-item-response"
            }
        },
        "CurriculumFormatCode":{
            "title":"Format",
            "maxLength":"30",
            "type":"string",
            "description":"A code for the format, such as online, in which a program is offered. 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
        },
        "CurriculumStatusCode":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"The status code for a program.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurriculumId":{
            "title":"Curriculum ID",
            "type":"integer",
            "description":"The generated primary key column for a program.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ProgramTypeId":{
            "title":"Program Type ID",
            "type":"integer",
            "description":"The unique identifier for a program type that's associated with a program.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreditTypeCode":{
            "title":"Type of Credit",
            "maxLength":"30",
            "type":"string",
            "description":"A code for the type of credit used in a program. 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
        },
        "IsWishableFlag":{
            "title":"Wish List Enabled",
            "maxLength":"255",
            "type":"boolean",
            "description":"Indicates whether a program can be added to a user's wish list. If yes, a user can add the program to their wish list. If no, the add to wish list option isn't available. The default value is yes.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MaximumTimespanMeasure":{
            "title":"Maximum Duration",
            "maxLength":"30",
            "type":"string",
            "description":"A unit of measure for the maximum length of time allowed to complete the program. A list of accepted values is defined in the lookup type ORA_HER_TIMESPAN_MEASURE.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MaximumTimespanMeasureMeaning":{
            "title":"Maximum Duration Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of the unit of measure for the maximum length of time allowed to complete the program. A list of accepted values is defined in the lookup type ORA_HER_TIMESPAN_MEASURE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CampusId":{
            "title":"Campus ID",
            "type":"integer",
            "description":"The unique identifier for a campus that's associated with a program.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "offeringCampuses":{
            "title":"Offering Campuses",
            "type":"array",
            "description":"The offering campuses resource is a child of the course offerings resource and provides a list of campuses associated with a course offering.",
            "items":{
                "$ref":"#/components/schemas/curriculumItems-program-offeringCampuses-item-response"
            }
        },
        "FirstAdmitDate":{
            "title":"First Admit Date",
            "type":"string",
            "description":"The first date when a program is available for admission.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "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/curriculumItems-program-parameters-item-response"
            }
        },
        "CurriculumTitle":{
            "title":"Title",
            "maxLength":"100",
            "type":"string",
            "description":"The title or formal description of a program.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Images

Type: array

Title: Images

The images resource is a child of the courses resource and provides a list of image attachments associated with a course.

Show Source

• Array of: object curriculumItems-program-images-item-response

{
    "title":"Images",
    "type":"array",
    "description":"The images resource is a child of the courses resource and provides a list of image attachments associated with a course.",
    "items":{
        "$ref":"#/components/schemas/curriculumItems-program-images-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 Campuses

Type: array

Title: Offering Campuses

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

Show Source

• Array of: object curriculumItems-program-offeringCampuses-item-response

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

Nested Schema : Offering Credentials

Type: array

Title: Offering Credentials

The offering credentials resource is a child of the programs resource and provides a list of credentials available for a program.

Show Source

• Array of: object curriculumItems-program-offeringCredentials-item-response

{
    "title":"Offering Credentials",
    "type":"array",
    "description":"The offering credentials resource is a child of the programs resource and provides a list of credentials available for a program.",
    "items":{
        "$ref":"#/components/schemas/curriculumItems-program-offeringCredentials-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 curriculumItems-program-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/curriculumItems-program-parameters-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 curriculumItems-program-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/curriculumItems-program-tags-item-response"
    }
}

Nested Schema : curriculumItems-program-images-item-response

Type: object

Show Source

• ImageContent: string (byte)
  Title: Attachment Content

  Read Only: true

  The content of the attachment associated with the course.
• ImageContextCode: string
  Title: Curriculum Attachment Context

  Read Only: true

  Maximum Length: 30

  The context name of the attachment associated with the course.
• ImageId: integer (int64)
  Title: Curriculum Attachment ID

  Read Only: true

  The unique identifier of the attachment associated with the course.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "ImageId":{
            "title":"Curriculum Attachment ID",
            "type":"integer",
            "description":"The unique identifier of the attachment associated with the course.",
            "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"
            }
        },
        "ImageContent":{
            "title":"Attachment Content",
            "type":"string",
            "description":"The content of the attachment associated with the course.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ImageContextCode":{
            "title":"Curriculum Attachment Context",
            "maxLength":"30",
            "type":"string",
            "description":"The context name of the attachment associated with the course.",
            "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 : 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 : curriculumItems-program-offeringCampuses-item-response

Type: object

Show Source

• CampusId: integer (int64)
  Title: Campus

  Read Only: true

  The unique identifier for the campus where a course is offered.
• CampusName: string
  Title: Name

  Read Only: true

  Maximum Length: 50

  The name of the campus where a course is offered.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "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":"The unique identifier for the campus where a course 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 a course 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 : curriculumItems-program-offeringCredentials-item-response

Type: object

Show Source

• CredentialDisplaySequence: integer (int32)
  Title: Display Sequence

  Read Only: true

  A sequence number that overrides the default sort order for a program's credentials.
• CredentialFormalName: string
  Read Only: true

  Maximum Length: 100

  The formal name of the credential.
• CredentialId: integer (int64)
  Title: Credential

  Read Only: true

  The unique identifier for a credential value that's associated with a program.
• CredentialName: string
  Title: Name

  Read Only: true

  Maximum Length: 50

  The name of the credential.
• FinalCredentialFlag: boolean
  Title: Final Credential

  Read Only: true

  Maximum Length: 1

  An indicator that identifies a credential as the final or maximum credential available for a program.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "FinalCredentialFlag":{
            "title":"Final Credential",
            "maxLength":"1",
            "type":"boolean",
            "description":"An indicator that identifies a credential as the final or maximum credential available for a program.",
            "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"
            }
        },
        "CredentialDisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"A sequence number that overrides the default sort order for a program's credentials.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "CredentialFormalName":{
            "maxLength":"100",
            "type":"string",
            "description":"The formal name of the credential.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CredentialId":{
            "title":"Credential",
            "type":"integer",
            "description":"The unique identifier for a credential value that's associated with a program.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CredentialName":{
            "title":"Name",
            "maxLength":"50",
            "type":"string",
            "description":"The name of the credential.",
            "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 : curriculumItems-program-parameters-item-response

Type: object

Show Source

• ContactHoursQuantity: integer (int32)
  Title: Contact Hours

  Read Only: true

  Default Value: 0

  The number of contact hours required to satisfy a program parameter.
• DisplaySequenceNumber: integer (int32)
  Title: Display Sequence

  Read Only: true

  A sequence number that overrides the default sort order for a program's child courses.
• 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.
• 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
        },
        "ContactHoursQuantity":{
            "title":"Contact Hours",
            "type":"integer",
            "description":"The number of contact hours required to satisfy a program parameter.",
            "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
        },
        "DisplaySequenceNumber":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"A sequence number that overrides the default sort order for a program's child courses.",
            "format":"int32",
            "nullable":false,
            "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"
            }
        },
        "RequirementCategoryName":{
            "title":"Name",
            "maxLength":"50",
            "type":"string",
            "description":"The name of the requirement category code.",
            "nullable":false,
            "readOnly":true,
            "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
        },
        "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
        },
        "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 : curriculumItems-program-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 tag value for a course.
• CurriculumTagValueCode: string
  Title: Tag Value Code

  Read Only: true

  Maximum Length: 30

  The code of the curriculum tag value.
• CurriculumTagValueId: integer (int64)
  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 tag value for a course.",
            "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"
    }
}

Links

images

Operation: /fscmRestApi/resources/11.13.18.05/curriculumItems/{curriculumItemsUniqID}/child/program/{programUniqID}/child/images

Parameters:

• curriculumItemsUniqID: $request.path.curriculumItemsUniqID
• programUniqID: $request.path.programUniqID

The images resource is a child of the courses resource and provides a list of image attachments associated with a course.

offeringCampuses

Operation: /fscmRestApi/resources/11.13.18.05/curriculumItems/{curriculumItemsUniqID}/child/program/{programUniqID}/child/offeringCampuses

Parameters:

• curriculumItemsUniqID: $request.path.curriculumItemsUniqID
• programUniqID: $request.path.programUniqID

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

offeringCredentials

Operation: /fscmRestApi/resources/11.13.18.05/curriculumItems/{curriculumItemsUniqID}/child/program/{programUniqID}/child/offeringCredentials

Parameters:

• curriculumItemsUniqID: $request.path.curriculumItemsUniqID
• programUniqID: $request.path.programUniqID

The offering credentials resource is a child of the programs resource and provides a list of credentials available for a program.

parameters

Operation: /fscmRestApi/resources/11.13.18.05/curriculumItems/{curriculumItemsUniqID}/child/program/{programUniqID}/child/parameters

Parameters:

• curriculumItemsUniqID: $request.path.curriculumItemsUniqID
• programUniqID: $request.path.programUniqID

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

tags

Operation: /fscmRestApi/resources/11.13.18.05/curriculumItems/{curriculumItemsUniqID}/child/program/{programUniqID}/child/tags

Parameters:

• curriculumItemsUniqID: $request.path.curriculumItemsUniqID
• programUniqID: $request.path.programUniqID

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

Back to Top