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

機械翻訳について

チャネル・タイプに関連付けられているすべてのチャネルを取得します。

get

/crmRestApi/resources/11.13.18.05/serviceChannelTypesLOV/{LookupCode}/child/svcChannelLookups

リクエスト

パス・パラメータ

LookupCode(required): string

このパラメータの値は、リソース・アイテムを一意に識別するために使用されるキーのハッシュである可能性があります。クライアントはハッシュ・キー値を生成しないでください。かわりに、クライアントはフィルタを使用してコレクション・リソースを問い合せ、特定のリソース・アイテムにナビゲートする必要があります。例: products?q=InventoryItemId=

問合せパラメータ

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
finder: string
コレクションを検索するための事前定義済ファインダとして使用されます。

フォーマット : ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

使用可能なファインダ名および対応するファインダ変数を次に示します:
- ChannelEnabledFinder :指定したファインダで有効なチャネルを検索します。
  ファインダ変数:
- ChannelVOChannelShortNameAltKey :指定した代替キーでチャネルを検索します。
  ファインダ変数:
  - ChannelShortName :チャネルの短縮名。
- DefaultChannelByTypeFinder :特定のチャネル・タイプのデフォルト・チャネルを検索します。
  ファインダ変数:
  - AccountName :チャネルのアカウント名。
  - ChannelTypeCd :チャネルに関連付けられたチャネル・タイプ。
- EnabledChannelByBUAndStripeAndTypeFinder :アプリケーション・ストライプ、ビジネス・ユニットおよびチャネル・タイプの組合せに対して有効なチャネルを検索します。
  ファインダ変数:
  - BUOrgId :検索をフィルタするビジネス・ユニット識別子。
  - ChannelTypeCd :検索をフィルタするチャネル・タイプ。
  - StripeCd :検索をフィルタするアプリケーション・ストライプ。
- PrimaryKey :指定した主キーを持つチャネルを検索します。
  ファインダ変数:
  - ChannelId :通信チャネルの一意の識別子。
limit: integer

このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
links: string

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

例:
self,canonical
offset: integer

リソース・コレクションの開始位置を定義するために使用します。オフセットがリソース数を超えると、リソースは返されません。デフォルト値は0です。
onlyData: boolean

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

このパラメータは、指定されたフィールドに基づいてリソース・コレクションを順序付けます。パラメータ値は、属性名のカンマ区切りの文字列で、それぞれオプションでコロンと「asc」または「desc」が続きます。昇順の場合は「asc」、降順の場合は「desc」を指定します。デフォルト値は「asc」です。たとえば、?orderBy=field1:asc,field2:descです
q: string
この問合せパラメータは、where句を定義します。リソース・コレクションは、指定された式を使用して問い合せられます。この問合せパラメータの値は、1つ以上の式です。例 : ?q=部門番号>=10および<= 30;Loc!=NY

フォーマット : ?q=expression1;expression2

次の問合せ可能属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
- APIId; string;チャネルAPIの一意の識別子。
- APIPassword; string; チャネルAPIのパスワード。
- APIVersion; string;チャネルのAPIバージョン。
- AccessToken; string; チャネルに使用されるアクセス・トークン。
- AccountName; string;チャネルに関連付けられたアカウントの名前。
- AuthToken; string;ソーシャル・チャネルに使用される認可トークン。
- AuthenticationURL; string;チャネル認証URL。
- AuthorizationURL; string; チャネル認可URL。
- BUOrgId; integer;チャネルに関連付けられたビジネス・ユニットの一意の識別子。
- BusinessUnitName; string;チャネルに関連付けられたビジネス・ユニットの名前。
- ChannelId; integer;通信チャネルの一意の識別子。
- ChannelShortName; string;チャネルの短縮名。
- ChannelTypeCd; string;通信チャネルのタイプ。
- CreatedBy; string;チャネルを作成したユーザー。
- CreationDate; string;チャネルが作成された日付。
- CustomerTypeCd; string; コンシューマ、ビジネス、両方など、チャネルにメッセージを送信する必要がある顧客のタイプ。
- DisplayName; string;通信チャネルの表示名。
- EnabledFlag; boolean;チャネルがアクティブかどうかを示します。
- EndPoint; string;チャネルのエンドポイント。
- IncludeSenderEmailFlag; boolean;送信者の電子メール・アドレスをアウトバウンド・メッセージに含めるかどうかを示します。
- IncludeSenderNameFlag; boolean;送信者の名前をアウトバウンド・メッセージに含めるかどうかを示します。
- LastUpdateDate; string; チャネルが最後に更新された日付。
- LastUpdateLogin; string;チャネルを最後に更新したユーザーのログイン。
- LastUpdatedBy; string; チャネルを最後に更新したユーザー。
- MultipleMatchesActionCd; string;メッセージ送信者に対して複数の一致が見つかった場合(Select NoneやSelect First Matchなど)、アプリケーションが実行するアクション。
- NetworkTypeCd; string; チャネルに関連付けられたソーシャル・ネットワーク。
- NoMatchActionCd; string; メッセージ送信者に対して一致が見つからない場合(NothingやCreate Contactなど)にアプリケーションが実行するアクション。
- OpenSrCount; integer;削除もクローズもされていないチャネルに関連付けられたサービス・リクエストの数。
- OriginalSystemReference; string;インポートされたチャネルの元の参照システム。
- Port; string;チャネルに関連付けられたポート。
- PrivatePToPAllowedFlag; boolean;チャネルがプライベート・メッセージを許可するかどうかを示します。
- PurposeCd; string; サポート、販売、照会などのチャネルの目的。
- RefreshToken; string;ソーシャル・チャネルに使用されるリフレッシュ・トークン。
- SourceCd; string; チャネル作成のソース・インタフェース。
- StripeCd; string;チャネルのアプリケーション・ストライプ。
- TokenAccessURL; string; チャネル・トークン・アクセスURL。
- TokenRequestURL; string;チャネルでトークン・リクエストを渡すURL。
totalResults: boolean

"?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。デフォルト値はfalseです。

ヘッダー・パラメータ

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のデフォルト・バージョンを選択します。

ルート・スキーマ : serviceChannelTypesLOV-svcChannelLookups

タイプ: object

ソースを表示

count(required): integer

現在の範囲で返されたリソース・インスタンスの数。
hasMore(required): boolean

サーバーで使用可能なリソースが、レスポンスで返されたサブセットより多いかどうかを示します。値がtrueの場合、サーバーから取得するリソースがさらにあります。デフォルト値はfalseです。
items: array Items

タイトル: Items

コレクション内のアイテム。
limit(required): integer

サーバーで使用される実際のページング・サイズ。
links(required): array Links

タイトル: Links

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

現在のページで使用されるオフセット値。
totalResults: integer

"?totalResults=true"の場合の推定行数。それ以外の場合、カウントは含まれません。

{
    "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/serviceChannelTypesLOV-svcChannelLookups-item-response"
            }
        }
    }
}

ネストされたスキーマ : アイテム

タイプ: array

タイトル: Items

コレクション内のアイテム。

ソースを表示

Array of: object serviceChannelTypesLOV-svcChannelLookups-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/serviceChannelTypesLOV-svcChannelLookups-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"
    }
}

ネストされたスキーマ : serviceChannelTypesLOV-svcChannelLookups-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 social network associated with the channel.",
            "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 channel authentication URL.",
            "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 communication 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 channel authorization URL.",
            "nullable":true,
            "x-queryable":true
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates whether the channel has been updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "TokenAccessURL":{
            "title":"Token Access URL",
            "maxLength":1000,
            "type":"string",
            "description":"The channel token access URL.",
            "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 channel.",
            "nullable":true,
            "x-queryable":true
        },
        "DisplayName":{
            "title":"Display Name",
            "maxLength":400,
            "type":"string",
            "description":"The display name of the communication 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 associated with the channel 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 whether 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 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 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"
    }
}

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

タイプ: 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."
        }
    }
}

トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対するGETリクエストを発行することによって、すべてのチャネル・タイプ参照を取得する方法を示しています。

cURLコマンド

- curl -u <username:password> \ -X http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceChannelTypesLOV/ORA_SVC_CHAT/child/svcChannelLookups

レスポンス本文の例

{
    "items": [
        {
            "ChannelId": 100100104291162,
            "ChannelTypeCd": "ORA_SVC_CHAT",
            "NetworkTypeCd": null,
            "AccountName": "Chat",
            "DisplayName": "Chat",
            "PrivatePToPAllowedFlag": true,
            "OriginalSystemReference": null,
            "EnabledFlag": true,
            "CreatedBy": "SEED_DATA_FROM_APPLICATION",
            "CreationDate": "2017-06-26T20:17:51.972+00:00",
            "LastUpdatedBy": "SEED_DATA_FROM_APPLICATION",
            "LastUpdateDate": "2019-03-19T03:21:25.273+00:00",
            "LastUpdateLogin": "-1",
            "EndPoint": null,
            "Port": null,
            "APIVersion": null,
            "APIId": null,
            "APIPassword": null,
            "AuthenticationURL": null,
            "AuthorizationURL": null,
            "TokenRequestURL": null,
            "TokenAccessURL": null,
            "AccessToken": null,
            "RefreshToken": null,
            "AuthToken": null,
            "OpenSrCount": null,
            "ChannelTypeCdLovSwitcher": "LOV_ChannelTypeCd",
            "StripeCd": "ORA_SVC_CRM",
            "BUOrgId": null,
            "BusinessUnitName": null,
            "UpdateFlag": true,
            "DeleteFlag": true,
            "PurposeCd": "SUPPORT",
            "CustomerTypeCd": "ORA_SVC_BOTH",
            "MultipleMatchesActionCd": "ORA_SVC_NONE",
            "NoMatchActionCd": "ORA_SVC_NO_ACTION",
            "IncludeSenderNameFlag": false,
            "IncludeSenderEmailFlag": false,
            "links": [
                {
                    "rel": "self",
                    "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceChannelTypesLOV/ORA_SVC_CHAT/child/svcChannelLookups/100100104291162",
                    "name": "svcChannelLookups",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceChannelTypesLOV/ORA_SVC_CHAT/child/svcChannelLookups/100100104291162",
                    "name": "svcChannelLookups",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceChannelTypesLOV/ORA_SVC_CHAT",
                    "name": "serviceChannelTypesLOV",
                    "kind": "item"
                },
                {
                    "rel": "lov",
                    "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceChannelTypesLOV/ORA_SVC_CHAT/child/svcChannelLookups/100100104291162/lov/CustomerTypeCdLookup",
                    "name": "CustomerTypeCdLookup",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceChannelTypesLOV/ORA_SVC_CHAT/child/svcChannelLookups/100100104291162/lov/YesNoLOV",
                    "name": "YesNoLOV",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceChannelTypesLOV/ORA_SVC_CHAT/child/svcChannelLookups/100100104291162/lov/NoMatchActionCdLookup",
                    "name": "NoMatchActionCdLookup",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceChannelTypesLOV/ORA_SVC_CHAT/child/svcChannelLookups/100100104291162/lov/MultipleMatchesActionCdLookup",
                    "name": "MultipleMatchesActionCdLookup",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceChannelTypesLOV/ORA_SVC_CHAT/child/svcChannelLookups/100100104291162/lov/PurposeCdLookup",
                    "name": "PurposeCdLookup",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceChannelTypesLOV/ORA_SVC_CHAT/child/svcChannelLookups/100100104291162/lov/BusinessUnitLOV",
                    "name": "BusinessUnitLOV",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceChannelTypesLOV/ORA_SVC_CHAT/child/svcChannelLookups/100100104291162/lov/NetworkTypeCdLOV",
                    "name": "NetworkTypeCdLOV",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceChannelTypesLOV/ORA_SVC_CHAT/child/svcChannelLookups/100100104291162/lov/StripeCdLOV",
                    "name": "StripeCdLOV",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceChannelTypesLOV/ORA_SVC_CHAT/child/svcChannelLookups/100100104291162/lov/ChannelTypeCdLOV",
                    "name": "ChannelTypeCdLOV",
                    "kind": "collection"
                }
            ]
        }
    ],
    "count": 1,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceChannelTypesLOV/ORA_SVC_CHAT/child/svcChannelLookups",
            "name": "svcChannelLookups",
            "kind": "collection"
        }
    ]
}

「トップに戻る」