Attachment Write Method
Attachment APIでは添付ファイルに対するアクセスを提供します。
Attachment Writeでは、指定したAttachmentを新規に登録、または更新することができます。
POST |
https://{Request Host}/v1/attachment?partition=[value] |
---|
Scope
Attachment Writeを行うために必要なアクセス権は次の通りです。
attachment_w
Input Variables
GETやPOST Methodを利用する場合、HTTP Headerのパラメータに値を指定する必要があります。詳細はHTTP Headerを参照してください。
また、指定できるParameterは以下の通りです。
必須 | Parameter | Definition |
---|---|---|
● | partition | Partition Idを数値で指定します。 アクセス可能なPartition Idを確認したい場合、Partition Readで取得してください。 |
次の値をXML形式でPOST時のデータブロックに指定できます。
Attachment APIで取扱可能な任意のFieldはありません。
Tag | Definition |
---|---|
Attachment | Attachmentを表すルート要素です。 |
Item | 一つのAttachment情報を表します。 |
Id | AttachmentのIdです。 新規作成時には-1を、更新時には更新対象のAttachmentのIDを指定します。 |
Resource | Attachmentを登録するResourceを指定します。 Resourceの値は、Resource Listを参照してください。 |
ResourceId | Attachmentを登録するResourceのレコードのIdを指定します。更新で変更することはできません。 |
ContentType | ContentのMime Typeを指定します。詳細はAttachment - Mime Type Listを参照してください。更新で変更することが可能です。 |
FileName | 拡張子付きのファイル名を指定します。更新で変更することが可能です。 |
Content | Base64 Encodeされたファイル内容を指定します。更新で変更することが可能です。 |
新規登録および更新における注意点
- ファイル数に制限はありませんが、1ファイルのサイズが10MBを超えるものはサポートされません。
- Windowsのファイル名で使用できない文字は指定することはできません。
- ファイルの拡張子を含め、255バイトを超える名称を指定することはできません。
- Attachment APIで書き込んだ添付ファイルは、PORTERSの各リソースの詳細画面下部に表示される「サブリスト 添付ファイル」に添付されます。
但し、「サブリスト 添付ファイル」を非表示にしている場合、画面からの確認はできません。
Result Values
処理が成功した場合は、Response HeaderにHTTP Statusとして200が返り、Output Valuesで解説している値が取得できます。
エラーが発生した場合は、200以外の値が返ります。
Output Values
出力値はXML形式で取得できます。
Tag | Definition |
---|---|
Attachment | Attachmentデータを表すルート要素です。 |
Item | 一つのAttachment情報を表します。 |
Id | 更新または新規登録されたAttachmentのIdです。 |
Code | 処理結果を表すcodeです。詳細は、Result Code Listを参照してください。 |
Attachment Write Sample
※本サンプルでは、Encodeを行わずに記載しています。実際のRequest時には内容によってEncode/Decodeが必要です。
次のサンプルは、レジュメID=10001に履歴書のWordファイルを新規登録した場合の例です。
Input XML <?xml version="1.0" encoding="UTF-8" standalone="yes"?> |
Output XML <?xml version="1.0" encoding="UTF-8" standalone="yes"?> |