Get a service business unit
get
/crmRestApi/resources/11.13.18.05/serviceBusinessUnits/{BUOrgId}
Request
Path Parameters
-
BUOrgId(required): integer(int64)
The unique identifier of the business unit.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
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 -
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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:
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.
Root Schema : serviceBusinessUnits-item-response
Type:
Show Source
object
-
BUOrgId: integer
Title:
Business Unit ID
Read Only:true
The unique identifier of the business unit. -
BusinessUnitId: integer
Read Only:
true
The unique identifier of the business unit. -
BusinessUnitName: string
Title:
Business Unit
Read Only:true
Maximum Length:240
The name of the business unit. -
categories: array
Categories
Title:
Categories
The categories resource is used to view the categories associated with a business unit. Categories are used to group service requests. -
channels: array
Channels
Title:
Channels
The channels resource is used to view the channels associated with a business unit. Channels used to listen and respond to customers. -
fndSetEnabledLookups: array
Business Unit Lookups
Title:
Business Unit Lookups
The reference set enabled lookups resource is used to view the lookups associated with a business unit. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Read Only:
true
The name of the business unit. -
profileOptions: array
Profile Options
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.
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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:
Show Source
object
-
BUOrgId: integer
(int64)
Title:
Business Unit ID
Read Only:true
The unique identifier of the business unit associated with the category. -
CategoryId: integer
Title:
Category ID
Read Only:true
The unique identifier of the category. -
CategoryName: string
Title:
Category Name
Read Only:true
Maximum Length:400
The name of the category. -
CategoryShortName: string
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. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the category. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the category was created. -
CSSFlag: boolean
Title:
Visible in Customer Self-Service
Read Only:true
Maximum Length:1
Indicates if the category is visible in the customer self-service portal. -
EnabledFlag: boolean
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. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the category was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the category. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The session login associated with the user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OriginalSystemReference: string
Title:
Original System
Read Only:true
Maximum Length:255
The reference to the original system from which the category was imported (if imported). -
ParentCategoryId: integer
(int64)
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. -
StripeCd: string
Title:
Stripe Code
Read Only:true
Maximum Length:30
The code indicating the application stripe of the service request category.
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 : serviceBusinessUnits-channels-item-response
Type:
Show Source
object
-
AccessToken: string
Title:
Access Token
Maximum Length:400
The access token used for the social channel. -
AccountName: string
Title:
Account Name
Maximum Length:400
The name of the account associated with the channel. -
APIId: string
Title:
API
Maximum Length:400
The unique identifier of the channel API. -
APIPassword: string
Title:
API Password
Maximum Length:400
The password for the channel API. -
APIVersion: string
Title:
API Version
Maximum Length:400
The API version of the channel. -
AuthenticationURL: string
Title:
Authentication URL
Maximum Length:1000
The URL to authenticate the channel. -
AuthorizationURL: string
Title:
Authorization URL
Maximum Length:1000
The URL to authorize the channel. -
AuthToken: string
Title:
Authorization Token
Maximum Length:400
The authorization token used for the social channel. -
BUOrgId: integer
(int64)
Title:
Business Unit ID
The unique identifier of the business unit associated with the channel. -
BusinessUnitName: string
Title:
Business Unit Name
Maximum Length:255
The name of the business unit associated with the channel. -
ChannelId: integer
(int64)
Title:
Channel
Read Only:true
The unique identifier of the channel. -
ChannelShortName: string
Title:
Channel Code
Maximum Length:450
The short name of the channel. -
ChannelTypeCd: string
Title:
Channel Type
Maximum Length:30
The code indicating the type of the communication channel. -
ChannelTypeCdLovSwitcher: string
Read Only:
true
The name of the channel type list of values picker. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the channel. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the channel was created. -
CustomerTypeCd: string
Title:
Customer Type
Maximum Length:30
The type of customers expected to send a message to the channel, such as Consumer, Business, or Both. -
DeleteFlag: boolean
Read Only:
true
Indicates if the channel has been deleted. -
DisplayName: string
Title:
Display Name
Maximum Length:400
The display name of the channel. -
EnabledFlag: boolean
Title:
Active
Maximum Length:1
Default Value:true
Indicates whether the channel is active. -
EndPoint: string
Title:
Endpoint
Maximum Length:1000
The endpoint of the channel. -
IncludeSenderEmailFlag: boolean
Title:
Include Sender Email
Maximum Length:1
Default Value:false
Indicates whether the sender's email address should be included in the outbound message. -
IncludeSenderNameFlag: boolean
Title:
Include Sender Name
Maximum Length:1
Default Value:false
Indicates whether the sender's name should be included in the outbound message. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the channel was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the channel. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the channel. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MultipleMatchesActionCd: string
Title:
If Multiple Matches Found for Sender
Maximum Length:30
The action the application should take if multiple matches are found for the message sender, such as Select None or Select First Match. -
NetworkTypeCd: string
Title:
Network
Maximum Length:30
The code indicating the type of social network. -
NoMatchActionCd: string
Title:
If No Matches Found for Sender
Maximum Length:30
The action the application should take if no matches are found for the message sender, such as Nothing or Create Contact. -
OpenSrCount: integer
Read Only:
true
The number of service requests that are neither deleted nor closed. -
OriginalSystemReference: string
Title:
Original System
Maximum Length:255
The original system of reference for a channel that was imported. -
Port: string
Title:
Port
Maximum Length:10
The port associated with the channel. -
PrivatePToPAllowedFlag: boolean
Title:
Private Conversation Allowed
Maximum Length:1
Default Value:true
Indicates whether the channel allows private messages. -
PurposeCd: string
Title:
Purpose
Maximum Length:30
The purpose of the channel such as Support, Sales, Inquiry. -
RefreshToken: string
Title:
Refresh Token
Maximum Length:400
The refresh token used for the social channel. -
SourceCd: string
Title:
Source Code
Maximum Length:30
Default Value:ORA_SVC_ADMIN_UI
The source interface for the channel creation. -
StripeCd: string
Title:
Stripe Code
Maximum Length:30
The code indicating the application stripe of the channel. -
TokenAccessURL: string
Title:
Token Access URL
Maximum Length:1000
The URL to access the channel token. -
TokenRequestURL: string
Title:
Token Request URL
Maximum Length:1000
The URL to pass a token request on the channel. -
UpdateFlag: boolean
Read Only:
true
Indicates if the channel has been updated.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : serviceBusinessUnits-fndSetEnabledLookups-item-response
Type:
Show Source
object
-
BUOrgId: integer
Title:
Business Unit ID
Read Only:true
The unique identifier of the business unit. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the reference set enable lookup. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the reference set enabled lookup was created. -
Description: string
Title:
Description
Read Only:true
Maximum Length:240
The description of the reference set enabled lookup value. -
DisplaySequence: integer
(int64)
Title:
Display Sequence
Read Only:true
The display order of the reference set enabled lookup value. -
EndDateActive: string
(date)
Title:
End Date
Read Only:true
The date when the reference set enabled lookup becomes inactive. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the last reference set enabled lookup was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the reference set enabled lookup. -
LastUpdateLogin: string
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: array
Links
Title:
Links
The link relations associated with the resource instance. -
LookupCode: string
Title:
Lookup Code
Read Only:true
Maximum Length:30
The code indicating the property of the reference set enabled lookup. -
LookupType: string
Title:
Lookup Type
Read Only:true
Maximum Length:30
The type of the reference set enabled lookup. -
Meaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
The display value of the reference set enabled lookup. -
SetId: integer
(int64)
Title:
Set ID
Read Only:true
The unique identifier of the reference set associated with the lookup. -
StartDateActive: string
(date)
Title:
Start Date
Read Only:true
The date when the reference set enabled lookup becomes active.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : serviceBusinessUnits-profileOptions-item-response
Type:
Show Source
object
-
BUOrgId: integer
(int64)
Title:
Business Unit Organization ID
The unique identifier of the business unit associated with the profile option. -
BusinessUnitName: string
Title:
Business Unit
Read Only:true
Maximum Length:240
The name of the business unit associated with the profile option. -
BusinessUnitStatus: string
Title:
Active
Read Only:true
Maximum Length:30
The status of the business unit, such as active or inactive. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who first created the profile option. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the profile option was created. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the profile option was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the profile option. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the profile option. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OptionId: integer
(int64)
Title:
Service Profile Option ID
Read Only:true
The unique identifier of the profile option. -
OptionShortName: string
Title:
Profile Short Name
Maximum Length:64
The short name of the profile option. -
ProfileDescription: string
Title:
Description
Read Only:true
Maximum Length:240
The description of the profile option. -
ProfileDisplayName: string
Title:
Profile Display Name
Read Only:true
Maximum Length:240
The display name of the profile option. -
ProfileOptionCode: string
Title:
Profile Option Code
Maximum Length:80
The code indicating the type of the profile option. -
ProfileOptionValue: string
Title:
Business Unit Profile Value
Maximum Length:1000
The profile option value for a business unit. -
SiteProfileOptionValue: string
Title:
Site Level Value
Read Only:true
Maximum Length:1000
The site level value of a profile option. -
UseSiteValueFlag: boolean
Title:
Use Site Value
Maximum Length:1
Default Value:true
Indicates if the site level profile option value must be used by the application. The default value is true.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- categories
-
Parameters:
- BUOrgId:
$request.path.BUOrgId
The categories resource is used to view the categories associated with a business unit. Categories are used to group service requests. - BUOrgId:
- channels
-
Parameters:
- BUOrgId:
$request.path.BUOrgId
The channels resource is used to view the channels associated with a business unit. Channels used to listen and respond to customers. - BUOrgId:
- fndSetEnabledLookups
-
Operation: /crmRestApi/resources/11.13.18.05/serviceBusinessUnits/{BUOrgId}/child/fndSetEnabledLookupsParameters:
- BUOrgId:
$request.path.BUOrgId
The reference set enabled lookups resource is used to view the lookups associated with a business unit. - BUOrgId:
- profileOptions
-
Parameters:
- BUOrgId:
$request.path.BUOrgId
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. - BUOrgId:
Examples
The following example shows how to get a 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/204
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "BUOrgId": 204, "BusinessUnitName": "Vision Operations", "BusinessUnitId": 204, "Name": "Vision Operations", "links": [ ... ] }