Get all student management categories
get
/fscmRestApi/resources/11.13.18.05/studentManagementCategories
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- KeywordFinder Finds all the categories that match with the specified keyword in category name and category description.
Finder Variables- Active; string; Indicates whether to get active or inactive categories.
- ExcludeCategoryId; integer; Identifier of the parent category which needs to be excluded for finding a subcategory.
- Keyword; string; Keyword; string; to search in category name and category description.
- PrimaryKey Finds all student management categories that match the primary key criteria specified.
Finder Variables- CategoryId; integer; Unique identifier for the student management category.
- RuleExistsFinder Finds all the categories which are mapped to business rule definitions.
Finder Variables
- KeywordFinder Finds all the categories that match with the specified keyword in category name and category description.
-
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:- ActiveFlag; boolean; Indicates whether a category is active or inactive.
- CategoryCode; string; The unique code for a category.
- CategoryDescription; string; The description of a category.
- CategoryId; integer; The unique identifier for a category.
- CategoryName; string; The name of a category, such as Enrollment or Billing.
- CreatedBy; string; The person who created the category.
- CreationDate; string; The date and time when the category was created.
- LastUpdateDate; string; The date and time when the category was updated.
- LastUpdatedBy; string; The person who updated the category.
- MappedEventCount; integer; The number of events mapped to a category.
- SeedDataLock; integer; Indicates whether the record is predefined. The value 0 means the record isn't predefined. The value 1 means the record is predefined and can't be updated. A value greater than 1 means the record is predefined but can be updated.
- SeededDataFlag; boolean; Indicates whether the associated row is predefined.
-
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 : studentManagementCategories
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 : studentManagementCategories-item-response
Type:
Show Source
object
-
ActiveFlag: boolean
Title:
Active
Maximum Length:1
Indicates whether a category is active or inactive. -
CategoryCode: string
Title:
Category Code
Maximum Length:30
The unique code for a category. -
categoryDataGroups: array
Category Data Groups
Title:
Category Data Groups
Use the category data groups resource to view, create, modify, or delete category data groups. -
CategoryDescription: string
Title:
Description
Maximum Length:240
The description of a category. -
categoryEvents: array
Category Events
Title:
Category Events
Use the category events resource to view, create, modify, or delete category events. -
CategoryId: integer
(int64)
Title:
Category ID
The unique identifier for a category. -
CategoryName: string
Title:
Category Name
Maximum Length:50
The name of a category, such as Enrollment or Billing. -
categoryRuleAttributes: array
Category Rule Attributes
Title:
Category Rule Attributes
Use the category rule attributes resource to view, create, modify, or delete category rule attributes. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The person who created the category. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the category was created. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the category was updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The person who updated the category. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MappedEventCount: integer
Title:
Mapped Events
Read Only:true
The number of events mapped to a category. -
SeedDataLock: integer
(int32)
Title:
Predefined Data
Default Value:0
Indicates whether the record is predefined. The value 0 means the record isn't predefined. The value 1 means the record is predefined and can't be updated. A value greater than 1 means the record is predefined but can be updated. -
SeededDataFlag: boolean
Read Only:
true
Indicates whether the associated row is predefined. -
subcategories: array
Subcategories
Title:
Subcategories
Use the student management subcategories resource to view, create, modify, or delete subcategories. For example, an enrollment category can have various subcategories.
Nested Schema : Category Data Groups
Type:
array
Title:
Category Data Groups
Use the category data groups resource to view, create, modify, or delete category data groups.
Show Source
Nested Schema : Category Events
Type:
array
Title:
Category Events
Use the category events resource to view, create, modify, or delete category events.
Show Source
Nested Schema : Category Rule Attributes
Type:
array
Title:
Category Rule Attributes
Use the category rule attributes resource to view, create, modify, or delete category rule attributes.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Subcategories
Type:
array
Title:
Subcategories
Use the student management subcategories resource to view, create, modify, or delete subcategories. For example, an enrollment category can have various subcategories.
Show Source
Nested Schema : studentManagementCategories-categoryDataGroups-item-response
Type:
Show Source
object
-
ArtifactGroupCode: string
Title:
Data Group Code
Read Only:true
Maximum Length:50
The data group unique code, such as ACADSTRUCTUREPROFILE. -
ArtifactGroupId: integer
(int64)
Title:
Data Group ID
The unique identifier for a data group. -
ArtifactGroupName: string
Title:
Data Group Name
Maximum Length:50
The name of a data group. -
ArtifactGroupTypeCode: string
Title:
Data Group Type Code
Read Only:true
Maximum Length:30
The type of the data group, for example, a data profile or a data contract. -
ArtifactGroupTypeMeaning: string
Title:
Data Group Type
Read Only:true
Maximum Length:80
The meaning of the data group type code, for example, a data profile or a data contract. -
CategoryArtifactGroupId: integer
(int64)
Title:
Category Data Group ID
The unique identifier for the data group and category association. -
Description: string
Title:
Data Group Description
Read Only:true
Maximum Length:240
The description of a data group. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ProcessNames: string
Title:
Process Names
Read Only:true
The list of processes that are mapped to a contract.
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.
Nested Schema : studentManagementCategories-categoryEvents-item-response
Type:
Show Source
object
-
ActiveFlag: boolean
Title:
Active
Read Only:true
Maximum Length:1
Indicates whether an event is active or inactive. -
CategoryEventMapId: integer
(int64)
Title:
Category Event Map ID
Read Only:true
The unique identifier for the category and event mapping. -
EventCode: string
Title:
Event Code
Read Only:true
Maximum Length:30
The unique code for an event. -
EventDescription: string
Title:
Event Description
Read Only:true
Maximum Length:240
The description of an event. -
EventId: integer
(int64)
Title:
Event ID
The unique identifier for an event that occurs in the application, for example, Enrollment Drop and Refund Posted. -
EventName: string
Title:
Event Name
Maximum Length:50
The name of an event, such as Enrollment Drop. -
EventTimingRuleCode: string
Read Only:
true
Maximum Length:30
The timing rule type code for a date based event. For example, the ORA_HEY_EVENT_TIMING_AFTER code indicates a communication can be sent after the event occurs. A list of accepted values is defined in the lookup type ORA_HEY_EVENT_TIMING_RULE_TYPE. -
eventTokens: array
Event Tokens
Title:
Event Tokens
The event tokens resource provides a list of event tokens. -
EventTypeCode: string
Title:
Event Type
Read Only:true
Maximum Length:30
The type of an event, such as a transactional or date-based event. A list of accepted values is defined in the lookup type ORA_HEY_EVENT_TYPE. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SeededDataFlag: boolean
Read Only:
true
Indicates whether the associated row is predefined.
Nested Schema : Event Tokens
Type:
array
Title:
Event Tokens
The event tokens resource provides a list of event tokens.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : studentManagementCategories-categoryEvents-eventTokens-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
TokenCode: string
Title:
Token Code
Read Only:true
Maximum Length:30
The unique code for a communication token. -
TokenDescription: string
Title:
Token Description
Read Only:true
Maximum Length:256
The description of a communication token. -
TokenId: integer
(int64)
Title:
Token ID
Read Only:true
The unique identifier for a communication token. -
TokenIsMandatoryFlag: boolean
Read Only:
true
Maximum Length:1
Indicates that the communication token is required for the mapped event. -
TokenName: string
Title:
Token Name
Read Only:true
Maximum Length:30
The name of a communication token, such as FIRST_NAME. -
TokenTypeCode: string
Title:
Token Type
Read Only:true
Maximum Length:30
The type of a communication token, such as a token specific to a single communication event or a token for all communications. A list of accepted values is defined in the lookup type ORA_HEY_TOKEN_TYPE.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : studentManagementCategories-categoryRuleAttributes-item-response
Type:
Show Source
object
-
AllowCallOtherRulesFlag: boolean
Title:
Allow Subcategories
Maximum Length:1
Default Value:true
Indicates whether rules of this category can call rules that belong to other categories. These other categories are known as subcategories of this category. -
AllowRuleChangesFlag: boolean
Title:
Allow Rule Changes
Maximum Length:1
Default Value:true
Indicates whether changes to rules are allowed for this category. -
CategoryRuleId: integer
(int64)
Title:
Rule Category ID
The unique identifier for a rule category. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : studentManagementCategories-subcategories-item-response
Type:
Show Source
object
-
CategoryAssociationId: integer
(int64)
Title:
Category Association ID
The unique identifier for the subcategory and category association. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SubcategoryDescription: string
Title:
Description
Read Only:true
Maximum Length:240
The description of a subcategory. -
SubcategoryId: integer
(int64)
Title:
Subcategory ID
The unique identifier for a subcategory. -
SubcategoryName: string
Title:
Subcategory Name
Maximum Length:50
The name of a subcategory.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source