1. REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Tasks
  3. List of Values
  4. Service Business Units

Get all service business units

get

/crmRestApi/resources/11.13.18.05/serviceBusinessUnits

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:

    • PrimaryKey: Finds a service business unit with the specified primary key.
      Finder Variables:
      • BUOrgId; integer; The unique identifier of the business unit.
  • 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:
    • BUOrgId; integer; The unique identifier of the business unit.
    • BusinessUnitId; integer; The unique identifier of the business unit.
    • BusinessUnitName; string; The name of the business unit.
    • Name; string; The name of the business unit.
  • 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 : serviceBusinessUnits
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : serviceBusinessUnits-item-response
Type: object
Show Source
Nested Schema : Categories
Type: array
Title: Categories
The categories resource is used to view the categories associated with a business unit. Categories are used to group service requests.
Show Source
Nested Schema : Channels
Type: array
Title: Channels
The channels resource is used to view the channels associated with a business unit. Channels used to listen and respond to customers.
Show Source
Nested Schema : Business Unit Lookups
Type: array
Title: Business Unit Lookups
The reference set enabled lookups resource is used to view the lookups associated with a business unit.
Show Source
Nested Schema : Profile Options
Type: array
Title: Profile Options
The profile options resource is used to view the profile options associated with a business unit, such as product catalog usage or email template for service request responses.
Show Source
Nested Schema : serviceBusinessUnits-categories-item-response
Type: object
Show Source
  • Title: Business Unit ID
    Read Only: true
    The unique identifier of the business unit associated with the category.
  • Title: Category ID
    Read Only: true
    The unique identifier of the category.
  • Title: Category Name
    Read Only: true
    Maximum Length: 400
    The name of the category.
  • Title: Category Short Name
    Read Only: true
    Maximum Length: 240
    The short name of the category. This value is auto-generated from CategoryName. You can edit the name to make it a unique value, if required.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the category.
  • Title: Creation Date
    Read Only: true
    The date and time when the category was created.
  • Title: Visible in Customer Self-Service
    Read Only: true
    Maximum Length: 1
    Indicates if the category is visible in the customer self-service portal.
  • Title: Enabled
    Read Only: true
    Maximum Length: 1
    Indicates whether the category is enabled. If enabled, the value is Y, else the value is N.
  • Title: Last Updated Date
    Read Only: true
    The date and time when the category was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the category.
  • Title: Last Update Login
    Read Only: true
    Maximum Length: 32
    The session login associated with the user who last updated the row.
  • Links
  • Title: Original System
    Read Only: true
    Maximum Length: 255
    The reference to the original system from which the category was imported (if imported).
  • Title: Parent Category ID
    Read Only: true
    The unique identifier of the parent category. The value is NULL if the category is the root category.
  • Title: Stripe Code
    Read Only: true
    Maximum Length: 30
    The code indicating the application stripe of the service request category.
Nested Schema : serviceBusinessUnits-channels-item-response
Type: object
Show Source
Nested Schema : serviceBusinessUnits-fndSetEnabledLookups-item-response
Type: object
Show Source
  • Title: Business Unit ID
    Read Only: true
    The unique identifier of the business unit.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the reference set enable lookup.
  • Title: Creation Date
    Read Only: true
    The date when the reference set enabled lookup was created.
  • Title: Description
    Read Only: true
    Maximum Length: 240
    The description of the reference set enabled lookup value.
  • Title: Display Sequence
    Read Only: true
    The display order of the reference set enabled lookup value.
  • Title: End Date
    Read Only: true
    The date when the reference set enabled lookup becomes inactive.
  • Title: Last Updated Date
    Read Only: true
    The date when the last reference set enabled lookup was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the reference set enabled lookup.
  • Title: Last Update Login
    Read Only: true
    Maximum Length: 32
    The login details of the user who last updated the reference set enabled lookup.
  • Links
  • Title: Lookup Code
    Read Only: true
    Maximum Length: 30
    The code indicating the property of the reference set enabled lookup.
  • Title: Lookup Type
    Read Only: true
    Maximum Length: 30
    The type of the reference set enabled lookup.
  • Title: Meaning
    Read Only: true
    Maximum Length: 80
    The display value of the reference set enabled lookup.
  • Title: Set ID
    Read Only: true
    The unique identifier of the reference set associated with the lookup.
  • Title: Start Date
    Read Only: true
    The date when the reference set enabled lookup becomes active.
Nested Schema : serviceBusinessUnits-profileOptions-item-response
Type: object
Show Source
Back to Top

Examples

The following example shows how to get all service business units by submitting a GET request on the REST resource using cURL.

cURL Command

curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceBusinessUnits

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
    "items": [
        {
            "BUOrgId": 204,
            "BusinessUnitName": "Vision Operations",
            "BusinessUnitId": 204,
            "Name": "Vision Operations",
            "links": [
					...
					]
			},
			{
            "BUOrgId": 300100026725086,
            "BusinessUnitName": "ABC Operations",
            "BusinessUnitId": 300100026725086,
            "Name": "ABC Operations",
            "links": [
					...
					]
			},
			...
Back to Top