Read APIで出力されるXMLのFormatは、次のようなTypeに分けられます。
- Standard Format
- Data Type：Number
- Data Type：Option
- Data Type：System[Reference] & User
- Data Type：Link
- Data Type：Image
※Field TypeとData Typeの詳細は、Field Type & Data Type Listを参照してください。
Standard Format
Read APIで出力される標準的なXMLのFormatは次の通りです。
|
<Resource Name Total=N Count=N Start=N> |
<Item>タグは、Resourceに所属する一つのデータを表し、条件に応じて0以上の<Item>タグが出力されます。
<Item>タグには、一つまたは複数の<Alias>タグが出力されます。
Data Type：Number
値が小数の場合は、小数点以下の桁数を指定して出力することはできません。
保存された値と等しい桁数で出力されます。なお、小数点以下の桁数は最大2桁です。
Data Type：Option
複数の選択肢が選択されている場合は、Option Alias (Root)タグの間に複数のAliasが出力されます。
出力されるAliasは末端のAliasです。ここでは親子関係は表現されません。
|
<Field Alias (Option Type)> |
次のサンプルは、JOBの地域に対して、「東京」と「神奈川」が指定されている場合の出力例です。
|
<Job> |
Data Type：System[Reference] & User
System[Reference] 、User Typeの項目は、出力するFieldの設定に応じて、参照先のResourceに所属する項目が出力されます。
出力Fieldの設定方法は、Parameter > Read – Fieldを参照してください。
|
<Field Alias (System[Reference] Type)> |
次のサンプルは、JOBの所有者に対して「鈴木 一郎」が設定されており、Request時にUser.P_IdとUser.P_Nameの情報取得を指定した場合の例です。
|
<Job> ※青字部分が参照先Resourceのタグ ※緑字部分が参照先Resourceに所属する項目 |
Data Type：Link
Link TypeはContact（コンタクト）IDのみ出力できます。
※System[Reference] 、User Typeとは異なり、Contact.P_Name等の情報は取得できません。
※Contact.P_Name等の情報は、Contact（コンタクト）APIで別途取得することができます。
Data Type：Image
Image Typeで出力できるタグはFileName、ContentType、Contentのみです。
デフォルトの出力では、FileNameのみが出力されます。ContentType、Contentを出力する場合は、以下の書式でImage TypeのField Aliasの後に出力したいタグを（）で括ります。
field_alias(FileName,ContentType,Content)
複数のタグを指定する場合は、コンマで区切ります。
なお、画像型項目はResource APIのconditionには指定できません。また、上位Resourceの画像型項目を参照取得することもできません。
Output Values
出力値はXML形式で取得できます。
| Tag | Definition |
|---|---|
| Content | Base64 Encodeされた画像ファイル。 |
| ContentType | Contentで指定するデータの種類を指定します。通常Mime Typeと同じ内容を示します。 Image Typeで扱える種類は、image/jpeg（jpg、jpeg）、image/gif（gif）、image/png（png）、image/bmp（bmp）です。 |
| FileName | 画像のファイル名。 |
Sample
以下は、Resume Read時に画像型項目Resume.U_XXXを指定し、FileName,ContentTypeを取得する場合の例です。
|
Input Parameter https://{Request Host}/v1/resume?partition=999999&field=Resume.U_XXX(FileName,ContentType) |
|
Output XML <?xml version="1.0" encoding="UTF-8" standalone="yes"?> |