Jump to

• Request
• Response

Get all curriculum item current instances

get

/fscmRestApi/resources/11.13.18.05/curriculumCurrentItemsLOV

Request

Query Parameters

• 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
  
  

  • ByCurriculumTypeFinder Finds active current curriculum instances that match the criteria specified.
    Finder Variables
    • CurriculumTypeCodes; string; Only the active and current curriculum instances which match the passed curriculum types are returned.
    • InUseCurriculumCode; string; Curriculum code for the lookup. If a value is provided, that curriculum instance is returned even if it's no longer active or current.
    • InUseCurriculumId; integer; Curriculum identifier for the lookup. If a value is provided, that curriculum instance is returned even if it's no longer active or current.
  • ByKeywordFinder Finds active and current curriculum instances that match the criteria specified.
    Finder Variables
    • AcademicLevelId; integer; Only the active and current curriculum instances which match the passed academic level are returned.
    • AcademicOrgId; integer; Only the active and current curriculum instances which match the passed academic organization are returned.
    • CurriculumTagIds; string; Only the active and current curriculum instances which match the passed academic organization are returned.
    • CurriculumTypeCodes; string; Only the active and current curriculum instances which match the passed curriculum types are returned.
    • Keyword; string; Only the active and current curriculum instances where either the code, title, name, subject or catalog number matches the passed keyword are returned.
  • PrimaryKey Finds the curriculum instance that matches the primary key criteria specified.
    Finder Variables
    • CurriculumInstanceId; integer; The unique identifier of the curriculum instance.
• 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:
  

  • AcademicLevelNames; string; The academic levels associated with the curriculum instance.
  • CurriculumCatalogNumber; string; The catalog number of the curriculum.
  • CurriculumCode; string; The unique code of the curriculum.
  • CurriculumId; integer; The generated unique identifier of a curriculum.
  • CurriculumInstanceId; integer; The generated unique identifier of a curriculum instance.
  • CurriculumName; string; The name of the curriculum instance.
  • CurriculumStatusCode; string; The status code of the curriculum instance. A list of accepted values is defined in the lookup type ORA_HER_SYSTEM_STATUS_CODE.
  • CurriculumStatusMeaning; string; The meaning of the status of the curriculum instance. A list of accepted values is defined in the lookup type ORA_HER_SYSTEM_STATUS_CODE.
  • CurriculumTitle; string; The title of the curriculum instance.
  • CurriculumTypeCode; string; The curriculum type code.
  • CurriculumTypeId; integer; The unique identifier of a curriculum type.
  • CurriculumTypeName; string; The curriculum type name.
  • EntityNames; string; Entity Names
  • MaximumUnitsQuantity; number; A numeric value indicating the maximum units of the course.
  • MinimumUnitsQuantity; number; A numeric value indicating the minimum units of the course.
  • MultipleAcademicLevelFlag; boolean; Indicates that there are multiple academic levels for the curriculum instance. The default value is false.
  • MultipleEntitiesFlag; boolean; Multiple Entities
  • ProgramTypeId; integer; Program Type ID
  • ProgramTypeName; string; Program Type Name
  • SubjectCode; string; The code for the curriculum's academic subject.
  • SubjectId; integer; The unique identifier for the curriculum's academic subject.
  • SubjectName; string; The name of the subject of the curriculum.
  • UnitRangeTypeCode; string; The other unit range type code of the course. A list of accepted values is defined in the lookup type ORA_HER_RANGE_TYPE.
  • UnitRangeTypeMeaning; string; The other unit range type meaning of the course. A list of accepted values is defined in the lookup type ORA_HER_RANGE_TYPE.
• 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:
  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 : curriculumCurrentItemsLOV

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/curriculumCurrentItemsLOV-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"LOV",
        "group":"HED"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object curriculumCurrentItemsLOV-item-response

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

Type: object

Show Source

• AcademicLevelNames: string
  Title: Academic Level Names

  Read Only: true

  Maximum Length: 4000

  The academic levels associated with the curriculum instance.
• CurriculumCatalogNumber: string
  Title: Catalog Number

  Read Only: true

  Maximum Length: 10

  The catalog number of the curriculum.
• CurriculumCode: string
  Title: Curriculum Code

  Read Only: true

  Maximum Length: 50

  The unique code of the curriculum.
• CurriculumId: integer (int64)
  Title: Curriculum ID

  Read Only: true

  The generated unique identifier of a curriculum.
• CurriculumInstanceId: integer (int64)
  Title: Curriculum Instance ID

  Read Only: true

  The generated unique identifier of a curriculum instance.
• CurriculumLongDescription: string (byte)
  Title: Long Description

  Read Only: true

  The description of the curriculum instance.
• CurriculumName: string
  Title: Name

  Read Only: true

  Maximum Length: 50

  The name of the curriculum instance.
• CurriculumStatusCode: string
  Title: Curriculum Status Code

  Read Only: true

  Maximum Length: 30

  The status code of the curriculum instance. A list of accepted values is defined in the lookup type ORA_HER_SYSTEM_STATUS_CODE.
• CurriculumStatusMeaning: string
  Title: Curriculum Status

  Read Only: true

  Maximum Length: 80

  The meaning of the status of the curriculum instance. A list of accepted values is defined in the lookup type ORA_HER_SYSTEM_STATUS_CODE.
• CurriculumTitle: string
  Title: Title

  Read Only: true

  Maximum Length: 100

  The title of the curriculum instance.
• CurriculumTypeCode: string
  Title: Curriculum Type Code

  Read Only: true

  Maximum Length: 30

  The curriculum type code.
• CurriculumTypeId: integer (int64)
  Title: Curriculum Type ID

  Read Only: true

  The unique identifier of a curriculum type.
• CurriculumTypeName: string
  Title: Curriculum Type Name

  Read Only: true

  Maximum Length: 50

  The curriculum type name.
• EntityNames: string
  Title: Entity Names

  Read Only: true

  Maximum Length: 4000

  Entity Names
• links: array Links
  Title: Links

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

  Read Only: true

  A numeric value indicating the maximum units of the course.
• MinimumUnitsQuantity: number
  Title: Minimum Units

  Read Only: true

  A numeric value indicating the minimum units of the course.
• MultipleAcademicLevelFlag: boolean
  Title: Multiple Academic Levels

  Read Only: true

  Maximum Length: 1

  Indicates that there are multiple academic levels for the curriculum instance. The default value is false.
• MultipleEntitiesFlag: boolean
  Title: Multiple Entities

  Read Only: true

  Maximum Length: 1

  Multiple Entities
• ProgramTypeId: integer (int64)
  Title: Program Type ID

  Read Only: true

  Program Type ID
• ProgramTypeName: string
  Title: Program Type Name

  Read Only: true

  Maximum Length: 50

  Program Type Name
• SubjectCode: string
  Title: Subject Code

  Read Only: true

  Maximum Length: 30

  The code for the curriculum's academic subject.
• SubjectId: integer (int64)
  Title: Academic Subject ID

  Read Only: true

  The unique identifier for the curriculum's academic subject.
• SubjectName: string
  Title: Subject

  Read Only: true

  Maximum Length: 50

  The name of the subject of the curriculum.
• UnitRangeTypeCode: string
  Title: Unit Range Type Code

  Read Only: true

  Maximum Length: 30

  The other unit range type code of the course. A list of accepted values is defined in the lookup type ORA_HER_RANGE_TYPE.
• UnitRangeTypeMeaning: string
  Title: Unit Range Type

  Read Only: true

  Maximum Length: 80

  The other unit range type meaning of the course. A list of accepted values is defined in the lookup type ORA_HER_RANGE_TYPE.

{
    "type":"object",
    "properties":{
        "CurriculumCatalogNumber":{
            "title":"Catalog Number",
            "maxLength":"10",
            "type":"string",
            "description":"The catalog number of the curriculum.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurriculumTypeCode":{
            "title":"Curriculum Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The curriculum type code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurriculumTypeId":{
            "title":"Curriculum Type ID",
            "type":"integer",
            "description":"The unique identifier of a curriculum type.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SubjectName":{
            "title":"Subject",
            "maxLength":"50",
            "type":"string",
            "description":"The name of the subject of the curriculum.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurriculumInstanceId":{
            "title":"Curriculum Instance ID",
            "type":"integer",
            "description":"The generated unique identifier of a curriculum instance.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "UnitRangeTypeMeaning":{
            "title":"Unit Range Type",
            "maxLength":"80",
            "type":"string",
            "description":"The other unit range type meaning of the course. A list of accepted values is defined in the lookup type ORA_HER_RANGE_TYPE.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurriculumName":{
            "title":"Name",
            "maxLength":"50",
            "type":"string",
            "description":"The name of the curriculum instance.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UnitRangeTypeCode":{
            "title":"Unit Range Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The other unit range type code of the course. A list of accepted values is defined in the lookup type ORA_HER_RANGE_TYPE.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EntityNames":{
            "title":"Entity Names",
            "maxLength":"4000",
            "type":"string",
            "description":"Entity Names",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AcademicLevelNames":{
            "title":"Academic Level Names",
            "maxLength":"4000",
            "type":"string",
            "description":"The academic levels associated with the curriculum instance.",
            "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"
            }
        },
        "SubjectId":{
            "title":"Academic Subject ID",
            "type":"integer",
            "description":"The unique identifier for the curriculum's academic subject.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ProgramTypeName":{
            "title":"Program Type Name",
            "maxLength":"50",
            "type":"string",
            "description":"Program Type Name",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurriculumCode":{
            "title":"Curriculum Code",
            "maxLength":"50",
            "type":"string",
            "description":"The unique code of the curriculum.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurriculumStatusMeaning":{
            "title":"Curriculum Status",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of the status of the curriculum instance. A list of accepted values is defined in the lookup type ORA_HER_SYSTEM_STATUS_CODE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MinimumUnitsQuantity":{
            "title":"Minimum Units",
            "type":"number",
            "description":"A numeric value indicating the minimum units of the course.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"11",
                "scale":"2"
            },
            "x-queryable":true
        },
        "CurriculumTypeName":{
            "title":"Curriculum Type Name",
            "maxLength":"50",
            "type":"string",
            "description":"The curriculum type name.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurriculumLongDescription":{
            "title":"Long Description",
            "type":"string",
            "description":"The description of the curriculum instance.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CurriculumStatusCode":{
            "title":"Curriculum Status Code",
            "maxLength":"30",
            "type":"string",
            "description":"The status code of the curriculum instance. A list of accepted values is defined in the lookup type ORA_HER_SYSTEM_STATUS_CODE.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MultipleAcademicLevelFlag":{
            "title":"Multiple Academic Levels",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates that there are multiple academic levels for the curriculum instance. The default value is false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurriculumId":{
            "title":"Curriculum ID",
            "type":"integer",
            "description":"The generated unique identifier of a curriculum.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ProgramTypeId":{
            "title":"Program Type ID",
            "type":"integer",
            "description":"Program Type ID",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SubjectCode":{
            "title":"Subject Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code for the curriculum's academic subject.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MultipleEntitiesFlag":{
            "title":"Multiple Entities",
            "maxLength":"1",
            "type":"boolean",
            "description":"Multiple Entities",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MaximumUnitsQuantity":{
            "title":"Maximum Units",
            "type":"number",
            "description":"A numeric value indicating the maximum units of the course.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"11",
                "scale":"2"
            },
            "x-queryable":true
        },
        "CurriculumTitle":{
            "title":"Title",
            "maxLength":"100",
            "type":"string",
            "description":"The title of the curriculum instance.",
            "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 : 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."
        }
    }
}

Back to Top