AppSuite(付録)

AppSuiteの機能を利用するための詳しい資料です。

印刷ボタン

AppSuite APIの仕様

共通仕様


HTTPを使用して送受信します。非ASCII文字や一部記号をパラメーター名や値として送信する場合、UTF-8でURLエンコードしてください。

URL

desknet's NEOのURLと同じパスの"appsr"を指定します。

【例】desknet's NEOのURLが"https://local.yourdomain/cgi-bin/dneo/dneo.cgi"の場合
https://local.yourdomain/cgi-bin/dneo/appsr.cgi

リクエスト

APIのリクエストは以下の形式です。APIによっては固有のキーがあるものもあります。

【例】
access_key=xxxxxxxxxx&action=xxx_data&app_id=@sample_app

【パラメーター】
パラメーター名 指定する値 説明
access_key [アクセスキー] 必ず指定してください。[アクセスキー設定]で発行したアクセスキーを指定します。
action [API処理名] 必ず指定してください。APIごとの固定値を指定します。
app_id [アプリケーションID | @アプリケーション識別子] 必ず指定してください。以下のいずれかの方法でアプリケーションを指定します。
アプリケーションID
先頭に"@"を付けたアプリケーション識別子

レスポンス

APIのレスポンスは以下の形式です。APIによっては固有のキーがあるものもあります。

【例】
{
 "status":"ng",
 "errorno":-10,
 "errormessage":"エラーメッセージ"
 "errmsgadd":"{{担当}}"
}

【JSONオブジェクト値】
キー 説明
status [ok | ng] 処理に成功したときは"ok"、そうでないときは"ng"になります。
errorno [エラー番号] エラーごとの番号です。エラーが発生した場合のみ設定されます。
errormessage [エラーメッセージ] エラーの内容を示すメッセージです。エラーが発生した場合のみ設定されます。
errmsgadd [追加情報] 部品に関連するエラーが発生した場合、その部品名が設定されます。


データ一覧 API


概要

アプリケーションのデータを一覧取得します。

リクエスト[GET]
【例】
access_key=xxxxxxxxxx&action=list_data&app_id=@sample_app&fields=[{"field_name":"担当"},{"field_name":"顧客"}]&filter={"item":[{"field_id":"103","operator":">","value":"10000"}]}&keyword=山田&sort_field_id=101&sort_order=asc&offset=500&limit=100

【パラメーター】
パラメーター名 指定する値 説明
action list_data 固定値
fields [部品設定] レスポンスで取得する部品を指定します。
省略した場合、すべての部品の値を取得します。
ここで取得した部品がキーワード検索の対象の部品になります。
部品を指定する際の書式は、部品設定をご覧ください。
※書式内の"field_name"を空欄にできません。
filter [絞り込み条件] 指定した場合、その条件でデータが絞り込まれます。
絞り込み条件を指定する際の書式は、絞り込み条件をご覧ください。
keyword [キーワード] 指定した場合、そのキーワードでデータが絞り込まれます。
sort_field_id [部品のID] 並び順のキーになる部品を指定します。
部品のIDは[アプリケーション設定 > 部品管理]にて確認できます。
sort_order [asc | desc] "sort_field_id"で指定した部品の値をどの順序で並べ替えるかを指定します。
"asc"にすると昇順、"desc"にすると降順になります。省略すると、昇順になります。
offset [開始位置] 何件目から取得するか(先頭は0)を指定します。省略すると、先頭から取得します。
limit [取得件数上限] 最大何件取得するかを指定します。省略すると、最大5000件取得します。
※ここで指定した値に関わらず、取得件数の上限は5000件です。

レスポンス
【例】
{
 "status":"ok",
 "list":{
  "item":[
   {
    "\\permissions":{
     "allow_write":"on",
     "allow_delete":"on"
    },
    "データID":{
     "val":"1",
     "deny_write":"on"
    },
    (中略)
   },
  (中略)
 }
}

【JSONオブジェクト値】
キー 説明
item [データの配列] データ参照 APIの"record"下とほぼ同じです。
データ参照 APIとの違いに関しては、 部品別の機能対応表一覧形式の画面に表示できる部品 をご覧ください。


データ件数取得 API


概要

アプリケーションのデータの件数を取得します。

リクエスト[GET]
【例】
access_key=xxxxxxxxxx&action=count_data&app_id=@sample_app&fields=[{"field_name":"担当"},{"field_name":"顧客"}]&filter={"item":[{"field_id":"103","operator":">","value":"10000"}]}&keyword=山田

【パラメーター】
パラメーター名 指定する値 説明
action count_data 固定値
fields [部品設定] キーワード検索の対象の部品を指定します。
省略した場合、すべての部品の値がキーワード検索の対象になります。
部品を指定する際の書式は、部品設定をご覧ください。
※書式内の"field_name"を空欄にできません。
filter [絞り込み条件] 指定した場合、その条件で絞り込んだ件数を取得します。
絞り込み条件を指定する際の書式は、絞り込み条件をご覧ください。
keyword [キーワード] 指定した場合、そのキーワードで絞り込んだ件数を取得します。

レスポンス
【例】
{
 "status":"ok",
 "allcnt":"1000"
}

【JSONオブジェクト値】
キー 説明
allcnt [データ件数] アプリケーションのデータの件数です。
条件を指定した場合はそれで絞り込まれた件数になります。


データ参照 API


概要

アプリケーションのデータを1件取得します。

リクエスト[GET]
【例】
access_key=xxxxxxxxxx&action=get_data&app_id=@sample_app&data_id=1

【パラメーター】
パラメーター名 指定する値 説明
action get_data 固定値
data_id [データID] 必ず指定してください。取得対象となるデータのデータIDを指定します。

レスポンス
【例】
{
 "status":"ok",
 "record":{
  "\\permissions":{
   "allow_write":"on",
   "allow_delete":"on"
  },
  "データID":{
   "val":"1",
   "deny_write":"on"
  },
  (中略)
 }
}

【JSONオブジェクト値】
キー 説明
allow_write [on | off] このデータを変更できる場合に"on"、そうでない場合に"off"になります。
allow_delete [on | off] このデータを削除できる場合に"on"、そうでない場合に"off"になります。
部品名 JSON形式 部品ごとの値を設定します。値の書式は以下の通りです。
[val]:部品値のJSONオブジェクト値を参照してください。
[deny_write]:この部品値を変更できない場合、"on"になります。
[type]:計算結果のタイプが設定されます。(部品が自動計算の場合のみ)
[hint]:計算エラーの場合、エラー内容が設定されます。(部品が自動計算の場合のみ)
[error]:部品値がエラーの場合、以下のエラーコードが設定されます。
  unauthorized: 値に参照権がありません。
  reference_error: 参照エラーが発生しています。
  under_maintenance: 参照先のアプリケーションがメンテナンス中です。

【部品値のJSONオブジェクト値】
部品 値の書式
文字(1行)/文字(複数行)/ラジオボタン/プルダウン/数値/リッチテキスト/[データID] 値がそのまま設定されます。
チェックボックス/リストボックス 選択値がタブ区切りで設定されます。
日付 値がyyyy-MM-dd形式で設定されます。
時刻 値が00:00:00からの経過秒数で設定されます。
日時/[登録日時]/[更新日時] 値がyyyy-MM-ddTHH:mm形式で設定されます。
添付ファイル {
 "attach":{
  "item":[
   {
    "id":"1",
    "attachdisp":"logo.png",
    "mimetype":"image/png",
    "url":"appsuite…",
    "size":10000
   },
   …
  ]
 }
}
自動計算 計算結果の値が設定されます。
ユーザー選択/[登録者]/[更新者] {
 "users":{
  "item":[
   {
    "id":"1",
    "Name":"山田太郎",
    "summary":"情報システム室",
    "description":{"assign":"情報システム室"}
   },
   …
  ]
 }
}
組織選択 {
 "groups":{
  "item":[
   {
    "id":"1",
    "Name":"情報システム室",
    "description":"東京本社"
   },
   …
  ]
 }
}
表部品 {
 "child_records":{
  "item":[
   {"部品名": , …},
   …
  ]
 }
}
参照データ一覧 値は設定されません。
[revision] レビジョン番号です。データが変更されるたびに値が増えます。


データ追加 API


概要

アプリケーションにデータを追加します。

リクエスト[POST]
【例】
access_key=xxxxxxxxxx&action=insert_data&app_id=@sample_app&{{担当}}=1&{{顧客}}=田中花子

【パラメーター】
パラメーター名 指定する値 説明
action insert_data 固定値
{{部品名}} [部品値] 部品ごとの値を設定します。値の指定方法は以下の通りです。
[文字(1行)、文字(複数行)、ラジオボタン、プルダウン、数値、リッチテキスト]: 値をそのまま指定します。
[チェックボックス、リストボックス]: 選択値をタブ区切りで指定します。
[日付]: yyyy-MM-dd形式で指定します。
[時刻]: 00:00:00からの経過秒数で指定します。
[日時]: yyyy-MM-ddTHH:mm形式で指定します。
[添付ファイル]: "multipart/form-data"で送信します。
[ユーザー選択]: ユーザーシステムIDをタブ区切りで指定します。
[組織選択]: 組織システムIDをタブ区切りで指定します。
[表部品]: JSON形式で指定します。
    [
     {"部品名": , …},
     …
    ]

レスポンス
【例】
{
 "status":"ok",
 "ID":"1"
}

【JSONオブジェクト値】
キー 説明
ID [データID] 追加されたデータのデータIDです。


データ変更 API


概要

アプリケーションのデータを変更します。

リクエスト[POST]
【例】
access_key=xxxxxxxxxx&action=update_data&app_id=@sample_app&data_id=1&{{revision}}=2&{{担当}}=1&{{顧客}}=田中花子

【パラメーター】
パラメーター名 指定する値 説明
action update_data 固定値
data_id [データID] 必ず指定してください。変更対象となるデータのデータIDを指定します。
{{revision}} [レビジョン番号] 必ず指定してください。指定した値とデータのレビジョン番号が一致するか検証されます。0を指定すると、検証されません。
{{部品名}} [部品値] 変更する値を設定します。指定方法はデータ追加 APIと基本的に同じです。
添付ファイル部品は追加するファイルのみ指定します。削除する場合は以下の通りに指定します。
{{部品名}}.del_attachment_id={{ファイルID}}


データ削除 API


概要

アプリケーションのデータを削除します。

リクエスト[POST]
【例】
access_key=xxxxxxxxxx&action=delete_data&app_id=@sample_app&data_id=1

【パラメーター】
パラメーター名 指定する値 説明
action delete_data 固定値
data_id [データID] 削除対象となるデータのデータIDを指定します。