機械翻訳について

ジャンプ先

• リクエスト
• レスポンス

スマート・データの更新

patch

/crmRestApi/resources/11.13.18.05/daaSSmartData/{daaSSmartDataUniqID}

リクエスト

パス・パラメータ

• daaSSmartDataUniqID(required): string
  これは、DaaSスマート・データ・リソースのコンポジット・キーを構成し、DaaSスマート・データのインスタンスを一意に識別するために使用される属性のハッシュ・キーです。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントは、DaaSスマート・データの特定のインスタンスに移動してハッシュ・キーを取得するために、DaaSスマート・データ収集リソースを問い合せる必要があります。

ヘッダー・パラメータ

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

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

• application/json

リクエスト本文 - application/json ()

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

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

タイプ: object

ソースを表示

• AccountFields: string
  住所、名前(姓)などの取引先に関する情報を含むフィールド。
• AccountSuggestionAPIEndpoint: string
  キーワードによるアカウント提案の取得に使用されるDaaS提案APIエンドポイント。
• AddressFields: string
  住所1、PINコードなど、住所を形成するフィールド。
• AddressSuggestionAPIEndpoint: string
  キーワードによるアドレスの提案の取得に使用されるDaaS提案APIエンドポイント。

{
    "type":"object",
    "properties":{
        "AddressSuggestionAPIEndpoint":{
            "type":"string",
            "description":"The DaaS Suggestion API endpoint used to get address suggestions by a keyword.",
            "nullable":true
        },
        "AccountFields":{
            "type":"string",
            "description":"The fields that include information about the account such as Address, Last Name, and so on.",
            "nullable":true
        },
        "AddressFields":{
            "type":"string",
            "description":"The fields that form the address such as Address 1, Pin code, and so on.",
            "nullable":true
        },
        "AccountSuggestionAPIEndpoint":{
            "type":"string",
            "description":"The DaaS Suggestion API endpoint used to get account suggestions by a keyword.",
            "nullable":true
        }
    }
}

トップに戻る

応答

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

• application/json

デフォルトのレスポンス

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

ヘッダー

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

本文( )

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

タイプ: object

ソースを表示

• AccountFields: string
  住所、名前(姓)などの取引先に関する情報を含むフィールド。
• AccountSmartDataEnabled: string
  読取り専用: true

  アカウントがスマート・データに対して使用可能かどうかを示します。
• AccountSuggestionAPIEndpoint: string
  キーワードによるアカウント提案の取得に使用されるDaaS提案APIエンドポイント。
• Address: string
  読取り専用: true

  スマート・データに関連付けられた企業の住所。
• AddressFields: string
  住所1、PINコードなど、住所を形成するフィールド。
• AddressSuggestionAPIEndpoint: string
  キーワードによるアドレスの提案の取得に使用されるDaaS提案APIエンドポイント。
• IconUrl: string
  読取り専用: true

  会社のアイコンまたはロゴのURL。
• Id: string
  読取り専用: true

  会社の一意の識別子。
• Industry: string
  読取り専用: true

  会社が属する幅広い産業。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• OrganizationName: string
  読取り専用: true

  スマート・データに関連付けられている企業の名前。
• Revenue: string
  読取り専用: true

  スマート・データに関連する企業の売上。

{
    "type":"object",
    "properties":{
        "OrganizationName":{
            "type":"string",
            "description":"The name of the company associated with the smart data.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Industry":{
            "type":"string",
            "description":"The broad industry to which the company belongs to.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IconUrl":{
            "type":"string",
            "description":"The url to the icon or logo of the company.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AddressSuggestionAPIEndpoint":{
            "type":"string",
            "description":"The DaaS Suggestion API endpoint used to get address suggestions by a keyword.",
            "nullable":true,
            "x-queryable":true
        },
        "AccountFields":{
            "type":"string",
            "description":"The fields that include information about the account such as Address, Last Name, and so on.",
            "nullable":true,
            "x-queryable":true
        },
        "Address":{
            "type":"string",
            "description":"The address of the company associated wth the smart data.",
            "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"
            }
        },
        "Revenue":{
            "type":"string",
            "description":"The revenue of the company associated wth the smart data.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Id":{
            "type":"string",
            "description":"The unique identifier of the company.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AccountSmartDataEnabled":{
            "type":"string",
            "description":"Indicates if the account is enabled for smart data.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AddressFields":{
            "type":"string",
            "description":"The fields that form the address such as Address 1, Pin code, and so on.",
            "nullable":true,
            "x-queryable":true
        },
        "AccountSuggestionAPIEndpoint":{
            "type":"string",
            "description":"The DaaS Suggestion API endpoint used to get account suggestions by a keyword.",
            "nullable":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."
        }
    }
}

「トップに戻る」