マーケティングプラットフォームのファイル情報を参照するためのAPIです。
file.get
メソッド | URL |
---|---|
GET | https://{domainname}/services/rest/file |
パラメータ名 | 必須 | 内容 |
---|---|---|
search_key{cid} | オプション | 検索条件のキー項目 指定可能なキー項目は下記「検索条件に指定可能なカラム」参照 |
search_operator{cid} | オプション | “検索条件の比較演算子を指定 eq( = ), ne( != ), ge( >= ), gt( > ), le( <= ), lt( < ), like” |
search_value{cid} | オプション | 検索値 Nullを指定する場合は、何も指定しません。 例: search_value1= |
order | オプション | 並び順の項目 指定可能な並び順の項目は下記「検索条件・並び順に指定可能なカラム」参照 |
direction | オプション | 並び順を指定する 「asc」(昇順)または「desc」(降順) |
limit | オプション | 1回のリクエストで取得するレコード数 (最大1000) |
offset | オプション | レコードのオフセット |
カラム名 | 検索条件 | 並び順 | 内容 |
---|---|---|---|
Id | ○ | ○ | ファイルID |
Name | ○ | ○ | ファイル名 |
Extension | ○ | ○ | ファイル拡張子 |
Temporary | ○ | ○ | テンポラリフラグ 0:使用済 1:未使用 |
DateRegist | ○ | ○ | 登録日時(JST) YYYY-mm-ddTHH:MM:SS+09:00 |
DateUpdate | ○ | ○ | 更新日時(JST) YYYY-mm-ddTHH:MM:SS+09:00 |
なし
なし
コード | 内容 |
---|---|
200 | 正常終了 |
なし
★ エレメント名:File ★ データ型:GenericFileType
カラム名 | データ型 | 内容 |
---|---|---|
Id | string | ファイルID |
DateRegist | dateTime | 登録日時(JST) YYYY-mm-ddTHH:MM:SS+09:00 |
DateUpdate | dateTime | 更新日時(JST) YYYY-mm-ddTHH:MM:SS+09:00 |
Name | string | ファイル名 |
Extension | string | ファイル拡張子 |
Temporary | string | テンポラリフラグ 0:使用済 1:未使用 |
Body | base64Binary | データ(Base64エンコード) |
なし
<?xml version="1.0" encoding="UTF-8"?>
<FileList xmlns="http://smartseminar.jp/" version="1.5">
<File>
<Id>test</Id>
<Extension>txt</Extension>
<Temporary>1</Temporary>
<Body>/9j/4AAQSkZJRgABAQAAAQABAAD/2wCEAAkGBhQSEBUUEhQVEB
QUFRUUFhQVFRQUFBQUFBUVFRQVFRQYHCYeFxkjGR(途中略)
5qcNn4/mrs2RZXDXKbgjB8lbcFE1vALashMQgCVCFQIQhAJEIQFkqEIEKAEqE
AhCEAhCEAhCEAhCEAhCEAhCEAhCEAhCEAhCEAhCEAhCEH//2Q==</Body>
<DateRegist>2011-04-11T20:54:26+09:00</DateRegist>
<DateUpdate>2011-04-11T20:54:26+09:00</DateUpdate>
</File>
</FileList>
BodyをHTMLソースに記述する場合、下記のようにBase64でエンコードしたデータをそのままHTMLに記述することができます。
<img src="data:${MIMEパート名};base64,${Base64エンコードデータ}">
例:sample.pngのHTML表示
<img src="data:image/png;base64,iVBORw0KGgo...">