アプリ設定API

説明概要

アプリ設定を操作するアプリ設定APIを説明します。
APIによっては、GET/POSTリクエストに対してJSONやXMLをレスポンスします。

アプリ設定API

操作	GET	POST	リクエストURL	レスポンス(JSON)	実行に必要な権限
アプリ一覧を取得する	○	-	<ContextRoot>/API/Admin/ProcessModel/list	count、ProcessModelEntryのリスト	システム管理権限
アプリをリリースする	-	○	<ContextRoot>/API/PMM/ProcessModel/<processModelInfoId>/release	リリース情報	アプリ管理権限
処理担当者設定の指定組織を変更する	-	○	<ContextRoot>/API/Admin/ProcessModel/<processModelInfoId>/AllocationRule/update	更新情報	システム管理権限

「<ContextRoot>」は、DataSpider BPMのルートURIである「http(s)://<ホスト名>:<ポート番号>/userweb」を意味します。

アプリ設定APIのレスポンス

ProcessModelEntryの構造

属性	型	説明
authorities	-	-
processModelInfoCategory	文字列	アプリのカテゴリ
processModelInfoCreateQuserName	文字列	アプリの作成ユーザ
processModelInfoCssClass	文字列	アプリの状態 model: 通常 model not-activated: 未リリースの状態 model not-active: 運用停止中(非稼働)の状態 model updated: 新しいバージョンがリリースされた状態
processModelInfoHasActiveProcessModel	boolean	アプリの稼働状態 true: 稼働中 false: 運用停止中(非稼働)または未リリース
processModelInfoId	整数	アプリのID
processModelInfoName	文字列	アプリの名前
processModelInfoNote	文字列	アプリの管理者向けメモ
processModelInfoViewPriority	整数	アプリの表示優先度
processModelInfoUpdateDatetime	文字列	アプリの更新日時
processModelVersion	整数	アプリの稼働バージョン
starred	boolean	スターの有無 true: スター有 false: スター無

正常応答の例


 {
   "count":30,
   "processModelInfos":[
     {
       "authorities":null,
       "processModelInfoCreateQuserName":"佐藤",
       "processModelInfoCssClass":"model",
       "processModelInfoHasActiveProcessModel":true,
       "processModelInfoId":3,
       "processModelInfoName":"Q001-企画書レビュー",
       "processModelInfoNote":"企画書提案アプリ",
       "processModelInfoViewPriority":0,
       "processModelInfoUpdateDatetime":"2023-10-20T13:34:47+0900",
       "processModelVersion":2,
       "starred":true
     },
     {
       "authorities":null,
       "processModelInfoCreateQuserName":"佐藤",
       "processModelInfoCssClass":"model not-activated",
       "processModelInfoHasActiveProcessModel":false,
       "processModelInfoId":4,
       "processModelInfoName":"Q002-受注報告",
       "processModelInfoNote":"受注処理アプリ",
       "processModelInfoViewPriority":0,
       "processModelInfoUpdateDatetime":"2023-10-21T14:35:48+0900",
       "processModelVersion":null,
       "starred":false
     },
   ]
 }

アプリ設定API詳細

アプリ一覧を取得する: /API/Admin/ProcessModel/list

GET リクエストパラメータ

パラメータ名	必須	説明
limit	任意	対象アプリの最大件数指定しない場合は、「1」が指定されたものとみなされます。
start	任意	対象アプリの開始位置指定しない場合は、「0」が指定されたものとみなされます。例: 検索結果の全件が100件で、startに「10」、limitに「50」を指定した場合、100件のうち11件目から60件目までを取得します。
category	任意	取得するアプリのカテゴリを指定します。
query	任意	取得するアプリのアプリ名を指定します。値が指定された場合、その値がアプリ名の一部に含まれているアプリを検索します。
starredOnly	任意	取得するアプリのスター有無を、以下から指定します。指定しない場合は、両方を取得します。 true: スター有のアプリ false: スター無のアプリ
dbFile	任意	指定したアプリ共有アドオンを使用しているアプリを検索します。選択型データ項目で使用する選択肢マスタ: select/<アドオンファイル名> 「PDF ファイル生成」で使用するPDFフォーム: pdf/<アドオンファイル名> サービスタスク定義ファイル: serviceTask/<アドオンファイル名> 例) 「ExpenseCalculation」というアドオンファイル名のサービスタスク定義ファイルを持つアプリを検索します。 dbFile=serviceTask/ExpenseCalculation アプリ共有アドオンに関する詳細は、「アプリ共有アドオン(管理)」を参照してください。
sortProperty	任意	結果データのソートする項目を、以下から指定します。 processModelInfoId: アプリのID processModelInfoUpdateDatetime: アプリの更新日時 viewPriority: アプリの表示優先度
sortDirection	任意	結果データのソートする順序を、以下から指定します。 ASC: 昇順 DESC: 降順

レスポンス

count: 該当するアプリの件数

limitおよびstartで絞り込んだ取得件数ではありません。

processModelInfos: 該当するアプリの ProcessModelEntryのリスト

発生する可能性のあるエラー

InvalidStart: 10012
InvalidLimit: 10013

アプリをリリースする: /API/PMM/ProcessModel/<processModelInfoId>/release

POST リクエストパラメータ

パラメータ名	必須	説明
processModelInfoId	必須	対象アプリのID クエリパラメータの指定ではなく、パスパラメータでの指定となります。リクエストURLの<processModelInfoId>に指定します。
note	任意	対象アプリのバージョンメモ今回のリリースに関するバージョンメモの文字列を指定します。バージョンメモは、256文字以下にしてください。

レスポンス

リリース情報
- processModelId: リリースしたアプリのバージョン別のID
- processModelInfoId: リリースしたアプリのID
- version: リリースしたアプリのバージョン

正常応答の例


 {
   "processModelId":6,
   "processModelInfoId":1,
   "version":2,
 }

発生する可能性のあるエラー

InvalidProcessModelInfoId: 10017
InvalidNote: 10023
InvalidProcessModel: 10024
ProcessModelInfoDoesNotExist: 20025
Forbidden: HTTP 403

処理担当者設定の指定組織を変更する: /API/Admin/ProcessModel/<processModelInfoId>/AllocationRule/update

POST リクエストパラメータ

パラメータ名	必須	説明
processModelInfoId	必須	対象アプリのID クエリパラメータの指定ではなく、パスパラメータでの指定となります。リクエストURLの<processModelInfoId>に指定します。
version	必須	対象アプリのバージョン処理担当者を変更するアプリのバージョンを以下から指定します。 Creating: 開発中バージョン Latest: 最新バージョン <バージョン番号>: 指定のバージョン
fromQgroupIds	必須	変更前組織の組織ID(配列)
toQgroupIds	必須	変更後組織の組織ID(配列)

レスポンス

更新情報
- updated: 更新結果

正常応答の例
```
 {
   "updated":true
 }
		
```

発生する可能性のあるエラー

ProcessModelInfoDoesNotExist: 20025
Forbidden: HTTP 403