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

機械翻訳について

チャネル・リソース・メンバーの作成

post

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

リクエスト

パス・パラメータ

ChannelId(required): integer(int64)

チャネルの一意の識別子。

ヘッダー・パラメータ

Metadata-Context:

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

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

次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、サーバーは作成操作ではなくアップサート操作を実行します。アップサート操作中、サーバーはペイロードに一致する既存のリソースを検索しようとします。一致が見つかった場合、サーバーは、新しいリソースを作成するのではなく、既存のリソースを更新します。見つからないかfalse (デフォルト)の場合、サーバーは作成操作を実行します。アップサート操作は、有効日RESTリソースではサポートされていないことに注意してください。

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

application/json

次の表では、このタスクのリクエストの本文パラメータについて説明します。

ルート・スキーマ : スキーマ

タイプ: object

ソースを表示

AccountCredentials: string

タイトル: Account Credentials

最大長: 400

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

タイトル: Account Token

最大長: 400

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

タイトル: Channel ID

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

タイトル: Channel Resource ID

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

タイトル: Party ID

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

最大長: 360

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

{
    "type":"object",
    "properties":{
        "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
            }
        },
        "AccountToken":{
            "title":"Account Token",
            "maxLength":400,
            "type":"string",
            "description":"The account token associated with the channel.",
            "nullable":false
        },
        "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"
            }
        },
        "ChannelId":{
            "title":"Channel ID",
            "type":"integer",
            "description":"The unique identifier of the channel.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "AccountCredentials":{
            "title":"Account Credentials",
            "maxLength":400,
            "type":"string",
            "description":"The account credentials of the channel resource.",
            "nullable":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
            }
        }
    }
}

トップに戻る

応答

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

application/json

デフォルトのレスポンス

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

ヘッダー

Metadata-Context(required):

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

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

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

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

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

トップに戻る

例:

次の例は、RESTリソースに対してPOSTリクエストを発行してチャネル・リソース・メンバーを作成する方法を示しています。

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

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

POST /crmRestApi/resources/11.13.18.05/channels/1/child/resourceMembers
HOST: servername.fa.us2.oraclecloud.com
authorization: Basic U0FMRVNfQURNSU46V2VsY29tZTE=
content-type: application/vnd.oracle.adf.resourceitem+json

リクエスト本文の例

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

{"PartyId": "3158", 
"AccountToken": "RESTACC"}

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

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

HTTP/1.1 201 CREATED
Server: Oracle-HTTP-Server-11g
Content-Type: application/vnd.oracle.adf.resourceitem+json
Content-Language: en

レスポンス本文の例

次の例は、レスポンス本文の内容を示しています。

{
  "ChannelResourceId": 300100107975012,
  "ChannelId": 1,
  "PartyId": 3158,
  "PartyIdFK": 3158,
  "PartyName": "Merced Khayer",
  "EmailAddress": "sendmail-test-discard@oracle.com",
  "FormattedPhoneNumber": "+1 ",
  "AccountToken": "RESTACC",
  "AccountCredentials": null,
  "CreatedBy": "SALES_ADMIN",
  "CreationDate": "2017-04-14T08:12:51+00:00",
  "LastUpdateDate": "2017-04-14T08:12:51.045+00:00",
  "LastUpdateLogin": "4D1C610A4B51165AE05356C0F20AB312",
  "LastUpdatedBy": "SALES_ADMIN",
  "links": [
    {
      "rel": "self",
      "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/channels/1/child/resourceMembers/300100107975012",
      "name": "resourceMembers",
      "kind": "item",
      "properties": {
        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
      }
    },
    {
      "rel": "canonical",
      "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/channels/1/child/resourceMembers/300100107975012",
      "name": "resourceMembers",
      "kind": "item"
    },
    {
      "rel": "parent",
      "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/channels/1",
      "name": "channels",
      "kind": "item"
    },
    {
      "rel": "lov",
      "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/channels/1/child/resourceMembers/300100107975012/lov/ResourceLOV",
      "name": "ResourceLOV",
      "kind": "collection"
    }
  ]
}

「トップに戻る」