アセスメントの更新
patch
/crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/Assessment/{AssessmentId}
リクエスト
パス・パラメータ
- AssessmentId(required): integer(int64)
アセスメントの一意の識別子。
- CompanyNumber(required): string
パートナの会社の代替キー識別子。
ヘッダー・パラメータ
- Metadata-Context:
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version:
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
サポートされるメディア・タイプ
- application/json
次の表では、このタスクのリクエストの本文パラメータについて説明します。
ルート・スキーマ : スキーマ
タイプ:
ソースを表示
object
-
AssessAnswerGroups: array Assessment Answer Groups
タイトル:
Assessment Answer Groups
アセスメント回答グループ・リソースは、アセスメント内の質問グループを表示および更新するために使用します。 -
AssessedLanguage: string
タイトル:
Assessment Language
最大長:4
デフォルト値:US
アセスメントの言語。 -
AssessedObjectId: integer (int64)
タイトル:
Assessed Object ID
アセスメント済ビジネス・オブジェクトの一意の識別子。 -
AssessmentId: integer (int64)
タイトル:
Assessment ID
アセスメントの一意の識別子。 -
ConflictId: integer (int64)
タイトル:
Conflict ID
デフォルト値:0
モバイル・データベースやサーバーなどの切断されたモバイルの場合に、異なるデータベースに重複が作成される場合に、行の一意性を保証するために使用される値。 -
Name: string
タイトル:
Name
最大長:255
アセスメントの名前。 -
StatusCode: string
タイトル:
Status
最大長:30
デフォルト値:INCOMPLETE
アセスメントの有効なステータスを示すコード。 有効な値は、IN_PROGRESSおよびCOMPLETEです。 -
TotalAnswered: number
タイトル:
Total Questions Answered
アセスメントで回答された質問の数。 -
TotalQuestions: number
タイトル:
Total Questions
アセスメントで回答する質問の合計数。
ネストされたスキーマ : アセスメント回答グループ
タイプ:
array
タイトル:
Assessment Answer Groups
アセスメント回答グループ・リソースは、アセスメント内の質問グループを表示および更新するために使用します。
ソースを表示
ネストされたスキーマ : partners-Assessment-AssessAnswerGroups-item-patch-request
タイプ:
ソースを表示
object
-
AssessAnswerGroupId: integer (int64)
アンサー・グループの一意の識別子。
-
AssessmentAnswer: array AssessmentAnswer
-
AssessmentId: integer (int64)
アンサー・グループに関連付けられたアセスメントの一意の識別子。
ネストされたスキーマ : スキーマ
タイプ:
ソースを表示
object
-
Answered: string
質問が回答済かどうかを示します。
-
AnswerId: integer (int64)
アンサーに関連付けられたアセスメントの一意の識別子。
-
AttributeValueId: integer (int64)
タイトル:
Response
レスポンスの一意の識別子。 -
Comments: string
タイトル:
Comments
最大長:1500
エンド・ユーザーが入力したアセスメント・ランタイム・コメント。 -
HasComments: string
コメントが存在するかどうかを示します。
応答
サポートされるメディア・タイプ
- application/json
デフォルトのレスポンス
次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
- Metadata-Context(required):
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version(required):
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
ルート・スキーマ : partners-Assessment-item-response
タイプ:
ソースを表示
object
-
AssessAnswerGroups: array Assessment Answer Groups
タイトル:
Assessment Answer Groups
アセスメント回答グループ・リソースは、アセスメント内の質問グループを表示および更新するために使用します。 -
AssessedLanguage: string
タイトル:
Assessment Language
最大長:4
デフォルト値:US
アセスメントの言語。 -
AssessedObjectId: integer (int64)
タイトル:
Assessed Object ID
アセスメント済ビジネス・オブジェクトの一意の識別子。 -
AssessedObjTypeCode: string
タイトル:
Object Type Code
最大長:30
査定済ビジネス・オブジェクトのタイプを示すコード。 -
AssessmentId: integer (int64)
タイトル:
Assessment ID
アセスメントの一意の識別子。 -
AssessmentScore: integer (int64)
タイトル:
Score
デフォルト値:0
査定の計算済スコア。 -
AssessTemplateId: integer (int64)
タイトル:
Template Name
このアセスメントのソースとして機能したアセスメント・テンプレートの一意の識別子。 -
BusinessUnit: integer (int64)
タイトル:
Business Unit
査定の作成時に渡されるビジネス・ユニットの名前で、ビジネス・オブジェクトのビジネス・ユニットに対応します。 -
ConflictId: integer (int64)
タイトル:
Conflict ID
デフォルト値:0
モバイル・データベースやサーバーなどの切断されたモバイルの場合に、異なるデータベースに重複が作成される場合に、行の一意性を保証するために使用される値。 -
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:64
アセスメント・レコードを作成したユーザー。 -
LastUpdateDate: string (date-time)
タイトル:
Last Updated Date
読取り専用:true
査定レコードが最後に更新された日時。 -
LastUpdatedBy: string
タイトル:
Last Updated By
読取り専用:true
最大長:64
アセスメント・レコードを最後に更新したユーザー。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
Name: string
タイトル:
Name
最大長:255
アセスメントの名前。 -
RatingFeedback: string
タイトル:
Feedback
読取り専用:true
評点にマップされたフィードバック。 -
RatingTerm: string
タイトル:
Rating
読取り専用:true
関連付けられたアセスメント・テンプレートで構成されたアセスメントの総合評点。 -
StatusCode: string
タイトル:
Status
最大長:30
デフォルト値:INCOMPLETE
アセスメントの有効なステータスを示すコード。 有効な値は、IN_PROGRESSおよびCOMPLETEです。 -
StatusFuse: string
タイトル:
Status
読取り専用:true
アセスメントのステータス。 -
TemplateName: string
タイトル:
Template
アセスメント・テンプレートの名前。 -
TemplateType: string
タイトル:
Template Type
アセスメントに関連付けられたアセスメント・テンプレートのタイプ。 -
TotalAnswered: number
タイトル:
Total Questions Answered
アセスメントで回答された質問の数。 -
TotalQuestions: number
タイトル:
Total Questions
アセスメントで回答する質問の合計数。
ネストされたスキーマ : アセスメント回答グループ
タイプ:
array
タイトル:
Assessment Answer Groups
アセスメント回答グループ・リソースは、アセスメント内の質問グループを表示および更新するために使用します。
ソースを表示
ネストされたスキーマ : partners-Assessment-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
回答グループの名前。
ネストされたスキーマ : アセスメント回答
タイプ:
array
タイトル:
Assessment Answers
アセスメント回答リソースは、質問グループ内の質問に対するレスポンスを表示および更新するために使用されます。
ソースを表示
ネストされたスキーマ : partners-Assessment-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
質問に対するレスポンス。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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.
ネストされたスキーマ : properties
タイプ:
ソースを表示
object
-
changeIndicator: string
リソース・インスタンスのインジケータまたはETag値を変更します。
リンク
- AssessAnswerGroups
-
パラメータ:
- AssessmentId:
$request.path.AssessmentId
- CompanyNumber:
$request.path.CompanyNumber
(AssessAnswerGroupsのリソース) - AssessmentId:
- AssessmentTemplateVA
-
パラメータ:
- ファインダ:
AssessmentTemplateByBUIdFinder%3BAssessObjType%3D{AssessedObjTypeCode}%2CRelatedObjType%3D{RelatedObjTypeCode}%2CBindBUId%3D{BusinessUnit}
アセスメント・テンプレート・リソースは、アセスメント・テンプレートの表示に使用されます。 アセスメントに関連付けられたテンプレートが格納されます。 - ファインダ:
- LookupPVO1
-
パラメータ:
- ファインダ:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DMOW_ASSESSMENT_STATUS_CODE%2CBindLookupCode%3D{StatusCode}
参照リソースは、標準参照コードの表示に使用されます。 - ファインダ: