Field Read Method
Field APIは、Resourceの項目情報に対するアクセスを提供します。
Field Readでは、指定した条件に対応するFieldのリストを取得することができます。
|
GET |
https://{Request Host}/v1/field?partition=[value]&resource=[value]&active=[value]&count=[Value]&start=[value] |
|---|
Scope
Field Readを行うために必要なアクセス権は次の通りです。
field_r
Input Variables
GETやPOST Methodを利用する場合、HTTP Headerのパラメータに値を指定する必要があります。詳細はHTTP Headerを参照してください。
また、指定できるParameterは以下の通りです。
| 必須 | Parameter | Definition |
|---|---|---|
| ● | partition | Partition Idを数値で指定します。 アクセス可能なPartition Idを確認したい場合、Partition Readで取得してください。 |
| ● | resource | Resourceの種類を指定します。 指定できる値は、Resource Listを参照してください。 |
| ー | active | 項目の使用/未使用の種別を指定します。 次の値を指定することができます。省略した場合は-1が指定されたものとみなします。 -1：すべての項目を取得 0：未使用の項目のみを取得 1：使用中の項目のみを取得 |
| ー | count | 取得するデータの件数を数値で指定します。 指定できる値の範囲は、1～200までです。省略した場合は10が指定されたものとみなします。 |
| ー | start | 取得するデータの開始インデックス。0以上の値を数値で指定します。省略した場合は0が指定されたものとみなします。 |
Result Values
処理が成功した場合は、Response HeaderにHTTP Statusとして200が返り、Output Valuesで解説している値が取得できます。
エラーが発生した場合は、200以外の値が返ります。
Output Values
出力値はXML形式で取得できます。Field APIで取扱可能な任意のFieldはありません。
| Tag | Definition |
|---|---|
| Field | 条件に該当するFieldを含むルート要素です。 取得できたデータの数がCountに、取得データのインデックスがStartに設定されます。Startは0から始まるインデックスです。 |
| Total | Fieldの属性。指定した検索条件で取得できる総件数を示します。 |
| Count | Fieldの属性。今回取得したデータの件数を示します。 |
| Start | Fieldの属性。今回取得したデータの開始インデックスを示します。 |
| Code | 処理結果を表すcodeです。詳細は、Result Code Listを参照してください。 |
| Item | 一つのField情報を表します。 |
| Field.P_Id | 項目のIdです |
| Field.P_Name | 項目の名称です。 |
| Field.P_Alias | 項目のAliasです。 |
| Field.P_Type | 項目の種類です。 詳細はField Type & Data Type Listを参照してください。 |
| Field.P_Required | 項目の必須設定状態を表します。 0：通常項目 1：入力必須項目 |
| Field.P_Max | Text Typeの場合は最大文字数を表します。 Number Typeの場合は最大値を表します。 |
| Field.P_Min | Text Typeの場合は最小文字数を表します。 Number Typeの場合は最小値を表します。 |
| Field.P_DecimalFraction | Number Typeの場合に、少数以下の桁数を表します。 |
| Field.P_ReferTo | Option Typeの場合、その項目に関連づけられている選択肢のAliasを表します。 Reference Typeの場合、参照している上位Resourceの項目のAliasを表します。 |
| Field.P_ResourceType | Resourceの値です。詳細は、Resource Listを参照してください。 |
Field Read Sample
※本サンプルでは、Encodeを行わずに記載しています。実際のRequest時には内容によってEncode/Decodeが必要です。
次のサンプルは、JobのすべてのFieldから2件のデータを取得した場合の例です。
|
Input Parameter https://{Request Host}/v1/field?partition=999999&resource=3&active=-1&count=2 |
|
Output XML <?xml version="1.0" encoding="UTF-8" standalone="yes"?> |