サービスレポートテンプレート

このリソースでは、1 つ以上のサービスレポートテンプレート ID を入力することができ、テンプレートに関する情報を返します。作業指示、作業指示品目、サービス予定のサービスレポートを生成できます。

ServiceReportTemplate は Field Service が有効になっている組織の API ユーザーが利用できます。またエクスペリエンスビルダーサイトでも有効になっています。

URI

/services/data/vXX.X/support/fieldservice/ServiceReportTemplate

形式

JSON

HTTP メソッド

GET

認証

Authorization: Bearer token

パラメーター

パラメーター	説明
templateIds	サービスレポートテンプレート ID のリスト (カンマ区切りの文字列値)。テンプレート ID が無効の場合、API の応答には失敗が表示されます。
showDefault	デフォルトのサービスレポートテンプレートが応答で返されるかどうかを示す boolean パラメーター。true の場合、デフォルトのテンプレートが含まれます。false (デフォルト) の場合、デフォルトのテンプレートは含まれません。たとえば、要求にデフォルト以外の 2 つのテンプレートの ID が含まれていて、showDefault=true である場合、応答には 3 つのテンプレートの情報が含まれます。
templateTypes	レポートテンプレートが使用できるレコードタイプは、ServiceAppointment、WorkOrder、WorkOrderLineItem です。サービスレポートには、次の 4 つのサブテンプレートがあります。 WO — 作業指示 WOLI — 作業指示品目 WO_SA — 作業指示のサービス予定 WOLI_SA — 作業指示品目のサービス予定

レスポンスボディ

サービスレポートには、ヘッダー、本文、フッターという削除できない 3 つの主要領域があります。各領域には、セクション、関連リスト、または署名コンポーネントのうち少なくとも 1 つが含まれている必要がありますが、コンポーネントは空でもかまいません。ヘッダーとフッターには定義済みのセクションが含まれていて、他のコンポーネントを追加することはできません。本文には、各コンポーネントを 1 つ以上含めることができます。