機械翻訳について

ジャンプ先

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

適応検索設定詳細の更新

patch

/crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/child/AdaptiveSearch/{Id}

リクエスト

パス・パラメータ

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

ヘッダー・パラメータ

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

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

• application/json

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

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

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

タイプ: object

ソースを表示

• Account: string
  最大長: 80

  デフォルト値: Y

  アカウントが適応型検索公開用に選択されているかどうかを示します。
• Activity: string
  最大長: 80

  デフォルト値: Y

  適応検索公開にアクティビティが選択されているかどうかを示します。
• Contact: string
  最大長: 80

  デフォルト値: Y

  適応型検索公開に担当者が選択されているかどうかを示します。
• Lead: string
  最大長: 80

  デフォルト値: Y

  リードがアダプティブ検索公開用に選択されているかどうかを示します。
• Opportunity: string
  最大長: 80

  デフォルト値: Y

  商談が適応型検索公開用に選択されているかどうかを示します。
• Partner: string
  最大長: 80

  デフォルト値: N

  パートナが適応型検索公開用に選択されているかどうかを示します。
• PartnerContact: string
  最大長: 80

  デフォルト値: N

  パートナ担当者がアダプティブ検索公開用に選択されているかどうかを示します。
• Product: string
  最大長: 80

  デフォルト値: N

  適応型検索公開に対して製品が選択されているかどうかを示します。
• ProductGroup: string
  最大長: 80

  デフォルト値: N

  適応型検索公開に対して製品グループが選択されているかどうかを示します。
• ServiceRequest: string
  最大長: 80

  デフォルト値: N

  アダプティブ検索公開のサービス・リクエストが選択されているかどうかを示します。

{
    "type":"object",
    "properties":{
        "Account":{
            "maxLength":80,
            "type":"string",
            "description":"Indicates whether the account has been selected for adaptive search publish.",
            "nullable":false,
            "default":"Y"
        },
        "ProductGroup":{
            "maxLength":80,
            "type":"string",
            "description":"Indicates whether Product Group has been selected for the adaptive search publish.",
            "nullable":false,
            "default":"N"
        },
        "Opportunity":{
            "maxLength":80,
            "type":"string",
            "description":"Indicates whether the opportunity has been selected for adaptive search publish.",
            "nullable":false,
            "default":"Y"
        },
        "Lead":{
            "maxLength":80,
            "type":"string",
            "description":"Indicates whether the lead has been selected for adaptive search publish.",
            "nullable":false,
            "default":"Y"
        },
        "Activity":{
            "maxLength":80,
            "type":"string",
            "description":"Indicates whether the activity has been selected for adaptive search publish.",
            "nullable":false,
            "default":"Y"
        },
        "Product":{
            "maxLength":80,
            "type":"string",
            "description":"Indicates whether Product has been selected for the adaptive search publish.",
            "nullable":false,
            "default":"N"
        },
        "Partner":{
            "maxLength":80,
            "type":"string",
            "description":"Indicates whether the partner has been selected for adaptive search publish.",
            "nullable":false,
            "default":"N"
        },
        "PartnerContact":{
            "maxLength":80,
            "type":"string",
            "description":"Indicates whether the partner contact has been selected for adaptive search publish.",
            "nullable":false,
            "default":"N"
        },
        "ServiceRequest":{
            "maxLength":80,
            "type":"string",
            "description":"Indicates whether the service request has been selected for adaptive search publish.",
            "nullable":false,
            "default":"N"
        },
        "Contact":{
            "maxLength":80,
            "type":"string",
            "description":"Indicates whether the contact has been selected for adaptive search publish.",
            "nullable":false,
            "default":"Y"
        }
    }
}

トップに戻る

応答

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

• application/json

デフォルトのレスポンス

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

ヘッダー

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

本文( )

ルート・スキーマ : setupAssistants-AdaptiveSearch-item-response

タイプ: object

ソースを表示

• Account: string
  最大長: 80

  デフォルト値: Y

  アカウントが適応型検索公開用に選択されているかどうかを示します。
• Activity: string
  最大長: 80

  デフォルト値: Y

  適応検索公開にアクティビティが選択されているかどうかを示します。
• Contact: string
  最大長: 80

  デフォルト値: Y

  適応型検索公開に担当者が選択されているかどうかを示します。
• Id: string
  最大長: 80

  アダプティブ検索設定タスクの一意の識別子。
• Lead: string
  最大長: 80

  デフォルト値: Y

  リードがアダプティブ検索公開用に選択されているかどうかを示します。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• Opportunity: string
  最大長: 80

  デフォルト値: Y

  商談が適応型検索公開用に選択されているかどうかを示します。
• Partner: string
  最大長: 80

  デフォルト値: N

  パートナが適応型検索公開用に選択されているかどうかを示します。
• PartnerContact: string
  最大長: 80

  デフォルト値: N

  パートナ担当者がアダプティブ検索公開用に選択されているかどうかを示します。
• Product: string
  最大長: 80

  デフォルト値: N

  適応型検索公開に対して製品が選択されているかどうかを示します。
• ProductGroup: string
  最大長: 80

  デフォルト値: N

  適応型検索公開に対して製品グループが選択されているかどうかを示します。
• ServiceRequest: string
  最大長: 80

  デフォルト値: N

  アダプティブ検索公開のサービス・リクエストが選択されているかどうかを示します。

{
    "type":"object",
    "properties":{
        "Account":{
            "maxLength":80,
            "type":"string",
            "description":"Indicates whether the account has been selected for adaptive search publish.",
            "nullable":false,
            "default":"Y",
            "x-queryable":true
        },
        "ProductGroup":{
            "maxLength":80,
            "type":"string",
            "description":"Indicates whether Product Group has been selected for the adaptive search publish.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "Opportunity":{
            "maxLength":80,
            "type":"string",
            "description":"Indicates whether the opportunity has been selected for adaptive search publish.",
            "nullable":false,
            "default":"Y",
            "x-queryable":true
        },
        "Lead":{
            "maxLength":80,
            "type":"string",
            "description":"Indicates whether the lead has been selected for adaptive search publish.",
            "nullable":false,
            "default":"Y",
            "x-queryable":true
        },
        "Activity":{
            "maxLength":80,
            "type":"string",
            "description":"Indicates whether the activity has been selected for adaptive search publish.",
            "nullable":false,
            "default":"Y",
            "x-queryable":true
        },
        "Product":{
            "maxLength":80,
            "type":"string",
            "description":"Indicates whether Product has been selected for the adaptive search publish.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Id":{
            "maxLength":80,
            "type":"string",
            "description":"The unique identifier of the adaptive search setup task.",
            "nullable":false,
            "x-queryable":true
        },
        "Partner":{
            "maxLength":80,
            "type":"string",
            "description":"Indicates whether the partner has been selected for adaptive search publish.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "PartnerContact":{
            "maxLength":80,
            "type":"string",
            "description":"Indicates whether the partner contact has been selected for adaptive search publish.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "ServiceRequest":{
            "maxLength":80,
            "type":"string",
            "description":"Indicates whether the service request has been selected for adaptive search publish.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "Contact":{
            "maxLength":80,
            "type":"string",
            "description":"Indicates whether the contact has been selected for adaptive search publish.",
            "nullable":false,
            "default":"Y",
            "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."
        }
    }
}

「トップに戻る」