実行結果お知らせの追加

リクエストURL

ホスト

https://api.next-engine.org

エンドポイント

/api_v1_notice_execution/add

リファレンス内容

実行結果お知らせ追加について

入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります。

実行結果のお知らせを追加します

処理結果はレスポンスのステータスコードで確認します。

入力パラメータ

パラメータ	値	省略	備考
`access_token`	access_token取得により取得した値	必須(SDKの場合不要)
`refresh_token`	access_token取得により取得した値	可能(SDKの場合不要)	【指定してaccess_tokenの有効期限が切れた場合】正常に出力パラメータが設定されaccess_tokenとrefresh_tokenが新しい値に更新されます【省略してaccess_tokenの有効期限が切れた場合】出力パラメータ「result」の値がredirectになります（成功時以外の出力パラメータ参照)
`wait_flag`	1:メイン機能過負荷でも可能な限りエラーにせず実行1以外:メイン機能過負荷の場合、003002のエラーを返却	可能(省略時は1以外とする)	詳細はパラメータ共通事項「待機フラグについて」を参照して下さい
`execution_notice_success`	成功/失敗フラグ	可能省略時は成功(1)とする	1:成功通知 0:失敗通知
`execution_notice_title`	お知らせの件名	必須
`execution_notice_content`	お知らせの内容	必須

出力パラメータ

パラメータ名	値	備考
`result`	`success`	success以外の場合の出力パラメータは成功時以外の出力パラメータ参照
`execution_notice_id`	お知らせ通知ID	このIDは実行結果お知らせの検索などに利用できます
`access_token`	入力パラメータで指定したaccess_token／新たに発行されたaccess_token	有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります
`access_token_end_date`	access_tokenの有効期限切れ日時
`refresh_token`	入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token	access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります
`refresh_token_end_date`	refresh_tokenの有効期限切れ日時

実行結果お知らせ

項目名	フィールド名	データ型	備考
お知らせ通知ID	`execution_notice_id`	数値型	実行結果お知らせ通知に一意に付与される番号
成功/失敗フラグ	`execution_notice_success`	数値型	0=失敗、1=成功
件名	`execution_notice_title`	文字列型	お知らせ通知件名
内容	`execution_notice_content`	文字列型	お知らせ通知内容
既読/未読フラグ	`execution_notice_read`	数値型	0=未読、1=既読
作成日	`execution_notice_creation_date`	日時型	実行結果通知が作成された日時
最終更新日	`execution_notice_last_modified_date`	日時型	実行結果通知が最後に修正された日時

サンプル

リクエスト

curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d 'access_token=xxx&refresh_token=xxx&execution_notice_success=1&execution_notice_title=xxx&execution_notice_content=xxx' http://api.next-engine.org/api_v1_notice_execution/add

レスポンス

{
  "execution_notice_id": "29",
  "result": "success",
  "access_token": "xxx",
  "access_token_end_date": "2018-08-02 10:41:04",
  "refresh_token": "xxx",
  "refresh_token_end_date": "2018-08-04 10:41:04"
}

エラー

エラーコード

エンドポイント固有のエラーコードを以下に示します。共通エラーコードはメッセージコード一覧を参照してください。

エラーコード	メッセージ	対処方法
`019001`	アクセス情報[xxxxxx]の許可が必要です。	ネクストエンジンの「アプリを作る」「APIタブ」にてアクセス許可をする必要があります
`019002`	POSTパラメータにexecution_notice_titleが指定されていない、または値が空です。	execution_notice_titleを指定してください
`019003`	POSTパラメータにexecution_notice_contentが指定されていない、または値が空です。	execution_notice_contentを指定してください