機械翻訳について

ジャンプ先

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

地理設定データの更新

patch

/crmRestApi/resources/11.13.18.05/setupAssistants/{Name}/child/Geographies/{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

ソースを表示

• CountryFirst: string
  最大長: 80

  地理データをインポートする必要がある最初の国。
• CountrySecond: string
  最大長: 80

  地理データをインポートする必要がある2番目の国。
• CountryThird: string
  最大長: 80

  地理データをインポートする必要がある3番目の国。
• EnableGeoEncoding: string
  最大長: 5

  デフォルト値: N

  インポートされた国に対して地理エンコーディングを使用可能にする必要があるかどうかを示します。

{
    "type":"object",
    "properties":{
        "CountryThird":{
            "maxLength":80,
            "type":"string",
            "description":"The third country for which the geography data has to be imported.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CountrySecond":{
            "maxLength":80,
            "type":"string",
            "description":"The second country for which the geography data has to be imported.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "EnableGeoEncoding":{
            "maxLength":5,
            "type":"string",
            "description":"Indicates if the geography encoding has to be enabled for the imported countries.",
            "nullable":true,
            "default":"N",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CountryFirst":{
            "maxLength":80,
            "type":"string",
            "description":"The first country for which the geography data has to be imported.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

トップに戻る

応答

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

• application/json

デフォルトのレスポンス

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

ヘッダー

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

本文( )

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

タイプ: object

ソースを表示

• CountryFirst: string
  最大長: 80

  地理データをインポートする必要がある最初の国。
• CountrySecond: string
  最大長: 80

  地理データをインポートする必要がある2番目の国。
• CountryThird: string
  最大長: 80

  地理データをインポートする必要がある3番目の国。
• EnableGeoEncoding: string
  最大長: 5

  デフォルト値: N

  インポートされた国に対して地理エンコーディングを使用可能にする必要があるかどうかを示します。
• Id: string
  地理設定タスクの一意の識別子。
• links: array Links
  タイトル: Links

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

{
    "type":"object",
    "properties":{
        "CountryThird":{
            "maxLength":80,
            "type":"string",
            "description":"The third country for which the geography data has to be imported.",
            "nullable":true,
            "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"
            }
        },
        "CountrySecond":{
            "maxLength":80,
            "type":"string",
            "description":"The second country for which the geography data has to be imported.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Id":{
            "type":"string",
            "description":"The unique identifier of geography setup task.",
            "nullable":false,
            "x-queryable":true
        },
        "EnableGeoEncoding":{
            "maxLength":5,
            "type":"string",
            "description":"Indicates if the geography encoding has to be enabled for the imported countries.",
            "nullable":true,
            "default":"N",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CountryFirst":{
            "maxLength":80,
            "type":"string",
            "description":"The first country for which the geography data has to be imported.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "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."
        }
    }
}

「トップに戻る」