【できごと】投稿/編集
タイムラインに【できごと】を投稿、または投稿された【できごと】を編集するAPIについて説明します。
リクエストURL
- 機能：
- 【できごと】を投稿します。
- 機能：
- 「:id」で指定された【できごと】を編集します。
リクエストメソッド
POST
リクエスト
| パラメータ | 項目名 | 説明 | 必須 | 値 | デフォルト値 |
|---|---|---|---|---|---|
| timeline_key | APIキー | APIのユーザ認証するためのキー (APIキーについて,詳しくはAPIキーについてを参照してください。) | ◯ | 英数字 | なし |
| timeline_id | タイムラインのID | 【できごと】を投稿するタイムラインのID | ◯ (投稿のみ) | 数値 | なし |
| id | 【できごと】のID | 【できごと】のID (URLのパスに含めてください) | ◯ (更新のみ) | 数値 | なし |
| title | 【できごと】のタイトル | 【できごと】のタイトル | ◯ (投稿のみ) | 文字列 | なし |
| description | 【できごと】の本文 | 【できごと】の本文 | ◯ (投稿のみ) | 文字列 | なし |
| start_time | 【できごと】の開始日時 | 【できごと】の開始日時 | ◯ (投稿のみ) | 日時 | なし |
| end_time | 【できごと】の終了日時 | 【できごと】の終了日時 | ◯ (投稿のみ) | 日時 | なし |
| grade | 縦軸の値 | 【できごと】の縦軸の値 | ◯ (投稿のみ) | 数値または文字列※1 | なし |
| link | 【できごと】の関連URL | 【できごと】に関連するURL(3つまで指定できます) | - | URL | なし |
| image | 【できごと】の画像 | 【できごと】に添附する画像(Base64でエンコードして送信してください) | - | (略)※2 | なし |
| image_type | 画像のメディアタイプ | 【できごと】に添附する画像のメディアタイプ (「image/jpeg」など） |
◯(image送信時のみ) | (略) | なし |
※1 縦軸の値はタイムラインの縦軸モードが「数値モード」の場合は数値を、「文字モード」の場合は縦軸ラベル名として有効な文字列を指定します。
縦軸ラベル名として有効な文字列の一覧は、タイムライン取得APIで取得できます。
各モードの詳細については縦軸モードについてを参照してください
※2 「【できごと】の画像」の値として「delete」を指定することで【できごと】に添付済みの画像を削除することが出来ます。
サンプルリクエストURL
新規に【できごと】を作成する場合は、以下のURLにアクセスします。
既存の【できごと】(ID=13)を編集する場合は、以下のURLにアクセスします。
レスポンス
レスポンスは以下の要素から構成されます。
| 要素名 | 説明 | 値 |
|---|---|---|
| response | ||
| status | ||
| code | ステータスコード | 数値 |
| message | ステータスメッセージ | 文字列 |
| language | 言語情報 | 文字列 |
| result | ||
| article | 【できごと】の詳細 |
「【できごと】の詳細」に含まれる要素については【できごと】取得APIを参照してください。
サンプルレスポンス
以下は、新規に【できごと】を作成するリクエストに対するレスポンスのサンプルです。
エラー
検索条件の指定が不充分な場合はエラーとなります。
