API 呼び出し
API 呼び出しでの PII および機密データ
すべての PII および機密データの表示は、Vuforia の次の設定を使用して制御できます。
|
設定
|
情報
|
||
|---|---|---|---|
|
この設定を無効にすると、次のようになります。
• 手順情報 (手順タイトル、ユーザーコメント) が公開用に編集されます
• ステップ情報 (ステップの説明、ステップタイトル、ユーザーコメント、メディアフィードバック) が公開用に編集されます
• ユーザー情報 (名、姓、電子メール、役割) が公開用に編集されます
この設定は、デフォルトで無効になっています。
この設定が有効になっている場合、上記のデータは公開用に編集されません。
|
|||
|
この設定を有効にすると、返されるデータが影響を受けます。
この設定は、デフォルトで無効になっています。
|
 |
これら 2 つの設定が互いに競合する場合は、情報の公開用の編集または短縮が優先されます。
|
API 呼び出し
指定した組織のセッションデータを返す /customer-events/<組織 ID>/report API を呼び出すことができます。その後、クエリーパラメータを使用して結果をフィルタできます。次のクエリーパラメータが便利です。
• feedback
• serialNumber
• failures
• progress
上記のパラメータの詳細については、使用可能なパラメータを参照してください。
 |
最適な結果を得るためには、URL パラメータをエンコードする必要があります。一部の文字はエンコードしないと機能しません。たとえば、シリアル番号が 'serial$number#with|special&chars' の場合、URL パラメータとしての使用が安全であり、推奨されるエンコードされたバージョンは 'serial%24number%23with%7Cspecial%26chars' です。
|
次の例が使用可能です。
ページ付けされた結果
API 応答はページに分割されています。ページサイズは状況によって異なり、保証されてはいませんが、通常は約 100 個の要素が含まれます。
追加のページが使用可能な場合、応答には nextPagePostBody 要素が含まれます。この要素は、便宜上最初のリクエストのパラメータをレプリケーションし、次のページにポインタを追加します。
次のページを取得するには、nextPagePostBody をリクエストの本文として使用し、同じエンドポイントに別の POST リクエストを送信します。応答に nextPagePostBody 要素が含まれなくなるまで、このプロセスを続けます。
nextPagePostBody を含む出力例を次に示します。
{
"items": [ ... ]
...
"nextPagePostBody": {
"granularity": "step",
"progress": [
"completed",
"abandoned",
"ongoing"
],
"startTime": "2025-04-21T22:00:00.000Z",
"endTime": "2025-10-22T21:59:59.999Z",
"latestStepState": true,
"page": 2
}
}
次に行われる POST 呼び出しは、以下のようになります。
POST https://vuforia.portal.ptc.com/customer-events/<orgId>/report
{
"granularity": "step",
"progress": [
"completed",
"abandoned",
"ongoing"
],
"startTime": "2025-04-21T22:00:00.000Z",
"endTime": "2025-10-22T21:59:59.999Z",
"latestStepState": true,
"page": 2
}