機械翻訳について

ジャンプ先

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

目標分割の更新

patch

/crmRestApi/resources/11.13.18.05/salesObjectives/{ObjectiveId}/child/SalesObjectiveSplits/{ObjectiveSplitId}

リクエスト

パス・パラメータ

• ObjectiveId(required): integer(int64)
  目標の一意の識別子。
• ObjectiveSplitId(required): integer(int64)
  目標分割の一意の識別子。

ヘッダー・パラメータ

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

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

• application/json

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

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

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

タイプ: object

ソースを表示

• AccountId: integer (int64)
  タイトル: Account

  目標に割り当てられたアカウントの一意の識別子。
• ActualValue: integer (int64)
  タイトル: Attainment

  デフォルト値: 0

  目標分割の実績達成値。
• GeographyName: string
  タイトル: Geography

  最大長: 255

  地理の名前(JAPAC、EMEA、Americasなど)。
• TargetValue: integer (int64)
  タイトル: Target

  デフォルト値: 0

  目標分割のターゲットの一意の識別子。

{
    "type":"object",
    "properties":{
        "GeographyName":{
            "title":"Geography",
            "maxLength":255,
            "type":"string",
            "description":"The name of the geography, such as JAPAC, EMEA, or Americas.",
            "nullable":false
        },
        "TargetValue":{
            "title":"Target",
            "type":"integer",
            "description":"The unique identifier for the target of the objective split.",
            "format":"int64",
            "nullable":true,
            "default":0,
            "x-hints":{
                "precision":18
            }
        },
        "AccountId":{
            "title":"Account",
            "type":"integer",
            "description":"The unique identifier of the account assigned to the objective.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ActualValue":{
            "title":"Attainment",
            "type":"integer",
            "description":"The actual attainment value for the objective split.",
            "format":"int64",
            "nullable":true,
            "default":0,
            "x-hints":{
                "precision":18
            }
        }
    }
}

トップに戻る

応答

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

• application/json

デフォルトのレスポンス

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

ヘッダー

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

本文( )

ルート・スキーマ : salesObjectives-SalesObjectiveSplits-item-response

タイプ: object

ソースを表示

• AccountId: integer (int64)
  タイトル: Account

  目標に割り当てられたアカウントの一意の識別子。
• ActualValue: integer (int64)
  タイトル: Attainment

  デフォルト値: 0

  目標分割の実績達成値。
• CreatedBy: string
  読取り専用: true

  最大長: 64

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

  レコードが作成された日付。
• DisplayPeriodName: string
  タイトル: Period

  最大長: 15

  目標分割期間の表示名。
• GeographyId: integer (int64)
  タイトル: Geography

  地理の一意の識別子。
• GeographyName: string
  タイトル: Geography

  最大長: 255

  地理の名前(JAPAC、EMEA、Americasなど)。
• LastUpdateDate: string (date-time)
  読取り専用: true

  レコードが最後に更新された日付。
• LastUpdatedBy: string
  読取り専用: true

  最大長: 64

  レコードを最後に更新したユーザー。
• LastUpdateLogin: string
  読取り専用: true

  最大長: 32

  レコードを最後に更新したユーザーのログイン。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• ObjectiveId: integer (int64)
  タイトル: Objective

  目標の一意の識別子。
• ObjectiveSplitId: integer (int64)
  目標分割の一意の識別子。
• PartyUniqueName: string
  読取り専用: true

  最大長: 900

  アカウントの名前。
• PeriodType: string
  タイトル: Period Type Code

  最大長: 30

  目標分割の期間のタイプ。
• ProdGroupName: string
  タイトル: Product Group

  読取り専用: true

  最大長: 250

  製品グループの名前。
• ProductId: integer (int64)
  タイトル: Product Group

  製品の一意の識別子。
• TargetValue: integer (int64)
  タイトル: Target

  デフォルト値: 0

  目標分割のターゲットの一意の識別子。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProdGroupName":{
            "title":"Product Group",
            "maxLength":250,
            "type":"string",
            "description":"The name of the product group.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PeriodType":{
            "title":"Period Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The type of period for the objective split.",
            "nullable":true,
            "x-queryable":true
        },
        "TargetValue":{
            "title":"Target",
            "type":"integer",
            "description":"The unique identifier for the target of the objective split.",
            "format":"int64",
            "nullable":true,
            "default":0,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "GeographyId":{
            "title":"Geography",
            "type":"integer",
            "description":"The unique identifier for the geography.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectiveId":{
            "title":"Objective",
            "type":"integer",
            "description":"The unique identifier of the objective.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AccountId":{
            "title":"Account",
            "type":"integer",
            "description":"The unique identifier of the account assigned to the objective.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PartyUniqueName":{
            "maxLength":900,
            "type":"string",
            "description":"The name of the account.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GeographyName":{
            "title":"Geography",
            "maxLength":255,
            "type":"string",
            "description":"The name of the geography, such as JAPAC, EMEA, or Americas.",
            "nullable":false,
            "x-queryable":true
        },
        "ProductId":{
            "title":"Product Group",
            "type":"integer",
            "description":"The unique identifier for the product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ActualValue":{
            "title":"Attainment",
            "type":"integer",
            "description":"The actual attainment value for the objective split.",
            "format":"int64",
            "nullable":true,
            "default":0,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectiveSplitId":{
            "type":"integer",
            "description":"The unique identifier of the objective split.",
            "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"
            }
        },
        "DisplayPeriodName":{
            "title":"Period",
            "maxLength":15,
            "type":"string",
            "description":"The display name for the objective split period.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "PeriodType"
                ]
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date on which the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "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."
        }
    }
}

トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対するパッチ・リクエストを発行することによって、目標分割を更新する方法を示しています。

cURLコマンド

curl -u <username:password> \ -X PATCH https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/salesObjectives/300100091619347/child/SalesObjectiveSplits/300100091619392

リクエスト本文の例

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

{
      "ActualValue":"200",
      "TargetValue":"101"      
   }

レスポンス本文の例

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

{
"AccountId": null,
"ActualValue": 200,
"CreatedBy": "SALES_ADMIN",
"CreationDate": "2016-11-10T23:26:48-08:00",
"GeographyId": null,
"LastUpdateDate": "2016-11-11T00:21:16-08:00",
"LastUpdateLogin": "4101B34432126FE8E05392D0F00A4D46",
"LastUpdatedBy": "SALES_ADMIN",
"ObjectiveId": 300100091619347,
"ObjectiveSplitId": 300100091619392,
"PeriodType": "YEAR",
"DisplayPeriodName": null,
"TargetValue": 101,
"ProdGroupName": null,
"ProdGroupId": null,
"PartyUniqueName": null,
"GeographyName": null,
"links":[
{"rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/salesObjectives/300100091619347/child/SalesObjectiveSplits/300100091619392",???},
{"rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/salesObjectives/300100091619347/child/SalesObjectiveSplits/300100091619392",???},
{"rel": "parent", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/salesObjectives/300100091619347",???}
]
}

「トップに戻る」