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

Get all business units

get

/crmRestApi/resources/11.13.18.05/crmBusinessUnits

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
      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:
      • BUId; integer; The unique identifier of a business unit.
      • BUName; string; The name of the business unit.
      • BusinessUnitId; integer; The unique identifier of a business unit.
      • DefaultBUFlag; boolean; Indicates whether the current business unit is logged in user's default business unit. It has the value true and false.
      • 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 : crmBusinessUnits
    Type: object
    Show Source
    Nested Schema : Items
    Type: array
    Title: Items
    The items in the collection.
    Show Source
    Nested Schema : crmBusinessUnits-item-response
    Type: object
    Show Source
    Nested Schema : Assessment Templates
    Type: array
    Title: Assessment Templates
    The assesment templates resource is used to view the assesment templates. It stores the templates associated with assessments.
    Show Source
    Nested Schema : Common Set Id Lookups
    Type: array
    Title: Common Set Id Lookups
    The common set id lookups resource is used to view lookup values for set id enabled lookup types.
    Show Source
    Nested Schema : Opportunity Status Values
    Type: array
    Title: Opportunity Status Values
    The opportunity status values resource is used to view the opportunity status value. The configurable setup data is defined specifically for sales usage.
    Show Source
    Nested Schema : Sales Methods
    Type: array
    Title: Sales Methods
    The sales methods resource is used to view an approach which is used in the sales process. A method can encompass every stage associated with the sales process such as prospecting, forecasting, or closing opportunities.
    Show Source
    Nested Schema : crmBusinessUnits-assessmentTemplates-item-response
    Type: object
    Show Source
    Nested Schema : crmBusinessUnits-fndCommonSetIdLookups-item-response
    Type: object
    Show Source
    Nested Schema : crmBusinessUnits-optyStatus-item-response
    Type: object
    Show Source
    Nested Schema : crmBusinessUnits-salesMethods-item-response
    Type: object
    Show Source
    Nested Schema : Sales Stages
    Type: array
    Title: Sales Stages
    The sales stages resource is used to view the sales stage. The sales stage for a given sales method describes the progress of an opportunity in the sales cycle.
    Show Source
    Nested Schema : crmBusinessUnits-salesMethods-SalesStage-item-response
    Type: object
    Show Source
    Nested Schema : Attachments
    Type: array
    Title: Attachments
    The attachments resource is used to view, create, and update attachments.
    Show Source
    Nested Schema : Sales Stage Process Steps
    Type: array
    Title: Sales Stage Process Steps
    The sales stage process steps resource is used view the sales stage process steps. It is a sequence of recommended steps tied to a particular sales stage which is used to guide the sales representative through the opportunity lifecycle.
    Show Source
    Nested Schema : crmBusinessUnits-salesMethods-SalesStage-Attachments-item-response
    Type: object
    Show Source
    Nested Schema : crmBusinessUnits-salesMethods-SalesStage-SalesStageProcessSteps-item-response
    Type: object
    Show Source
    Back to Top