投稿作成

投稿を作成します。

注意

※ 投稿時のサービス通知の既定値は false (送信しない)です。

API の種類

サーバー API

Request URL

https://apis.worksmobile.com/r/{API ID}/home/v1/articles

HTTP Method

POST(Content-Type: multipart/form-data; boundary="$boundary”; charset=UTF-8)

Request

パラメーター	タイプ	必須	説明
article	String	Y	下記の article の説明を参照
添付ファイル名	Multipart	N	添付ファイル名は UTF-8 で URL エンコードする必要があります。下記の「添付ファイルの制限」を参照

article

下記を JSON 形式で記述します。

パラメーター	タイプ	必須	説明
domainId	Integer	Y	ドメイン ID
boardNo	Long	Y	掲示板の番号
title	String	Y	タイトル
body	String	Y	内容
registerUtcDate	Long	N	投稿の作成時刻(単位: timestamp in millisecond) 既定値: 現在時刻過去の時刻のみ指定可能です。
modifyUtcDate	Long	N	投稿の修正時刻(単位: timestamp in millisecond) 過去の時刻のみ指定可能です。
useComment	Boolean	N	コメントの可否既定値: True
sendCreatedNotify	Boolean	N	投稿時のサービス通知の有無 ※ 既定値：false
attentionPeriodInDays	Integer	N	必読期間(単位: 日) 既定値: 0日
accountId	String	N	投稿者のアカウント情報
memberName	String	N	投稿者の名前
department	String	N	投稿者の部署

投稿者情報の適用

添付ファイル

ファイルの制限

1投稿あたりの添付ファイル数は合計 19 個以下に制限されます。
添付ファイルのアップロード容量の合計は 20MB 未満である必要があります。
管理者が許可しているファイル形式のみ添付することができます。

Request Example

multipart bodyの Content-Disposition: form-data; name="article" 以後がアップロードするファイルのデータとなります。

https://apis.worksmobile.com/r/{API ID}/home/articles
Content-Type: multipart/form-data; boundary=WebAppBoundary


--WebAppBoundary
Content-Disposition: form-data; name="article"

{
   "title":"[TC][OpenApi] testTitle",
   "body":"testBody",
   "registerUtcDate":null,
   "modifyUtcDate":null,
   "useComment":true,
   "boardNo":{{boardNo}},
   "domainId":"{{domainId}}",
   "accountId":"{{accountId}}",
   "memberName":null,
   "department":null,
   "attentionPeriodInDays":0
}

--WebAppBoundary
Content-Disposition: form-data; name="attach_file_name1.txt";

textContent

--WebAppBoundary
Content-Disposition: form-data; name="attach_file_name2.txt";

textContent2

--WebAppBoundary--

Response

プロパティ	タイプ	必須	説明
boardNo	Long	Y	掲示板の番号
articleNo	Long	Y	投稿の番号

Response Example

{
    "boardNo": 123123,
    "articleNo": 1111
}

API呼び出しに失敗した場合、HTTP status codeでエラーを返します。

HTTP status code	error	message	説明
400	Bad Request	Invalid Parameter	不正なパラメーター
403	Forbidden	Blocked Extension File	制限されているファイル形式
413	Payload too large	Over Quota File Size	制限されたファイルサイズを超過
507	Insufficient Storage	Over Upload Quota	共有ストレージ容量の超過

HTTP/1.1 400 
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Date: Tue, 07 May 2019 07:44:09 GMT
Connection: close
{
    "error": "Bad Request",
    "message": "Invalid parameter",
    "status": 400
}

LINE WORKS Developers