1. REST API for Oracle Fusion Cloud Student Management
  2. Tasks
  3. Student Management Categories

Get all student management categories

get

/fscmRestApi/resources/11.13.18.05/studentManagementCategories

Request

Query Parameters
  • 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).
  • 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
  • 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
    • 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.
    • 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
    • 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.
    • The resource item payload will be filtered in order to contain only data (no links section, for example).
    • 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
    • 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.
    • 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
    • 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".
    • 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

    Default Response

    The following table describes the default response for this task.
    Headers
    • 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".
    • 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 : studentManagementCategories
    Type: object
    Show Source
    Nested Schema : Items
    Type: array
    Title: Items
    The items in the collection.
    Show Source
    Nested Schema : studentManagementCategories-item-response
    Type: object
    Show Source
    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 : 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: object
    Show Source
    Nested Schema : studentManagementCategories-categoryEvents-item-response
    Type: object
    Show Source
    • Title: Active
      Read Only: true
      Maximum Length: 1
      Indicates whether an event is active or inactive.
    • Title: Category Event Map ID
      Read Only: true
      The unique identifier for the category and event mapping.
    • Title: Event Code
      Read Only: true
      Maximum Length: 30
      The unique code for an event.
    • Title: Event Description
      Read Only: true
      Maximum Length: 240
      The description of an event.
    • Title: Event ID
      The unique identifier for an event that occurs in the application, for example, Enrollment Drop and Refund Posted.
    • Title: Event Name
      Maximum Length: 50
      The name of an event, such as Enrollment Drop.
    • 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.
    • Event Tokens
      Title: Event Tokens
      The event tokens resource provides a list of event tokens.
    • 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
    • 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 : studentManagementCategories-categoryEvents-eventTokens-item-response
    Type: object
    Show Source
    • Links
    • Title: Token Code
      Read Only: true
      Maximum Length: 30
      The unique code for a communication token.
    • Title: Token Description
      Read Only: true
      Maximum Length: 256
      The description of a communication token.
    • Title: Token ID
      Read Only: true
      The unique identifier for a communication token.
    • Read Only: true
      Maximum Length: 1
      Indicates that the communication token is required for the mapped event.
    • Title: Token Name
      Read Only: true
      Maximum Length: 30
      The name of a communication token, such as FIRST_NAME.
    • 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 : studentManagementCategories-categoryRuleAttributes-item-response
    Type: object
    Show Source
    • 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.
    • Title: Allow Rule Changes
      Maximum Length: 1
      Default Value: true
      Indicates whether changes to rules are allowed for this category.
    • Title: Rule Category ID
      The unique identifier for a rule category.
    • Links
    Nested Schema : studentManagementCategories-subcategories-item-response
    Type: object
    Show Source
    Back to Top