機械翻訳について

ジャンプ先

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

パートナ・プログラムの国の更新

patch

/crmRestApi/resources/11.13.18.05/partnerPrograms/{ProgramNumber}/child/PartnerProgramCountries/{ProgramCountryId}

リクエスト

パス・パラメータ

• ProgramCountryId(required): integer
  プログラム国のシステム生成の一意の識別子および主キー。
• ProgramNumber(required): string
  プログラムごとに生成される代替キー識別子。

ヘッダー・パラメータ

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

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

• application/json

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

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

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

タイプ: object

ソースを表示

{
    "type":"object",
    "properties":{
    }
}

トップに戻る

応答

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

• application/json

デフォルトのレスポンス

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

ヘッダー

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

本文( )

ルート・スキーマ : partnerPrograms-PartnerProgramCountries-item-response

タイプ: object

ソースを表示

• CountryCode: string
  最大長: 2

  パートナ・プログラムが適用される国コード。
• CountryName: string
  タイトル: Territory Name

  読取り専用: true

  最大長: 80

  パートナ・プログラムが適用される国の名前。
• CreatedBy: string
  読取り専用: true

  最大長: 64

  行を作成したユーザー。
• CreationDate: string (date-time)
  読取り専用: true

  行が作成された日時。
• DeleteFlag: boolean
  読取り専用: true

  プログラム国を削除できるかどうかを示します。 値がYの場合、プログラム国を削除できます。 デフォルト値はNです。
• LastUpdateDate: string (date-time)
  読取り専用: true

  行が最後に更新された日時。
• LastUpdatedBy: string
  読取り専用: true

  最大長: 64

  行を最後に更新したユーザー。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• PartnerProgramId: integer
  国に関連付けられているパートナ・プログラムの一意の識別子。
• ProgramCountryId: integer
  プログラム国のシステム生成の一意の識別子および主キー。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CountryName":{
            "title":"Territory Name",
            "maxLength":80,
            "type":"string",
            "description":"The name of a country to which a partner program applies.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartnerProgramId":{
            "type":"integer",
            "description":"The unique identifier for the partner program associated with the country.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ProgramCountryId":{
            "type":"integer",
            "description":"The system-generated unique identifier and primary key for the program country.",
            "nullable":false,
            "x-queryable":false
        },
        "CountryCode":{
            "maxLength":2,
            "type":"string",
            "description":"The country code to which the partner program applies.",
            "nullable":false,
            "x-queryable":true
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates whether the program countries can be deleted. If the value is Y, then the program countries can be deleted. The default value is N.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time the row was last updated.",
            "format":"date-time",
            "nullable":false,
            "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."
        }
    }
}

トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対するパッチ・リクエストを発行することによって、パートナ・プログラムの国を更新する方法を示しています。

cURLコマンド

curl -v -u Username:Password curl -v -u Username:Password -H "content-type:application/vnd.oracle.adf.resourceitem+json" -X PATCH "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/partnerPrograms/CDRM_12005/child/PartnerProgramCountries/300100071293763" -d '{request_payload}'

リクエスト本文の例

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

{
"CountryCode" : "US"
}

レスポンス本文の例

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

{
  "CountryCode" : "US",
  "CreatedBy" : "CHANNEL_OPERATIONS_MANAGER",
  "CreationDate" : "2016-02-17T17:12:40-08:00",
  "LastUpdateDate" : "2016-02-17T17:12:40-08:00"
  }

「トップに戻る」