Get all service business unit profile values

get

/api/boss/data/objects/ora/cxServiceCore/common/v1/serviceBusinessUnits

Request

Query Parameters
  • Effective date value in the ISO 8601 date format 'YYYY-MM-DD'. This date is required by business logic to search for effective-dated business objects.
  • Restricts the resource fields. Only the specified fields and mandatory system fields are returned.
  • The resource collection will be queried using the specified filter condition.
  • Specifies whether the server should estimate the total number of records for a given query and include the count in the response.
  • Restricts the number of resource items returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resource items.
    Default Value: 25
  • Defines the starting position of the resource collection. If offset exceeds the resource count then no resource items are returned.
    Default Value: 0
  • Orders a resource collection based on the specified fields. The parameter value is a comma-separated string of field names, each optionally followed by a colon and "asc" (default) or "desc".

There's no request body for this operation.

Back to Top

Response

Default Response

An array of items response
Body ()
Root Schema : serviceBusinessUnits_view-default
Match All
Show Source
Nested Schema : __collection_context
Type: object
Show Source
Nested Schema : serviceBusinessUnits_view-default-allOf[1]
Type: object
Show Source
Nested Schema : totalItems
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : oraCxServiceCoreCommon.ServiceBusinessUnit_item-response
Match All
Show Source
Nested Schema : oraCxServiceCoreCommon.ServiceBusinessUnit_item
Match All
The service business units resource is used to view, create, and update business unit profile values for service.
Show Source
Nested Schema : oraCxServiceCoreCommon.ServiceBusinessUnit_item-fields
Type: object
Show Source
Nested Schema : Service Business Unit
Type: object
Title: Service Business Unit
The service business units resource is used to view, create, and update business unit profile values for service.
Nested Schema : __busObj_context
Type: object
Show Source
Nested Schema : businessUnit
Match All
Business unit associated with the service business unit profile value.
Show Source
Nested Schema : profileOptionName
Match All
Name of the service business unit profile option.
Show Source
  • Title: Profile Option Name
    Name of the service business unit profile option.
  • Allowed Values: [ "ORA_SVC_SR_RESPONSE_TEMPLATE_NAME_ISR", "ORA_SVC_SR_SYSTEM_RESPONSE_TEMPLATE_NAME_ISR", "SVC_HCM_PROD_CATALOG_USAGE", "SVC_ISR_PROD_CATALOG_USAGE", "SVC_OUTBOUND_EMAIL_FROM", "SVC_PROD_CATALOG_USAGE", "SVC_SR_FORWARD_TEMPLATE_NAME", "SVC_SR_RESPONSE_TEMPLATE_NAME", "SVC_SR_RESPONSE_TEMPLATE_NAME_HRD", "SVC_SR_SYSTEM_RESPONSE_TEMPLATE_NAME", "SVC_SR_SYSTEM_RESPONSE_TEMPLATE_NAME_HRD", "SVC_SR_FORWARD_TEMPLATE_NAME_HRD" ]
Nested Schema : oraErpCoreStructure.BusinessUnit_item-fields
Match All
Show Source
Nested Schema : oraHcmHrCoreWorkStructures.Organization_abstract-item
Match All
Show Source
Nested Schema : oraErpCoreStructure.BusinessUnit_item-fields-allOf[0]
Type: object
Show Source
Nested Schema : oraHcmHrCoreWorkStructures.Organization_abstract-item-allOf[0]
Type: object
Show Source
Nested Schema : oraHcmHrCoreWorkStructures.OrganizationBase_abstract-item
Type: object
Show Source
Nested Schema : oraErpCoreStructure.BusinessUnit_item-fields-allOf[2]
Type: object
Show Source
Nested Schema : oraErpCoreStructure.BusinessUnit_item-fields-allOf[3]
Type: object
Nested Schema : Business Unit
Type: object
Title: Business Unit
Business unit associated with the service business unit profile value.
Nested Schema : actionOccurrence
Match All
Action Occurrence accessor for the organization.
Show Source
Nested Schema : location
Match All
Location accessor for the organization.
Show Source
Nested Schema : oraHcmHrCoreEmployment.ActionOccurrence_item-fields
Type: object
Show Source
Nested Schema : Action Occurrence
Type: object
Title: Action Occurrence
Action Occurrence accessor for the organization.
Nested Schema : action
Match All
Action accessor for action occurrence item.
Show Source
Nested Schema : actionReason
Match All
Action reason accessor for action occurrence item.
Show Source
Nested Schema : oraHcmHrCoreEmployment.Action_item-fields
Type: object
Show Source
Nested Schema : Action
Type: object
Title: Action
Action accessor for action occurrence item.
Nested Schema : $context
Type: object
Show Source
Nested Schema : oraHcmHrCoreEmployment.ActionReason_item-fields
Type: object
Show Source
Nested Schema : Action Reason
Type: object
Title: Action Reason
Action reason accessor for action occurrence item.
Nested Schema : oraHcmHrCoreWorkStructures.Location_item-fields
Match All
Show Source
Nested Schema : oraHcmHrCoreWorkStructures.Location_abstract-item
Match All
Show Source
Nested Schema : oraHcmHrCoreWorkStructures.Location_abstract-item-allOf[0]
Type: object
Show Source
Nested Schema : oraHcmHrCoreWorkStructures.LocationBase_abstract-item
Type: object
Show Source
Nested Schema : oraHcmHrCoreWorkStructures.Location_item-fields-allOf[1]
Type: object
Show Source
Nested Schema : Location
Type: object
Title: Location
Location accessor for the organization.
Nested Schema : actionOccurrence
Match All
Action Occurrence accessor for the location.
Show Source
Nested Schema : country
Match All
Country name for the location address.
Show Source
Nested Schema : mainAddress
Match All
Main address accessor for the location.
Show Source
Nested Schema : setIdSet
Match All
Set Id set accessor for the location.
Show Source
Nested Schema : status
Match All
Show Source
Nested Schema : timezone
Match All
Time zone code for the location address.
Show Source
Nested Schema : Action Occurrence
Type: object
Title: Action Occurrence
Action Occurrence accessor for the location.
Nested Schema : oraCommonAppsInfraObjects.Territory_item-fields
Match All
Show Source
Nested Schema : oraCommonAppsInfraObjects.Territory_abstract-item
Type: object
Show Source
Nested Schema : oraCommonAppsInfraObjects.Territory_item-fields-allOf[1]
Type: object
Show Source
Nested Schema : Country
Type: object
Title: Country
Country name for the location address.
Nested Schema : oraHcmHrCoreWorkStructures.LocationAddress_item-fields
Match All
Show Source
Nested Schema : oraHcmHrCoreWorkStructures.LocationAddressBase_abstract-item
Type: object
Show Source
Nested Schema : oraHcmHrCoreWorkStructures.LocationAddress_item-fields-allOf[1]
Type: object
Show Source
Nested Schema : Main Address
Type: object
Title: Main Address
Main address accessor for the location.
Nested Schema : country
Match All
Country accessor for the location address.
Show Source
Nested Schema : location
Match All
Location accessor for the location address.
Show Source
Nested Schema : type
Match All
Show Source
  • Read Only: true
  • Allowed Values: [ "BILL", "BUSN", "CHK", "CODE", "H", "LEGL", "MAILING", "MAIN", "OTH", "T" ]
Nested Schema : Country
Type: object
Title: Country
Country accessor for the location address.
Nested Schema : Location
Type: object
Title: Location
Location accessor for the location address.
Nested Schema : oraCommonAppsInfraObjects.SetIdSet_item-fields
Match All
Show Source
Nested Schema : oraCommonAppsInfraObjects.SetIdSet_abstract-item
Type: object
Show Source
Nested Schema : oraCommonAppsInfraObjects.SetIdSet_item-fields-allOf[1]
Type: object
Show Source
Nested Schema : Set Id Set
Type: object
Title: Set Id Set
Set Id set accessor for the location.
Nested Schema : oraCommonAppsInfraObjects.Timezone_item-fields
Type: object
Show Source
Nested Schema : Time Zone
Type: object
Title: Time Zone
Time zone code for the location address.
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 --location 'https://servername.fa.us2.oraclecloud.com/api/boss/data/objects/ora/cxServiceCore/common/v1/$en-US/serviceBusinessUnits?%24limit=2' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <token>'

Example of Response Body

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

{
  "items": [
    {
      "optionId": "300100665383598",
      "profileOptionName": "SVC_OUTBOUND_EMAIL_FROM",
      "profileOptionValue": "sample-value@example.com",
      "siteLevelValueFlag": false,
      "$id": "300100665383598"
    }
  ],
  "hasMore": false
}
Back to Top