Rainbow Engine

IT技術を分かりやすく簡潔にまとめることによる学習の効率化、また日常の気付きを記録に残すことを目指します。

Pleasanter

PleasanterのAPIの使い方&レコード作成の例をご紹介

投稿日:2023年4月12日 更新日:

 

<目次>

(1) PleasanterのAPIの使い方&レコード作成の例をご紹介
 やりたいこと
 (1-0) 概要
 (1-1) STEP1:テスト用サイトのインポート
 (1-2) STEP2:HTTPリクエストの準備
 (1-3) STEP3:実行結果の確認
 (1-4) 小技(Tips)

(1) PleasanterのAPIの使い方&レコード作成の例をご紹介

やりたいこと

・PleasanterのAPIを素早く試してみたい。

(1-0) 概要

まずはPostman(APIを手軽に検証できるサービス)でAPIを疎通してみます。
Postmanを使った事が無い方は、下記の記事も併せてご覧頂けると理解がスムーズです。

(1-1) STEP1:テスト用サイトのインポート

まずは下準備として、添付のJSONを取り込んで、テスト用のサイトを準備します。
・①「管理」→「サイトパッケージのインポート」を押下します。
(図111)
・②添付のJSONを選択して「インポート」押下します。
(図112)
・③サイトが作成されます。
(図113)

(1-2) STEP2:HTTPリクエストの準備

次にPostmanからHTTPリクエストを送るための情報をセットします。
●①HTTPメソッド、URL
(例)
https://demo.pleasanter.org/api/items/7185230/create
→「7185230」の部分はご自身のサイトIDに変更
(図114)
●②リクエストヘッダー部
(例)
「Content-Type」に「application/json」を追加
(図121)
●③リクエストボディ部
下記のようなJSON形式で指定します。
(例)
{
     "ApiVersion": 1.1,
     "ApiKey": "xxxxxxxxxx(ご自身のAPIキーを指定)",
     "Title": "APIコールテスト",
     "Status": "100",
     "CompletionTime": "2022/12/28",
     "ClassHash": {
         "ClassA": "100",
         "ClassB": "問い合わせ",
         "ClassC": "業務システム",
         "ClassD": "132173",
         "ClassE": "132177"
    }
}

 

(注意点)
・①デフォルト項目(例:タイトル=Title、状況=Status)はxxxxHash(例:ClassHash)の外に記述する
→xxxxHashの内部に記述してしまうと、500 Internal Server Errorになってしまいます。

 

・②xxxxHash(例:ClassHashなど)はClassA、ClassB、・・・の項目をカンマ区切りで羅列できる
(図122)

 

・③「組織」をプルタブで選ぶ項目の場合([[Dept]]などを指定してる項目)、組織IDを与える。

(図123)ここの値をJSONの値に設定

 

・④APIキーはユーザーごとに発行できます。
(図124)

(1-3) STEP3:実行結果の確認

上記内容でリクエストを送った際の、成功例のレスポンスや更新結果の例をご紹介します。
 
●実行結果(成功例のレスポンス)
(例)
{
    "Id": 7185272,
    "StatusCode": 200,
    "LimitPerDate": 10000,
    "LimitRemaining": 9967,
    "Message": "\" APIコールテスト \" を作成しました。"
}
(図131)
●実行結果(画面)
⇒レコードが作成された
(図132)

(1-4) 小技(Tips)

ClassXなど項目に対応する物理名を素早く調べる小技をご紹介します。
・①ブラウザでF12を押して開発者ツールを開きます。
(図141)

・②「要素の選択」を押下します。

(図142)

・③この状態で調べたい項目をクリックすると、右側に出てくる「Issues_XXXX」のXXXXの部分が項目名になります。

→リクエストのボディ部で指定する名前になります。
(図143)

Adsense審査用広告コード


Adsense審査用広告コード


-Pleasanter
-

執筆者:


comment

メールアドレスが公開されることはありません。 が付いている欄は必須項目です

関連記事

PleasanterのAPIをPythonからコールするサンプルをご紹介

  <目次> (1) PleasanterのAPIをPythonからコールするサンプルをご紹介  (1-0) やりたいこと  (1-1) サンプルサイト  (1-2) サンプルプログラム   …

  • English (United States)
  • 日本語
Top