Get all curriculum items
get
/fscmRestApi/resources/11.13.18.05/searchCurriculumItems
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- EffectiveDateFinder Finds all curriculum items that match the effective date specified.
Finder Variables- effectiveDate; string; Effective date keyword for the curriculum item.
- FindByCurriculumId Finds all curriculum items that match the keyword specified.
Finder Variables- bindCurriculumId; integer; Keyword for the curriculum item.
- PrimaryKey Finds all curriculum items that match the primary key criteria specified.
Finder Variables- CurriculumHeaderId; integer; Unique identifier for the curriculum item.
- EffectiveDateFinder Finds all curriculum items that match the effective date specified.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- AcademicLevelId; integer; The unique identifier for an academic level.
- AcademicLevelName; string; The name of the academic level associated with a curriculum item such as undergraduate or graduate.
- AcademicOrgId; integer; The unique identifier for an academic organization.
- AcademicOrgName; string; The academic organization that owns the curriculum item.
- CreatedBy; string; The user who created the curriculum item.
- CreationDate; string; The date and time when the curriculum item was created.
- CurriculumBuildStatusId; integer; The unique identifier for a curriculum build status.
- CurriculumBuildStatusName; string; The name of a user defined build or lifecycle status code.
- CurriculumHeaderId; integer; The generated primary key column for a curriculum record.
- CurriculumId; integer; The unique identifier for a curriculum item such as a course list or program.
- CurriculumType; string; The type of curriculum item, such as a scheduled course.
- CurriculumTypeId; integer; The unique identifier for a type of curriculum item, such as a scheduled course.
- EffectiveEndDate; string; The effective end date of the curriculum item.
- EffectiveStartDate; string; The effective start date of the curriculum item.
- InstitutionId; integer; The unique identifier for an institution.
- InstitutionName; string; The institution that owns the curriculum item.
- LastUpdateDate; string; The date and time when the curriculum item was last updated.
- LastUpdatedBy; string; The user who last updated the curriculum item.
- Name; string; The name or short description of a curriculum item.
- SystemStatusCode; string; A user defined code for a build or lifecycle status for a curriculum item, such as Under Review or Approved.
- SystemStatusMeaning; string; A display field for a build or lifecycle status for a curriculum item, such as Under Review or Approved.
- Title; string; The formal title of a curriculum item.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
-
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 TopResponse
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.
Root Schema : searchCurriculumItems
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : searchCurriculumItems-item-response
Type:
Show Source
object
-
AcademicLevelId: integer
(int64)
Title:
Academic Level ID
Read Only:true
The unique identifier for an academic level. -
AcademicLevelName: string
Title:
Academic Level Name
Read Only:true
Maximum Length:100
The name of the academic level associated with a curriculum item such as undergraduate or graduate. -
AcademicOrgId: integer
(int64)
Title:
Academic Organization ID
Read Only:true
The unique identifier for an academic organization. -
AcademicOrgName: string
Title:
Academic Organization
Read Only:true
Maximum Length:50
The academic organization that owns the curriculum item. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the curriculum item. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the curriculum item was created. -
CurriculumBuildStatusId: integer
(int64)
Title:
Curriculum Build Status ID
Read Only:true
The unique identifier for a curriculum build status. -
CurriculumBuildStatusName: string
Title:
Build Status
Read Only:true
Maximum Length:50
The name of a user defined build or lifecycle status code. -
CurriculumHeaderId: integer
(int64)
Title:
Curriculum Header ID
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 list or program. -
CurriculumType: string
Title:
Curriculum Item Type
Read Only:true
Maximum Length:30
The type of curriculum item, such as a scheduled course. -
CurriculumTypeId: integer
(int64)
Title:
Curriculum Type ID
Read Only:true
The unique identifier for a type of curriculum item, such as a scheduled course. -
EffectiveEndDate: string
(date)
Title:
Effective End Date
Read Only:true
The effective end date of the curriculum item. -
EffectiveStartDate: string
(date)
Title:
Effective Start Date
Read Only:true
The effective start date of the curriculum item. -
InstitutionId: integer
(int64)
Title:
Institution ID
Read Only:true
The unique identifier for an institution. -
InstitutionName: string
Title:
Institution
Read Only:true
Maximum Length:50
The institution that owns the curriculum item. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the curriculum item was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the curriculum item. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Title:
Name
Read Only:true
Maximum Length:150
The name or short description of a curriculum item. -
SystemStatusCode: string
Title:
Build Status Code
Read Only:true
Maximum Length:30
A user defined code for a build or lifecycle status for a curriculum item, such as Under Review or Approved. -
SystemStatusMeaning: string
Read Only:
true
Maximum Length:80
A display field for a build or lifecycle status for a curriculum item, such as Under Review or Approved. -
Title: string
Title:
Title
Read Only:true
Maximum Length:100
The formal title of a curriculum item.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.