Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API

機械翻訳について

サービス・ビジネス・ユニットの取得

get

/crmRestApi/resources/11.13.18.05/serviceBusinessUnits/{BUOrgId}

リクエスト

パス・パラメータ

BUOrgId(required): integer(int64)

ビジネス・ユニットの一意の識別子。

問合せパラメータ

dependency: string

このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。通常、これらは属性変更の影響をプレビューするために使用されます。このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。この問合せパラメータの値は、依存性フィールドのセットです。例: dependency=ProductId=2

フォーマット: <attr1>=<val1>,<attr2>=<value2>
expand: string

このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。この問合せパラメータの値は"all"または""です。カンマをセパレータとして使用して、複数の子を指定できます。例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
fields: string

このパラメータは、リソース・フィールドをフィルタします。指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。両方を指定した場合、フィールドのみが考慮されます。

フォーマット : ?fields=Attribute1,Attribute2

子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2
links: string

このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。パラメータ値書式は、次のカンマ区切りリストです : <link_relation>

例:
self,canonical
onlyData: boolean

リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。

ヘッダー・パラメータ

Metadata-Context:

REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version:

RESTクライアントとサービスの間のプロトコル・バージョン。クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

この操作にはリクエスト本文がありません。

トップに戻る

応答

サポートされるメディア・タイプ

application/json

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。

ヘッダー

Metadata-Context(required):

REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version(required):

RESTクライアントとサービスの間のプロトコル・バージョン。クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

ルート・スキーマ : serviceBusinessUnits-item-response

タイプ: object

ソースを表示

BUOrgId: integer

タイトル: Business Unit ID

読取り専用: true

ビジネス・ユニットの一意の識別子。
BusinessUnitId: integer

読取り専用: true

ビジネス・ユニットの一意の識別子。
BusinessUnitName: string

タイトル: Business Unit

読取り専用: true

最大長: 240

ビジネス・ユニットの名前。
categories: array Categories

タイトル: Categories

カテゴリ・リソースは、ビジネス・ユニットに関連付けられたカテゴリを表示するために使用されます。カテゴリは、サービス・リクエストのグループ化に使用されます。
channels: array Channels

タイトル: Channels

チャネル・リソースは、ビジネス・ユニットに関連付けられたチャネルの表示に使用されます。顧客の声を聞き、応答するために使用されるチャネル。
fndSetEnabledLookups: array Business Unit Lookups

タイトル: Business Unit Lookups

参照セットが使用可能な参照リソースは、ビジネス・ユニットに関連付けられた参照の表示に使用されます。
links: array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
Name: string

読取り専用: true

ビジネス・ユニットの名前。
profileOptions: array Profile Options

タイトル: Profile Options

プロファイル・オプション・リソースは、サービス・リクエスト・レスポンスの製品カタログ使用状況やEメール・テンプレートなど、ビジネス・ユニットに関連付けられたプロファイル・オプションを表示するために使用されます。

{
    "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
        }
    }
}

ネストされたスキーマ : カテゴリ

タイプ: array

タイトル: Categories

カテゴリ・リソースは、ビジネス・ユニットに関連付けられたカテゴリを表示するために使用されます。カテゴリは、サービス・リクエストのグループ化に使用されます。

ソースを表示

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"
    }
}

ネストされたスキーマ : チャネル

タイプ: array

タイトル: Channels

チャネル・リソースは、ビジネス・ユニットに関連付けられたチャネルの表示に使用されます。顧客の声を聞き、応答するために使用されるチャネル。

ソースを表示

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"
    }
}

ネストされたスキーマ : ビジネス・ユニット参照

タイプ: array

タイトル: Business Unit Lookups

参照セットが使用可能な参照リソースは、ビジネス・ユニットに関連付けられた参照の表示に使用されます。

ソースを表示

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"
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

Array of: object link

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

ネストされたスキーマ : プロファイル・オプション

タイプ: array

タイトル: Profile Options

プロファイル・オプション・リソースは、サービス・リクエスト・レスポンスの製品カタログ使用状況やEメール・テンプレートなど、ビジネス・ユニットに関連付けられたプロファイル・オプションを表示するために使用されます。

ソースを表示

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"
    }
}

ネストされたスキーマ : serviceBusinessUnits-categories-item-response

タイプ: object

ソースを表示

BUOrgId: integer (int64)

タイトル: Business Unit ID

読取り専用: true

カテゴリに関連付けられたビジネス・ユニットの一意の識別子。
CategoryId: integer

タイトル: Category ID

読取り専用: true

カテゴリの一意の識別子。
CategoryName: string

タイトル: Category Name

読取り専用: true

最大長: 400

カテゴリの名前。
CategoryShortName: string

タイトル: Category Short Name

読取り専用: true

最大長: 240

カテゴリの短縮名。この値は、CategoryNameから自動生成されます。必要に応じて、名前を編集して一意の値にすることができます。
CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

カテゴリを作成したユーザー。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

カテゴリが作成された日時。
CSSFlag: boolean

タイトル: Visible in Customer Self-Service

読取り専用: true

最大長: 1

カテゴリが顧客セルフサービス・ポータルに表示されるかどうかを示します。
EnabledFlag: boolean

タイトル: Enabled

読取り専用: true

最大長: 1

カテゴリが使用可能かどうかを示します。有効な場合、値はY、それ以外の場合はNです。
LastUpdateDate: string (date-time)

タイトル: Last Updated Date

読取り専用: true

カテゴリが最後に更新された日時。
LastUpdatedBy: string

タイトル: Last Updated By

読取り専用: true

最大長: 64

カテゴリを最後に更新したユーザー。
LastUpdateLogin: string

タイトル: Last Update Login

読取り専用: true

最大長: 32

行を最後に更新したユーザーに関連付けられたセッション・ログイン。
links: array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
OriginalSystemReference: string

タイトル: Original System

読取り専用: true

最大長: 255

カテゴリのインポート元のシステムへの参照(インポートされている場合)。
ParentCategoryId: integer (int64)

タイトル: Parent Category ID

読取り専用: true

親カテゴリの一意の識別子。カテゴリがルート・カテゴリの場合、値はNULLです。
StripeCd: string

タイトル: Stripe Code

読取り専用: true

最大長: 30

サービス・リクエスト・カテゴリのアプリケーション・ストライプを示すコード。

{
    "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
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

Array of: object link

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

ネストされたスキーマ : リンク

タイプ: object

ソースを表示

href: string

タイトル: hyperlink reference

関連リソースへのURI。
kind: string

タイトル: kind

許可された値: [ "collection", "item", "describe", "other" ]

関連リソースの種類。
name: string

タイトル: name

関連リソースへのリンクの名前。
properties: object properties
rel: string

タイトル: relation

許可された値: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

リソース・インスタンスとの関係の名前。例: 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."
                }
            }
        }
    }
}

ネストされたスキーマ : properties

タイプ: object

ソースを表示

changeIndicator: string

リソース・インスタンスのインジケータまたはETag値を変更します。

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

ネストされたスキーマ : serviceBusinessUnits-channels-item-response

タイプ: object

ソースを表示

AccessToken: string

タイトル: Access Token

最大長: 400

ソーシャル・チャネルに使用されるアクセス・トークン。
AccountName: string

タイトル: Account Name

最大長: 400

チャネルに関連付けられているアカウントの名前。
APIId: string

タイトル: API

最大長: 400

チャネルAPIの一意の識別子。
APIPassword: string

タイトル: API Password

最大長: 400

チャネルAPIのパスワード。
APIVersion: string

タイトル: API Version

最大長: 400

チャネルのAPIバージョン。
AuthenticationURL: string

タイトル: Authentication URL

最大長: 1000

チャネルを認証するためのURL。
AuthorizationURL: string

タイトル: Authorization URL

最大長: 1000

チャネルを認可するURL。
AuthToken: string

タイトル: Authorization Token

最大長: 400

ソーシャル・チャネルに使用される認可トークン。
BUOrgId: integer (int64)

タイトル: Business Unit ID

チャネルに関連付けられたビジネス・ユニットの一意の識別子。
BusinessUnitName: string

タイトル: Business Unit Name

最大長: 255

チャネルに関連付けられているビジネス・ユニットの名前。
ChannelId: integer (int64)

タイトル: Channel

読取り専用: true

チャネルの一意の識別子。
ChannelShortName: string

タイトル: Channel Code

最大長: 450

チャネルの短縮名。
ChannelTypeCd: string

タイトル: Channel Type

最大長: 30

通信チャネルのタイプを示すコード。
ChannelTypeCdLovSwitcher: string

読取り専用: true

チャネル・タイプ値リスト・ピッカーの名前。
CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

チャネルを作成したユーザー。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

チャネルが作成された日付。
CustomerTypeCd: string

タイトル: Customer Type

最大長: 30

チャネルにメッセージを送信する必要がある顧客のタイプ(消費者、ビジネス、両方など)。
DeleteFlag: boolean

読取り専用: true

チャネルが削除されたかどうかを示します。
DisplayName: string

タイトル: Display Name

最大長: 400

チャネルの表示名。
EnabledFlag: boolean

タイトル: Active

最大長: 1

デフォルト値: true

チャネルがアクティブかどうかを示します。
EndPoint: string

タイトル: Endpoint

最大長: 1000

チャネルのエンドポイント。
IncludeSenderEmailFlag: boolean

タイトル: Include Sender Email

最大長: 1

デフォルト値: false

送信者のEメール・アドレスをアウトバウンド・メッセージに含める必要があるかどうかを示します。
IncludeSenderNameFlag: boolean

タイトル: Include Sender Name

最大長: 1

デフォルト値: false

送信者の名前をアウトバウンド・メッセージに含める必要があるかどうかを示します。
LastUpdateDate: string (date-time)

タイトル: Last Updated Date

読取り専用: true

チャネルが最後に更新された日付。
LastUpdatedBy: string

タイトル: Last Updated By

読取り専用: true

最大長: 64

チャネルを最後に更新したユーザー。
LastUpdateLogin: string

タイトル: Last Update Login

読取り専用: true

最大長: 32

チャネルを最後に更新したユーザーのログイン。
links: array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
MultipleMatchesActionCd: string

タイトル: If Multiple Matches Found for Sender

最大長: 30

選択なしや最初の一致の選択など、メッセージ送信者に対して複数の一致が見つかった場合にアプリケーションが実行する処理。
NetworkTypeCd: string

タイトル: Network

最大長: 30

ソーシャル・ネットワークのタイプを示すコード。
NoMatchActionCd: string

タイトル: If No Matches Found for Sender

最大長: 30

なしや担当者の作成など、メッセージ送信者に対して一致が見つからない場合にアプリケーションが実行する処理。
OpenSrCount: integer

読取り専用: true

削除もクローズもされていないサービス・リクエストの数。
OriginalSystemReference: string

タイトル: Original System

最大長: 255

インポートされたチャネルの元の参照システム。
Port: string

タイトル: Port

最大長: 10

チャネルに関連付けられたポート。
PrivatePToPAllowedFlag: boolean

タイトル: Private Conversation Allowed

最大長: 1

デフォルト値: true

チャネルでプライベート・メッセージを許可するかどうかを示します。
PurposeCd: string

タイトル: Purpose

最大長: 30

サポート、営業、照会などのチャネルの目的。
RefreshToken: string

タイトル: Refresh Token

最大長: 400

ソーシャル・チャネルに使用されるリフレッシュ・トークン。
SourceCd: string

タイトル: Source Code

最大長: 30

デフォルト値: ORA_SVC_ADMIN_UI

チャネル作成のソース・インタフェース。
StripeCd: string

タイトル: Stripe Code

最大長: 30

チャネルのアプリケーション・ストライプを示すコード。
TokenAccessURL: string

タイトル: Token Access URL

最大長: 1000

チャネル・トークンにアクセスするためのURL。
TokenRequestURL: string

タイトル: Token Request URL

最大長: 1000

チャネルでトークン・リクエストを渡すURL。
UpdateFlag: boolean

読取り専用: true

チャネルが更新されたかどうかを示します。

{
    "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
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

Array of: object link

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

ネストされたスキーマ : serviceBusinessUnits-fndSetEnabledLookups-item-response

タイプ: object

ソースを表示

BUOrgId: integer

タイトル: Business Unit ID

読取り専用: true

ビジネス・ユニットの一意の識別子。
CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

参照セットを作成したユーザーが参照を使用可能にします。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

参照セットが使用可能な参照が作成された日付。
Description: string

タイトル: Description

読取り専用: true

最大長: 240

参照セットが使用可能な参照値の摘要。
DisplaySequence: integer (int64)

タイトル: Display Sequence

読取り専用: true

参照セットが使用可能な参照値の表示順序。
EndDateActive: 文字列(日付)

タイトル: End Date

読取り専用: true

参照セットが使用可能な参照が非アクティブになる日付。
LastUpdateDate: string (date-time)

タイトル: Last Updated Date

読取り専用: true

最終参照セット使用可能参照が最後に更新された日付。
LastUpdatedBy: string

タイトル: Last Updated By

読取り専用: true

最大長: 64

参照セットが使用可能な参照を最後に更新したユーザー。
LastUpdateLogin: string

タイトル: Last Update Login

読取り専用: true

最大長: 32

参照セットが使用可能な参照を最後に更新したユーザーのログイン詳細。
links: array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
LookupCode: string

タイトル: Lookup Code

読取り専用: true

最大長: 30

参照セットが使用可能な参照のプロパティを示すコード。
LookupType: string

タイトル: Lookup Type

読取り専用: true

最大長: 30

参照セットが使用可能な参照のタイプ。
Meaning: string

タイトル: Meaning

読取り専用: true

最大長: 80

参照セットが使用可能な参照の表示値。
SetId: integer (int64)

タイトル: Set ID

読取り専用: true

参照に関連付けられている参照セットの一意の識別子。
StartDateActive: 文字列(日付)

タイトル: Start Date

読取り専用: true

参照セットが使用可能な参照がアクティブになる日付。

{
    "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
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

Array of: object link

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

ネストされたスキーマ : serviceBusinessUnits-profileOptions-item-response

タイプ: object

ソースを表示

BUOrgId: integer (int64)

タイトル: Business Unit Organization ID

プロファイル・オプションに関連付けられたビジネス・ユニットの一意の識別子。
BusinessUnitName: string

タイトル: Business Unit

読取り専用: true

最大長: 240

プロファイル・オプションに関連付けられたビジネス・ユニットの名前。
BusinessUnitStatus: string

タイトル: Active

読取り専用: true

最大長: 30

ビジネス・ユニットのステータス(アクティブ、非アクティブなど)。
CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

最初にプロファイル・オプションを作成したユーザー。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

プロファイル・オプションが作成された日付。
LastUpdateDate: string (date-time)

タイトル: Last Updated Date

読取り専用: true

プロファイル・オプションが最後に更新された日付。
LastUpdatedBy: string

タイトル: Last Updated By

読取り専用: true

最大長: 64

プロファイル・オプションを最後に更新したユーザー。
LastUpdateLogin: string

タイトル: Last Update Login

読取り専用: true

最大長: 32

プロファイル・オプションを最後に更新したユーザーのログイン。
links: array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
OptionId: integer (int64)

タイトル: Service Profile Option ID

読取り専用: true

プロファイル・オプションの一意の識別子。
OptionShortName: string

タイトル: Profile Short Name

最大長: 64

プロファイル・オプションの短縮名。
ProfileDescription: string

タイトル: Description

読取り専用: true

最大長: 240

プロファイル・オプションの説明。
ProfileDisplayName: string

タイトル: Profile Display Name

読取り専用: true

最大長: 240

プロファイル・オプションの表示名。
ProfileOptionCode: string

タイトル: Profile Option Code

最大長: 80

プロファイル・オプションのタイプを示すコード。
ProfileOptionValue: string

タイトル: Business Unit Profile Value

最大長: 1000

ビジネス・ユニットのプロファイル・オプション値。
SiteProfileOptionValue: string

タイトル: Site Level Value

読取り専用: true

最大長: 1000

プロファイル・オプションのサイト・レベル値。
UseSiteValueFlag: boolean

タイトル: Use Site Value

最大長: 1

デフォルト値: true

サイト・レベルのプロファイル・オプション値をアプリケーションで使用する必要があるかどうかを示します。デフォルト値は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
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

Array of: object link

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

リンク

categories

操作: /crmRestApi/resources/11.13.18.05/serviceBusinessUnits/{BUOrgId}/child/categories

パラメータ:

BUOrgId: $request.path.BUOrgId

チャネル

操作: /crmRestApi/resources/11.13.18.05/serviceBusinessUnits/{BUOrgId}/child/channels

パラメータ:

BUOrgId: $request.path.BUOrgId

fndSetEnabledLookups

操作: /crmRestApi/resources/11.13.18.05/serviceBusinessUnits/{BUOrgId}/child/fndSetEnabledLookups

パラメータ:

BUOrgId: $request.path.BUOrgId

参照セットが使用可能な参照リソースは、ビジネス・ユニットに関連付けられた参照の表示に使用されます。

profileOptions

操作: /crmRestApi/resources/11.13.18.05/serviceBusinessUnits/{BUOrgId}/child/profileOptions

パラメータ:

BUOrgId: $request.path.BUOrgId

トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対するGETリクエストを発行することによって、サービス・ビジネス・ユニットを取得する方法を示しています。

cURLコマンド

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

レスポンス本文の例

次の例は、JSON形式のレスポンス本文のコンテンツを示しています。

{
            "BUOrgId": 204,
            "BusinessUnitName": "Vision Operations",
            "BusinessUnitId": 204,
            "Name": "Vision Operations",
            "links": [
					...
					]
			}

「トップに戻る」