機械翻訳について

ジャンプ先

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

アセスメント回答グループの更新

patch

/crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/Assessments/{AssessmentId}/child/AssessAnswerGroups/{AssessAnswerGroupId}

リクエスト

パス・パラメータ

• AssessAnswerGroupId(required): integer(int64)
  アンサー・グループの一意の識別子。
• AssessmentId(required): integer(int64)
  アセスメントの一意の識別子。
• OptyNumber(required): string
  商談の一意の代替識別子。

ヘッダー・パラメータ

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

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

• application/json

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

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

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

タイプ: object

ソースを表示

• AssessAnswerGroupId: integer (int64)
  アンサー・グループの一意の識別子。
• AssessmentAnswer: array Assessment Answers
  タイトル: Assessment Answers

  アセスメント回答リソースは、質問グループ内の質問に対するレスポンスを表示および更新するために使用されます。
• AssessmentId: integer (int64)
  アンサー・グループに関連付けられたアセスメントの一意の識別子。

{
    "type":"object",
    "properties":{
        "AssessAnswerGroupId":{
            "type":"integer",
            "description":"The unique identifier of the answer group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "AssessmentId":{
            "type":"integer",
            "description":"The unique identifier of the assessment associated with answer group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "AssessmentAnswer":{
            "title":"Assessment Answers",
            "type":"array",
            "description":"The assessment answers resource is used to view and update a response to a question in the question group.",
            "items":{
                "$ref":"#/components/schemas/opportunities-Assessments-AssessAnswerGroups-AssessmentAnswer-item-patch-request"
            }
        }
    }
}

ネストされたスキーマ : アセスメント回答

タイプ: array

タイトル: Assessment Answers

アセスメント回答リソースは、質問グループ内の質問に対するレスポンスを表示および更新するために使用されます。

ソースを表示

• Array of: object schema

{
    "title":"Assessment Answers",
    "type":"array",
    "description":"The assessment answers resource is used to view and update a response to a question in the question group.",
    "items":{
        "$ref":"#/components/schemas/opportunities-Assessments-AssessAnswerGroups-AssessmentAnswer-item-patch-request"
    }
}

ネストされたスキーマ : スキーマ

タイプ: object

ソースを表示

• Answered: string
  質問が回答済かどうかを示します。
• AnswerId: integer (int64)
  アセスメント回答の一意の識別子。
• AttributeValueId: integer (int64)
  タイトル: Response

  レスポンスの一意の識別子。
• Comments: string
  タイトル: Comments

  最大長: 1500

  エンド・ユーザーが入力したアセスメント・ランタイム・コメント。
• HasComments: string
  コメントが存在するかどうかを示します。

{
    "type":"object",
    "properties":{
        "HasComments":{
            "type":"string",
            "description":"Indicates if the comments are present or not.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Comments"
                ]
            }
        },
        "AnswerId":{
            "type":"integer",
            "description":"The unique identifier of the assessment answer.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "Comments":{
            "title":"Comments",
            "maxLength":1500,
            "type":"string",
            "description":"The assessment runtime comments entered by end user.",
            "nullable":true
        },
        "Answered":{
            "type":"string",
            "description":"Indicates if the question is answered or not.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "AttributeValueId",
                    "Comments",
                    "FreeformTextRow"
                ]
            }
        },
        "AttributeValueId":{
            "title":"Response",
            "type":"integer",
            "description":"The unique identifier of the response.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        }
    }
}

トップに戻る

応答

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

• application/json

デフォルトのレスポンス

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

ヘッダー

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

本文( )

ルート・スキーマ : opportunities-Assessments-AssessAnswerGroups-item-response

タイプ: object

ソースを表示

• AssessAnswerGroupId: integer (int64)
  アンサー・グループの一意の識別子。
• AssessmentAnswer: array Assessment Answers
  タイトル: Assessment Answers

  アセスメント回答リソースは、質問グループ内の質問に対するレスポンスを表示および更新するために使用されます。
• AssessmentId: integer (int64)
  アンサー・グループに関連付けられたアセスメントの一意の識別子。
• AttributeGroupId: integer (int64)
  関連テンプレートの質問グループの一意の識別子。
• links: array Links
  タイトル: Links

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

  回答グループの名前。

{
    "type":"object",
    "properties":{
        "AttributeGroupId":{
            "type":"integer",
            "description":"The unique identifier of the question group of the associated template.",
            "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"
            }
        },
        "AssessAnswerGroupId":{
            "type":"integer",
            "description":"The unique identifier of the answer group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AssessmentId":{
            "type":"integer",
            "description":"The unique identifier of the assessment associated with answer group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Name":{
            "type":"string",
            "description":"The name of the answer group.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssessmentAnswer":{
            "title":"Assessment Answers",
            "type":"array",
            "description":"The assessment answers resource is used to view and update a response to a question in the question group.",
            "items":{
                "$ref":"#/components/schemas/opportunities-Assessments-AssessAnswerGroups-AssessmentAnswer-item-response"
            }
        }
    }
}

ネストされたスキーマ : アセスメント回答

タイプ: array

タイトル: Assessment Answers

アセスメント回答リソースは、質問グループ内の質問に対するレスポンスを表示および更新するために使用されます。

ソースを表示

• Array of: object opportunities-Assessments-AssessAnswerGroups-AssessmentAnswer-item-response

{
    "title":"Assessment Answers",
    "type":"array",
    "description":"The assessment answers resource is used to view and update a response to a question in the question group.",
    "items":{
        "$ref":"#/components/schemas/opportunities-Assessments-AssessAnswerGroups-AssessmentAnswer-item-response"
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : opportunities-Assessments-AssessAnswerGroups-AssessmentAnswer-item-response

タイプ: object

ソースを表示

• Answered: string
  質問が回答済かどうかを示します。
• AnswerId: integer (int64)
  アセスメント回答の一意の識別子。
• AssessmentId: integer (int64)
  アンサーに関連付けられたアセスメントの一意の識別子。
• AttributeGroupId: integer (int64)
  タイトル: Question Group

  アセスメント回答に関連付けられた質問グループの一意の識別子。
• AttributeId: integer (int64)
  タイトル: Question

  アセスメント回答に関連付けられた質問の一意の識別子。
• AttributeName: string
  読取り専用: true

  最大長: 500

  質問の名前。
• AttributeValueId: integer (int64)
  タイトル: Response

  レスポンスの一意の識別子。
• Comments: string
  タイトル: Comments

  最大長: 1500

  エンド・ユーザーが入力したアセスメント・ランタイム・コメント。
• HasComments: string
  コメントが存在するかどうかを示します。
• links: array Links
  タイトル: Links

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

  読取り専用: true

  質問に対するレスポンス。

{
    "type":"object",
    "properties":{
        "AssessmentId":{
            "type":"integer",
            "description":"The unique identifier of the assessments associated with answer.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AttributeId":{
            "title":"Question",
            "type":"integer",
            "description":"The unique identifier of the question associated with assessment answer.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "Comments":{
            "title":"Comments",
            "maxLength":1500,
            "type":"string",
            "description":"The assessment runtime comments entered by end user.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeValueId":{
            "title":"Response",
            "type":"integer",
            "description":"The unique identifier of the response.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "AttributeGroupId":{
            "title":"Question Group",
            "type":"integer",
            "description":"The unique identifier of the question group associated with assessment answer.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "HasComments":{
            "type":"string",
            "description":"Indicates if the comments are present or not.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Comments"
                ]
            },
            "x-queryable":true
        },
        "ResponseValue":{
            "title":"Response",
            "type":"string",
            "description":"The response to the question.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AttributeName":{
            "maxLength":500,
            "type":"string",
            "description":"The name of the question.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AnswerId":{
            "type":"integer",
            "description":"The unique identifier of the assessment answer.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Answered":{
            "type":"string",
            "description":"Indicates if the question is answered or not.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "AttributeValueId",
                    "Comments",
                    "FreeformTextRow"
                ]
            },
            "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."
        }
    }
}

リンク

AssessmentAnswer

操作: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/Assessments/{AssessmentId}/child/AssessAnswerGroups/{AssessAnswerGroupId}/child/AssessmentAnswer

パラメータ:

• AssessAnswerGroupId: $request.path.AssessAnswerGroupId
• AssessmentId: $request.path.AssessmentId
• OptyNumber: $request.path.OptyNumber

アセスメント回答リソースは、質問グループ内の質問に対するレスポンスを表示および更新するために使用されます。

トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対してPATCHリクエストを発行することによって、アセスメント回答グループを更新する方法を示しています。

cURLコマンド

curl -u <username:password> \ -X PATCH -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/opportunities/300100090218733/child/Assessments/300100090145749/child/AssessAnswerGroups/300100090195736

リクエスト本文の例

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

	{
	"Name": "Deal"
	}

レスポンス本文の例

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

{
    "AssessAnswerGroupId" : 300100090195736,
    "AssessmentId" : 300100090145749,
    "AttributeGroupId" : 100000012061102,
    "Name" : "Deal",
    "links" : [ {
      "rel" : "self",
      "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/opportunities/CDRM_78925/child/Assessments/300100090145749/child/AssessAnswerGroups/300100090195736",
      "name" : "AssessAnswerGroups",
      "kind" : "item"
    }, {
      "rel" : "canonical",
      "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/opportunities/CDRM_78925/child/Assessments/300100090145749/child/AssessAnswerGroups/300100090195736",
      "name" : "AssessAnswerGroups",
      "kind" : "item"
    }, {
      "rel" : "parent",
      "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/opportunities/CDRM_78925/child/Assessments/300100090145749",
      "name" : "Assessments",
      "kind" : "item"
    }, {
      "rel" : "child",
      "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/opportunities/CDRM_78925/child/Assessments/300100090145749/child/AssessAnswerGroups/300100090195736/child/AssessmentAnswer",
      "name" : "AssessmentAnswer",
      "kind" : "collection"
    } ]
  }

「トップに戻る」