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

機械翻訳について

チャネルの取得

get

/crmRestApi/resources/11.13.18.05/channels/{ChannelId}

リクエスト

パス・パラメータ

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

ルート・スキーマ : 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

チャネル認証のUniform Resource Locator。
AuthorizationURL: string

タイトル: Authorization URL

最大長: 1000

チャネル承認のUniform Resource Locator。
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

チャネル・タイプを示すコード。たとえば、電子メール、電話、ソーシャルなどです。受け入れられる値のリストは、参照ORA_SVC_CHANNEL_TYPE_CDで定義されます。
ChannelTypeCdLovSwitcher: string

読取り専用: true

チャネル・タイプを示すコード。たとえば、電子メール、電話、ソーシャルなどです。受け入れられる値のリストは、参照ORA_SVC_CHANNEL_TYPE_CDで定義されます。
CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

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

タイトル: Creation Date

読取り専用: true

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

タイトル: Customer Type

最大長: 30

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

読取り専用: true

チャネルが削除されたかどうかを示します。デフォルト値はfalseです。
DisplayName: string

タイトル: Display Name

最大長: 400

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

タイトル: Active

最大長: 1

デフォルト値: true

チャネルがアクティブかどうかを示します。デフォルト値は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

ポストのソーシャル・ネットワークを示すコード。たとえば、Facebook、Twitterです。受け入れられる値のリストは、参照HZ_INSTANT_MESSENGER_TYPEで定義されます。
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

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

タイトル: Purpose

最大長: 30

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

タイトル: Refresh Token

最大長: 400

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

タイトル: Channel Resources

チャネル・リソースは、サービス担当者やサービス・マネージャなど、サービス・チャネルに関連付けられている従業員またはパートナのリストの表示、作成、更新および削除に使用されます。リソースがチャネルに関連付けられている場合は、そのチャネルを使用して顧客と通信できます。
senderIdentificationPriorities: array Sender Identification Priorities

タイトル: Sender Identification Priorities

送信者識別優先度リソースを使用して、channels.The送信者識別優先度の識別優先度を表示、作成、更新および削除します。これは、メッセージの送信者に複数のパーティ識別子が見つかった場合の競合を解決するために使用されます。
SourceCd: string

タイトル: Source Code

最大長: 30

デフォルト値: ORA_SVC_ADMIN_UI

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

タイトル: Stripe Code

最大長: 30

サービス・リクエスト・カテゴリのアプリケーション・ストライプを示すコード。受け入れられる値のリストは、参照ORA_SVC_STRIPE_CDで定義されます。
TokenAccessURL: string

タイトル: Token Access URL

最大長: 1000

チャネル・トークン・アクセスURL。
TokenRequestURL: string

タイトル: Token Request URL

最大長: 1000

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

読取り専用: true

チャネルが更新されたかどうかを示します。デフォルト値はfalseです。

{
    "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 social network of the post. For example, Facebook, Twitter. A list of accepted values is defined in the lookup HZ_INSTANT_MESSENGER_TYPE.",
            "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 uniform resource locator of the channel authentication.",
            "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
        },
        "resourceMembers":{
            "title":"Channel Resources",
            "type":"array",
            "description":"The channel resources is used to view, create, update, and delete the list of employees or partners, such as service representatives or service managers, who are associated with a service channel. If a resource is associated with a channel, then they can communicate with the customer using that channel.",
            "items":{
                "$ref":"#/components/schemas/channels-resourceMembers-item-response"
            }
        },
        "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 uniform resource locator of the channel authorization.",
            "nullable":true,
            "x-queryable":true
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates if the channel has been updated. The default value is false.",
            "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 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 code indicating the channel type. For example, email, phone, social, and so on. A list of accepted values is defined in the lookup ORA_SVC_CHANNEL_TYPE_CD.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "EnabledFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the channel is active. The default value is true.",
            "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. The default value is false.",
            "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. The default value is true.",
            "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 service request category. A list of accepted values is defined in the lookup ORA_SVC_STRIPE_CD.",
            "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 channel type. For example, email, phone, social, and so on. A list of accepted values is defined in the lookup ORA_SVC_CHANNEL_TYPE_CD.",
            "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
        },
        "senderIdentificationPriorities":{
            "title":"Sender Identification Priorities",
            "type":"array",
            "description":"The sender identification priorities resource is used to view, create, update, and delete identification priorities for channels.The sender identification priority is used to resolve a conflict if multiple party identifiers are found for a sender of a message.",
            "items":{
                "$ref":"#/components/schemas/channels-senderIdentificationPriorities-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

タイトル: Channel Resources

チャネル・リソースは、サービス担当者やサービス・マネージャなど、サービス・チャネルに関連付けられている従業員またはパートナのリストの表示、作成、更新および削除に使用されます。リソースがチャネルに関連付けられている場合は、そのチャネルを使用して顧客と通信できます。

ソースを表示

Array of: object channels-resourceMembers-item-response

{
    "title":"Channel Resources",
    "type":"array",
    "description":"The channel resources is used to view, create, update, and delete the list of employees or partners, such as service representatives or service managers, who are associated with a service channel. If a resource is associated with a channel, then they can communicate with the customer using that channel.",
    "items":{
        "$ref":"#/components/schemas/channels-resourceMembers-item-response"
    }
}

ネストされたスキーマ : 送信者識別優先度

タイプ: array

タイトル: Sender Identification Priorities

送信者識別優先度リソースを使用して、channels.The送信者識別優先度の識別優先度を表示、作成、更新および削除します。これは、メッセージの送信者に複数のパーティ識別子が見つかった場合の競合を解決するために使用されます。

ソースを表示

Array of: object channels-senderIdentificationPriorities-item-response

{
    "title":"Sender Identification Priorities",
    "type":"array",
    "description":"The sender identification priorities resource is used to view, create, update, and delete identification priorities for channels.The sender identification priority is used to resolve a conflict if multiple party identifiers are found for a sender of a message.",
    "items":{
        "$ref":"#/components/schemas/channels-senderIdentificationPriorities-item-response"
    }
}

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

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

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

タイプ: object

ソースを表示

AccountCredentials: string

タイトル: Account Credentials

最大長: 400

チャネル・リソースのアカウント資格証明。
AccountToken: string

タイトル: Account Token

最大長: 400

チャネルに関連付けられたアカウント・トークン。
ChannelId: integer (int64)

タイトル: Channel ID

チャネルの一意の識別子。
ChannelResourceId: integer (int64)

タイトル: Channel Resource ID

チャネルに関連付けられたリソースの一意の識別子。
CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

チャネル・リソースを追加したユーザー。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

チャネル・リソースが追加された日付。
EmailAddress: string

読取り専用: true

最大長: 320

チャネルに関連付けられたリソースの電子メール・アドレス。
FormattedPhoneNumber: string

読取り専用: true

チャネルに関連付けられたリソースの電話番号。
LastUpdateDate: string (date-time)

タイトル: Last Update

読取り専用: true

チャネル・リソースを最後に更新したユーザー。
LastUpdatedBy: string

タイトル: Updated By

読取り専用: true

最大長: 64

チャネル・リソースを最後に更新したユーザーのログイン。
LastUpdateLogin: string

タイトル: Update Login

読取り専用: true

最大長: 32

チャネル・リソースが最後に更新された日付。
links: array Links

タイトル: Links

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

タイトル: Party ID

チャネルに関連付けられたリソースのパーティの一意の識別子。
PartyIdFK: integer (int64)

読取り専用: true

チャネルに関連付けられたリソースのパーティの外部キー識別子。
PartyName: string

最大長: 360

チャネルに関連付けられたリソースのパーティの名前。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The login of the user who last updated the channel resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the channel resource was added.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who added the channel resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyName":{
            "maxLength":360,
            "type":"string",
            "description":"The name of the party of the resource associated with the channel.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "ChannelId":{
            "title":"Channel ID",
            "type":"integer",
            "description":"The unique identifier of the channel.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EmailAddress":{
            "maxLength":320,
            "type":"string",
            "description":"The email address of the resource associated with the channel.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "ChannelResourceId":{
            "title":"Channel Resource ID",
            "type":"integer",
            "description":"The unique identifier of the resource associated with the channel.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique identifier of the party of the resource associated with the channel.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AccountToken":{
            "title":"Account Token",
            "maxLength":400,
            "type":"string",
            "description":"The account token associated with the channel.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "FormattedPhoneNumber":{
            "type":"string",
            "description":"The phone number of the resource associated with the channel.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AccountCredentials":{
            "title":"Account Credentials",
            "maxLength":400,
            "type":"string",
            "description":"The account credentials of the channel resource.",
            "nullable":true,
            "x-queryable":true
        },
        "PartyIdFK":{
            "type":"integer",
            "description":"The foreign key identifier of the party of the resource associated with the channel.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update",
            "type":"string",
            "description":"The user who last updated the channel resource.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The date when the channel resource was last updated.",
            "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"
    }
}

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

タイプ: object

ソースを表示

ChannelId: integer (int64)

タイトル: Channel ID

送信者優先度キューに関連付けられたチャネルの一意の識別子。
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

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

タイトル: Lookup Type

最大長: 30

ビジネス担当者、コンシューマ、従業員など、メッセージの送信者のタイプ。
PrioritySequence: integer (int64)

タイトル: Priority Sequence

送信者タイプの優先度順序。
PrioritySequenceId: integer (int64)

タイトル: Priority Sequence ID

送信者優先度順序の一意の識別子。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "ExtnEventActionProperty":"HideInFieldUpdate"
            },
            "x-queryable":true
        },
        "PrioritySequence":{
            "title":"Priority Sequence",
            "type":"integer",
            "description":"The priority sequence of the sender type.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "ExtnEventActionProperty":"HideInFieldUpdate"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "ExtnEventActionProperty":"HideInFieldUpdate"
            },
            "x-queryable":true
        },
        "LookupType":{
            "title":"Lookup Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of sender of a message such as Business Contact, Consumer, or Employee.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ChannelId":{
            "title":"Channel ID",
            "type":"integer",
            "description":"The unique identifier of the channel associated with the sender priority sequeuce.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "ExtnEventActionProperty":"HideInFieldUpdate"
            },
            "x-queryable":true
        },
        "PrioritySequenceId":{
            "title":"Priority Sequence ID",
            "type":"integer",
            "description":"The unique identifier of the sender priority sequence.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "ExtnEventActionProperty":"HideInFieldUpdate"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "ExtnEventActionProperty":"HideInFieldUpdate"
            },
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "ExtnEventActionProperty":"HideInFieldUpdate"
            },
            "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"
    }
}

リンク

BusinessUnitLOV

操作: /crmRestApi/resources/11.13.18.05/serviceBusinessUnits

ビジネス・ユニットの一意の識別子を含む値リスト。

LOVリンク関連では、次のプロパティが定義されます:

ソース属性: BUOrgId;ターゲット属性: BusinessUnitId
表示属性: 名前

ChannelTypeCdLOV

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

ファインダ: LookupTypeFinder%3BLookupType%3DORA_SVC_CHANNEL_TYPE_CD

チャネル・タイプを示す値リスト。

LOVリンク関連では、次のプロパティが定義されます:

ソース属性: ChannelTypeCd;ターゲット属性: LookupCode
表示属性: 意味

CustomerTypeCdLookup

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

ファインダ: LookupTypeFinder%3BLookupType%3DORA_SVC_CUSTOMER_TYPE_CD

LOVリンク関連では、次のプロパティが定義されます:

ソース属性: CustomerTypeCd;ターゲット属性: LookupCode
表示属性: 意味

MultipleMatchesActionCdLookup

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

ファインダ: LookupTypeFinder%3BLookupType%3DORA_SVC_MULT_MATCHES_ACTION_CD

LOVリンク関連では、次のプロパティが定義されます:

ソース属性: MultipleMatchesActionCd;ターゲット属性: LookupCode
表示属性: 意味

NetworkTypeCdLOV

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

ファインダ: LookupTypeFinder%3BLookupType%3DHZ_INSTANT_MESSENGER_TYPE

ソーシャル・ネットワーク・タイプを示す値リスト。

LOVリンク関連では、次のプロパティが定義されます:

ソース属性: NetworkTypeCd;ターゲット属性: LookupCode
表示属性: 意味

NoMatchActionCdLookup

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

ファインダ: LookupTypeFinder%3BLookupType%3DORA_SVC_NO_MATCH_ACTION_CD

LOVリンク関連では、次のプロパティが定義されます:

ソース属性: NoMatchActionCd;ターゲット属性: LookupCode
表示属性: 意味

PurposeCdLookup

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

ファインダ: LookupTypeFinder%3BLookupType%3DORA_SVC_CHANNEL_PURPOSE

LOVリンク関連では、次のプロパティが定義されます:

ソース属性: PurposeCd;ターゲット属性: LookupCode
表示属性: 意味

SourceCdLOV

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

ファインダ: LookupTypeFinder%3BLookupType%3DORA_SVC_SOURCE_CD

LOVリンク関連では、次のプロパティが定義されます:

ソース属性: SourceCd;ターゲット属性: LookupCode
表示属性: 意味

StripeCdLOV

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

ファインダ: LookupTypeFinder%3BLookupType%3DORA_SVC_STRIPE_CD

アプリケーション・ストライプを示す値リスト。

LOVリンク関連では、次のプロパティが定義されます:

ソース属性: StripeCd;ターゲット属性: LookupCode
表示属性: 意味

YesNoLOV

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

ファインダ: LookupTypeFinder%3BLookupType%3DYES_NO

チャネルがアクティブかどうかを示す値リスト。

LOVリンク関連では、次のプロパティが定義されます:

ソース属性: IncludeSenderEmailFlag;ターゲット属性: LookupCode
表示属性: 意味

resourceMembers

操作: /crmRestApi/resources/11.13.18.05/channels/{ChannelId}/child/resourceMembers

パラメータ:

ChannelId: $request.path.ChannelId

senderIdentificationPriorities

操作: /crmRestApi/resources/11.13.18.05/channels/{ChannelId}/child/senderIdentificationPriorities

パラメータ:

ChannelId: $request.path.ChannelId

トップに戻る

例:

特定のチャネルの詳細を取得するには、次のURI構文でGETを使用します:

リクエストURIの例

次に、リクエストURLの例を示します。

https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/channels/300100095223514

リクエスト・ヘッダーの例

次に、リクエスト・ヘッダーの例を示します。

GET /crmRestApi/resources/11.13.18.05/channels/300100095223514 HTTP/1.1
HOST: servername.fa.us2.oraclecloud.com
authorization: Basic U0FMRVNfQURNSU46V2VsY29tZTE=
content-type: application/vnd.oracle.adf.resourceitem+json

レスポンス・ヘッダーの例

次に、レスポンス・ヘッダーの例を示します。

HTTP/1.1 200: OK
Date: Mon, 12 Jan 2017 13:30:04 GMT
Server: Oracle-HTTP-Server-11g
Content-Type: application/vnd.oracle.adf.resourceitem+json
Content-Language: en

レスポンス本文の例

次に、JSON形式のレスポンス本文の例を示します。

{
"ChannelId": 300100095223514,
"ChannelTypeCd": "ORA_SVC_SOCIAL",
"NetworkTypeCd": null,
"AccountName": "REST-03181052",
"DisplayName": "REST-03181052",
"PrivatePToPAllowedFlag": true,
"OriginalSystemReference": null,
"EnabledFlag": true,
"CreatedBy": "SALES_ADMIN",
"CreationDate": "2017-01-12T02:18:13-08:00",
"LastUpdatedBy": "SALES_ADMIN",
"LastUpdateDate": "2017-01-12T02:18:13-08:00",
"LastUpdateLogin": null,
"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",
"links": [
  {
"rel": "self",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/channels/300100095223514",
"name": "channels",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787200106A6176612E6C616E672E4F626A656374000000000000000000000078700000000178"
}
},
  {
"rel": "canonical",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/channels/300100095223514",
"name": "channels",
"kind": "item"
},
  {
"rel": "lov",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/channels/300100095223514/lov/YesNoLOV",
"name": "YesNoLOV",
"kind": "collection"
},
  {
"rel": "lov",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/channels/300100095223514/lov/NetworkTypeCdLOV",
"name": "NetworkTypeCdLOV",
"kind": "collection"
},
  {
"rel": "lov",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/channels/300100095223514/lov/StripeCdLOV",
"name": "StripeCdLOV",
"kind": "collection"
},
  {
"rel": "lov",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/channels/300100095223514/lov/ChannelTypeCdLOV",
"name": "ChannelTypeCdLOV",
"kind": "collection"
},
  {
"rel": "child",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/channels/300100095223514/child/resourceMembers",
"name": "resourceMembers",
"kind": "collection"
}
],
}

「トップに戻る」