Field Service 開発者ガイド
jField Service フロー
Field Service フローに対応する情報を返します。このリソースは REST API バージョン 42.0 以降で使用できます。
このリソースは、フロー定義の API 参照名を受け入れ、有効なフローバージョンに関する情報を返します。有効なフローバージョンがない場合、最新のフローバージョンが返されます。フロー要素は、トランスレーションワークベンチを使用して、この API を呼び出すユーザーの言語に翻訳できます。特定のフローバージョンの要素が翻訳されている場合、返されるデータではクエリの言語が使用されます。詳細は、「トランスレーションワークベンチのフローコンポーネント」を参照してください。
このリソースは、Field Service モバイルアプリケーションのユーザー権限と「フローを実行」ユーザー権限を持つ API ユーザーが利用できます。
- URI
- /services/data/vXX.X/support/fieldservice/Flow?developerNames=Flow Unique Name
- 形式
- JSON、XML
- HTTP メソッド
- GET
- 認証
- Authorization: Bearer token
- パラメーター
-
パラメーター 説明 developerNames フロー定義の一意の名前。現在、このパラメーターを使用して指定できる一意の名前は 1 つだけです。
レスポンスボディ
次の表で、レスポンスボディの主要要素について説明します。
| 項目 | 型 | 説明 | ||
|---|---|---|---|---|
| Flows | Array | フローのリスト | ||
| CreatedDate | String | フローが作成された日付 | ||
| Description | String | フローの説明 | ||
| FullName | String | フローの完全な名前 | ||
| Id | String | フローの一意の ID | ||
| LastModifiedDate | String | フローが最後に更新された日付 | ||
| Metadata | ||||
| Choices | Array | 項目で使用される選択肢のリスト | ||
| ChoiceText | String | 選択肢のテキスト | ||
| DataType | String | 選択肢のデータ型 | ||
| Name | String | 選択肢の名前 | ||
| Screens | オブジェクトの配列 | フローの画面のリスト。 | ||
| AllowBack | Boolean | 画面から戻ることができるかどうか | ||
| AllowFinish | Boolean | 画面からフローを完了できるかどうか | ||
| AllowPause | Boolean | 画面から一時停止できるかどうか | ||
| Fields | オブジェクトの配列 | 画面で使用される項目のリスト | ||
| HelpText | String | 画面のヘルプテキスト | ||
| Label | String | 画面の表示ラベル | ||
| LocationX | Number | 画面の X 座標 | ||
| LocationY | Number | 画面の Y 座標 | ||
| Name | String | 画面の名前 | ||
| ProcessType | String | フローのプロセスの種別。この場合は「FieldServiceMobile」となる。 | ||
| Status | String | フローの状況 | ||
| VersionNumber | Number | フローのバージョン番号 | ||
例
この要求サンプルでは、フロー定義に「FS_Flow」という一意の名前を使用しています。
応答には次の 2 つの画面が含まれます。
- Screen 1
- Screen 2
- Field 1: テキスト項目
- RadioButton: 2 つの選択肢がある項目
- Field 2: テキスト項目
- 要求
-
GET
/services/data/v42.0/support/fieldservice/Flow?developerNames=FS_Flow
- 応答
-