使用可能なパラメータ
このセクションで説明する API (/customer-events/<組織 ID>/report) は、Vuforia Expert Capture 手順のセッションのリストを新しいものから順に並べ替えてフェッチします。デフォルトでは、すべてのセッションが返され、結果は 1 つ以上のパラメータを使用してフィルタできます。その後、結果は 100 のセッションページに分けられます。各ページには次のページへのリンクが含まれます。
 |
クエリーパラメータに granularity または progress などのデフォルト値が指定されていない場合、そのクエリーパラメータはデフォルトで無視されます。
|
次のテーブルに、API での結果のフィルタに使用できるすべてのパラメータに関する情報を示します。
• POST メソッドを使用する場合は、リクエストのボディにパラメータを入力します。たとえば、以下のようになります。
{ "serialNumber": "serialNo", "granularity": "step" }
• 廃止予定の GET エンドポイントを使用する場合は、URL クエリーパラメータとしてパラメータを入力します。たとえば、以下のようになります。
/report?serialNumber=serialNo&granularity=step
|
パラメータ
|
タイプ
|
説明
|
||
|---|---|---|---|---|
|
endTime
|
string($date-time)
(クエリー)
|
指定した UTC 日時以前に開始されたセッションのみを RFC3339 形式でレポートします。
例: 2022-10-11T19:30:44.005Z
|
||
|
failures
|
(クエリー)
|
ステップが失敗したセッションを除外または排他的に含めます。このパラメータは次のいずれかの値に設定できます。
• exclude - 失敗したステップが 1 つ以上あるすべてのセッションを除外
• only - 失敗したステップが 1 つ以上あるセッションのみを返す
|
||
|
feedback
|
array[string]
(クエリー)
|
指定したフィードバックステータスのセッションをレポートします。このパラメータは次のいずれかの値に設定できます。
• incomplete - 必要なフィードバックがスキップされたステップが少なくとも 1 つあるセッションを返す
• complete - 必要なフィードバックを含むすべてのステップが完了したセッションを返す
• na - フィードバックを必要とするステップを含まないすべてのセッション、または破棄されたか進行中のセッションを返す
|
||
|
granularity
|
string
(クエリー)
|
セッションの精度のレベルを指定します。このパラメータは次のいずれかの値に設定できます。
• procedure - ステップデータがない手順に関するセッションデータを返す
• step - ステップデータを含む手順に関するセッションデータを返す
これはデフォルトで procedure に設定されます。
|
||
|
latestStepState
|
string
(クエリー)
|
true に設定すると、ステップに対する最新の変更のみがレポートされます。デフォルトでは、POST メソッドの場合は true に設定され、GET メソッドの場合は false に設定されます。
|
||
|
organizationId (必須)
|
string($uuid)
(パス)
|
組織の ID。これは必須です。
|
||
|
procedureIds (POST のみ)
|
array[string]
(クエリー)
|
指定した手順のいずれかに属するセッションのみをレポートします。
|
||
|
procedureStatus
|
このパラメータは廃止予定であるため、代わりに feedback パラメータを使用することをお勧めします。
|
使用可能な値には、incomplete および complete が含まれます。
|
||
|
progress
|
array[string]
(クエリー)
|
指定した進行状況ステータスのセッションをレポートします。このパラメータは次のいずれかの値に設定できます。
• completed - 現場の作業者がセッションを完了して送信
• abandoned - 現場の作業者がセッションを削除
• ongoing - 現場の作業者がセッションをまだ完了および送信していない。セッションはまだ進行中
これはデフォルトで completed に設定されます。つまり、API 呼び出しを使用し、このパラメータを指定しない場合、値が completed に設定されているかのように動作するため、デフォルトでは完了した手順のみが返されます。
|
||
|
serialNumber
|
string
(クエリー)
|
指定したシリアル番号の手順のセッションデータをレポートします。
|
||
|
startTime
|
string($date-time)
(クエリー)
|
指定した UTC 日時以降に開始されたセッションのみを RFC3339 形式でレポートします。
例: 2022-10-11T19:30:44.005Z
|
||
|
x-correlation-id
|
string($uuid)
(ヘッダー)
|
デバッグ用に使用するオプションのユーザー指定 UUID。設定されていない場合は、自動的に生成されます。各リクエストには一意の x-correlation-id が必要です。
例: 25aa3648-7609-47cc-aa21-ce0a1ob0cb10
|
