Jump to

• Request
• Response
• Examples

Get all service business units

get

/crmRestApi/resources/11.13.18.05/serviceBusinessUnits

Request

Query Parameters

• 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
• finder: string
  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.
• limit: integer
  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.
• 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
  
• offset: integer
  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.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  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
• q: string
  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.
• totalResults: boolean
  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

• 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 Top

Response

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.

Body ()

Root Schema : serviceBusinessUnits

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/serviceBusinessUnits-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"LOV",
        "group":"OEC"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object serviceBusinessUnits-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/serviceBusinessUnits-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : serviceBusinessUnits-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "fndSetEnabledLookups":{
            "title":"Business Unit Lookups",
            "type":"array",
            "description":"The reference set enabled lookups resource is used to view the lookups associated with a business unit.",
            "items":{
                "$ref":"#/components/schemas/serviceBusinessUnits-fndSetEnabledLookups-item-response"
            }
        },
        "channels":{
            "title":"Channels",
            "type":"array",
            "description":"The channels resource is used to view the channels associated with a business unit. Channels used to listen and respond to customers.",
            "items":{
                "$ref":"#/components/schemas/serviceBusinessUnits-channels-item-response"
            }
        },
        "BusinessUnitId":{
            "type":"integer",
            "description":"The unique identifier of the business unit.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "dependencies":[
                    "BUOrgId"
                ]
            },
            "x-queryable":true
        },
        "BUOrgId":{
            "title":"Business Unit ID",
            "type":"integer",
            "description":"The unique identifier of the business unit.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "categories":{
            "title":"Categories",
            "type":"array",
            "description":"The categories resource is used to view the categories associated with a business unit. Categories are used to group service requests.",
            "items":{
                "$ref":"#/components/schemas/serviceBusinessUnits-categories-item-response"
            }
        },
        "BusinessUnitName":{
            "title":"Business Unit",
            "maxLength":"240",
            "type":"string",
            "description":"The name of the business unit.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "profileOptions":{
            "title":"Profile Options",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/serviceBusinessUnits-profileOptions-item-response"
            }
        },
        "Name":{
            "type":"string",
            "description":"The name of the business unit.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "dependencies":[
                    "BusinessUnitName"
                ]
            },
            "x-queryable":true
        }
    }
}

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

• Array of: object serviceBusinessUnits-categories-item-response

{
    "title":"Categories",
    "type":"array",
    "description":"The categories resource is used to view the categories associated with a business unit. Categories are used to group service requests.",
    "items":{
        "$ref":"#/components/schemas/serviceBusinessUnits-categories-item-response"
    }
}

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

• Array of: object serviceBusinessUnits-channels-item-response

{
    "title":"Channels",
    "type":"array",
    "description":"The channels resource is used to view the channels associated with a business unit. Channels used to listen and respond to customers.",
    "items":{
        "$ref":"#/components/schemas/serviceBusinessUnits-channels-item-response"
    }
}

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

• Array of: object serviceBusinessUnits-fndSetEnabledLookups-item-response

{
    "title":"Business Unit Lookups",
    "type":"array",
    "description":"The reference set enabled lookups resource is used to view the lookups associated with a business unit.",
    "items":{
        "$ref":"#/components/schemas/serviceBusinessUnits-fndSetEnabledLookups-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

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

• Array of: object serviceBusinessUnits-profileOptions-item-response

{
    "title":"Profile Options",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/serviceBusinessUnits-profileOptions-item-response"
    }
}

Nested Schema : serviceBusinessUnits-categories-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "CategoryId":{
            "title":"Category ID",
            "type":"integer",
            "description":"The unique identifier of the category.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the category.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the category was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the category.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OriginalSystemReference":{
            "title":"Original System",
            "maxLength":"255",
            "type":"string",
            "description":"The reference to the original system from which the category was imported (if imported).",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CategoryShortName":{
            "title":"Category Short Name",
            "maxLength":"240",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StripeCd":{
            "title":"Stripe Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the application stripe of the service request category.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CategoryName":{
            "title":"Category Name",
            "maxLength":"400",
            "type":"string",
            "description":"The name of the category.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CSSFlag":{
            "title":"Visible in Customer Self-Service",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the category is visible in the customer self-service portal.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BUOrgId":{
            "title":"Business Unit ID",
            "type":"integer",
            "description":"The unique identifier of the business unit associated with the category.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the category is enabled. If enabled, the value is Y, else the value is N.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentCategoryId":{
            "title":"Parent Category ID",
            "type":"integer",
            "description":"The unique identifier of the parent category. The value is NULL if the category is the root category.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the category was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The session login associated with the user who last updated the row.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : serviceBusinessUnits-channels-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the channel was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NetworkTypeCd":{
            "title":"Network",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the type of social network.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Port":{
            "title":"Port",
            "maxLength":"10",
            "type":"string",
            "description":"The port associated with the channel.",
            "nullable":true,
            "x-queryable":true
        },
        "AuthenticationURL":{
            "title":"Authentication URL",
            "maxLength":"1000",
            "type":"string",
            "description":"The URL to authenticate the channel.",
            "nullable":true,
            "x-queryable":true
        },
        "TokenRequestURL":{
            "title":"Token Request URL",
            "maxLength":"1000",
            "type":"string",
            "description":"The URL to pass a token request on the channel.",
            "nullable":true,
            "x-queryable":true
        },
        "EndPoint":{
            "title":"Endpoint",
            "maxLength":"1000",
            "type":"string",
            "description":"The endpoint of the channel.",
            "nullable":true,
            "x-queryable":true
        },
        "ChannelId":{
            "title":"Channel",
            "type":"integer",
            "description":"The unique identifier of the channel.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "APIId":{
            "title":"API",
            "maxLength":"400",
            "type":"string",
            "description":"The unique identifier of the channel API.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceCd":{
            "title":"Source Code",
            "maxLength":"30",
            "type":"string",
            "description":"The source interface for the channel creation.",
            "nullable":false,
            "default":"ORA_SVC_ADMIN_UI",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "NoMatchActionCd":{
            "title":"If No Matches Found for Sender",
            "maxLength":"30",
            "type":"string",
            "description":"The action the application should take if no matches are found for the message sender, such as Nothing or Create Contact.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AuthorizationURL":{
            "title":"Authorization URL",
            "maxLength":"1000",
            "type":"string",
            "description":"The URL to authorize the channel.",
            "nullable":true,
            "x-queryable":true
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates if the channel has been updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "TokenAccessURL":{
            "title":"Token Access URL",
            "maxLength":"1000",
            "type":"string",
            "description":"The URL to access the channel token.",
            "nullable":true,
            "x-queryable":true
        },
        "IncludeSenderNameFlag":{
            "title":"Include Sender Name",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the sender's name should be included in the outbound message.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RefreshToken":{
            "title":"Refresh Token",
            "maxLength":"400",
            "type":"string",
            "description":"The refresh token used for the social channel.",
            "nullable":true,
            "x-queryable":true
        },
        "MultipleMatchesActionCd":{
            "title":"If Multiple Matches Found for Sender",
            "maxLength":"30",
            "type":"string",
            "description":"The action the application should take if multiple matches are found for the message sender, such as Select None or Select First Match.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "APIVersion":{
            "title":"API Version",
            "maxLength":"400",
            "type":"string",
            "description":"The API version of the channel.",
            "nullable":true,
            "x-queryable":true
        },
        "AccessToken":{
            "title":"Access Token",
            "maxLength":"400",
            "type":"string",
            "description":"The access token used for the social channel.",
            "nullable":true,
            "x-queryable":true
        },
        "DisplayName":{
            "title":"Display Name",
            "maxLength":"400",
            "type":"string",
            "description":"The display name of the channel.",
            "nullable":true,
            "x-queryable":true
        },
        "APIPassword":{
            "title":"API Password",
            "maxLength":"400",
            "type":"string",
            "description":"The password for the channel API.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ChannelTypeCdLovSwitcher":{
            "type":"string",
            "description":"The name of the channel type list of values picker.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "EnabledFlag":{
            "title":"Active",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the channel is active.",
            "nullable":false,
            "default":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "BusinessUnitName":{
            "title":"Business Unit Name",
            "maxLength":"255",
            "type":"string",
            "description":"The name of the business unit associated with the channel.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the channel.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OpenSrCount":{
            "type":"integer",
            "description":"The number of service requests that are neither deleted nor closed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the channel.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OriginalSystemReference":{
            "title":"Original System",
            "maxLength":"255",
            "type":"string",
            "description":"The original system of reference for a channel that was imported.",
            "nullable":true,
            "x-queryable":true
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates if the channel has been deleted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CustomerTypeCd":{
            "title":"Customer Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of customers expected to send a message to the channel, such as Consumer, Business, or Both.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "IncludeSenderEmailFlag":{
            "title":"Include Sender Email",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the sender's email address should be included in the outbound message.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PrivatePToPAllowedFlag":{
            "title":"Private Conversation Allowed",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the channel allows private messages.",
            "nullable":true,
            "default":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "StripeCd":{
            "title":"Stripe Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the application stripe of the channel.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AuthToken":{
            "title":"Authorization Token",
            "maxLength":"400",
            "type":"string",
            "description":"The authorization token used for the social channel.",
            "nullable":true,
            "x-queryable":true
        },
        "BUOrgId":{
            "title":"Business Unit ID",
            "type":"integer",
            "description":"The unique identifier of the business unit associated with the channel.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":"18"
            },
            "x-queryable":true
        },
        "ChannelShortName":{
            "title":"Channel Code",
            "maxLength":"450",
            "type":"string",
            "description":"The short name of the channel.",
            "nullable":false,
            "x-queryable":true
        },
        "PurposeCd":{
            "title":"Purpose",
            "maxLength":"30",
            "type":"string",
            "description":"The purpose of the channel such as Support, Sales, Inquiry.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ChannelTypeCd":{
            "title":"Channel Type",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the type of the communication channel.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the channel was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the channel.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AccountName":{
            "title":"Account Name",
            "maxLength":"400",
            "type":"string",
            "description":"The name of the account associated with the channel.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : serviceBusinessUnits-fndSetEnabledLookups-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the reference set enabled lookup.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the reference set enabled lookup was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"The description of the reference set enabled lookup value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the reference set enable lookup.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LookupType":{
            "title":"Lookup Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of the reference set enabled lookup.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"The display order of the reference set enabled lookup value.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LookupCode":{
            "title":"Lookup Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the property of the reference set enabled lookup.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StartDateActive":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the reference set enabled lookup becomes active.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EndDateActive":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the reference set enabled lookup becomes inactive.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BUOrgId":{
            "title":"Business Unit ID",
            "type":"integer",
            "description":"The unique identifier of the business unit.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SetId":{
            "title":"Set ID",
            "type":"integer",
            "description":"The unique identifier of the reference set associated with the lookup.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Meaning":{
            "title":"Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"The display value of the reference set enabled lookup.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the last reference set enabled lookup was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The login details of the user who last updated the reference set enabled lookup.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : serviceBusinessUnits-profileOptions-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the profile option.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BusinessUnitStatus":{
            "title":"Active",
            "maxLength":"30",
            "type":"string",
            "description":"The status of the business unit, such as active or inactive.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the profile option was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who first created the profile option.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProfileDescription":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"The description of the profile option.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OptionShortName":{
            "title":"Profile Short Name",
            "maxLength":"64",
            "type":"string",
            "description":"The short name of the profile option.",
            "nullable":false,
            "x-queryable":true
        },
        "ProfileOptionValue":{
            "title":"Business Unit Profile Value",
            "maxLength":"1000",
            "type":"string",
            "description":"The profile option value for a business unit.",
            "nullable":true,
            "x-queryable":true
        },
        "OptionId":{
            "title":"Service Profile Option ID",
            "type":"integer",
            "description":"The unique identifier of the profile option.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ProfileDisplayName":{
            "title":"Profile Display Name",
            "maxLength":"240",
            "type":"string",
            "description":"The display name of the profile option.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProfileOptionCode":{
            "title":"Profile Option Code",
            "maxLength":"80",
            "type":"string",
            "description":"The code indicating the type of the profile option.",
            "nullable":false,
            "x-queryable":true
        },
        "UseSiteValueFlag":{
            "title":"Use Site Value",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the site level profile option value must be used by the application. The default value is true.",
            "nullable":false,
            "default":true,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "BUOrgId":{
            "title":"Business Unit Organization ID",
            "type":"integer",
            "description":"The unique identifier of the business unit associated with the profile option.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "BusinessUnitName":{
            "title":"Business Unit",
            "maxLength":"240",
            "type":"string",
            "description":"The name of the business unit associated with the profile option.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"edit"
            },
            "x-queryable":true
        },
        "SiteProfileOptionValue":{
            "title":"Site Level Value",
            "maxLength":"1000",
            "type":"string",
            "description":"The site level value of a profile option.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the profile option was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the profile option.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

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