Attachment Read Method
Attachment APIでは添付ファイルに対するアクセスを提供します。
Attachment Readでは、指定した検索条件に対応するAttachmentのデータを取得することができます。
|
GET |
https://{Request Host}/v1/attachment?partition=[value]&requestType=[value]&resource=[value]&resourceId=[value]&id=[value]&count=[value]&start=[value] |
|---|
Scope
Attachment Readを行うために必要なアクセス権は次の通りです。
attachment_r, process_r, resume_r, candidate_r, job_r, recruiter_r, client_r
Input Variables
GETやPOST Methodを利用する場合、HTTP Headerのパラメータに値を指定する必要があります。詳細はHTTP Headerを参照してください。
また、指定できるParameterは以下の通りです。
Parameter間の条件はAND指定されたものとして検索されます。
| 必須 | Parameter | Definition |
|---|---|---|
| ● | partition | Partition Idを数値で指定します。 アクセス可能なPartition Idを確認したい場合、Partition Readで取得してください。 |
| ● | requestType | Contentの取得有無を指定します。 0：<Content>タグにBase64 Encodeされたデータが付加されます。 1：<Content>タグは含まれません。 |
| ● | resource | 取得するResourceを指定します。 指定できる値は、Resource Listを参照してください。 |
| ー | resourceId | 関連するResourceのレコードのIdを指定します。 CandidateのId, JobのIdなどが該当します。 |
| ー | id | 取得したいAttachmentのIdを指定します。 |
| ー | count | 取得するデータの件数を数値で指定します。 指定できる値の範囲は、1～200までです。省略した場合は10が指定されたものとみなします。 |
| ー | start | 取得するデータの開始インデックスです。 0以上の値を数値で指定します。省略した場合は0が指定されたものとみなします。 |
Result Values
処理が成功した場合は、Response HeaderにHTTP Statusとして200が返り、Output Valuesで解説している値が取得できます。
エラーが発生した場合は、200以外の値が返ります。
Output Values
出力値はXML形式で取得できます。Attachment APIで取扱可能な任意のFieldはありません。
| Tag | Definition |
|---|---|
| Attachment | 条件に該当するAttachmentを含むルート要素です。 取得できたデータの数がCountに、取得データのインデックスがStartに設定されます。Startは0から始まるインデックスです。 Attachmentの一つずつをItem要素として列挙します。 |
| Total | Attachmentの属性。指定した検索条件で取得できる総件数を示します。 |
| Count | Attachmentの属性。今回取得したデータの件数を示します。 |
| Start | Attachmentの属性。今回取得したデータの開始インデックスを示します。 |
| Code | 処理結果を表すcodeです。詳細は、Result Code Listを参照してください。 |
| Item | 一つのAttachment情報を表します。 |
| Id | AttachmentのIdです。 |
| Resource | 関連するResourceを表す項目です。 Resourceの値は、Resource Listを参照してください。 |
| ResourceId | 関連するResourceのレコードのIdを表します。 |
| ContentType | Contentのデータの種類を表します。 通常Mime Typeと同じ内容を示します。詳細はAttachment - Mime Type Listを参照してください。 |
| FileName | Attachmentのファイル名です。 |
| Content | Base64 Encodeされたファイルです。 |
Attachment Read Sample
※本サンプルでは、Encodeを行わずに記載しています。実際のRequest時には内容によってEncode/Decodeが必要です。
次のサンプルは、レジュメID=10006に添付されているファイルを取得した場合の例です。
|
Input Parameter https://{Request Host}/v1/attachment?partition=999999&requestType=0&resource=17&resourceId=10006 |
|
Output XML <?xml version="1.0" encoding="UTF-8" standalone="yes"?> |