機械翻訳について

ジャンプ先

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

テリトリのリソースの更新

patch

/crmRestApi/resources/11.13.18.05/territories/{TerritoryVersionId}/child/TerritoryResource/{TerritoryResourceUniqID}

リクエスト

パス・パラメータ

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

ヘッダー・パラメータ

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

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

• application/json

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

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

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

タイプ: object

ソースを表示

• AdministratorFlag: boolean
  タイトル: Team Member Administrator

  最大長: 1

  リソースがテリトリの管理者であるかどうかを示します。
• FunctionCode: string
  タイトル: Team Member Function

  最大長: 30

  テリトリに関連付けられたリソースの機能のコード。
• ManageForecastFlag: boolean
  タイトル: Forecasting Delegate

  最大長: 1

  テリトリ・リソースに、テリトリの所有者の代理でテリトリ予測を管理する職責が付与されているかどうかを示します。
• ResourceId: integer (int64)
  タイトル: Resource ID

  リソース・マネージャからのリソースの一意の識別子。
• TerritoryVersionId: integer (int64)
  タイトル: Territory Version ID

  テリトリ・バージョンの一意の識別子。

{
    "type":"object",
    "properties":{
        "FunctionCode":{
            "title":"Team Member Function",
            "maxLength":30,
            "type":"string",
            "description":"The code for the function of the resource associated with the territory.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "TerritoryVersionId":{
            "title":"Territory Version ID",
            "type":"integer",
            "description":"The unique identifier of the territory version.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ManageForecastFlag":{
            "title":"Forecasting Delegate",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether a territory resource has been given the responsibility to manage the territory forecast on behalf of the owner of the territory.",
            "nullable":true
        },
        "AdministratorFlag":{
            "title":"Team Member Administrator",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the resource is an administrator of the territory.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ResourceId":{
            "title":"Resource ID",
            "type":"integer",
            "description":"The unique identifier of the resource from the resource manager.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

トップに戻る

応答

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

• application/json

デフォルトのレスポンス

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

ヘッダー

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

本文( )

ルート・スキーマ : territories-TerritoryResource-item-response

タイプ: object

ソースを表示

• AdministratorFlag: boolean
  タイトル: Team Member Administrator

  最大長: 1

  リソースがテリトリの管理者であるかどうかを示します。
• CreatedBy: string
  タイトル: Created By

  読取り専用: true

  最大長: 64

  テリトリ・チーム・メンバーを作成したユーザー。
• CreationDate: string (date-time)
  タイトル: Creation Date

  読取り専用: true

  テリトリ・チーム・メンバーが作成された日付。
• Email: string
  タイトル: Email

  読取り専用: true

  最大長: 320

  テリトリ・チーム・メンバーのEメール・アドレス。
• FunctionCode: string
  タイトル: Team Member Function

  最大長: 30

  テリトリに関連付けられたリソースの機能のコード。
• 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

  リソース・インスタンスに関連付けられたリンク関係。
• ManageForecastFlag: boolean
  タイトル: Forecasting Delegate

  最大長: 1

  テリトリ・リソースに、テリトリの所有者の代理でテリトリ予測を管理する職責が付与されているかどうかを示します。
• Manager: string
  読取り専用: true

  最大長: 360

  マネージャの名前。
• OrganizationName: string
  タイトル: Organization

  読取り専用: true

  最大長: 240

  組織の名前。
• OwnerFlag: boolean
  タイトル: Owner

  読取り専用: true

  テリトリ・チーム・メンバーが所有者かどうかを示します。
• ResourceId: integer (int64)
  タイトル: Resource ID

  リソース・マネージャからのリソースの一意の識別子。
• ResourceName: string
  タイトル: Resource Name

  読取り専用: true

  最大長: 360

  テリトリに関連付けられたリソースの名前。
• ResourceNumber: string
  タイトル: Resource Registry ID

  読取り専用: true

  最大長: 30

  テリトリ・チーム・メンバーのレジストリID。
• RoleName: string
  タイトル: Team Member Role

  読取り専用: true

  最大長: 60

  リソースに関連付けられているチーム・メンバー・ロールの名前。
• TerritoryVersionId: integer (int64)
  タイトル: Territory Version ID

  テリトリ・バージョンの一意の識別子。
• TerrResourceId: integer (int64)
  タイトル: Territory Resource ID

  テリトリ・リソースの一意の識別子。
• UniqueTerritoryNumber: string
  タイトル: Unique Territory Number

  最大長: 30

  テリトリ・チーム・メンバーの一意のテリトリ番号。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the territory team member.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationName":{
            "title":"Organization",
            "maxLength":240,
            "type":"string",
            "description":"The name of the organization.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date the territory team member was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UniqueTerritoryNumber":{
            "title":"Unique Territory Number",
            "maxLength":30,
            "type":"string",
            "description":"The unique territory number of the territory team member.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the territory team member.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Email":{
            "title":"Email",
            "maxLength":320,
            "type":"string",
            "description":"The email address of the territory team member.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "AdministratorFlag":{
            "title":"Team Member Administrator",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the resource is an administrator of the territory.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ResourceName":{
            "title":"Resource Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of the resource associated with the territory.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OwnerFlag":{
            "title":"Owner",
            "type":"boolean",
            "description":"Indicates whether the territory team member is the owner.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "FunctionCode":{
            "title":"Team Member Function",
            "maxLength":30,
            "type":"string",
            "description":"The code for the function of the resource associated with the territory.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Manager":{
            "maxLength":360,
            "type":"string",
            "description":"The name of the manager.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RoleName":{
            "title":"Team Member Role",
            "maxLength":60,
            "type":"string",
            "description":"The name of the team member role associated with the resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "TerritoryVersionId":{
            "title":"Territory Version ID",
            "type":"integer",
            "description":"The unique identifier of the territory version.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ResourceNumber":{
            "title":"Resource Registry ID",
            "maxLength":30,
            "type":"string",
            "description":"The registry ID of the territory team member.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ManageForecastFlag":{
            "title":"Forecasting Delegate",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether a territory resource has been given the responsibility to manage the territory forecast on behalf of the owner of the territory.",
            "nullable":true,
            "x-queryable":true
        },
        "ResourceId":{
            "title":"Resource ID",
            "type":"integer",
            "description":"The unique identifier of the resource from the resource manager.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TerrResourceId":{
            "title":"Territory Resource ID",
            "type":"integer",
            "description":"The unique identifier of the territory resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date the territory team member 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 team member.",
            "nullable":true,
            "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."
        }
    }
}

リンク

LookupFunctionCodeViewAccessor

操作: /crmRestApi/resources/11.13.18.05/fndStaticLookups

パラメータ:

• ファインダ: LookupTypeIsEnabledFinder%3BBindLookupType%3DMOT_TEAM_MEMBER_FUNCTION

法的や営業担当など、テリトリに関連付けられたリソースのロールまたは機能の値リスト。

LOVリンク関連では、次のプロパティが定義されます:

• ソース属性: FunctionCode;ターゲット属性: LookupCode
• 表示属性: 意味

LookupYesNoViewAccessor

操作: /crmRestApi/resources/11.13.18.05/fndStaticLookups

パラメータ:

• ファインダ: LookupTypeFinder%3BBindLookupType%3DYES_NO

リソースがテリトリの管理者であるかどうかを示す値リスト。 有効な値ははいおよびいいえです。

LOVリンク関連では、次のプロパティが定義されます:

• ソース属性: AdministratorFlag;ターゲット属性: LookupCode
• 表示属性: 意味

トップに戻る

例:

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

cURLコマンド

curl -u <username:password> \ -X -X PATCH -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/territories/300100091635502/child/TerritoryResource/300100091635503

リクエスト本文の例

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

{
  "ManageForecastFlag":"true"
}

レスポンス本文の例

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

{
"TerrResourceId": 300100091635503,
"ResourceId": 100010025532672,
"ResourceName": "Gabrielle Lee",
"TerritoryVersionId": 300100091635502,
"FunctionCode": null,
"OrganizationName": null,
"RoleName": null,
"ManageForecastFlag": true,
"AdministratorFlag": null,
"Manager": null,
"links":[
{"rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/territories/300100091635502/child/TerritoryResource/300100091635503",???},
{"rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/territories/300100091635502/child/TerritoryResource/300100091635503",???},
{"rel": "parent", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/territories/300100091635502",???},
{"rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/territories/300100091635502/child/TerritoryResource/300100091635503/lov/LookupFunctionCodeViewAccessor",???},
{"rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/territories/300100091635502/child/TerritoryResource/300100091635503/lov/LookupYesNoViewAccessor",???}
]
}

「トップに戻る」