機械翻訳について

ジャンプ先

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

目標履歴レコードの更新

patch

/crmRestApi/resources/11.13.18.05/goals/{GoalNumber}/child/GoalHistory/{GoalHistoryUniqID}

リクエスト

パス・パラメータ

• GoalHistoryUniqID(required): string
  これは、目標履歴リソースに対してコンポジット・キー(HistoryRecordObjectId、HistoryRecordOwnerId、HistoryRecordDateおよびGoalId)を構成する属性のハッシュ・キーで、目標履歴のインスタンスを一意に識別するために使用されます。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントは、目標履歴の特定のインスタンスにナビゲートするために、主キー値に対するフィルタを使用して目標履歴収集リソースを問い合せる必要があります。
  
  次に例を示します: GoalHistory?q=HistoryRecordObjectId=<value1>;HistoryRecordOwnerId=<value2>;HistoryRecordDate=<value3>;GoalId=<value4>
• GoalNumber(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

ソースを表示

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

トップに戻る

応答

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

• application/json

デフォルトのレスポンス

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

ヘッダー

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

本文( )

ルート・スキーマ : goals-GoalHistory-item-response

タイプ: object

ソースを表示

• DynamicNumber1Name: string
  読取り専用: true

  最大長: 200

  動的番号1の名前
• DynamicNumber1UOM: string
  読取り専用: true

  最大長: 200

  動的番号1単位
• DynamicNumber1Value: integer (int64)
  読取り専用: true

  動的数値1の値
• DynamicNumber2Name: string
  読取り専用: true

  最大長: 200

  動的番号2の名前
• DynamicNumber2UOM: string
  読取り専用: true

  最大長: 200

  動的番号2単位
• DynamicNumber2Value: integer (int64)
  読取り専用: true

  動的数値2の値
• DynamicText1Name: string
  読取り専用: true

  最大長: 200

  動的テキスト1の名前
• DynamicText1Value: string
  読取り専用: true

  最大長: 200

  動的テキスト1の値
• DynamicText2Name: string
  読取り専用: true

  最大長: 200

  動的テキスト2の名前
• DynamicText2Value: string
  読取り専用: true

  最大長: 200

  動的テキスト2の値
• GoalId: integer (int64)
  読取り専用: true

  目標ID
• HistoryParticipantId: integer (int64)
  読取り専用: true

  履歴参加者ID
• HistoryRecordDate: string (date-time)
  読取り専用: true

  履歴レコード日
• HistoryRecordId: integer
  読取り専用: true

  履歴レコードID
• HistoryRecordObjectId: integer (int64)
  読取り専用: true

  履歴レコード・オブジェクトの一意の識別子。
• HistoryRecordObjectNumber: string
  読取り専用: true

  最大長: 256

  履歴レコード・オブジェクトの代替識別子。
• HistoryRecordOwnerId: integer (int64)
  読取り専用: true

  履歴レコード所有者ID
• HistoryRecordOwnerName: string
  読取り専用: true

  最大長: 360

  履歴レコードの所有者。
• HistoryRecordOwnerNumber: string
  読取り専用: true

  最大長: 30

  履歴レコード所有者の代替の一意の識別子。
• KPIId: integer (int64)
  読取り専用: true

  KPI ID
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• StaticText: string
  読取り専用: true

  最大長: 4000

  静的テキスト

{
    "type":"object",
    "properties":{
        "DynamicNumber1Value":{
            "type":"integer",
            "description":"Dynamic Number 1 Value",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "HistoryRecordObjectNumber":{
            "maxLength":256,
            "type":"string",
            "description":"The alternate identifier of the history record object.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StaticText":{
            "maxLength":4000,
            "type":"string",
            "description":"Static Text",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DynamicText2Value":{
            "maxLength":200,
            "type":"string",
            "description":"Dynamic Text 2 Value",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DynamicNumber2Name":{
            "maxLength":200,
            "type":"string",
            "description":"Dynamic Number 2 Name",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HistoryRecordOwnerNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The alternate unique identifier of the history record owner.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HistoryRecordOwnerName":{
            "maxLength":360,
            "type":"string",
            "description":"The owner of the history record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DynamicText1Name":{
            "maxLength":200,
            "type":"string",
            "description":"Dynamic Text 1 Name",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DynamicNumber1Name":{
            "maxLength":200,
            "type":"string",
            "description":"Dynamic Number 1 Name",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DynamicNumber1UOM":{
            "maxLength":200,
            "type":"string",
            "description":"Dynamic Number 1 UOM",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DynamicNumber2UOM":{
            "maxLength":200,
            "type":"string",
            "description":"Dynamic Number 2 UOM",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HistoryParticipantId":{
            "type":"integer",
            "description":"History Participant ID",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "HistoryRecordId":{
            "type":"integer",
            "description":"History Record ID",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HistoryRecordDate":{
            "type":"string",
            "description":"History Record Date",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DynamicText1Value":{
            "maxLength":200,
            "type":"string",
            "description":"Dynamic Text 1 Value",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HistoryRecordOwnerId":{
            "type":"integer",
            "description":"History Record Owner ID",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "KPIId":{
            "type":"integer",
            "description":"KPI ID",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DynamicNumber2Value":{
            "type":"integer",
            "description":"Dynamic Number 2 Value",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "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"
            }
        },
        "HistoryRecordObjectId":{
            "type":"integer",
            "description":"The unique identifier of the history record object.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DynamicText2Name":{
            "maxLength":200,
            "type":"string",
            "description":"Dynamic Text 2 Name",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GoalId":{
            "type":"integer",
            "description":"Goal ID",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "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."
        }
    }
}

「トップに戻る」