すべての評価を取得
get
/crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/Assessment
リクエスト
パス・パラメータ
- CompanyNumber(required): string
パートナの会社の代替キー識別子。
問合せパラメータ
- dependency: string
このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: dependency=ProductId=2
フォーマット: <attr1>=<val1>,<attr2>=<value2> - expand: string
このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"all"または""です。 カンマをセパレータとして使用して、複数の子を指定できます。 例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
- fields: string
このパラメータは、リソース・フィールドをフィルタします。 指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。 間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。 属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。 両方を指定した場合、フィールドのみが考慮されます。
フォーマット : ?fields=Attribute1,Attribute2
子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2 - finder: string
コレクションを検索するための事前定義済ファインダとして使用されます。
フォーマット : ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
使用可能なファインダ名および対応するファインダ変数を次に示します:- PrimaryKey : 商談アセスメント識別子でアセスメントを検索します。
ファインダ変数:- AssessmentId; integer;商談評価の一意の識別子。
- PrimaryKey : 商談アセスメント識別子でアセスメントを検索します。
- limit: integer
このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
- links: string
このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>
例:
self,canonical
- offset: integer
リソース・コレクションの開始位置を定義するために使用します。 オフセットがリソース数を超えると、リソースは返されません。 デフォルト値は0です。
- onlyData: boolean
リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
- orderBy: string
このパラメータは、指定されたフィールドに基づいてリソース・コレクションを順序付けます。 パラメータ値は、属性名のカンマ区切りの文字列で、それぞれオプションでコロンと「asc」または「desc」が続きます。 昇順の場合は「asc」、降順の場合は「desc」を指定します。 デフォルト値は「asc」です。 たとえば、?orderBy=field1:asc,field2:descです
- q: string
この問合せパラメータは、where句を定義します。 リソース・コレクションは、指定された式を使用して問い合せられます。 この問合せパラメータの値は、1つ以上の式です。 例 : ?q=部門番号>=10および<= 30;Loc!=NY
フォーマット : ?q=expression1;expression2
次の問合せ可能属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
- AssessTemplateId; integer; この評価のソースとして提供されている評価テンプレートの一意の識別子。
- AssessedLanguage; string;評価の言語。
- AssessedObjTypeCode; string; 評価されるビジネス・オブジェクトのタイプを示すコード。
- AssessedObjectId; integer;評価されるビジネス・オブジェクトの一意の識別子。
- AssessmentId; integer;評価の一意の識別子。
- AssessmentScore; integer; 評価の計算済スコア。
- BusinessUnit; integer;アセスメントの作成時に渡されるビジネス・ユニットの名前で、ビジネス・オブジェクトのビジネス・ユニットに対応します。
- ConflictId; integer; モバイル・データベースやサーバーなどの切断されたモバイルの場合に、異なるデータベースに重複が作成された場合に、行の一意性を保証するために使用される値。
- CreatedBy; string; アセスメント・レコードを作成したユーザー。
- LastUpdateDate; string; アセスメント・レコードが最後に更新された日時。
- LastUpdatedBy; string; アセスメント・レコードを最後に更新したユーザー。
- 名前、文字列、評価の名前。
- StatusCode; string; 評価の有効なステータスを示すコード。 有効な値は、IN_PROGRESSおよびCOMPLETEです。
- StatusFuse; string;評価のステータス。
- TemplateName; string;アセスメント・テンプレートの名前。
- TemplateType; string;評価に関連付けられた評価テンプレートのタイプ。
- TotalAnswered; number;評価で回答された質問の数。
- TotalQuestions; number;評価で回答される質問の合計数。
- totalResults: boolean
"?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
- Metadata-Context:
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version:
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
この操作にはリクエスト本文がありません。
トップに戻る応答
サポートされるメディア・タイプ
- application/json
デフォルトのレスポンス
次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
- Metadata-Context(required):
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version(required):
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
ルート・スキーマ : partners-Assessment
タイプ:
ソースを表示
object
-
count(required): integer
現在の範囲で返されたリソース・インスタンスの数。
-
hasMore(required): boolean
サーバーで使用可能なリソースが、レスポンスで返されたサブセットより多いかどうかを示します。 値がtrueの場合、サーバーから取得するリソースがさらにあります。 デフォルト値はfalseです。
-
items: array Items
タイトル:
Items
コレクション内のアイテム。 -
limit(required): integer
サーバーで使用される実際のページング・サイズ。
-
links(required): array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
offset(required): integer
現在のページで使用されるオフセット値。
-
totalResults: integer
"?totalResults=true"の場合の推定行数。それ以外の場合、カウントは含まれません。
ネストされたスキーマ : 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値を変更します。