機械翻訳について

ジャンプ先

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

テリトリのルール境界値の更新

patch

/crmRestApi/resources/11.13.18.05/territories/{TerritoryVersionId}/child/TerritoryRule/{TerrRuleId}/child/TerritoryRuleBoundary1/{TerrRuleBoundaryId}/child/TerritoryRuleBndryValue1/{TerrRuleBndryValueId}

リクエスト

パス・パラメータ

• TerrRuleBndryValueId(required): integer(int64)
  テリトリ・ルール境界値の一意の識別子。
• TerrRuleBoundaryId(required): integer(int64)
  テリトリ・ルール境界の一意の識別子。
• TerrRuleId(required): integer(int64)
  テリトリ・ルールの一意の識別子。
• TerritoryVersionId(required): integer(int64)
  テリトリ・バージョンの一意の識別子。

ヘッダー・パラメータ

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

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

• application/json

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

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

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

タイプ: object

ソースを表示

• AddrElementAttribute1: string
  タイトル: Additional Attribute 1

  最大長: 150

  柔軟な住所書式をサポートするための追加住所要素。
• AddrElementAttribute2: string
  タイトル: Additional Attribute 2

  最大長: 150

  柔軟な住所書式をサポートするための追加住所要素。
• AddrElementAttribute3: string
  タイトル: Additional Attribute 3

  最大長: 150

  柔軟な住所書式をサポートするための追加住所要素。
• AddrElementAttribute4: string
  タイトル: Additional Attribute 4

  最大長: 150

  柔軟な住所書式をサポートするための追加住所要素。
• AddrElementAttribute5: string
  タイトル: Additional Attribute 5

  最大長: 150

  柔軟な住所書式をサポートするための追加住所要素。
• AddressCity: string
  タイトル: City

  最大長: 60

  市区町村
• AddressCountry: string
  タイトル: Country

  最大長: 2

  国
• AddressCounty: string
  タイトル: County

  最大長: 60

  County
• AddressPostalCode: string
  タイトル: Postal Code

  最大長: 60

  郵便番号
• AddressProvince: string
  タイトル: Province

  最大長: 60

  Province
• AddressState: string
  タイトル: State

  最大長: 60

  都道府県。
• DimensionMember: string
  テリトリ・ディメンション・メンバーの名前。
• IncludeHierarchyFlag: boolean
  タイトル: Include Hierarchy

  最大長: 1

  ディメンション・メンバーが階層とともに含まれているかどうかを示します。 デフォルト値はtrueです。
• TerrRuleBoundaryId: integer (int64)
  タイトル: Territory Number

  テリトリ・ルール境界の識別子。

{
    "type":"object",
    "properties":{
        "AddrElementAttribute5":{
            "title":"Additional Attribute 5",
            "maxLength":150,
            "type":"string",
            "description":"Additional address element to support flexible address format.",
            "nullable":true
        },
        "DimensionMember":{
            "type":"string",
            "description":"The name of the territory dimension member.",
            "nullable":true
        },
        "AddressCountry":{
            "title":"Country",
            "maxLength":2,
            "type":"string",
            "description":"Country.",
            "nullable":true
        },
        "IncludeHierarchyFlag":{
            "title":"Include Hierarchy",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the dimension member is included along with its hierarchy or not. The default value is true.",
            "nullable":true
        },
        "AddrElementAttribute1":{
            "title":"Additional Attribute 1",
            "maxLength":150,
            "type":"string",
            "description":"Additional address element to support flexible address format.",
            "nullable":true
        },
        "AddrElementAttribute2":{
            "title":"Additional Attribute 2",
            "maxLength":150,
            "type":"string",
            "description":"Additional address element to support flexible address format.",
            "nullable":true
        },
        "AddrElementAttribute3":{
            "title":"Additional Attribute 3",
            "maxLength":150,
            "type":"string",
            "description":"Additional address element to support flexible address format.",
            "nullable":true
        },
        "AddressPostalCode":{
            "title":"Postal Code",
            "maxLength":60,
            "type":"string",
            "description":"Postal Code.",
            "nullable":true
        },
        "AddrElementAttribute4":{
            "title":"Additional Attribute 4",
            "maxLength":150,
            "type":"string",
            "description":"Additional address element to support flexible address format.",
            "nullable":true
        },
        "AddressCounty":{
            "title":"County",
            "maxLength":60,
            "type":"string",
            "description":"County.",
            "nullable":true
        },
        "AddressProvince":{
            "title":"Province",
            "maxLength":60,
            "type":"string",
            "description":"Province.",
            "nullable":true
        },
        "AddressCity":{
            "title":"City",
            "maxLength":60,
            "type":"string",
            "description":"City.",
            "nullable":true
        },
        "TerrRuleBoundaryId":{
            "title":"Territory Number",
            "type":"integer",
            "description":"The identifier of the territory rule boundary.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "AddressState":{
            "title":"State",
            "maxLength":60,
            "type":"string",
            "description":"State.",
            "nullable":true
        }
    }
}

トップに戻る

応答

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

• application/json

デフォルトのレスポンス

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

ヘッダー

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

本文( )

ルート・スキーマ : territories-TerritoryRule-TerritoryRuleBoundary1-TerritoryRuleBndryValue1-item-response

タイプ: object

ソースを表示

• AddrElementAttribute1: string
  タイトル: Additional Attribute 1

  最大長: 150

  柔軟な住所書式をサポートするための追加住所要素。
• AddrElementAttribute2: string
  タイトル: Additional Attribute 2

  最大長: 150

  柔軟な住所書式をサポートするための追加住所要素。
• AddrElementAttribute3: string
  タイトル: Additional Attribute 3

  最大長: 150

  柔軟な住所書式をサポートするための追加住所要素。
• AddrElementAttribute4: string
  タイトル: Additional Attribute 4

  最大長: 150

  柔軟な住所書式をサポートするための追加住所要素。
• AddrElementAttribute5: string
  タイトル: Additional Attribute 5

  最大長: 150

  柔軟な住所書式をサポートするための追加住所要素。
• AddressCity: string
  タイトル: City

  最大長: 60

  市区町村
• AddressCountry: string
  タイトル: Country

  最大長: 2

  国
• AddressCounty: string
  タイトル: County

  最大長: 60

  County
• AddressPostalCode: string
  タイトル: Postal Code

  最大長: 60

  郵便番号
• AddressProvince: string
  タイトル: Province

  最大長: 60

  Province
• AddressState: string
  タイトル: State

  最大長: 60

  都道府県。
• CreatedBy: string
  タイトル: Created By

  読取り専用: true

  最大長: 64

  テリトリ・ルール境界値を作成したユーザー。
• CreationDate: string (date-time)
  タイトル: Creation Date

  読取り専用: true

  テリトリ・ルール境界値が作成された日付。
• DimensionMember: string
  テリトリ・ディメンション・メンバーの名前。
• DimensionMemberHigh: string
  タイトル: Territory Dimension Member High

  読取り専用: true

  最大長: 360

  連番が高いテリトリ・ディメンション・メンバーの名前。
• IncludeHierarchyFlag: boolean
  タイトル: Include Hierarchy

  最大長: 1

  ディメンション・メンバーが階層とともに含まれているかどうかを示します。 デフォルト値はtrueです。
• LastUpdateDate: string (date-time)
  タイトル: Last Updated Date

  読取り専用: true

  テリトリ・ルール境界値が最後に更新された日付。
• LastUpdatedBy: string
  タイトル: Last Updated By

  読取り専用: true

  最大長: 64

  テリトリ・ルール境界値を最後に更新したユーザー。
• LastUpdateLogin: string
  タイトル: Last Update Login

  読取り専用: true

  最大長: 32

  テリトリ・ルール境界値を最後に更新したユーザーのログイン。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• TerrDimensionCode: string
  タイトル: Dimension

  最大長: 5

  テリトリ・ディメンションを示すコード。 たとえば、AcTyp、Acct、Aux1、Aux2、Aux3、BUnit、CSize、Geo、Indst、OrgTp、Prod、Prtnr、SChnlなどです。
• TerrDimHighIntgId: string
  タイトル: Dimension Value Range

  最大長: 80

  順序番号が大きいOracle Business Intelligence (OBI)、テリトリ管理およびキューブの共通メンバーの一意の識別子。
• TerrDimIntgId: string
  タイトル: Dimension Value

  最大長: 80

  Oracle Business Intelligence (OBI)、テリトリ管理およびキューブの共通メンバーの一意の識別子。
• TerrRuleBndryValueId: integer (int64)
  タイトル: Territory Dimension Member ID

  テリトリ・ルール境界値の一意の識別子。
• TerrRuleBoundaryId: integer (int64)
  タイトル: Territory Number

  テリトリ・ルール境界の識別子。

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date the territory rule boundary value was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DimensionMemberHigh":{
            "title":"Territory Dimension Member High",
            "maxLength":360,
            "type":"string",
            "description":"The name of the territory dimension member with a high sequence number.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AddressCountry":{
            "title":"Country",
            "maxLength":2,
            "type":"string",
            "description":"Country.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressPostalCode":{
            "title":"Postal Code",
            "maxLength":60,
            "type":"string",
            "description":"Postal Code.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressCounty":{
            "title":"County",
            "maxLength":60,
            "type":"string",
            "description":"County.",
            "nullable":true,
            "x-queryable":true
        },
        "TerrDimHighIntgId":{
            "title":"Dimension Value Range",
            "maxLength":80,
            "type":"string",
            "description":"The unique identifier of the common member of Oracle Business Intelligence (OBI), Territory Management, and Cube with a high sequence number.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressCity":{
            "title":"City",
            "maxLength":60,
            "type":"string",
            "description":"City.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the territory rule boundary value.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the territory rule boundary value.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AddrElementAttribute5":{
            "title":"Additional Attribute 5",
            "maxLength":150,
            "type":"string",
            "description":"Additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":true
        },
        "DimensionMember":{
            "type":"string",
            "description":"The name of the territory dimension member.",
            "nullable":true,
            "x-queryable":true
        },
        "TerrDimIntgId":{
            "title":"Dimension Value",
            "maxLength":80,
            "type":"string",
            "description":"The unique identifier of the common member of Oracle Business Intelligence (OBI), Territory Management, and Cube.",
            "nullable":true,
            "x-queryable":true
        },
        "IncludeHierarchyFlag":{
            "title":"Include Hierarchy",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the dimension member is included along with its hierarchy or not. The default value is true.",
            "nullable":true,
            "x-queryable":true
        },
        "AddrElementAttribute1":{
            "title":"Additional Attribute 1",
            "maxLength":150,
            "type":"string",
            "description":"Additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":true
        },
        "AddrElementAttribute2":{
            "title":"Additional Attribute 2",
            "maxLength":150,
            "type":"string",
            "description":"Additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":true
        },
        "AddrElementAttribute3":{
            "title":"Additional Attribute 3",
            "maxLength":150,
            "type":"string",
            "description":"Additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":true
        },
        "AddrElementAttribute4":{
            "title":"Additional Attribute 4",
            "maxLength":150,
            "type":"string",
            "description":"Additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressProvince":{
            "title":"Province",
            "maxLength":60,
            "type":"string",
            "description":"Province.",
            "nullable":true,
            "x-queryable":true
        },
        "TerrRuleBndryValueId":{
            "title":"Territory Dimension Member ID",
            "type":"integer",
            "description":"The unique identifier of the territory rule boundary value.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TerrRuleBoundaryId":{
            "title":"Territory Number",
            "type":"integer",
            "description":"The identifier of the territory rule boundary.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TerrDimensionCode":{
            "title":"Dimension",
            "maxLength":5,
            "type":"string",
            "description":"The code indicating the territory dimension. For example, AcTyp, Acct, Aux1, Aux2, Aux3, BUnit, CSize, Geo, Indst, OrgTp, Prod, Prtnr, or SChnl.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date the territory rule boundary value was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the territory rule boundary value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AddressState":{
            "title":"State",
            "maxLength":60,
            "type":"string",
            "description":"State.",
            "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."
        }
    }
}

トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対してPATCHリクエストを発行することによって、テリトリのルール境界値を更新する方法を示しています。

cURLコマンド

curl -u <username:password> \ -X PATCH https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/territories/300100091635502/child/TerritoryRule/300100091635553/child/TerritoryRuleBoundary1/300100091635571/child/TerritoryRuleBndryValue1/300100091636168

リクエスト本文の例

次の例は、JSON形式のリクエスト本文のコンテンツを示しています。

{
  "IncludeHierarchyFlag": "false"
}

レスポンス本文の例

次の例は、JSON形式のレスポンス本文のコンテンツを示しています。

{
"TerrRuleBndryValueId": 300100091700499,
"TerrRuleBoundaryId": 300100091700498,
"DimensionMember": "OBIA AtanTour",
"DimensionMemberHigh": null,
"TerrDimHighIntgId": null,
"TerrDimIntgId": "100000020228289",
"TerrDimensionCode": "Acct",
"IncludeHierarchyFlag": false,
"links":[
{"rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/territories/300100091635502/child/TerritoryRule/300100091700497/child/TerritoryRuleBoundary1/300100091700498/child/TerritoryRuleBndryValue1/300100091700499",???},
{"rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/territories/300100091635502/child/TerritoryRule/300100091700497/child/TerritoryRuleBoundary1/300100091700498/child/TerritoryRuleBndryValue1/300100091700499",???},
{"rel": "parent", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/territories/300100091635502/child/TerritoryRule/300100091700497/child/TerritoryRuleBoundary1/300100091700498",???}
]
}

「トップに戻る」