外部連携 web api i／f仕様書 - cimtops-support.com · 変更履歴日付変更内容...

ConMas i-Reporter

外部連携 Web APIＩ／Ｆ仕様書

Copyright © 2014 CIMTOPS CORPORATION - All Rights Reserved.

変更履歴

日付変更内容2012年9月1日新規作成

2014年11月19日自動帳票作成APIにパラメーター"userMode"を追加。2014年1月14日自動帳票作成APIにパラメーター"labelMode"を追加。2015年1月23日定義権限設定ＡＰＩにパラメーター "defRoleMode"、"repRoleMode" を追加。2015年3月11日帳票削除APIにパラメーター"isDeleteLabel"追加2015年3月19日機能概要を修正2015年4月13日自動帳票作成APIにパラメーターを追加（システムキー(systemKey)、通知メッセージ関連(notice)）2015年5月8日帳票削除API、定義削除APIにトランザクションモードの記述を追加2015年8月1日帳票更新APIにパラメーター"labelMode"を追加。

2015年9月16日帳票更新APIにパラメーターを追加（システムキー(systemKey)）2015年10月8日自動帳票作成APIにパラメーター"defaultMode"を追加。2015年12月4日帳票コピーAPIを追加。2016年2月18日帳票CSVダウンロードAPIを追加。

2016年2月25日

帳票ダウンロードAPIに３パラメーターを追加・isCopySheetOutput・layoutType・isAllRevision

2016年2月29日自動帳票作成APIで、簡易CSV形式が使用できるようになりました。2016年7月14日帳票ファイル取得APIを追加2017年1月19日ラベル削除APIを追加2017年1月19日帳票ダウンロードAPIのパラメータ"isAllRevision"の誤記(0,1)を(false,true)に修正2017年1月31日帳票簡易詳細情報取得ＡＰＩ仕様にsystemKey1～5, defTopId, defTopOrgパラメーターを追加2017年2月7日帳票簡易詳細情報取得ＡＰＩ仕様にResultTypeパラメーターを追加

2017年6月26日

帳票一覧取得APIに以下抽出条件を追加・registTimeFrom "帳票の登録日時FROM"・registTimeTo "帳票の登録日時TO"・updateTimeFrom "帳票の最終更新日時FROM"・updateTimeTo "帳票の最終更新日時TO"

2017年7月4日帳票更新APIではカーボンコピーが動作しないことを追記2017年7月27日帳票更新APIにカーボンコピーを動作させるパラメーターを追加2017年7月27日帳票更新APIに入力完了帳票の更新を可能にするパラメーターを追加2018年5月18日自動帳票作成APIにシートコピー機能を追加2018年7月5日帳票更新APIに数値、数値選択、時間数、年月日、カレンダー年月日、時刻クラスターの値クリア設定を追加

2018年7月30日自動帳票作成APIに音声辞書登録機能を追加2018年11月5日ログイン、ログアウトAPIにAPI権限が必要である説明を追加

2018年11月28日自動帳票作成APIに数値系クラスターのしきい値設定変更説明を追加2018年12月10日自動帳票作成APIに数値系クラスターのしきい値設定変更説明を修正2018年12月19日クラスター取得APIを追加

2019年2月5日「クラスター取得API仕様」表題を追記

2019年2月19日帳票CSVダウンロードAPI仕様レコード区分＝S のレイアウトを追加・15：レイヤー入力テキスト・16：ページ番号


ConMas i-Reporter 外部連携インターフェース概要

外部システム

外部システム外部システム外部システム

ConMas Server

ASP.NETWeb

Application

ConMas Manager

Web Browser 帳票トップ定義ビュー

シート定義ビュー

クラスタ定義ビュー

定義権限ビュー

定義クラスター権限ビュー

定義参考資料ビュー

定義ラベルマスタービュー

定義ラベルビュー

帳票トップビュー

シートビュー

クラスタービュー

帳票権限ビュー

帳票クラスター権限ビュー

帳票参考資料ビュー

帳票ラベルマスター

ユーザーマスタービュー

グループマスタービュー

グループ所属マスタービュー

端末マスタービュー

システム設定ビュー

ConMas Generator

Windows Service Application

定義情報参照ビュー

帳票情報参照ビュー

マスター情報参照ビュー

ジョブ設定

入力フォルダー設定

出力フォルダー設定

ログ出力設定

ジョブスケジュール実行

設定・管理機能

管理・閲覧・編集・承認

帳票データー出力

自動帳票作成

監視・ジョブ実行

フォルダー監視実行

CSV CSV

外部Application実行

外部取り込み

アプリケーション

外部取り込み


外部取り込み


postgreSQL ClientFile System

【 Web API 連携】「ConMas Web Server」が提供するREST形式のWebAPIを利用して、データの取得、登録が可能です。ログインからセッションを保持した連続した操作が可能です。

＜呼び出し例＞RESTコマンド（ログイン）

↓（POST）RESTコマンド（帳票取得）

↓（POST）RESTコマンド（帳票登録）

↓（POST）RESTコマンド（ログアウト）

【データー参照ビュー】「ConMas i-Reporter」のデータベースから「postgreSQL」に直接接続し、「参照ビュー」からデータを取得できます。

「postgreSQL」のクライアントミドルウェア等の接続モジュールやドライバーが必要となります。

【フォルダ監視・ジョブスケジュール】「ConMas Generator」により、フォルダ監視によるデータのインポート、及び、定期ジョブ実行によるi-Reporterデータのエクスポートが可能です。

ConMas Generatorの入出力形式は、システム標準形式となるため、個別の外部プログラムにより、データ変換が必要となります。コマンドライン形式による外部プログラム実行が可能です。

ConMas Generator から変換プログラムを呼び出すことが可能です。

File System

外部システム

ConMas Web API

ログイン

ログアウト

Web API

定義一覧取得

定義簡易詳細情報取得

定義ロック取得／解除

定義権限情報取得／設定

定義ラベル情報取得／設定

帳票一覧取得

帳票簡易詳細情報取得

帳票ロック取得／解除

帳票権限情報取得／設定

帳票ラベル情報取得／設定

自動帳票作成

帳票更新

帳票削除

帳票ダウンロード

ユーザー情報取得

ユーザー情報登録

グループ情報取得

グループ情報更新

端末取得

URLスキーム取得

HTTP/HTTPS( REST )

PostgreSQL 9.1Data Base

ASP.NET Web Application

外部Application実行

外部取り込み


Web Client

インポートエクスポート

CSV

※標準機能 ※標準機能※標準機能

CSV

サーバー内の指定ディレクトリへのCSV,XMLファイル出力帳票画像、帳票PDFの出力

※オプション機能



選択値情報更新

定義削除

CSVHTTP/HTTPS

( REST )


　WebAPIについて

■ ＵＲＬhttp(s)://（ホスト名）/ConMasAPI/Rests/APIExecute.aspx

処理シーケンス

　　

■ 必須パラメーターパラメーターID 内容説明定義から作成時command APIコマンド識別文字列 RESTコマンド識別文字列必須

■ 任意パラメーターパラメーターID 内容説明定義から作成時

Webサーバ(IIS)レベルのエラー(接続できない、接続できても404/500など)についての処理はクライアント側で考慮するものとします。実行時エラーについては、各コマンドのレスポンスではなく、以下の共通のエラーデータをレスポンスとして返します。

■共通レスポンスノード関係名称説明メモconmas ルート

error 1 エラー情報code 1 エラーコード ※エラーコード表参照remarks 1 任意の数の付帯情報（エラーコードごとに定義）

remark 1..* 付帯情報ｎ

■エラーコード表エラーコード説明

0 エラーなしレスポンスの不要なコマンドが将来創設された場合の成功通知？-1 原因不明なエラー (Unknown Error)1 無効なコマンド(Command Not Found)2 パラメータ異常(Invalid Parameter)3 権限不足 (Privilege Error)4 非対応HTTPメソッド(例：GET不可) (Invalid HTTP Method)5 セッション無し　（2012.05.16追加）

1000 ~ コマンドごとの独自エラーコードを定義可

　※各コマンド別のパラメーター

ログインＡＰＩ(Login)

クライアント（お客様開発）

ConMas Web API(URL) http(s)://（ホスト名）/ConMasAPI/Rests/APIExecute.aspx

[送信パラメータ]command

= Loginuser= (USER ID)

password

ログインAPI呼び出し

各ＡＰＩ

HTTP Request

HTTP

HTTP Request

HTTP

ログアウトＡＰＩ(Logout)


= Logout

ログアウトAPI呼び出し

HTTP Request

HTTP

同一セッション内処理

各API呼び出し

各API呼び出し

各API呼び出し

各ＡＰＩHTTP Request

HTTP

各ＡＰＩHTTP Request

HTTP


　コマンド一覧

区分コマンド名称処理内容共通ログインログインする共通ログアウトログアウトする帳票一括操作自動帳票作成アップロードファイルから帳票データを作成帳票一括操作帳票更新入力帳票情報を更新する帳票一括操作帳票ダウンロード指定した定義の帳票データの、CSV、画像、PDFをダウンロード ※横CSV帳票一括操作帳票CSVダウンロード指定した定義の帳票データの、CSV、画像、PDFをダウンロード ※縦CSV帳票一括操作帳票削除条件に一致した帳票を論理削除、または、物理削除定義一括操作選択値情報更新アップロードされたファイルにより、定義内の選択クラスター要素を更新。またバリューリンク設定も可能定義一括操作定義削除条件に一致した定義を論理削除、または、物理削除定義操作定義一覧取得定義情報の一覧を取得する定義操作定義簡易詳細情報取得定義情報の簡易詳細情報を取得する定義操作定義ロック取得定義の排他ロックを取得する定義操作定義ロック解除定義の排他ロックを解除する定義操作定義権限取得定義権限情報を取得する定義操作定義権限設定定義権限情報を設定する定義操作定義ラベル取得定義ラベル情報を取得する定義操作定義ラベル更新定義ラベル情報を更新する定義操作帳票ラベル定義取得帳票ラベル定義情報を取得する定義操作帳票ラベル定義更新帳票ラベル定義情報を更新する帳票操作帳票一覧取得帳票情報の一覧を取得する帳票操作帳票簡易詳細情報取得帳票情報の簡易詳細情報を取得する帳票操作帳票ロック取得帳票の排他ロックを取得する帳票操作帳票ロック解除帳票の排他ロックを解除する帳票操作帳票権限取得帳票権限情報を取得する帳票操作帳票権限設定帳票権限情報を設定する帳票操作帳票ラベル取得帳票ラベル情報を取得する帳票操作帳票ラベル更新帳票ラベル情報を更新する帳票操作帳票コピー帳票コピーを行う帳票操作帳票ファイル取得帳票ファイル（PDF, Excel）の取得システムメンテグループ情報取得グループ情報を取得するシステムメンテグループ情報更新グループ情報を登録・更新するシステムメンテユーザー情報取得ユーザー情報を取得するシステムメンテユーザー情報登録ユーザー情報を登録・更新するシステムメンテグループ所属取得グループ所属情報を取得するシステムメンテグループ所属更新グループ所属情報を登録・更新するシステムメンテ定義ラベルマスタ取得定義ラベルマスター情報を取得するシステムメンテ定義ラベルマスタ登録定義ラベルマスター情報を登録・更新するシステムメンテ帳票ラベルマスタ取得帳票ラベルマスター情報を取得するシステムメンテ帳票ラベルマスタ登録帳票ラベルマスター情報を登録・更新するシステムメンテ端末情報取得端末情報を取得するシステムメンテ URLスキーム取得アプリ起動用カスタムURLスキームを取得する（ログイン認証情報付き）システムメンテラベル削除ラベルを削除する（条件指定あり）


共通API


　ログイン・ログアウトＡＰＩ仕様


　　

　ログイン・ログアウト

■ログイン＜リクエスト＞ＩＤ値説明コマンドcommand コマンドID RESTコマンド識別文字列 Loginuser ユーザーＩＤ i-ReporterのユーザーＩＤ必須password パスワード上記ユーザーのパスワード必須

＜レスポンス＞ノード関係名称説明メモconmas ルート

loginRegist 1 ログイン認証結果code 1 結果コード -1:不明なエラー、0:成功、1:認証失敗remark 1 結果メッセージ

＜認証後権限不足レスポンス＞ ※共通のレスポンスを使用ノード関係名称説明メモconmas ルート

error 1code 1 結果コード 3:権限不足remarks 1

remark 1..* 結果メッセージ各コマンド共通を参照

■ログアウトＩＤ値説明コマンドcommand コマンドID RESTコマンド識別文字列 Logout※ セッションが無い場合でも特にエラーは返さない。

＜レスポンス＞ ※共通のレスポンスを使用ノード関係名称説明メモconmas ルート

error 1code 1 結果コード各コマンド共通を参照remarks 1


　権限チェック

ログイン処理時にユーザーが所属するグループにAPI権限が付与されていることを確認します。権限不足の場合は、ログイン処理を中断し、共通レスポンスに従ってエラーを返却します。エラーコードは3:権限不足 (Privilege Error)、付帯情報はありません。





= Loginuser= (USER ID)

password


各ＡＰＩ

HTTP Request

HTTP

HTTP Request

HTTP



= Logout


HTTP Request

HTTP


各API呼び出し


帳票一括操作API


　自動帳票作成ＡＰＩ仕様


　機能説明

取り込んだCSV,XMLの内容で入力帳票を作成します。本APIで作成された帳票は”入力前”帳票となります。

　リクエストパラメータ

■自動帳票作成ＩＤ値説明定義command コマンドID RESTコマンド識別文字列 AutoGenerate

type ファイルタイプ必須

dataFile 帳票XML 帳票CSV/XMLをファイルアップロード必須

encoding コードページ値エンコード用コードページ値

userMode ユーザーモード

labelMode ラベルモード

defaultMode

type="csv"の場合のみ適用します。932:S-JIS、65001：UTF8※type="xml"はUTF8固定です。

"1"を指定する事で、アップロードファイル中の"作成ユーザー"のユーザーが帳票登録者として登録される。※"作成ユーザー"がなければ、API実行ユーザーが帳票登録者"1"を指定する事で、アップロードファイル中の"ラベル"が階層設定されていた場合に最下層のラベルのみに紐づけられます。

デフォルト値が指定できるクラスターの扱い方

0 : 定義のデフォルト値セットしない1 : 定義のデフォルト値セットする　＜セット対象＞　・作成用データに値指定が存在しないクラスター　　※CSVレイアウトの場合は、”C”で始まるクラスターデータ列の有無　　　xmlレイアウトの場合は、clusters - cluster - のvalueノードの有無

2 : 定義のデフォルト値セットする　＜セット対象＞　・作成用データに値指定が存在しないクラスター　・作成用データに値が存在し、その入力値が"空"で指定されているクラスター

任意指定←左記の動作をさせたい場合のみ、　defaultModeパラメータを　指定してください。

xml:XMLファイル、csv:CSVファイルxmlZip:XMLファイルのZIP化したファイル（画像ファイル取り込み）csvZip:CSVファイルのZIP化したファイル（画像ファイル取り込み）


自動帳票作成用ＸＭＬ

or



[送信パラメータ]command= Login

user= (USER ID)

password


自動帳票作成ＡＰＩ(AutoGenerate)

[送信パラメータ]command= AutoGenerate

type

HTTP Request

HTTP

自動帳票作成用CSV

HTTP Request

HTTP

結果XML


[送信パラメータ]command= Logout


HTTP Request

HTTP


自動帳票作成API呼び出し


＜レスポンス＞ノード関係名称必須説明メモconmas ルート

results 1 正常終了した場合のみ処理結果を返すresult

topId 1 処理入力帳票IDcode 1 結果コード各コマンド共通を参照 ※追加エラーコード参照remarks 1

remark 1..* 結果メッセージ各コマンド共通を参照error 1

code 1 結果コード各コマンド共通を参照remarks 1


■エラーコード表 (共通以外）エラーコード説明

取り込みPDFが不正シートコピー不可エラー音声辞書　未対応クラスターエラー音声辞書登録によるシートコピーエラー音声辞書設定不正エラーしきい値設定不正エラー

170011700217003

616000

17004


　XMLレイアウト（アップロード用）

要素（単一）要素（複数）属性

■定義／帳票

systemKey1 1 システムキー1systemKey2 1 システムキー2systemKey3 1 システムキー3systemKey4 1 システムキー4systemKey5 1 システムキー5

icon 通知メッセージアイコンmessageHeader 通知メッセージヘッダーヘッダーmessageBody 通知メッセージ本文本文imageHeader 通知メッセージ画像ヘッダ画像ヘッダurl 通知メッセージ参照URL 参照URLuseStartDate 通知メッセージ使用開始日使用開始日useEndDate 通知メッセージ使用終了日使用終了日imageFileName

addLabels 1label

iconname

documentName ドキュメントファイル名　または　ＵＲＬ

documentDisplayName ドキュメント名称ドキュメントの表示名称documentIcon ドキュメントアイコンファイル形式に対応したアイコン区分

1 ファイルの場合は同一Zip内に圧縮１帳票内で、重複不可

11 PDF

EXCELPowerPointWordXVLMOVIEPHOTOSOUNDOTHERS

document 1..* シート

repTopName 1

1 アイコンID 0~101 ラベル名称 "/"(スラッシュ)区切りで階層

ラベルリストラベルを付けない場合は省略可1..* ラベル

指定する際は、本XMLとPDFファイルをZIP圧縮の事

ノード関係名称必須説明メモ

remarksValue1 1 備考情報１

defTopId 1 TOP定義ＩＤ ◎ 対象となる定義のＩＤＩＤのみ指定　元ＩＤの最新公開リビジョン　※指定ＩＤが元ＩＤではない場合、　　特定の定義ＩＤＩＤの後ろに":"指定　特定の定義ＩＤ

remarksValue9 1 備考情報９remarksValue8 1 備考情報８

createRoleMode 1

pdfReplacePage 1 PDF差し替えページ指定０：全シート対象又は1～N：ページ指定※カンマ区切りで複数ページ指定可能

createUserId 1 作成ユーザー

remarksValue4 1 備考情報４

1 備考情報７

1 0:情報 1:注意 2:警告11

作成モード 0:すべて１:作成ユーザーが所属するＧのみ、２：作成ユーザーが所属するＧ＋上位のみ

差し替えPDFファイルの名称を入力。PDF自体はCSVと同階層におく。■PDF差し替えページ指定＝０の時は、対象定義のページ数、幅、高さがすべて一致するPDFである事。■PDF差し替えページ指定＝１～Nの時は、対象定義の指定ページと、幅、高さが一致し、指定したページの数とPDFページ数が一致する事。

1

通知メッセージ

作成ユーザーIDを指定

remarksValue3 1 備考情報３

remarksValue6 1 備考情報６1 備考情報５

notice 1

remarksValue5

11 通知メッセージ画像ファイ

ル名称通知メッセージ画像のファイル名※指定する際は、本CSVと画像ファイルを　ZIP圧縮の事

通知メッセージ画像ファイルの名称を入力。画像自体はCSVと同階層におく。

top 1 TOP

TOP帳票名称 △ 帳票名自動生成の場合は不要

remarksValue2 1 備考情報２

1

1

remarksValue10 1 備考情報１０

pdfFileName 1 PDFファイル名

conmas ルート

documents 1 シート帳票リスト

remarksValue7


documentSaveType 保管区分 0:ファイルシステム 1:URLdocumentMobileSave タブレット保存可否 0:可能　1:不可能useEndTime 有効期限 YYYY/MM/DD形式addLabels

labeliconname 記述形式は帳票ラベルと同様

備考情報５未設定は帳票の権限に依存

taskId タスクID タスクIDを指定

user スケジュール登録ユーザースケジュール登録するユーザーを指定

startDate 開始予定日時開始予定日時を指定

endDate 終了予定日時終了予定日時を指定

comment1 コメント１コメント１を指定

comment2 コメント２コメント２を指定

シート帳票リスト

referenceValue4 1 参考資料参照先文字列未入力の場合は、使用しない＜参考資料種別１　が　LIB　or　ADD　の場合＞LIB　＝登録済みのドキュメントIDADD ＝Zipに同封しているファイル名

referenceName4 1 参考資料名称未入力の場合は、使用しない

referenceType4 1 参考資料種別未入力の場合は、使用しない＜図書ライブラリ利用設定の場合以下の区分から選択＞LIB　＝登録済みの共通ライブラリーから指定ADD この帳票と同時に登録する”Ｄ”行の中から指定










remarksValue10 1 備考情報１０remarksValue9 1 備考情報９remarksValue8 1 備考情報８remarksValue7 1 備考情報７remarksValue6 1 備考情報６remarksValue5 1 備考情報５

◎ 帳票内のページ番号

remarksValue4 1 備考情報４remarksValue3 1 備考情報３remarksValue2 1 備考情報２

1..* シート

1 yyyy/MM/dd HH:mm 形式で入力　又はyyyy/MM/dd 形式で入力

1

1

1 必須

1 必須ユーザーIDをセット。複数ユーザー登録する場合は、";"で区切る

1 必須yyyy/MM/dd HH:mm 形式　又はyyyy/MM/dd 形式で入力

remarksValue1 1 備考情報１sheetName 1 帳票名称sheetNo 1 シートＮＯ

schedule 1..* スケジュール

referRole 1 参照可能グループID（複数の場合はセミコロン";"で区切る）

schedules 1 スケジュールリスト

1 アイコンID 0~101 ラベル名称 "/"(スラッシュ)区切りで階層

ラベルを付けない場合は省略可1..* ラベル

11

ラベルリスト

sheets 1sheet


クラスター名称を定義設定から書き変えます指定時はシートコピー不可,帳票コピー不可

mobileListDisplayNo 0..1 iPhoneリスト表示順 iPhoneリスト表示順を指定します指定時はシートコピー不可,帳票コピー不可

remarksValue9 1 備考情報９

remarksValue7 1 備考情報７

remarksValue5 1 備考情報５

備考情報１

clusterId

クラスターリスト

clusterNameChange 0..1 クラスター名称

コメント入力値チェッククラスター、トグル選択クラスターのみ適用

remarksValue10 1 備考情報１０

remarksValue8 1 備考情報８

comment 1 コメント

◎value 1 入力値 △ 入力結果の文字列値

remarksValue6 1 備考情報６

備考情報３remarksValue4 1 備考情報４

cluster 1..* クラスターclusters 1

remarksValue1 1

remarksValue3 1

sheetNo ◎

remarksValue2 1 備考情報２




















　ＣＳＶレイアウト（アップロード用）

■トップデータNO 項目説明必須タイプ備考

◎ 文字列◎ 数値

文字列 CSV手入力作成時の判別用のため、変更しても使用されない△ 文字列帳票名自動生成の場合は不要

文字列文字列文字列文字列文字列文字列文字列文字列文字列文字列文字列

文字列

文字列

文字列

文字列

文字列文字列文字列文字列文字列

■ドキュメントデーター必須タイプ備考

レコード区分 "D"固定 ◎ 文字列ドキュメントファイル名　または　ＵＲＬ文字列ファイルの場合は同一Zip内に圧縮１ＴＯＰないで、重複不可ドキュメント名称ドキュメントの表示名称 ◎ 文字列

指定時はシートコピー、帳票コピー不可inputAnswerback 0..1 アンサーバック入力値読み上 ”0”:しない　"1":する指定時はシートコピー、帳票コピー不可

クラスターID ◎ 指定時はシートコピー、帳票コピー不可words 1 呼び出し名称ひらがな指定時はシートコピー、帳票コピー不可

sheetNo 1 シート番号 ◎ 指定時はシートコピー、帳票コピー不可

iPhoneリスト表示可否 0:表示しない　1:表示する（指定なし時は定義設定に従う）指定時はシートコピー不可,帳票コピー不可

grammars 0..1 クラスターリスト

指定時はシートコピー不可,帳票コピー不可{ignore}指定　または　指定なし時は定義設定に従う




0..1 しきい値最小値・数値、数値選択、時間数、計算式のみ使用可能・定義側でしきい値最大使用が可能それが以外で指定されていた場合はエラー

・数値、数値選択、時間数、計算式のみ使用可能それが以外で指定されていた場合はエラー17004

minimum 0..1 最小値・数値、数値選択、時間数、計算式のみ使用可能それが以外で指定されていた場合はエラー17004

cluster 0..* クラスター

123

１９

差し替えPDFファイル名称 PDFファイル名※指定する際は、本CSVとPDFファイルを　ZIP圧縮の事


（新規）NO 項目説明

２１システムキー2 システムキー2２２システムキー3 システムキー3２３システムキー4 システムキー4２４システムキー5 システムキー5

システムキー1 システムキー1

ユーザーIDを指定する

１８

PDF差し替えページ指定０：全シート対象又は1～N：ページ指定※カンマ区切りで複数ページ指定可能

１５ラベル "[icon=1(~10)]"でアイコン指定（省略

可）"/"区切りでラベル階層

切複数

例）[icon=2]Label1/Label1-1;Label2(アイコンを省略した場合はアイコン１）

１６権限モード 0:すべて

１:作成ユーザーが所属するＧのみ２：作成ユーザーが所属するＧ＋上位のみ

１３ＴＯＰ備考情報９備考情報９１４ＴＯＰ備考情報１０備考情報１０

１２ＴＯＰ備考情報８備考情報８

９ＴＯＰ備考情報５備考情報５１０ＴＯＰ備考情報６備考情報６

７ＴＯＰ備考情報３備考情報３８ＴＯＰ備考情報４備考情報４

１７作成ユーザーID

６ＴＯＰ備考情報２備考情報２

３定義名称定義名称４帳票名称帳票名称

１レコード区分 "T"固定２定義ＩＤ帳票の場合は対象となる定義のＩＤ

１１ＴＯＰ備考情報７備考情報７

５ＴＯＰ備考情報１備考情報１

answerBack 1 アンサーバック

mobileDisplay 0..1 iPhoneリスト表示、非表示

clusterId 1

２０

・数値、数値選択、時間数、計算式のみ使用可能・定義側でしきい値最大使用が可能それが以外で指定されていた場合はエラー17004

allowMinValue

maximum 0..1 最大値

allowMaxValue 0..1 しきい値最大値


ドキュメントアイコンファイル形式に対応したアイコン区分文字列

保管区分 0:ファイルシステム 1:URL 数値タブレット保存可否 0:可能　1:不可能数値有効期限 YYYY/MM/DD形式日付ラベル文字列記述形式は帳票ラベルと同様

参照権限文字列未設定は帳票の権限に依存

■スケジュールデータ必須タイプ備考◎ 文字列◎ 数値◎ 文字列

◎ 文字列

文字列

文字列コメント２コメント２文字列

■シートデータ必須タイプ備考◎ 文字列◎ 数値

文字列 CSV手入力作成時の判別用のため、変更しても使用されない文字列無ければ定義の名称を使用文字列文字列文字列文字列文字列文字列文字列文字列文字列文字列文字列

文字列未入力の場合は、使用しない文字列

文字列


文字列


文字列

文字列未入力の場合は、使用しない

２３

シート参考資料参照先文字列参考資料参照先文字列３

１７

２５シート参考資料名称４参考資料名称４

未入力の場合は、使用しない＜参考資料種別３　が　LIB　or　ADD　の場合＞LIB　＝登録済みのドキュメントIDADD ＝Zipに同封しているファイル名

２４

シート参考資料種別４参考資料種別４未入力の場合は、使用しない＜図書ライブラリ利用設定の場合以下の区分から選択＞LIB　＝登録済みの共通ライブラリーから指定ADD ＝この帳票と同時に登録する”Ｄ”行の中から指定

未入力の場合は、使用しない＜参考資料種別２　が　LIB　or　ADD　の場合＞LIB　＝登録済みのドキュメントIDADD ＝Zipに同封しているファイル名

２１

シート参考資料種別３参考資料種別３未入力の場合は、使用しない＜図書ライブラリ利用設定の場合以下の区分から選択＞LIB　＝登録済みの共通ライブラリーから指定ADD ＝この帳票と同時に登録する”Ｄ”行の中から指定

２２シート参考資料名称３参考資料名称３

１９シート参考資料名称２参考資料名称２

２０

シート参考資料参照先文字列参考資料参照先文字列２

シート参考資料参照先文字列参考資料参照先文字列１未入力の場合は、使用しない＜参考資料種別１　が　LIB　or　ADD　の場合＞LIB　＝登録済みのドキュメントIDADD ＝Zipに同封しているファイル名

１８

シート参考資料種別２参考資料種別２未入力の場合は、使用しない＜図書ライブラリ利用設定の場合以下の区分から選択＞LIB　＝登録済みの共通ライブラリーから指定ADD ＝この帳票と同時に登録する”Ｄ”行の中から指定

１５

シート参考資料種別１参考資料種別１未入力の場合は、使用しない＜図書ライブラリ利用設定の場合以下の区分から選択＞LIB　＝登録済みの共通ライブラリーから指定ADD ＝この帳票と同時に登録する”Ｄ”行の中から指定

１６シート参考資料名称１参考資料名称１

１３シート備考情報９備考情報９１４シート備考情報１０備考情報１０

１１シート備考情報７備考情報７１２シート備考情報８備考情報８

９シート備考情報５備考情報５１０シート備考情報６備考情報６

７シート備考情報３備考情報３８シート備考情報４備考情報４

５シート備考情報１備考情報１６シート備考情報２備考情報２

３シート定義名称定義名称４シート帳票名称帳票名称

１レコード区分 "S"固定２シートＮＯ帳票内のページ番号

６コメント１コメント１７

NO 項目説明

ユーザーIDをセット。複数ユーザー登録する場合は、";"で区切る

４開始予定日時開始予定日時 yyyy/MM/dd HH:mm 形式で入力

　又はyyyy/MM/dd 形式で入力

５終了予定日時終了予定日時 yyyy/MM/dd HH:mm 形式で入力

　又はyyyy/MM/dd 形式で入力

２タスクID タスクID

３スケジュール登録ユーザースケジュール登録ユーザー


１レコード区分 "P"固定

６７

8"[icon=1(~10)]"でアイコン指定（省略可）"/"区切りでラベル階層

9 参照可能グループID（複数の場合はセミコロン";"で区切る）

4

PDFEXCEL</option>PowerPointWordXVLMOVIEPHOTOSOUNDOTHERS

5


文字列

文字列


文字列


文字列


文字列


文字列


文字列


■クラスターデータ必須タイプ備考◎ 文字列◎ 数値

文字列 CSV手入力作成時の判別用のため、変更しても使用されない文字列文字列文字列文字列文字列文字列文字列文字列文字列文字列文字列文字列チェッククラスター、トグル選択のみ適用文字列未指定、空の場合は定義設定指定時はシートコピー、帳票コピー不可数値整数値　未指定、空の場合は定義設定指定時はシートコピー、帳票コピー不可文字列 0:非表示　1:表示　未指定、空の場合は定義設定指定時はシートコピー、帳票コピー不可

１７ iPhoneリスト表示順 iPhoneリスト表示順を設定します１８ iPhoneリスト表示、非表示 iPhoneリスト表示を非表示にします

１６クラスター名称変更クラスター名称を変更します

備考情報４９クラスター備考情報５備考情報５

６クラスター備考情報２備考情報２７クラスター備考情報３備考情報３

１４クラスター備考情報１０備考情報１０１５コメントコメント

１２クラスター備考情報８備考情報８１３クラスター備考情報９備考情報９

１０クラスター備考情報６備考情報６１１クラスター備考情報７備考情報７

８クラスター備考情報４

クラスター備考情報１備考情報１

２クラスターＩＤシート内クラスター番号３クラスター名称クラスター名称

４１

シート参考資料参照先文字列参考資料参照先文字列９

３５

シート参考資料参照先文字列参考資料参照先文字列７

２９

シート参考資料参照先文字列参考資料参照先文字列５

未入力の場合は、使用しない＜参考資料種別１０　が　LIB　or　ADD　の場合＞LIB　＝登録済みのドキュメントIDADD ＝Zipに同封しているファイル名

NO 項目説明１レコード区分 "C"固定

４３シート参考資料名称１０参考資料名称１０

４４

シート参考資料参照先文字列参考資料参照先文字列１０

４クラスター入力値クラスターに入力されたデータ５

未入力の場合は、使用しない＜参考資料種別９　が　LIB　or　ADD　の場合＞LIB　＝登録済みのドキュメントIDADD ＝Zipに同封しているファイル名

４２

シート参考資料種別１０参考資料種別１０未入力の場合は、使用しない＜図書ライブラリ利用設定の場合以下の区分から選択＞LIB　＝登録済みの共通ライブラリーから指定ADD ＝この帳票と同時に登録する”Ｄ”行の中から指定

未入力の場合は、使用しない＜参考資料種別８　が　LIB　or　ADD　の場合＞LIB　＝登録済みのドキュメントIDADD ＝Zipに同封しているファイル名

３９

シート参考資料種別９参考資料種別９未入力の場合は、使用しない＜図書ライブラリ利用設定の場合以下の区分から選択＞LIB　＝登録済みの共通ライブラリーから指定ADD ＝この帳票と同時に登録する”Ｄ”行の中から指定

４０シート参考資料名称９参考資料名称９

３７シート参考資料名称８参考資料名称８

３８

シート参考資料参照先文字列参考資料参照先文字列８

未入力の場合は、使用しない＜参考資料種別７　が　LIB　or　ADD　の場合＞LIB　＝登録済みのドキュメントIDADD ＝Zipに同封しているファイル名

３６

シート参考資料種別８参考資料種別８未入力の場合は、使用しない＜図書ライブラリ利用設定の場合以下の区分から選択＞LIB　＝登録済みの共通ライブラリーから指定ADD ＝この帳票と同時に登録する”Ｄ”行の中から指定

未入力の場合は、使用しない＜参考資料種別６　が　LIB　or　ADD　の場合＞LIB　＝登録済みのドキュメントIDADD ＝Zipに同封しているファイル名

３３

シート参考資料種別７参考資料種別７未入力の場合は、使用しない＜図書ライブラリ利用設定の場合以下の区分から選択＞LIB　＝登録済みの共通ライブラリーから指定ADD ＝この帳票と同時に登録する”Ｄ”行の中から指定

３４シート参考資料名称７参考資料名称７

３１シート参考資料名称６参考資料名称６

３２

シート参考資料参照先文字列参考資料参照先文字列６

未入力の場合は、使用しない＜参考資料種別５　が　LIB　or　ADD　の場合＞LIB　＝登録済みのドキュメントIDADD ＝Zipに同封しているファイル名

３０

シート参考資料種別６参考資料種別６未入力の場合は、使用しない＜図書ライブラリ利用設定の場合以下の区分から選択＞LIB　＝登録済みの共通ライブラリーから指定ADD ＝この帳票と同時に登録する”Ｄ”行の中から指定

未入力の場合は、使用しない＜参考資料種別４　が　LIB　or　ADD　の場合＞LIB　＝登録済みのドキュメントIDADD ＝Zipに同封しているファイル名

２７

シート参考資料種別５参考資料種別５未入力の場合は、使用しない＜図書ライブラリ利用設定の場合以下の区分から選択＞LIB　＝登録済みの共通ライブラリーから指定ADD ＝この帳票と同時に登録する”Ｄ”行の中から指定

２８シート参考資料名称５参考資料名称５

２６

シート参考資料参照先文字列参考資料参照先文字列４


文字列

指定時はシートコピー、帳票コピー不可

文字列


文字列


文字列


■通知メッセージデータ必須タイプ備考◎ 文字列

通知メッセージアイコン通知メッセージアイコン ◎ 数値 0:情報 1:注意 2:警告通知メッセージヘッダー通知メッセージヘッダー ◎ 文字列ヘッダー通知メッセージ本文通知メッセージ本文文字列本文通知メッセージ画像ヘッダ通知メッセージ画像ヘッダ文字列画像ヘッダ通知メッセージ参照URL 通知メッセージ参照URL 文字列参照URL通知メッセージ使用開始日通知メッセージ使用開始日文字列使用開始日通知メッセージ使用終了日通知メッセージ使用終了日文字列使用終了日

文字列

９

通知メッセージ画像ファイル名称

通知メッセージ画像のファイル名※指定する際は、本CSVと画像ファイルを　ZIP圧縮の事

通知メッセージアイコンファイルの名称を入力。画像自体はCSVと同階層におく。


１レコード区分 "M"固定２３４





５６７８

１９

最大値・数値、数値選択、時間数、計算式のみ指定可能。それが以外で指定されていた場合はエラー17004

２０

最小値・数値、数値選択、時間数、計算式のみ指定可能。それが以外で指定されていた場合はエラー17004

２１

閾値最大値・数値、数値選択、時間数、計算式のみ指定可能。・定義側でしきい値最大使用が可能それが以外で指定されていた場合はエラー17004

２２

閾値最小値・数値、数値選択、時間数、計算式のみ指定可能。・定義側でしきい値最大使用が可能それが以外で指定されていた場合はエラー17004


■クラスター呼び出し音声認識辞書　指定は音声対象クラスターのみ必須タイプ備考◎ 文字列指定時はシートコピー、帳票コピー不可◎ 数値指定時はシートコピー、帳票コピー不可

文字列 CSV手入力作成時の判別用のため、変更しても使用されない指定時はシートコピー、帳票コピー不可◎ 文字列ひらがな指定時はシートコピー、帳票コピー不可

文字列指定時はシートコピー、帳票コピー不可文字列デフォルト:0 指定時はシートコピー、帳票コピー不可

帳票別の音声辞書として登録されます指定のないクラスターは定義の辞書が反映されます選択値呼び出しの事象は定義辞書が採用されます

■ＣＳＶレイアウト例"T",1,"定義名称","帳票名称1","備考１","備考２","備考３","","","","","","","""S",1,"シート定義名称１","シート名称１","備考１","","","","","","","","","""C","1""クラスター名１",,"ＡＡＡＡ株式会社","備考１","備考２","","","","","","","","""C","2","クラスター名２","田中太郎","備考１","備考２",","","","","","","","","""C","3","クラスター名３","100","備考１","備考２",","","","","","","","","""S",2,"シート名称２","備考１","備考２","","","","","","","","""C","1","愛知県","備考１","",","","","","","","","","""C","2","25","備考１","",","","","","","","","","""T",1,"帳票名称２","備考１","備考２","備考３","","","","","","","""S",1,"シート名称２","備考１","","","","","","","","","""C","1","BBBB株式会社","備考１","備考２","","","","","","","","""C","2","鈴木花子","備考１","備考２",","","","","","","","","""C","3","200","備考１","備考２",","","","","","","","","""S",2,"シート名称２","備考１","備考２","","","","","","","","""C","1","東京都","備考１","",","","","","","","","","""C","2","30","備考１","",","","","","","","","",""

　パラメータ”userMode”とは

本APIで作成された帳票は、帳票登録者・更新者がAPI実行ユーザーとなります。帳票登録者・更新者に任意のユーザーを割り当てる場合は、リクエストパラメーター"userMode"に"1"をセットする事で、XML,CSV中の"作成ユーザーID"が帳票登録者・更新者となります。※”作成ユーザーID”が未設定であれば、API実行ユーザーが帳票登録者・更新者となります。

　シートコピー

アップロード用CSV　または　XMLのシート階層で同じシート番号を複数記載するとシートコピーと動作となります

例）CSVの場合■CSVレイアウト例"T",1,"定義名称","帳票名称1","備考１","備考２","備考３","","","","","","","""S",1,"シート定義名称１","シート名称１","備考１","","","","","","","","","""C","1""クラスター名１",,"ＡＡＡＡ株式会社","備考１","備考２","","","","","","","","""C","2","クラスター名２","田中太郎","備考１","備考２",","","","","","","","","""C","3","クラスター名３","100","備考１","備考２",","","","","","","","","""S",1,"シート定義名称１","シート名称１","備考１","","","","","","","","","""C","1""クラスター名１",,"ＡＡＡＡ株式会社","備考１","備考２","","","","","","","","""C","2","クラスター名２","田中太郎","備考１","備考２",","","","","","","","","""C","3","クラスター名３","100","備考１","備考２",","","","","","","","","""S",2,"シート名称２","備考１","備考２","","","","","","","","""C","1","愛知県","備考１","",","","","","","","","","""C","2","25","備考１","",","","","","","","","",""

■XMLレイアウト例 <top> <defTopId>10530</defTopId> <repTopName>帳票名称１</repTopName> <sheets> <sheet> <sheetNo>1</sheetNo> <clusters> <cluster> <sheetNo>1</sheetNo> <clusterId>0</clusterId> <clusterName>クラスター名１</clusterName> <value>AAAA株式会社</value> </cluster> <cluster> <sheetNo>1</sheetNo> <clusterId>0</clusterId> <clusterName>クラスター名２</clusterName> <value>〇〇太郎</value> </cluster> </clusters> </sheet> <sheet> <sheetNo>1</sheetNo> <clusters> <cluster>

３呼び出し名称ひらがな４アンサーバック５アンサーバック入力値読み上”0”:しない　"1":する

１レコード区分 "V"固定２クラスターＩＤシート内クラスター番号３クラスター名称クラスター名称

NO 項目説明

帳票名称１

シート名称１シート名称２

帳票名称２


オリジナルシート

追加シート

オリジナルシート

音声入力機能は日本語対応のみです


<sheetNo>1</sheetNo> <clusterId>0</clusterId> <clusterName>クラスター名１</clusterName> <value>AAAA株式会社</value> </cluster> <cluster> <sheetNo>1</sheetNo> <clusterId>0</clusterId> <clusterName>クラスター名２</clusterName> <value>〇〇太郎</value> </cluster> </clusters> </sheet> <sheet> <sheetNo>2</sheetNo> <clusters> ....... </clusters> </sheet>

■追加シートの差し込み先オリジナルシートの真後ろに追加されます

■シートコピー不可に設定されたシートはコピーできません。エラーコード：16000を返し帳票は作成されません

　しきい値設定

数値、数値選択、計算式、時間数クラスターについては、定義設定値から値を変更可能です※XML,CSVレイアウト表参照指定なし、値なしの場合は、定義設定が引き継がれます

指定時は該当シートのシートコピー、帳票コピーができません

追加シート


　自動帳票作成ＡＰＩ仕様（簡易CSV形式）


　機能説明

従来の自動帳票作成よりも、より簡易なCSVで自動帳票作成が実行できます。取り込んだCSVの内容で入力帳票を作成します。本APIで作成された帳票は”入力前”帳票となります。


■自動帳票作成ＩＤ値説明定義command コマンドID RESTコマンド識別文字列 AutoGeneratetype ファイルタイプ "csvSimple" : CSVファイル、"csvZipSimple" : CSVZIPファイル必須dataFile 帳票XML 帳票CSV/XMLをファイルアップロード必須


userMode ユーザーモード


defaultMode


results 1 正常終了した場合のみ処理結果を返す

resulttopId 1 処理入力帳票ID

code 1 結果コード各コマンド共通を参照 ※追加エラーコード参照

デフォルト値が指定できるクラスターの扱い方

0 : 定義のデフォルト値セットしない

1 : 定義のデフォルト値セットする　＜セット対象＞　・作成用データに値指定が存在しないクラスター　　※ ”S*C*” 形式で指定するクラスターの有無

2 : 定義のデフォルト値セットする　＜セット対象＞　・作成用データに値指定が存在しないクラスター　・作成用データに値が存在し、その入力値が"空"で指定されているクラスター

任意指定←左記の動作をさせたい場合のみ、　defaultModeパラメータを　指定してください。

932:S-JIS、65001：UTF8

"1"を指定する事で、アップロードファイル中の"作成ユーザー"のユーザーが帳票登録者として登録される。※"作成ユーザー"がなければ、API実行ユーザーが帳票登録者になる。"1"を指定する事で、アップロードファイル中の"ラベル"が階層設定されていた場合に最下層のラベルのみに紐づけられます。





user= (USER ID)

password


自動帳票作成ＡＰＩ(AutoGenerate)

[送信パラメータ]command= AutoGenerate

type

HTTP Request

HTTP

自動帳票作成用CSV

HTTP Request

HTTP

結果XML




HTTP Request

HTTP


自動帳票作成API呼び出し


remarks 1


error 1

code 1 結果コード各コマンド共通を参照

remarks 1


■エラーコード表 (共通以外）エラーコード説明

取り込みPDFが不正取込CSVファイル解析エラー


■ＣＳＶレイアウト例

▼定義ID”３０１”の帳票定義（シート2枚含む）から、帳票を2つ作成する"H","defTopId","S1C0","S1C1","S1C2","S2C0","S2C1","S2C2""R","301","テストA","100","2016/04/01","テストB","200","2016/12/31""R","301","テストA","100","2016/04/01","テストB","200","2016/12/31"

・レコード区分　必須"H"行　ヘッダー行（指定する項目を定義する）"R"行　"H"行に対応した作成する帳票の各値を指定する

・defTopId　必須帳票定義のIDを指定します。

・クラスターを指定するには、シート番号とクラスターIDをセットで頭文字を使って記述します。　シート1（S1）にあるクラスターID0（C0）を指定するには、「S1C0」を記述します。

<例>

この例の場合のCSVヘッダー列は下記のようになります↓"H","defTopId","S1C0","S1C1","S2C2""R","301","テストA","100","2016/04/01"

▼定義IDのみ指定して帳票を作成する"H","defTopId""R","301""R","301""R","301"

上記CSVで自動帳票作成を実行した場合、入力値の無い帳票が3つ作成されます。

▼クラスターに画像を入力する画像クラスター、手書きフリーメモ、フリードロークラスター　に対応"H","defTopId","S1C0""R","301","image001.JPG"

CSVファイル内の対象クラスターに入力画像のファイル名称を入力します。　※ファイル名称は、拡張子まで入力する。CSVファイルと入力する画像ファイルをZIP圧縮してひとつのZIPファイルにまとめます。リクエストパラメータのファイルタイプで、”csvZipSimple”を選択します。

▼「defTopId」以外の帳票情報を指定する・帳票情報として「repTopName（帳票名称）」を指定する"H","defTopId","repTopName","S1C0""R","301","帳票名称あういうえお","テストABC"

・帳票情報として「repTopName（帳票名称）」を指定し、「addLabels（ラベル）」も指定する"H","defTopId","repTopName","addLabels","S1C0""R","301","帳票名称あういうえお","ラベルA","テストABC"

610050

帳票１

帳票２

帳票３

帳票１

シート番号１シート番号２

クラスターID ： 0


クラスターID ： 2 クラスターID ： 2



ここを指定するには、「S1C1」とする




■CSVレイアウトCSVに指定する識別子項目名説明必須備考

S*C*

systemKey1 システムキー1


クラスター入力値入力値を指定する



pdfReplacePage PDF差し替えページ指定０：全シート対象又は1～N：ページ指定※カンマ区切りで複数ページ指定可能

pdfFileName 差し替えPDFファイル名称 PDFファイル名※指定する際は、本CSVとPDFファイルを　ZIP圧縮する

差し替えPDFファイルの名称を入力。PDF自体はCSVと同階層に配置する。■PDF差し替えページ指定＝０の時は、対象定義のページ数、幅、高さがすべて一致するPDFである事。■PDF差し替えページ指定＝１～Nの時は、対象定義の指定ページと、幅、高さが一致し、指定したページの数とPDFページ数が一致する事。

remarksValue9 ＴＯＰ備考情報９備考情報９

createUserId 作成ユーザーID 作成ユーザーIDを指定する

remarksValue10 ＴＯＰ備考情報１０備考情報１０addLabels ラベル "[icon=1(~10)]"でアイコン指定（省略

可）"/"区切りでラベル階層";"区切りで複数ラベル


createRoleMode 権限モード 0:すべて１:作成ユーザーが所属するＧのみ２：作成ユーザーが所属するＧ＋上位のみ

remarksValue6 ＴＯＰ備考情報６備考情報６remarksValue7 ＴＯＰ備考情報７備考情報７remarksValue8 ＴＯＰ備考情報８備考情報８

remarksValue3 ＴＯＰ備考情報３備考情報３

remarksValue4 ＴＯＰ備考情報４備考情報４remarksValue5 ＴＯＰ備考情報５備考情報５

repTopName 帳票名称帳票名称remarksValue1 ＴＯＰ備考情報１備考情報１remarksValue2 ＴＯＰ備考情報２備考情報２

レコード区分 "H" : ヘッダー行（指定する項目を定義する）"R" : "H"行に対応した作成する帳票の各値を指定する

◎

◎defTopId 定義ＩＤ対象となる定義ＩＤ

"H" or "R"

・ＩＤのみ指定　　元ＩＤの最新公開リビジョン　　※指定ＩＤが元ＩＤではない場合、　　　特定の定義ＩＤ・ＩＤの後ろに":"指定　特定の定義ＩＤ

シート1（S1）にあるクラスターID0（C0）を指定するには、「S1C0」とする


　帳票更新ＡＰＩ仕様



■登録ＩＤ値説明コマンドcommand コマンドID RESTコマンド識別文字列 UpdateReporttype ファイルタイプ xml:XMLファイル、csv:CSVファイル、（画像つき：xmlZip、csvZip）必須dataFile 帳票XML 帳票XMLをファイルアップロード必須encoding コードページ値エンコード用コードページ値mode 0:通常　1:強制 1:強制時は排他強制解除、編集ステータス強制更新（既定値は0:通常）


isCabonCopy カーボンコピーの動作可否

isCompulsive 入力完了帳票への更新可否






remark 1..* 結果メッセージ各コマンド共通を参照※resultsエレメントは正常実行時のみ追加される追加エラーコードコードエラー内容備考1001 更新対象帳票なしエラー更新対象となる入力帳票が存在しない場合に発生。※入力帳票IDが正しい事を確認します。1002 入力完了帳票の更新エラー更新対象となる入力帳票が"入力完了"のため更新出来ず、発生するエラー。編集は不可能。1003 排他エラー他ユーザーがロック中のため、編集不可。※mode=1で実行すると、ロック情報を無視して編集します。

"1"を指定する事で、アップロードファイル中の"ラベル"が階層設定されていた場合に最下層のラベルのみに紐づけられます。

0:カーボンコピーしない（既定）1:カーボンコピーする

1:更新可


帳票更新用ＸＭＬ

or




user= (USER ID)

password


帳票更新ＡＰＩ(UpdateReport)

[送信パラメータ]command= UpdateReport

type

HTTP Request

HTTP

帳票更新用CSV

HTTP Request

HTTP 結果XML




HTTP Request

HTTP


帳票更新API呼び出し



要素（単一）要素（複数）属性部分更新の場合は、項目値に、{ignore}を設定することで、更新対象の項目から除外される。■定義／帳票ノード関係名称必須説明メモconmas ルート

top 1 TOPrepTopId 1 TOP帳票ＩＤ ◎ 対象となる帳票のＩＤ未入力時はエラーeditStatus 1 編集ステータス

repTopName 1 TOP帳票名称未入力は無視＝{ignore}remarksValue1 1 備考情報１remarksValue2 1 備考情報２remarksValue3 1 備考情報３remarksValue4 1 備考情報４remarksValue5 1 備考情報５remarksValue6 1 備考情報６remarksValue7 1 備考情報７remarksValue8 1 備考情報８remarksValue9 1 備考情報９remarksValue10 1 備考情報１０systemKey1 1 システムキー1systemKey2 1 システムキー2systemKey3 1 システムキー3systemKey4 1 システムキー4systemKey5 1 システムキー5

icon 通知メッセージアイコンmessageHeader 通知メッセージヘッダーヘッダーmessageBody 通知メッセージ本文本文imageHeader 通知メッセージ画像ヘッダ画像ヘッダurl 通知メッセージ参照URL 参照URLuseStartDate 通知メッセージ使用開始日使用開始日useEndDate 通知メッセージ使用終了日使用終了日imageFileName

labelMode 1 ラベルモード

addLabels 1 ラベルリストラベルを付けない場合は省略可未入力は無視＝{ignore}label 1..* ラベル

icon 1 アイコンID 0~10name 1 ラベル名称 "/"(スラッシュ)区切りで階層

pdfReplacePage 1

pdfFileName 1 PDFファイル名

sheets 1 シート帳票リストsheet 1..* シート

sheetNo 1 シートＮＯ ◎ 帳票内のページ番号sheetName 1 帳票名称remarksValue1 1 備考情報１remarksValue2 1 備考情報２remarksValue3 1 備考情報３remarksValue4 1 備考情報４remarksValue5 1 備考情報５remarksValue6 1 備考情報６remarksValue7 1 備考情報７remarksValue8 1 備考情報８remarksValue9 1 備考情報９remarksValue10 1 備考情報１０referenceType1 1 参考資料種別

referenceName1 1 参考資料名称

空文字、０～４以外の場合は、無視0:入力前1:編集中2:承認待ち3:差し戻し4:入力完了

1:対象の帳票に付けられているラベルをすべて外す。1:以外は、なにもしない

notice 1 通知メッセージ1 0:情報 1:注意 2:警告1111111 通知メッセージ画像ファイ

ル名称通知メッセージ画像のファイル名※指定する際は、本CSVと画像ファイルを　ZIP圧縮の事



指定する際は、本XMLとPDFファイルをZIP圧縮の事



referenceValue1 1 参考資料参照先文字列

referenceType2 1 参考資料種別




























clusters 1 クラスターリスト表示、検索用に使用する。cluster 1..* クラスター

sheetNo ◎clusterId ◎value 1 入力値不正な値の場合は、無視　※参照applicant 1 申請者ＩＤ

applicationDate 1 申請日

applicantComment 1 申請者コメントapprover 1 承認者ＩＤ

approvalDate 1 承認日

approverComment 1 承認者コメントapprovalSignImage 1 印影イメージ

remarksValue1 1 備考情報１remarksValue2 1 備考情報２remarksValue3 1 備考情報３remarksValue4 1 備考情報４remarksValue5 1 備考情報５remarksValue6 1 備考情報６remarksValue7 1 備考情報７remarksValue8 1 備考情報８remarksValue9 1 備考情報９remarksValue10 1 備考情報１０comment 1 コメントコメント入力値

クラスター入力値と不一致の場合は、無視、クラスター入力値と不一致の場合は、無視、クラスター入力値と不一致の場合は、無視クラスター入力値と不一致の場合は、無視、クラスター入力値と不一致の場合は、無視、クラスター入力値と不一致の場合は、無視ファイル名（サインの場合のみ指定）クラスター入力値と不一致の場合は、無視

チェッククラスター、トグル選択クラスターのみ適用


　ＣＳＶレイアウト（アップロード用）部分更新の場合は、項目値に、{ignore}を設定することで、更新対象の項目から除外される。■トップデータNO 項目説明必須タイプ備考

レコード区分 "T"固定 ◎ 文字列帳票ＩＤ対象となる帳票ＩＤ ◎ 数値未入力時はエラー定義名称定義名称文字列 CSV手入力作成時の判別用のため、変更しても使用されない帳票名称帳票名称文字列未入力は無視＝{ignore}ＴＯＰ備考情報１備考情報１文字列ＴＯＰ備考情報２備考情報２文字列ＴＯＰ備考情報３備考情報３文字列ＴＯＰ備考情報４備考情報４文字列ＴＯＰ備考情報５備考情報５文字列ＴＯＰ備考情報６備考情報６文字列ＴＯＰ備考情報７備考情報７文字列ＴＯＰ備考情報８備考情報８文字列ＴＯＰ備考情報９備考情報９文字列ＴＯＰ備考情報１０備考情報１０文字列編集ステータス編集ステータス文字列

文字列

文字列

文字列

文字列

文字列文字列文字列文字列文字列

１２１３１４

１５

１６

２０

２４

１7ラベルモードラベルモード 1:対象の帳票に付けられているラベルをすべて外す。

1:以外は、なにもしない

６７８９

１０１１

空文字、０～４以外の場合は、無視０：入力前１：編集中２：承認待ち３：差し戻し４：入力完了

ラベル "[icon=1(~10)]"でアイコン指定（省略可）"/"区切りでラベル階層

切り複数


１２３４５

１８


１９

差し替えPDFファイル名称 PDFファイル名※指定する際は、本CSVとPDFファイルを　ZIP圧縮の事


システムキー5 システムキー5

システムキー1 システムキー1２１システムキー2 システムキー2２２システムキー3 システムキー3２３システムキー4 システムキー4


■シートデータNO 項目説明必須タイプ備考

レコード区分 "S"固定 ◎ 文字列シートＮＯ帳票内のページ番号 ◎ 数値シート定義名称定義名称文字列 CSV手入力作成時の判別用のため、変更しても使用されないシート帳票名称帳票名称文字列無ければ定義の名称を使用シート備考情報１備考情報１文字列シート備考情報２備考情報２文字列シート備考情報３備考情報３文字列シート備考情報４備考情報４文字列シート備考情報５備考情報５文字列シート備考情報６備考情報６文字列シート備考情報７備考情報７文字列シート備考情報８備考情報８文字列シート備考情報９備考情報９文字列シート備考情報１０備考情報１０文字列シート参考資料種別１参考資料種別１文字列シート参考資料名称１参考資料名称１文字列シート参考資料参照先文字列参考資料参照先文字列１文字列シート参考資料種別２参考資料種別２文字列シート参考資料名称２参考資料名称２文字列シート参考資料参照先文字列参考資料参照先文字列２文字列シート参考資料種別３参考資料種別３文字列シート参考資料名称３参考資料名称３文字列シート参考資料参照先文字列参考資料参照先文字列３文字列シート参考資料種別４参考資料種別４文字列シート参考資料名称４参考資料名称４文字列シート参考資料参照先文字列参考資料参照先文字列４文字列シート参考資料種別５参考資料種別５文字列シート参考資料名称５参考資料名称５文字列シート参考資料参照先文字列参考資料参照先文字列５文字列シート参考資料種別６参考資料種別６文字列シート参考資料名称６参考資料名称６文字列シート参考資料参照先文字列参考資料参照先文字列６文字列シート参考資料種別７参考資料種別７文字列シート参考資料名称７参考資料名称７文字列シート参考資料参照先文字列参考資料参照先文字列７文字列シート参考資料種別８参考資料種別８文字列シート参考資料名称８参考資料名称８文字列シート参考資料参照先文字列参考資料参照先文字列８文字列シート参考資料種別９参考資料種別９文字列シート参考資料名称９参考資料名称９文字列シート参考資料参照先文字列参考資料参照先文字列９文字列シート参考資料種別１０参考資料種別１０文字列シート参考資料名称１０参考資料名称１０文字列シート参考資料参照先文字列参考資料参照先文字列１０文字列

３４５６７８

１２

１５１６１７１９２０２１

９１０１１１２１３１４

３１３２３３３５３６３７

２３２４２５２７２８２９

４７４８４９５１５２５３

３９４０４１４３４４４５


■クラスターデータNO 項目説明必須タイプ備考

レコード区分 "C"固定 ◎ 文字列クラスターＩＤシート内クラスター番号 ◎ 数値クラスター名称クラスター名称文字列 CSV手入力作成時の判別用のため、変更しても使用されないクラスター入力値クラスターに入力されたデータ文字列不正な値の場合は、無視　※参照クラスター備考情報１備考情報１文字列クラスター備考情報２備考情報２文字列クラスター備考情報３備考情報３文字列クラスター備考情報４備考情報４文字列クラスター備考情報５備考情報５文字列クラスター備考情報６備考情報６文字列クラスター備考情報７備考情報７文字列クラスター備考情報８備考情報８文字列クラスター備考情報９備考情報９文字列クラスター備考情報１０備考情報１０文字列申請者ＩＤ申請者ＩＤ文字列

申請日申請日文字列

申請者コメント申請者コメント文字列

承認者ＩＤ承認者ＩＤ文字列

承認日承認日文字列

承認者コメント承認者コメント文字列印影イメージ印影イメージ文字列

コメントコメント文字列チェッククラスター、トグル選択のみ適用

■通知メッセージデータ必須タイプ備考◎ 文字列

通知メッセージアイコン通知メッセージアイコン ◎ 数値 0:情報 1:注意 2:警告通知メッセージヘッダー通知メッセージヘッダー ◎ 文字列ヘッダー通知メッセージ本文通知メッセージ本文文字列本文通知メッセージ画像ヘッダ通知メッセージ画像ヘッダ文字列画像ヘッダ通知メッセージ参照URL 通知メッセージ参照URL 文字列参照URL通知メッセージ使用開始日通知メッセージ使用開始日文字列使用開始日通知メッセージ使用終了日通知メッセージ使用終了日文字列使用終了日

文字列

※参照以下のクラスター種別については、正しい値以外の値が入力値に設定した場合、無視されます。

　値のクリア

数値、数値選択、時間数、年月日、カレンダー年月日、時刻　クラスターに対し帳票更新APIで値のクリアするための設定※上記クラスター以外は、空文字指定でクリア動作

ConMasManager→システム管理→共通マスター管理で以下設定を行います

共通キー： API_MODE

共通項目名称： UPDATE_REPORT_CLEAR_MODE共通項目値： 0　クリアできない（既定）

1　空指定でクリアする

７８９

１０１１１２

１２３４５６

通知メッセージ画像ファイル名称

通知メッセージ画像のファイル名※指定する際は、本CSVと画像ファイルを　ZIP圧縮の事


１３１４

１５クラスター入力値と不一致の場合は、無視、ユーザーマスタに存在しない場合は、無視

１６クラスター入力値と不一致の場合は、無視、日付でない場合は無視

２２

２３４５６７８

９

トグル選択選択値に含まれる値単一選択

複数選択

年月日 yyyy/MM/dd 形式で日付として正しい値カレンダー年月日時刻 HH:mm:ss形式で時刻として正しい値チェック true, falseのみ

２０クラスター入力値と不一致の場合は、無視

２１ファイル名（サインの場合のみ指定）クラスター入力値と不一致の場合は、無視

クラスター種別正しい値

１７クラスター入力値と不一致の場合は、無視

１８クラスター入力値と不一致の場合は、無視、ユーザーマスタに存在しない場合は、無視

１９クラスター入力値と不一致の場合は、無視、日付でない場合は無視

NO 項目説明１レコード区分 "M"固定

（新規）


　帳票ダウンロードＡＰＩ仕様


　　


■帳票データ出力ＩＤ値説明コマンドcommand コマンドID RESTコマンド識別文字列 DownloadReportdefinition 定義ID 出力帳票の元となる定義IDを指定必須

※CSV列数が一致する定義単位でCSVファイルを生成するためreport 帳票ID 出力帳票の元となる帳票IDを指定

labelId ラベルＩＤ帳票に付いているラベルを指定して検索※条件無しは全て※"nolabel"でラベル無し（トップ階層）帳票を検索

publicStatus 1:テスト、2:公開公開ステータス※条件無しは全て

editStatus 0:入力前編集ステータス1:編集中 ※条件無しは全て2:承認待ち3:差し戻し4:入力完了

reportName 部分一致検索帳票名称remarks 部分一致検索帳票備考value 部分一致検索クラスター入力値registUser 帳票作成したユーザーのID 登録ユーザーIDregistTimeFrom yyyy/MM/dd HH:mm:ss 登録日時(from)registTimeTo yyyy/MM/dd HH:mm:ss 登録日時(to)updateUser 最後に帳票を更新したユーザーのID 更新ユーザーIDupdateTimeFrom yyyy/MM/dd HH:mm:ss 更新日時(from)updateTimeTo yyyy/MM/dd HH:mm:ss 更新日時(to)deleted 0:未削除帳票　1:削除済み帳票削除済みwithImage true/false クラスター画像を含むwithPDF true/false ＰＤＦファイルを含む

withExcel true/false Excelから作成した定義のみ

withPDFLayer true/false レイヤー画像付きＰＤＦファイルを含む

withClusterDetails true/false


isCopySheetOutput

layoutType

isAllRevision

エラー共通レスポンスWebサーバ(IIS)レベルのエラー(接続できない、接続できても404/500など)についての処理はクライアント側で考慮するものとします。

Ｅｘｃｅｌファイル含む※フリードローレイヤー画像は含まれません。

クラスター詳細情報含む

コピーシート出力する、しない

指定定義の全リビジョン定義を含める含めると指定された定義の全リビジョンから作成された帳票が対象となります。

0:標準フォーマット固定(既定）1:ConMasManagerデーター出力のCSVレイアウト設定を適用2:自動出力CSVレイアウトを適用

false:しない（既定）true:する

false:含めない(既定）true:含める

CSV出力レイアウトタイプ



帳票データ出力ＡＰＩ(GetReportReference)


= DownloadReport

帳票CSV

HTTP Request

HTTP


帳票データ出力API呼び出

帳票PDF

画像

画像帳票PDF


実行時エラーについては、各コマンドのレスポンスではなく、以下の共通のエラーデータをレスポンスとして返します。







　標準データ出力フォーマット

■複数帳票出力形式Manager、及び、WebAPIにて複数帳票を一括出力する場合の形式

ファイル単位：１定義行単位：１帳票

NO 項目説明必須タイプ備考帳票ID 文字列帳票名称文字列定義ID 文字列定義名称文字列元帳票ＩＤ文字列元帳票名称文字列リビジョンNO 文字列帳票種別 1:シート、2:セット文字列帳票種別名称文字列シート数文字列自動帳票作成対象区分 0:対象外、1:対象文字列自動帳票作成対象区分名称文字列公開ステータス 0:非公開、1:テスト、2:公開文字列公開ステータス名称文字列選択値自動取得対象対象外:0、対象:1 文字列選択値自動取得対象名称文字列モバイル保存有無帳票定義残さない＝0、帳票定義残す＝1 文字列モバイル保存有無名称文字列備考情報モバイル編集可否 0:編集不可、1:編集可文字列備考情報モバイル編集可否名称文字列備考情報1 文字列備考情報2 文字列備考情報3 文字列備考情報4 文字列備考情報5 文字列備考情報6 文字列備考情報7 文字列備考情報8 文字列備考情報9 文字列備考情報10 文字列削除フラグ文字列登録端末文字列登録者文字列登録者名称文字列登録日時文字列更新端末文字列更新者文字列更新者名称文字列更新日時文字列シート帳票名称シート１の名称文字列帳票内シート番号シート１～ｎ（１番目シートなのでこの場合は１）文字列シート備考情報1 文字列シート備考情報2 文字列シート備考情報3 文字列シート備考情報4 文字列シート備考情報5 文字列シート備考情報6 文字列シート備考情報7 文字列シート備考情報8 文字列シート備考情報9 文字列シート備考情報10 文字列クラスター1入力値入力値、または、画像ファイル名文字列画像データはPNGファイルとして別途保存される。

　表示値 iPad、PDFでの表示値

　クラスター種別

　申請者ID

　申請者名称

　申請日

　申請コメント

　承認者ID

　承認者名称

　承認日

　承認コメント

　クラスター備考１

　クラスター備考２

　クラスター備考３

３９

１２３４５６７８９

１０１１１２１３１４１５１６１７１８

４１４２

４０

１９２０３１３２３３３４３５３６３７３８

４３４４４５４６４７４８４９５０５１６２６３６４６５６６６７６８６９７０７１７２

リクエストパラメーター"withClusterDetails"を"true"に指定していると出力される。リクエストパラメーター"withClusterDetails"を"true"に指定していると出力される。リクエストパラメーター"withClusterDetails"を"true"に指定していると出力される。リクエストパラメーター"withClusterDetails"を"true"に指定していると出力される。

リクエストパラメーター"withClusterDetails"を"true"に指定していると出力される。リクエストパラメーター"withClusterDetails"を"true"に指定していると出力される。リクエストパラメーター"withClusterDetails"を"true"に指定していると出力される。

作成、査閲、承認クラスターの場合、出力される。他のクラスターは空作成、査閲、承認クラスターの場合、出力される。他のクラスターは空作成、査閲、承認クラスターの場合、出力される。他のクラスターは空

承認クラスターの場合、出力される。他のクラスターは空承認クラスターの場合、出力される。他のクラスターは空承認クラスターの場合、出力される。他のクラスターは空承認クラスターの場合、出力される。他のクラスターは空作成、査閲、承認クラスターの場合、出力される。他のクラスターは空

リクエストパラメーター"withClusterDetails"を"true"に指定していると出力される。リクエストパラメーター"withClusterDetails"を"true"に指定していると出力される。リクエストパラメーター"withClusterDetails"を"true"に指定していると出力される。リクエストパラメーター"withClusterDetails"を"true"に指定していると出力される。リクエストパラメーター"withClusterDetails"を"true"に指定していると出力される。

リクエストパラメーター"withClusterDetails"を"true"に指定していると出力される。


　クラスター備考４

　クラスター備考５

　クラスター備考６

　クラスター備考７

　クラスター備考８

　クラスター備考９

　クラスター備考１０

クラスターｎ入力値シート１の最後のクラスター文字列画像データはPNGファイルとして別途保存される。

シート帳票名称シート２の名称文字列帳票内シート番号シート１～ｎ（２番目シートなのでこの場合は２）文字列

　コピーシートの出力

■リクエストパラメーター"isCopySheet"をtrue指定することでコピーされたシート内情報の出力が可能です。

リクエストパラメーター"withClusterDetails"を"true"に指定していると出力される。リクエストパラメーター"withClusterDetails"を"true"に指定していると出力される。リクエストパラメーター"withClusterDetails"を"true"に指定していると出力される。リクエストパラメーター"withClusterDetails"を"true"に指定していると出力される。リクエストパラメーター"withClusterDetails"を"true"に指定していると出力される。リクエストパラメーター"withClusterDetails"を"true"に指定していると出力される。リクエストパラメーター"withClusterDetails"を"true"に指定していると出力される。

※シート内のクラスター値を列として出力

※帳票内のシート数分繰り返し出力

シートコピーを行うと帳票によってシートの数が普遍となります。CSVはシートコピーされたの最大分のシートに拡張して出力します。その際、シートコピーしていない帳票はコピーシート列が未入力となります。コピーシートは、CSV上コピーされたシートのすぐ後ろに追加されます。

入力帳票

シート１シート２シート３

シートコピーした帳票

シートコピーされていない帳票

シート４

シート１をコピーしてシート４を作成

シート１シート４シート２シート３

シート１をコピーして

作成されたシート４が

シート１の後ろに追加

シートコピーされていない場合は

未入力として出力


　CSVレイアウトの変更

■リクエストパラメーター"layoutType"に１，２を指定することで出力フィールドを任意に設定できます。・layoutType=1

Managerデーター出力機能の”Managerデーター出力設定”で設定したCSVレイアウトで出力します。・layoutType=2

Managerデーター出力機能の”自動出力レイアウト設定”で設定したCSVレイアウトで出力します。

適用される

CSVレイアウト


　ファイル形式

レスポンスファイル形式

■ZIP圧縮形式API結果レスポンスはzip圧縮形式で出力されます。ファイル名：”CSV_” + 出力日時(yyyyMMddHHmmss) + “.zip”

■解凍後帳票定義帳票単位にＣＳＶファイルが出力されています。ファイル名：”report” + 帳票定義ＩＤ + 帳票定義名称+ “.csv”

■画像ファイルwithImageパラメーター指定すると、画像ファイルも出力されます。ファイル名： ” picture” + ” _” + 帳票定義ＩＤ + 帳票定義名称+ “_” + 帳票ＩＤ + “_” + ページ番号+ “_” + クラスターＩＤ+"_" + クラスター名称+ “.png”CSVファイル内の対象フィールドに上記画像ファイル名が入力されます。

■PDFファイルwithPDFパラメーター指定すると、ＰＤＦファイルも出力されます。ファイル名： ” pdf” + ” _” + 帳票ＩＤ + “_” + 帳票名称+ “.pdf”

出力ファイル解凍

ＣＳＶファイル

画像ファイル

EXCELで表示したイメージ

１行に１帳票のデー

タが出力されます


　帳票CSVダウンロードＡＰＩ仕様


　　


■帳票データ出力ＩＤ値説明コマンドcommand コマンドID RESTコマンド識別文字列 DownloadCsvreport 帳票ID 出力帳票の元となる帳票IDを指定必須withImage true/false クラスター画像を含むwithPDF true/false ＰＤＦファイルを含むwithExcel true/false Ｅｘｃｅｌファイル含む Excelから作成した定義のみwithPDFLayer true/false レイヤー画像付きＰＤＦファイルを含むencoding コードページ値エンコード用コードページ値

エラー共通レスポンスWebサーバ(IIS)レベルのエラー(接続できない、接続できても404/500など)についての処理はクライアント側で考慮するものとします。実行時エラーについては、各コマンドのレスポンスではなく、以下の共通のエラーデータをレスポンスとして返します。






　レスポンスファイル形式

レスポンスファイル形式

■ZIP圧縮形式API結果レスポンスはzip圧縮形式で出力されます。ファイル名：”CSV_” + 出力日時(yyyyMMddHHmmss) + “.zip”

■解凍後対象帳票のＣＳＶファイルファイル名：”report.csv”

■画像ファイルwithImageパラメーター指定すると、画像ファイルも出力されます。ファイル名： ” report” + ” _” + 入力帳票ＩＤ + “_” + シート番号+ “_cluster_” + クラスターＩＤ + “.png”CSVファイル内の対象フィールドに上記画像ファイル名が入力されます。

■PDFファイルwithPDFパラメーター指定すると、ＰＤＦファイルも出力されます。ファイル名： ” pdf” + ” _” + 帳票ＩＤ + “_” + 帳票名称+ “.pdf”



帳票データ出力ＡＰＩ(DownloadCsv)


= DownloadCsv

帳票CSV

HTTP Request

HTTP


帳票CSVダウンロードAPI呼び出し

帳票PDF

画像

画像帳票PDF


　CSVレイアウト

1ファイル中に、入力帳票情報を"T","S","C"のレコード区分によって階層化してCSV出力を行います。T:入力帳票の基本情報S:入力帳票のシート情報。１～Nページ分のレコードを出力します。C:入力帳票のクラスター情報。シート内の各入力値を１レコード単位で出力します。

尚、ヘッダ行は存在しません。

例） CSVレイアウト例

"T","帳票ID","帳票名称",………………………"S",1,"シート帳票名称１",………………………"C","1""クラスター名１","入力値１"………………………"C","2""クラスター名２","入力値２"………………………"C","３""クラスター名３","入力値３"………………………"S",2,"シート帳票名称２",………………………"C","1""クラスター名１","入力値１"………………………"C","2""クラスター名２","入力値２"………………………

　レイヤー、FreeDrawクラスターの入力画像について

レイヤー、FreeDrawクラスターの入力画像情報も、画像クラスター同様に入力値に画像ファイル名をセットします。但し、レイヤー、FreeDrawは内部画像もそれぞれ個別出力を行うため複数画像が存在する事があります。このため画像が複数ある場合、入力値にカンマ区切りでファイル名が入ります。

　クラスター入力値フォーマットクラスター種別毎の文字形式

複数選択値（複数選択時は、カンマ区切り）チェックチェック時：true　未チェック時：ブランク又は false 作成

クラスタ種別形式年月日、カレンダー年月日 yyyy/MM/dd時刻 HH:mm:ssトグル数値単一選択値

手書きノート形式画像ファイル名※同階層に対象の画像ファイルが存在

手書きフリーメモ画像FreeDraw

作成：４、　未入力：ブランク又は 0査閲査閲：４、　未入力：ブランク又は 0

承認承認待ち：２承認：４未入力：ブランク又は 0

帳票名称１



　レコード区分＝T　レイアウト

　レコード区分＝S　レイアウト

2 帳票ID3 帳票名称

No 項目名備考1 レコード区分 "T"固定

6 元帳票ＩＤ7 元帳票名称

4 定義ID5 定義名称

10 帳票種別名称11 シート数

8 リビジョンNO9 帳票種別

14 公開ステータス15 公開ステータス名称

12 自動帳票作成対象区分13 自動帳票作成対象区分名称

18 選択値自動取得対象19 選択値自動取得対象名称

16 編集ステータス17 編集ステータス名称

22 備考情報モバイル編集可否23 備考情報モバイル編集可否名称

20 モバイル保存有無21 モバイル保存有無名称

26 備考情報327 備考情報4




34 削除フラグ35 登録端末


38 登録日時 yyyy/MM/dd HH:mm:ss 形式39 更新端末

36 登録者37 登録者名称

42 更新日時 yyyy/MM/dd HH:mm:ss 形式

43 ラベル "/"区切りでラベル階層";"区切りで複数ラベル

40 更新者41 更新者名称

2 シート番号１～N3 シート帳票名称

No 項目名備考1 レコード区分 "S"固定

6 シート備考情報37 シート備考情報4




14 レイヤー画像ファイル名※複数ある場合はカンマ区切り


15 レイヤー入力テキストレイヤーに設定したテキストデーター16 ページ番号シートの並び順


　レコード区分＝C　レイアウト

No 項目名備考

3 クラスターID4 クラスター名称

1 レコード区分 "C"固定2 シート番号１～N

7 クラスター表示値帳票上で表示されている値※FreeDrawクラスターの場合はコメント値

8 申請者ID 承認クラスターのみ出力される

5 クラスター種別6 クラスター入力値 ※クラスター入力値参照

11 申請日承認クラスターのみ出力されるyyyy/MM/dd形式

12 承認者ID 作成、査閲、承認クラスターのみ出力される

9 申請者名承認クラスターのみ出力される10 申請者コメント承認クラスターのみ出力される

15 承認者コメント作成、査閲、承認クラスターのみ出力される16 クラスター備考１

13 承認者名作成、査閲、承認クラスターのみ出力される

14 承認日作成、査閲、承認クラスターのみ出力されるyyyy/MM/dd形式

19 クラスター備考４20 クラスター備考５

17 クラスター備考２18 クラスター備考３

23 クラスター備考８24 クラスター備考９

21 クラスター備考６22 クラスター備考７

27 編集ユーザー名28 編集日時 yyyy/MM/dd HH:mm:ss形式

25 クラスター備考１０26 編集ユーザーID

31 高度32 コメント

29 緯度30 経度


　帳票削除ＡＰＩ仕様


　　


■帳票データ出力ＩＤ値説明コマンドcommand コマンドID RESTコマンド識別文字列 DeleteReportdefinition 定義ID 出力帳票の元となる定義IDを指定

report 帳票ID 出力帳票の元となる定義IDを指定



editStatus 0:入力前編集ステータス1:編集中 ※条件無しは全て2:承認待ち3:差し戻し4:入力完了

reportName 部分一致検索帳票名称remarks 部分一致検索備考value 部分一致検索クラスター入力値registUser 帳票作成したユーザーのID 登録ユーザーIDregistTimeFrom yyyy/MM/dd HH:mm:ss 登録日時(from)registTimeTo yyyy/MM/dd HH:mm:ss 登録日時(to)updateUser 最後に帳票を更新したユーザーのID 更新ユーザーIDupdateTimeFrom yyyy/MM/dd HH:mm:ss 更新日時(from)updateTimeTo yyyy/MM/dd HH:mm:ss 更新日時(to)deleted 0:未削除帳票　1:削除済み帳票 ※削除済みの帳票を物理削除mode 0:論理削除　1:物理削除既定値は0:論理削除isDeleteLabel 自動ラベル削除の可否ラベルの自動設定を有効にする場合は"true"

transactionMode

executeCount 処理件数指定


処理を行う帳票件数を指定します。指定しない場合は制限なし。transactionMode : 1 の時のみ有効

0 : 1トランザクションですべての削除処理を行います（既定）1 : 1帳票を1トランザクションで削除処理を行います

トランザクションモード指定



帳票削除ＡＰＩ(DeleteReport)


= DeleteReport&（各種抽出条件）

HTTP Request

HTTP


帳票削除API呼び出し

結果XML





■共通エラーコード表エラーコード説明


下記はリクエストパラメータにて、transactionMode を "1"（1帳票削除を1トランザクション）で実行する場合です。

■概要膨大な量の削除を行う場合、1トランザクションではサーバー負荷が増大し処理しきれずレスポンスが返ってこないため、1帳票の削除処理を1トランザクションで行い、さらに処理件数を指定することで負荷を減らすことが目的。

■リクエストパラメータ　executeCount（処理件数）について削除対象として検索された帳票IDの、”若い順から指定した処理件数分”だけ削除処理を行います。膨大な量の削除対象があったとしても、処理件数を指定した削除APIを連続してコールすることで確実にレスポンスが返ってきます。

■レスポンス ※transactionMode を "0"（削除するすべての帳票を1トランザクションで処理）とはレスポンス形式が異なりますのでご注意ください。ノード関係名称説明メモconmas ルート

result 1 処理結果情報code 1 共通エラーコード

targetCount 1 処理件数successCount 1 削除成功件数

errors 1 エラー情報error 0..* 削除できないものがあった場合

topId 1 帳票IDcode 1 エラーコード ※エラーコード表参照remarks 1 任意の数の付帯情報（エラーコードごとに定義）



-1 原因不明なエラー (Unknown Error)1001 定義削除の場合、その定義から作成した編集中帳票が存在した場合に表示

■処理サンプル処理件数（executeCount）を指定し、レスポンスの ”successCount” が ”０” になるまで処理を継続することで削除可能な帳票が全て削除できます。

※共通エラーコード表参照通常の削除モードと同じ共通エラーコードが入ります

[送信パラメータ]executeCount を指定して

結果XML

帳票削除API呼び出し

[レスポンス]successCount = 0 か？

開始

終了

Yes

No


定義一括操作API


　選択値情報更新ＡＰＩ仕様


　　


■登録ＩＤ値説明コマンドcommand コマンドID RESTコマンド識別文字列 UpdateSelectItemtype ファイルタイプ xml:XMLファイル、csv:CSVファイル必須dataFile データファイル登録用のXMLまたはCSVファイル必須

＜レスポンス＞ ※共通のレスポンスを使用ノード関係名称必須説明メモconmas ルート

results 1result

code 1 結果コード各コマンド共通を参照remark 1 結果内容

■エラーコード表エラーコードメッセージ説明

00000 Success 正常終了10000 Record Error その他行エラー10010 Format Error １件分のデータ形式が不正10020 Databse Error データーベース登録に失敗10030 File Open Error アップロードファイルのオープンに失敗10040 File Read Error ファイルの読み込みに失敗10050 CSV Error CSVファイルのデータ形式が不正10060 Data Not Found 更新先のデータが存在しない10070 Exclusive Error 排他エラー11000 Field Error (columnName) その他項目エラー11010 No Value Error (columnName) 必須項目無し11020 Input Error (columnName) 入力値不正11030 Numeric Error (columnName) 数値エラー11040 DateTime Error (columnName) 日付書式エラー

選択値情報更新用ＸＭ

or



選択値情報更新ＡＰＩ(UpdateSelectItem)


= UpdateSelectItem

選択値情報更新用CSV

HTTP Request

HTTP

結果XML


選択値情報更新API呼び出




ノード関係名称必須説明メモconmas ルート ◎

top 1..* TOPdefTopId 1 TOP定義ＩＤ ◎ 対象となる定義のＩＤsheets 1 シート帳票リスト

sheet 1..* シートsheetNo 1 シートＮＯ ◎ 帳票内のページ番号clusters 1 クラスターリスト ◎ 表示、検索用に使用する。

cluster 1..* クラスター ◎clusterId ◎labels 1 入力値 ◎ 入力結果の文字列値items ◎selected △

networks １network 1..* 選択項目

prevSheetNo 1 定義ＩＤ ◎ 対象となる定義のＩＤprevClusterId 1 シートＮＯ ◎ 定義内のページ番号nextSheetNo 1 クラスターＩＤ ◎ シート内クラスター番号nextClusterId 1 ラベル要素 ◎ 選択項目のラベル要素カンマ区切りvalueLinks 1 選択値要素 △ 選択項目のラベル要素カンマ区切り

valueLink 1..* ValueLink

parentValue 1 先行クラスターの選択値 ◎ 先行クラスターの選択値単一指定selectValues 1 後続クラスタの選択要素 △ 後続クラスタの選択要素複数カンマ区切り


■選択項目NO 項目説明必須タイプ備考

定義ＩＤ対象となる定義のＩＤ ◎ 数値レコード区分 "S"固定 ◎ 文字列シートＮＯ定義内のページ番号 ◎ 数値クラスターＩＤシート内クラスター番号 ◎ 数値ラベル要素選択項目のラベル要素 ◎ 文字列カンマ区切り選択値要素選択項目のラベル要素 ◎ 文字列カンマ区切りデフォルト選択値初期選択対象の選択値要素 △ 文字列カンマ区切り

■ValueLink　※バリューリンク設定はネットワーク設定がされているクラスター間のみで可能NO 項目説明必須タイプ備考

定義ＩＤ対象となる定義のＩＤ ◎ 数値レコード区分 "L"固定 ◎ 文字列先行シートＮＯ先行クラスターのシートＮＯ ◎ 数値先行クラスターＩＤ先行クラスターのＩＤ ◎ 数値後続シートＮＯ後続クラスターのシートＮＯ ◎ 数値後続クラスターＩＤ後続クラスターのＩＤ ◎ 数値先行クラスターの選択値先行クラスターの選択値 ◎ 文字列単一指定後続クラスタの選択要素後続クラスタの選択要素 △ 文字列複数カンマ区切り

処理フロー

　　（※該当する選択項目設定、ValueLink設定は上書き。）◆ValueLinkの反映

"ValueLink"は、TOPのXMLデータ内にのみに保持しているため、更新内容を反映したXMLをＴＯＰのレコードに更新すれば良い。

◆拡張パラメータ（InputParameter）の反映

";"(セミコロン)区切りのパラメーター文字列の該当部分を編集する。

選択値要素 Items=xxx,xxx,xxx,;ラベル要素 Labels=xxx,xxx,xxx;デフォルト選択値 Selected=xxx,xxx;

１

３４５６

２

５６７８

７

２１

３４

登録済みの定義XMLにアップロードファイルを反映

ＴＯＰ定義

定義XML選択値情報更新用ＸＭ

or

選択値情報更新用CSV

定義XML

登録済みの定義XMLにアップロードファイルを反映

ＴＯＰ定義

クラスター定義

定義XML

XMLデータ更新

拡張パラメーター更新

更新前の定義XMLデータを取得

更新内容を受信

Required=1;Default=1;Display=Labels;Items=新規開

拓営業,打ち合わせ,技術仕様確認,納品,インストール,不具

合対応,その他;Labels=新規開拓営業,打ち合わせ,技術仕

様確認,納品,インストール,不具合対応,その他;Selected=

インストール;


　定義削除ＡＰＩ仕様


　　


■帳票データ出力ＩＤ値説明コマンドcommand コマンドID RESTコマンド識別文字列 DeleteDefinitiondefinition 定義ID 出力帳票の元となる定義IDを指定必須



definitionName 部分一致検索定義名称remarks 部分一致検索備考registUser 帳票作成したユーザーのID 登録ユーザーIDregistTimeFrom yyyy/MM/dd HH:mm:ss 登録日時(from)registTimeTo yyyy/MM/dd HH:mm:ss 登録日時(to)updateUser 最後に帳票を更新したユーザーのID 更新ユーザーIDupdateTimeFrom yyyy/MM/dd HH:mm:ss 更新日時(from)updateTimeTo yyyy/MM/dd HH:mm:ss 更新日時(to)deleted 0:未削除帳票　1:削除済み帳票 ※削除済みの帳票を物理削除mode 0:論理削除　1:物理削除既定値は0:論理削除

transactionMode

executeCount 処理件数指定


トランザクションモード指定0 : 1トランザクションですべての削除処理を行います（既定）1 : 1定義を1トランザクションで削除処理を行います処理を行う件数を指定します。指定しない場合は制限なし。transactionMode : 1 の時のみ有効



定義削除ＡＰＩ(DeleteDefinition)


= DeleteDefinition&（各種抽出条件）

HTTP Request

HTTP


定義削除API呼び出し

結果XML







下記はリクエストパラメータにて、transactionMode を "1"（1定義削除を1トランザクション）で実行する場合です。

■概要膨大な量の削除を行う場合、1トランザクションではサーバー負荷が増大し処理しきれずレスポンスが返ってこないため、1定義の削除処理を1トランザクションで行い、さらに処理件数を指定することで負荷を減らすことが目的。

■リクエストパラメータ　executeCount（処理件数）について削除対象として検索された定義IDの、”若い順から指定した処理件数分”だけ削除処理を行います。膨大な量の削除対象があったとしても、処理件数を指定した削除APIを連続してコールすることで確実にレスポンスが返ってきます。

■レスポンス ※transactionMode を "0"（削除するすべての定義を1トランザクションで処理）とはレスポンス形式が異なりますのでご注意ください。ノード関係名称説明メモconmas ルート

result 1 処理結果情報code 1 共通エラーコード

targetCount 1 処理件数successCount 1 削除成功件数

errors 1 エラー情報error 0..* 削除できないものがあった場合

topId 1 定義IDcode 1 エラーコード ※エラーコード表参照remarks 1 任意の数の付帯情報（エラーコードごとに定義）



-1 原因不明なエラー (Unknown Error)1001 定義削除の場合、その定義から作成した編集中帳票が存在した場合に表示

■処理サンプル処理件数（executeCount）を指定し、レスポンスの ”successCount” が ”０” になるまで処理を継続することで削除可能な定義が全て削除できます。

※共通エラーコード表参照通常の削除モードと同じ共通エラーコードが入ります


結果XML

定義削除API呼び出し

[レスポンス]successCount = 0 か？

開始

終了

Yes

No


定義操作API


　定義一覧取得ＡＰＩ仕様


■ライブラリーＩＤ値説明コマンドcommand コマンドID RESTコマンド識別文字列 GetDefinitionListlabelId ラベルＩＤここで指定されたラベルが付いたラベル、定義／帳票を検索する既定は最上位階層

※条件無しは最上位ラベルとラベル無し定義／帳票を検索-9指定でラベル指定無し（全階層）

itemTargetLabel true / false 検索対象アイテムにラベルを含めるか既定はtrueitemTargetSheet true / false 検索対象アイテムにシートを含めるか既定はtrueitemTargetSet true / false 検索対象アイテムにセットを含めるか既定はtrueitemTargetBook true / false 検索対象アイテムにブックを含めるか既定はtruepublicStatus 1:テスト、2:公開公開ステータス既定は条件無し

※非公開はサーバーで除外　条件無しは全てword キーワード String 有効

※条件無しは全てwordTargetName true / false キーワード検索対象項目に名称を含めるか既定値はfalsewordTargetRemarks true / false キーワード検索対象項目に備考を含めるか既定値はfalseHistory true / false 履歴定義も対象とする既定値はfalseurlSchemeMode URL取得モード 1:認証無し、2:ログインユーザー認証付き

　XMLレイアウト

要素（単一）要素（複数）属性※ソート順は最終更新日時順 mobileSave■ライブラリーノード関係名称説明メモconmas ルート

items 1 ライブラリーリストitem 0..* ライブラリーアイテム

type 1 アイテムタイプ 0:ラベル、1:シート、2:セットitemId 1 アイテムＩＤ各タイプ毎のユニークキーname 1 アイテム名称アイテムの表示名称iconId 1 アイコンＩＤ表示アイコンのＩＤ予め端末に登録されているアイコンのＩＤdispRemarks 1 表示用備考アイテム下部に表示する備考情報サーバー側で表示用文字列生成して渡す。displayNumber 1 表示順ラベル表示順ラベル以外は0固定editStartus 1 編集ステータス 0固定itemOrg 1 元アイテムＩＤ元定義ＩＤ、元帳票ＩＤ typeが0の場合は0固定revNo 1 リビジョンＮＯ typeが0の場合は0固定current 1 カレント区分 0:履歴 1:最新 typeが0の場合は0固定mobileSave 1 ローカル保存可否 0:可能 1:不可registTime 1 登録日時updateTime 1 更新日時urlScheme 0..1 カスタムURLスキーム i-R起動用カスタムURLスキーム jp.co.cimtops.ireporter.createreport:repid=0000&auth=XXXXXX


　定義簡易詳細情報取得ＡＰＩ仕様


■簡易詳細情報ＩＤ値説明コマンドcommand コマンドID RESTコマンド識別文字列 GetDefinitionDetailtopId ＴＯＰＩＤ定義または帳票のＴＯＰＩＤ必須urlSchemeMode URL取得モード 1:認証無し、2:ログインユーザー認証付き



■簡易詳細情報ノード関係名称説明メモconmas ルート

detailInfo 0..1 詳細情報別リクエストで取得してラベルは無し。定義と帳票は共用。topId 1 ＴＯＰＩＤ定義または帳票のＴＯＰＩＤtopName 1 ＴＯＰ定義または帳票の名称reportType 1 帳票種別 1:シート、2:セットラベルは存在しないregistTime 1 登録日時定義または帳票の初回登録日時registUser 1 登録ユーザー定義または帳票の初回登録ユーザーupdateTime 1 更新日時定義または帳票の最終更新日時updateUser 1 更新ユーザー定義または帳票の最終更新ユーザーpublicStatus 1 公開ステータス 1:テスト、2:公開thumbnail 1 サムネイル画像サムネイル用画像データ　 base64文字列readOnly 1 編集可否編集権限が無い場合：1locked 1 帳票編集可否別のユーザーが排他ロックしている：1lockedUser 1 排他ユーザー名排他ロックユーザー名lockedUserId 1 排他ユーザーID 排他ロックユーザーIDsheetCount 1 ページ数ＴＯＰ配下のシート数editStatus 1 編集ステータス０固定mobileSave 1 モバイル保存有無ローカル保存可否　0：不可 1：可remarksName1 1 ＴＯＰ備考名称１remarksName2 1 ＴＯＰ備考名称２remarksName3 1 ＴＯＰ備考名称３remarksName4 1 ＴＯＰ備考名称４remarksName5 1 ＴＯＰ備考名称５remarksName6 1 ＴＯＰ備考名称６remarksName7 1 ＴＯＰ備考名称７remarksName8 1 ＴＯＰ備考名称８remarksName9 1 ＴＯＰ備考名称９remarksName10 1 ＴＯＰ備考名称１０remarksValue1 1 ＴＯＰ備考情報１remarksValue2 1 ＴＯＰ備考情報２remarksValue3 1 ＴＯＰ備考情報３remarksValue4 1 ＴＯＰ備考情報４remarksValue5 1 ＴＯＰ備考情報５remarksValue6 1 ＴＯＰ備考情報６remarksValue7 1 ＴＯＰ備考情報７remarksValue8 1 ＴＯＰ備考情報８remarksValue9 1 ＴＯＰ備考情報９remarksValue10 1 ＴＯＰ備考情報１０labels 1 ラベルリスト

label ０..* ラベルリストlabelId 1 ラベルＩＤラベル指定検索用name 1 ラベル名称iconId 1 アイコンＩＤ

clusters 1 クラスターリスト表示、検索用に使用する。cluster ０..* クラスター

sheetNo 1 シートNoclusterId 1 クラスターIDname 1 クラスター名称value 1 クラスター値定義の場合は空

approval 1 クラスターリスト表示用に使用定義の場合は空cluster ０..* クラスター

sheetNo 1 シートNoclusterId 1 クラスターIDname 1 クラスター名称value 1 クラスター値承認ステータス値を定義の場合は空

urlScheme 0..1 カスタムURLスキーム i-R起動用カスタムURLスキーム jp.co.cimtops.ireporter.createreport:repid=XXX&auth=XXXXXX


　定義ロック取得・定義ロック解除


■ロック取得ＩＤ値説明コマンドcommand コマンドID RESTコマンド識別文字列 LockDefinitiontopId ＴＯＰＩＤ定義または帳票のＴＯＰＩＤ必須

■ロック解除ＩＤ値説明コマンドcommand コマンドID RESTコマンド識別文字列 UnlockDefinitiontopId ＴＯＰＩＤ定義または帳票のＴＯＰＩＤ必須





　定義権限取得ＡＰＩ仕様


　　


■パラメーターＩＤ値説明コマンドcommand コマンドID RESTコマンド識別文字列 GetDefinitionRoletype ファイルタイプ xml:XMLファイル、csv:CSVファイル必須encoding コードページ値エンコード用コードページ値







グループＸＭＬ



定義権限取得ＡＰＩ(GetDefinitionRole)


= GetDefinitionRoletype = xml / csv

encoding= codepage

グループCSV

HTTP Request

HTTP


定義権限取得API呼び出し


　XMLレイアウト（ダウンロード用）


■定義権限ノード関係名称必須説明メモconmas ルート

defRole 1..*defTopId 1 ＴＯＰ定義ＩＤgroupId 1 グループＩＤroleDefRead 1 ロール（定義参照） 0:権限なし、1:権限ありroleDefUpdate 1 ロール（定義編集） 0:権限なし、1:権限ありroleDefDelete 1 ロール（定義削除） 0:権限なし、1:権限ありroleRepRead 1 ロール（帳票参照） 0:権限なし、1:権限ありroleRepUpdate 1 ロール（帳票編集） 0:権限なし、1:権限ありroleRepCreate 1 ロール（帳票作成） 0:権限なし、1:権限ありroleRepDelete 1 ロール（帳票削除） 0:権限なし、1:権限ありregistTerm 1 登録端末registUser 1 登録者registTime 1 登録日時updateTerm 1 更新端末updateUser 1 更新者updateTime 1 更新日時

　ＣＳＶレイアウト（ダウンロード用）

■定義権限NO 項目説明必須タイプ備考

ＴＯＰ定義ＩＤ数値グループＩＤ数値ロール（定義参照） 0:権限なし、1:権限あり数値ロール（定義編集） 0:権限なし、1:権限あり数値ロール（定義削除） 0:権限なし、1:権限あり数値ロール（帳票参照） 0:権限なし、1:権限あり数値ロール（帳票編集） 0:権限なし、1:権限あり数値ロール（帳票作成） 0:権限なし、1:権限あり数値ロール（帳票削除） 0:権限なし、1:権限あり数値登録端末文字列登録者文字列登録日時日時更新端末文字列更新者文字列更新日時日時

２２２３２４

１５１６１７１９２０２１

１４

１２

１０１１１２


　定義権限設定ＡＰＩ仕様


　　


■パラメーターＩＤ値説明コマンドcommand コマンドID RESTコマンド識別文字列 RegistDefinitionRoletype ファイルタイプ xml:XMLファイル、csv:CSVファイル必須encoding コードページ値エンコード用コードページ値dataFile データファイル登録用のXMLまたはCSVファイル必須defRoleMode 0:しない　1:反映する指定された定義ID以降の全リビジョン定義に設定を反映するrepRoleMode 0:しない　1:反映する指定された定義IDから作成された入力帳票に設定を反映する

※Mode指定時の動き


results 1result



00000 Success 正常終了10000 Record Error その他行エラー10010 Format Error １件分のデータ形式が不正10020 Databse Error データーベース登録に失敗10030 File Open Error アップロードファイルのオープンに失敗10040 File Read Error ファイルの読み込みに失敗11000 Field Error (columnName) その他項目エラー11010 No Value Error (columnName) 必須項目無し11020 Input Error (columnName) 入力値不正11030 Numeric Error (columnName) 数値エラー11040 DateTime Error (columnName) 日付書式エラー

defRoleMode repRoleMode 反映される範囲指定された定義IDの定義にのみ設定を反映します指定された定義ID以降の全リビジョン定義に設定を反映する指定された定義ID以降の全リビジョン定義と、そこから作成された入力帳票に設定を反映する指定された定義IDの定義と、そこから作成された入力帳票に設定を反映する

0110

0011

定義権限設定用ＸＭＬ

or



定義権限設定ＡＰＩ(RegistDefinitionRole)

[送信パラメータ]command= RegistDefinitionRole

type = xml / csv

dataFile=xml or csv Fileencodig

定義権限設定用CSV

HTTP Request

HTTP

結果XML


定義権限設定API呼び出し





defRole 1..*action 1 処理区分 ◎

defTopId 1 ＴＯＰ定義ＩＤ ◎groupId 1 グループＩＤ ◎ action="D" 且つ groupId="ALL" の場合は定義の権限を全削除roleDefRead 1 ロール（定義参照） 0:権限なし、1:権限ありroleDefUpdate 1 ロール（定義編集） 0:権限なし、1:権限ありroleDefDelete 1 ロール（定義削除） 0:権限なし、1:権限ありroleRepRead 1 ロール（帳票参照） 0:権限なし、1:権限ありroleRepUpdate 1 ロール（帳票編集） 0:権限なし、1:権限ありroleRepCreate 1 ロール（帳票作成） 0:権限なし、1:権限ありroleRepDelete 1 ロール（帳票削除） 0:権限なし、1:権限あり



処理区分 ◎ 文字列

ＴＯＰ定義ＩＤ ◎ 数値グループＩＤ action="D" 且つ groupId="ALL" の場合は定義の権限を全削除 ◎ 文字列ロール（定義参照） 0:権限なし、1:権限あり数値ロール（定義編集） 0:権限なし、1:権限あり数値ロール（定義削除） 0:権限なし、1:権限あり数値ロール（帳票参照） 0:権限なし、1:権限あり数値ロール（帳票編集） 0:権限なし、1:権限あり数値ロール（帳票作成） 0:権限なし、1:権限あり数値ロール（帳票削除） 0:権限なし、1:権限あり数値

１０１１

３４５６７９

２

A:新規追加U:更新D:削除M:マージ

部分更新の場合は、項目値に、{ignore}を設定することで、更新対象の項目から除外される。

１




　定義ラベル取得ＡＰＩ仕様


　　


■登録ＩＤ値説明コマンドcommand コマンドID RESTコマンド識別文字列 GetDefinitionLabeltype ファイルタイプ xml:XMLファイル、csv:CSVファイル必須encoding コードページ値エンコード用コードページ値







定義ラベルＸＭＬ



定義ラベル取得ＡＰＩ(GetDefenitionLabel)


= GetDefenitionLabeltype

定義ラベルCSV

HTTP Request

HTTP


定義ラベル取得API呼び出




■定義／帳票ノード関係名称必須説明メモconmas ルート

DefinitionLabel 1..*defTopId 1 ＴＯＰ定義ＩＤlabelId 1 ラベルＩＤregistTerm 1 登録端末registUser 1 登録者registTime 1 登録日時updateTerm 1 更新端末updateUser 1 更新者updateTime 1 更新日時



ＴＯＰ定義ＩＤ数値ラベルＩＤ数値登録端末文字列登録者文字列登録日時日時更新端末文字列更新者文字列更新日時日時

７８

１２３４５６


　定義ラベル登録ＡＰＩ仕様


　　


■登録ＩＤ値説明コマンドcommand コマンドID RESTコマンド識別文字列 RegistDefinitionLabeltype ファイルタイプ xml:XMLファイル、csv:CSVファイル必須encoding コードページ値エンコード用コードページ値dataFile データファイル登録用のXMLまたはCSVファイル必須


results 1result



00000 Success 正常終了10000 Record Error その他行エラー10010 File Open Error アップロードファイルのオープンに失敗10020 File Read Error ファイルの読み込みに失敗10030 Format Error １件分のデータ形式が不正10040 Databse Error データーベース登録に失敗11000 Field Error (columnName) その他項目エラー11010 No Value Error (columnName) 必須項目無し11020 Input Error (columnName) 入力値不正11030 Numeric Error (columnName) 数値エラー11040 DateTime Error (columnName) 日付書式エラー

定義ラベル登録用ＸＭ

or



定義ラベル登録ＡＰＩ(RegistDefenitionLabel)


= RegistDefenitionLabel

定義ラベル登録用CSV

HTTP Request

HTTP

結果XML


定義ラベル登録API呼び出





DefinitionLabel 1..*action 1 処理区分 ◎

defTopId 1 ＴＯＰ定義ＩＤ ◎labelId 1 ラベルＩＤ ◎




ＴＯＰ定義ＩＤ ◎ 数値ラベルＩＤ ◎ 数値３

A:新規追加D:削除

全て主キーのため追加と削除のみ。重複した場合は一意制約違反でエラー。

１



２


　帳票ラベル定義取得ＡＰＩ仕様


　　


■登録ＩＤ値説明コマンドcommand コマンドID RESTコマンド識別文字列 GetReportLabelDefinitiontype ファイルタイプ xml:XMLファイル、csv:CSVファイル必須encoding コードページ値エンコード用コードページ値







帳票ラベル定義ＸＭＬ



帳票ラベル定義取得ＡＰＩ(GetReportLabelDefenition)


= GetReportLabelDefenitiontype

帳票ラベル定義CSV

HTTP Request

HTTP


帳票ラベル定義取得API呼





reportLabelDefinition 1..*defTopId 1 ＴＯＰ定義ＩＤlabelId 1 ラベルＩＤregistTerm 1 登録端末registUser 1 登録者registTime 1 登録日時updateTerm 1 更新端末updateUser 1 更新者updateTime 1 更新日時



ＴＯＰ帳票ＩＤ数値ラベルＩＤ数値登録端末文字列登録者文字列登録日時日時更新端末文字列更新者文字列更新日時日時

７８

１２３４５６


　帳票ラベル定義登録ＡＰＩ仕様


　　


■登録ＩＤ値説明コマンドcommand コマンドID RESTコマンド識別文字列 RegistReportLabelDefinitiontype ファイルタイプ xml:XMLファイル、csv:CSVファイル必須encoding コードページ値エンコード用コードページ値dataFile データファイル登録用のXMLまたはCSVファイル必須


results 1result



00000 Success 正常終了10010 Format Error １件分のデータ形式が不正10020 Databse Error データーベース登録に失敗10030 File Open Error アップロードファイルのオープンに失敗10040 File Read Error ファイルの読み込みに失敗10040 Databse Error データーベース登録に失敗11000 Field Error (columnName) その他項目エラー11010 No Value Error (columnName) 必須項目無し11020 Input Error (columnName) 入力値不正11030 Numeric Error (columnName) 数値エラー11040 DateTime Error (columnName) 日付書式エラー

帳票ラベル定義登録用

or



帳票ラベル定義登録ＡＰＩ(RegistReportLabelDefenitio


= RegistReportLabelDefenition

帳票ラベル定義登録用CSV

HTTP Request

HTTP

結果XML


帳票ラベル定義登録API呼





reportLabelDefinition 1..*action 1 処理区分 ◎

defTopId 1 ＴＯＰ定義ＩＤ ◎labelId 1 ラベルＩＤ ◎




ＴＯＰ定義ＩＤ ◎ 数値ラベルＩＤ ◎ 数値３



１



２


帳票操作API


　帳票一覧取得ＡＰＩ仕様


■ライブラリーＩＤ値説明コマンドcommand コマンドID RESTコマンド識別文字列 GetReportListlabelId ラベルＩＤここで指定されたラベルが付いたラベル、定義／帳票を検索する既定は最上位階層

※条件無しは最上位ラベルとラベル無し定義／帳票を検索-9指定でラベル指定無し（全階層）

itemTargetLabel true / false 検索対象アイテムにラベルを含めるか既定はtrueitemTargetSheet true / false 検索対象アイテムにシートを含めるか既定はtrueitemTargetSet true / false 検索対象アイテムにセットを含めるか既定はtrueitemTargetBook true / false 検索対象アイテムにブックを含めるか既定はtruepublicStatus 1:テスト、2:公開公開ステータス既定は条件無し

※非公開はサーバーで除外　条件無しは全てeditStatus 0:入力前編集ステータス既定は条件無し

1:編集中 ※条件無しは全て2:承認待ち ※定義取得の場合は指定不可3:差し戻し4:入力完了

word キーワード String 有効※条件無しは全て

wordTargetName true / false キーワード検索対象項目に名称を含めるか既定値はfalsewordTargetValue true / false キーワード検索対象項目に入力値を含めるか既定値はfalsewordTargetRemarks true / false キーワード検索対象項目に備考を含めるか既定値はfalseHistory true / false 履歴定義も対象とする既定値はfalseurlSchemeMode URL取得モード 1:認証無し、2:ログインユーザー認証付きregistTimeFrom 帳票の登録日時FROM "yyyy/MM/dd HH:mm:ss”形式registTimeTo 帳票の登録日時TO "yyyy/MM/dd HH:mm:ss”形式updateTimeFrom 帳票の最終更新日時FROM "yyyy/MM/dd HH:mm:ss”形式updateTimeTo 帳票の最終更新日時TO "yyyy/MM/dd HH:mm:ss”形式


要素（単一）要素（複数）属性※ソート順は最終更新日時順■ライブラリーノード関係名称説明メモconmas ルート

items 1 ライブラリーリストitem 0..* ライブラリーアイテム

type 1 アイテムタイプ 0:ラベル、1:シート、2:セットitemId 1 アイテムＩＤ各タイプ毎のユニークキーname 1 アイテム名称アイテムの表示名称iconId 1 アイコンＩＤ表示アイコンのＩＤ予め端末に登録されているアイコンのＩＤdispRemarks 1 表示用備考アイテム下部に表示する備考情報サーバー側で表示用文字列生成して渡す。displayNumber 1 表示順ラベル表示順ラベル以外は0固定editStartus 1 編集ステータス 0:入力前、1:編集中、2:承認待ち、3:差し戻し、4:入力完了itemOrg 1 元アイテムＩＤ元定義ＩＤ、元帳票ＩＤ typeが0の場合は0固定revNo 1 リビジョンＮＯ typeが0の場合は0固定current 1 カレント区分 0:履歴 1:最新 typeが0の場合は0固定mobileReportSave 1 ローカル保存可否 0:可能 1:不可registTime 1 登録日時updateTime 1 更新日時urlScheme 0..1 カスタムURLスキーム i-R起動用カスタムURLスキーム jp.co.cimtops.ireporter.openreport:repid=0000&auth=XXXXXX


　帳票簡易詳細情報取得ＡＰＩ仕様


■簡易詳細情報ＩＤ値説明コマンドcommand コマンドID RESTコマンド識別文字列 GetReportDetailtopId ＴＯＰＩＤ定義または帳票のＴＯＰＩＤ必須 ※注１urlSchemeMode URL取得モード 1:認証無し、2:ログインユーザー認証付きdefTopId 定義ID 帳票が作成された定義ID 必須 ※注１defTopOrg 元定義ID 帳票が作成された定義の元定義ID 必須 ※注１systemKey1 システムキー１必須 ※注１systemKey2 システムキー２必須 ※注１systemKey3 システムキー３必須 ※注１systemKey4 システムキー４必須 ※注１systemKey5 システムキー５必須 ※注１ResultType リザルトタイプ 1：複数該当した場合、最初の一件のみ返す（規定）２：複数該当した場合、全件返す※注１　必須項目のうちどれか一つでも指定がなければ、パラメータ異常(Invalid Parameter)：2を返します。



■簡易詳細情報ノード関係名称説明メモconmas ルート

detailInfo 0..1 詳細情報別リクエストで取得してラベルは無し。定義と帳票は共用。topId 1 ＴＯＰＩＤ定義または帳票のＴＯＰＩＤtopName 1 ＴＯＰ定義または帳票の名称reportType 1 帳票種別 1:シート、2:セットラベルは存在しないregistTime 1 登録日時定義または帳票の初回登録日時registUser 1 登録ユーザー定義または帳票の初回登録ユーザーupdateTime 1 更新日時定義または帳票の最終更新日時updateUser 1 更新ユーザー定義または帳票の最終更新ユーザーpublicStatus 1 公開ステータス 1:テスト、2:公開thumbnail 1 サムネイル画像サムネイル用画像データ　 base64文字列readOnly 1 編集可否編集権限が無い場合：1locked 1 帳票編集可否別のユーザーが排他ロックしている：1lockedUser 1 排他ユーザー名排他ロックユーザー名lockedUserId 1 排他ユーザーID 排他ロックユーザーIDsheetCount 1 ページ数ＴＯＰ配下のシート数editStatus 1 編集ステータス 0:入力前、1:編集中、2:承認待ち、3:差し戻し、4:入力完了帳票以外は０固定mobileSave 1 モバイル保存有無使用しませんremarksName1 1 ＴＯＰ備考名称１remarksName2 1 ＴＯＰ備考名称２remarksName3 1 ＴＯＰ備考名称３remarksName4 1 ＴＯＰ備考名称４remarksName5 1 ＴＯＰ備考名称５remarksName6 1 ＴＯＰ備考名称６remarksName7 1 ＴＯＰ備考名称７remarksName8 1 ＴＯＰ備考名称８remarksName9 1 ＴＯＰ備考名称９remarksName10 1 ＴＯＰ備考名称１０remarksValue1 1 ＴＯＰ備考情報１remarksValue2 1 ＴＯＰ備考情報２remarksValue3 1 ＴＯＰ備考情報３remarksValue4 1 ＴＯＰ備考情報４remarksValue5 1 ＴＯＰ備考情報５remarksValue6 1 ＴＯＰ備考情報６remarksValue7 1 ＴＯＰ備考情報７remarksValue8 1 ＴＯＰ備考情報８remarksValue9 1 ＴＯＰ備考情報９remarksValue10 1 ＴＯＰ備考情報１０labels 1 ラベルリスト

label ０..* ラベルリストlabelId 1 ラベルＩＤラベル指定検索用name 1 ラベル名称iconId 1 アイコンＩＤ

clusters 1 クラスターリスト表示、検索用に使用する。cluster ０..* クラスター

sheetNo 1 シートNoclusterId 1 クラスターIDname 1 クラスター名称value 1 クラスター値定義の場合は空

approval 1 クラスターリスト表示用に使用定義の場合は空cluster ０..* クラスター

sheetNo 1 シートNoclusterId 1 クラスターIDname 1 クラスター名称value 1 クラスター値承認ステータス値を定義の場合は空

urlScheme 0..1 カスタムURLスキーム i-R起動用カスタムURLスキーム jp.co.cimtops.ireporter.openreport:repid=XXX&auth=XXXXXX


　帳票ロック取得・帳票ロック解除


■ロック取得ＩＤ値説明コマンドcommand コマンドID RESTコマンド識別文字列 LockReporttopId ＴＯＰＩＤ定義または帳票のＴＯＰＩＤ必須

■ロック解除ＩＤ値説明帳票command コマンドID RESTコマンド識別文字列 UnlockReporttopId ＴＯＰＩＤ定義または帳票のＴＯＰＩＤ必須





　帳票権限取得ＡＰＩ仕様


　　


■パラメーターＩＤ値説明コマンドcommand コマンドID RESTコマンド識別文字列 GetReportRoletype ファイルタイプ xml:XMLファイル、csv:CSVファイル必須encoding コードページ値エンコード用コードページ値










帳票権限取得ＡＰＩ(GetReportRole)


= GetReportRoletype = xml / csv

encoding= codepage

グループCSV

HTTP Request

HTTP


帳票権限取得API呼び出し





repRole 1..*repTopId 1 ＴＯＰ帳票ＩＤgroupId 1 グループＩＤroleRepRead 1 ロール（帳票参照） 0:権限なし、1:権限ありroleRepUpdate 1 ロール（帳票編集） 0:権限なし、1:権限ありroleRepDelete 1 ロール（帳票削除） 0:権限なし、1:権限ありregistTerm 1 登録端末registUser 1 登録者registTime 1 登録日時updateTerm 1 更新端末updateUser 1 更新者updateTime 1 更新日時



ＴＯＰ帳票ＩＤ数値グループＩＤ数値ロール（帳票参照） 0:権限なし、1:権限あり数値ロール（帳票編集） 0:権限なし、1:権限あり数値ロール（帳票削除） 0:権限なし、1:権限あり数値登録端末文字列登録者文字列登録日時日時更新端末文字列更新者文字列更新日時日時

２０２１２２２３２４

１９

１２

１４１５１７


　帳票権限設定ＡＰＩ仕様


　　


■パラメーターＩＤ値説明コマンドcommand コマンドID RESTコマンド識別文字列 RegistReportRoletype ファイルタイプ xml:XMLファイル、csv:CSVファイル必須encoding コードページ値エンコード用コードページ値dataFile データファイル登録用のXMLまたはCSVファイル必須


results 1result




帳票権限設定用ＸＭＬ

or



帳票権限設定ＡＰＩ(RegistReportRole)


= RegistReportRoletype = xml / csv

dataFile=xml or csv File

encodig帳票権限設定用CSV

HTTP Request

HTTP

結果XML


帳票権限設定API呼び出し





repRole 1..*action 1 処理区分 ◎

repTopId 1 ＴＯＰ帳票ＩＤ ◎groupId 1 グループＩＤ ◎ action="D" 且つ groupId="ALL" の場合は定義の権限を全削除roleRepRead 1 ロール（帳票参照） 0:権限なし、1:権限ありroleRepUpdate 1 ロール（帳票編集） 0:権限なし、1:権限ありroleRepDelete 1 ロール（帳票削除） 0:権限なし、1:権限あり




ＴＯＰ帳票ＩＤ ◎ 数値グループＩＤ action="D" 且つ groupId="ALL" の場合は定義の権限を全削除 ◎ 文字列ロール（帳票参照） 0:権限なし、1:権限あり数値ロール（帳票編集） 0:権限なし、1:権限あり数値ロール（帳票削除） 0:権限なし、1:権限あり数値

３８９

１１



１



２


　帳票ラベル取得ＡＰＩ仕様


　　


■登録ＩＤ値説明コマンドcommand コマンドID RESTコマンド識別文字列 GetReportLabeltype ファイルタイプ xml:XMLファイル、csv:CSVファイル必須encoding コードページ値エンコード用コードページ値







帳票ラベルＸＭＬ



帳票ラベル取得ＡＰＩ(GetReportLabel)


= GetReportLabeltype = xml / csv

帳票ラベルCSV

HTTP Request

HTTP


帳票ラベル取得API呼び出





reportLabel 1..*repTopId 1 ＴＯＰ帳票ＩＤlabelId 1 ラベルＩＤregistTerm 1 登録端末registUser 1 登録者registTime 1 登録日時updateTerm 1 更新端末updateUser 1 更新者updateTime 1 更新日時



ＴＯＰ帳票ＩＤ数値ラベルＩＤ数値登録端末文字列登録者文字列登録日時日時更新端末文字列更新者文字列更新日時日時

７８

１２３４５６


　帳票ラベル登録ＡＰＩ仕様


　　


■登録ＩＤ値説明コマンドcommand コマンドID RESTコマンド識別文字列 RegistReportLabeltype ファイルタイプ xml:XMLファイル、csv:CSVファイル必須encoding コードページ値エンコード用コードページ値dataFile データファイル登録用のXMLまたはCSVファイル必須


results 1result



00000 Success 正常終了10010 Format Error １件分のデータ形式が不正10020 Databse Error データーベース登録に失敗10030 File Open Error アップロードファイルのオープンに失敗10040 File Read Error ファイルの読み込みに失敗10040 Databse Error データーベース登録に失敗11000 Field Error (columnName) その他項目エラー11010 No Value Error (columnName) 必須項目無し11020 Input Error (columnName) 入力値不正11030 Numeric Error (columnName) 数値エラー11040 DateTime Error (columnName) 日付書式エラー

帳票ラベル登録用ＸＭ

or



帳票ラベル登録ＡＰＩ(RegistReportLabel)


= RegistReportLabeltype

帳票ラベル登録用CSV

HTTP Request

HTTP

結果XML


帳票ラベル登録API呼び出





reportLabel 1..*action 1 処理区分 ◎

repTopId 1 ＴＯＰ帳票ＩＤ ◎labelId 1 ラベルＩＤ ◎




ＴＯＰ帳票ＩＤ ◎ 数値ラベルＩＤ ◎ 数値３



１



２


　帳票コピーＡＰＩ仕様


　　


■帳票コピーＩＤ値説明コマンドcommand コマンドID RESTコマンド識別文字列 CopyReportreportId 帳票ID 帳票コピー元となる帳票IDを指定

copyReportMode 既定値は0:同一リビジョン定義から作成する


■レスポンスノード関係名称必須説明メモconmas ルート





remark 1..* 結果メッセージ各コマンド共通を参照※resultsエレメントは正常実行時のみ追加される



0:同一リビジョンの定義から作成する1:最新の定義から作成する



帳票コピーＡＰＩ(CopyReport)


= CopyReport&（各種抽出条件）

HTTP Request

HTTP


帳票コピーAPI呼び出し

結果XML


　帳票ファイル取得ＡＰＩ仕様


　　

　概要

PDF, EXCELファイルをそのままの形式でレスポンスします。


■帳票データ出力ＩＤ値説明コマンドcommand コマンドID RESTコマンド識別文字列 GetReportFile

fileType ファイル種類必須

report 帳票ID 取得する帳票IDを入力指定必須　※注意１systemKey1 システムキー1 取得する帳票IDのシステムキー１を入力指定必須　※注意１systemKey2 システムキー2 取得する帳票IDのシステムキー２を入力指定必須　※注意１systemKey3 システムキー3 取得する帳票IDのシステムキー３を入力指定必須　※注意１systemKey4 システムキー4 取得する帳票IDのシステムキー４を入力指定必須　※注意１systemKey5 システムキー5 取得する帳票IDのシステムキー５を入力指定必須　※注意１fileName ファイル名称指定

任意

pageNo 出力ページ指定

任意

※注意１report または systemKey1～5は帳票を一意に特定するためのキーとなります。このためどちらか一方のみが必須です。両方指定された場合は、systemKey側を使用します。

　レスポンス（異常）

ContentType=text/xml

ノード関係名称説明メモconmas ルート




-1 原因不明なエラー (Unknown Error)1 無効なコマンド(Command Not Found)2 パラメータ異常(Invalid Parameter)

出力シートを指定したい場合に設定します。出力ページは“カンマ区切り”でページ番号を指定します。連続するページ（範囲指定）は”ハイフン”で指定します。例）1ページ目と 3ページ目指定： 1,35ページ目～ 7ページ目指定： 2-41ページ目と 3ページ目と 5ページ目～ 7ページ目指定：1,3,5-7※fileType=pdf または pdfLayer限定

"pdf" ： PDFファイルを取得する"pdfLayer"：レイヤーつきPDFファイルを取得する"excel" ： Excelファイルを取得する

出力ファイル名を指定したい場合にセットします。ブランクの場合は、ファイル自動出力設定の名称となります。※.pdf や .xlsx等の拡張子は変更できません。

例）testと指定した場合test.pdf test.xls test.xlsx



帳票ファイル取得ＡＰＩ(GetReportFile)


= GetReportFile

HTTP Request

HTTP


帳票ファイル取得API呼び

帳票PDF

帳票Excel


3 権限不足 (Privilege Error) ※注１4 非対応HTTPメソッド(例：GET不可) (Invalid HTTP Method)5 セッション無し8 データーなし(Not Data Found) ※注２9 データー複数存在エラー ※注３

※注１　APIログインユーザーが対象の帳票に対して"参照"権限をもつ必要があります。※注２　Excelファイル取得の場合、元々Excel取り込みされていない帳票の場合は帳票が存在しても"データーなし(Not Data Found)"エラーとなります。※注３　システムキー検索で複数の帳票が見つかった場合、このエラーとなります。

　レスポンス（正常）

■fileType=pdfの場合（PDFファイル取得）ContentType=application/pdf

■fileType=excelの場合（Excelファイル取得）・.xlsファイルの場合

ContentType=application/vnd.ms-excel


　クラスター取得API仕様

　概要

帳票上のクラスター値のみを取得するシンプルなAPIです。・画像系のクラスターは画像をレスポンスします。・画像系以外のクラスターは入力値または表示値をレスポンスします。


■帳票データ出力ＩＤ値説明コマンドcommand コマンドID RESTコマンド識別文字列 GetClusterValuereport 帳票ID 取得する帳票IDを入力指定必須　※注意１systemKey1 システムキー1 取得する帳票のシステムキー１を入力指定必須　※注意１systemKey2 システムキー2 取得する帳票のシステムキー２を入力指定必須　※注意１systemKey3 システムキー3 取得する帳票のシステムキー３を入力指定必須　※注意１systemKey4 システムキー4 取得する帳票のシステムキー４を入力指定必須　※注意１systemKey5 システムキー5 取得する帳票のシステムキー５を入力指定必須　※注意１sheetNo 帳票内シート番号取得する帳票内シートの番号必須

clusterSearchMode クラスター指定方法必須

clusterSearchValue クラスター指定値クラスター指定方法で指定した指定値を指定必須

valueType 取得タイプ

※注意１report または systemKey1～5は帳票を一意に特定するためのキーとなります。このためどちらか一方のみが必須です。両方指定された場合は、systemKey側を使用します。

　レスポンス（異常）

ContentType=text/xml

ノード関係名称説明メモconmas ルート

error 1 エラー情報 ※エラー情報表参照code 1 エラーコードremarks 1 任意の数の付帯情報（エラーコードごとに定義）


■エラー情報表エラーコード説明付帯情報

-1 原因不明なエラー (Unknown Error)1 無効なコマンド(Command Not Found)2 パラメータ異常(Invalid Parameter) It is required either 'report' or all of 'systemKey's.

'sheetNo' is required.'clusterSearchMode' is required.'clusterSearchValue' is required.'report' must be an integer.'sheetNo' must be an integer.Invalid value in 'clusterSearchMode'.'valueType' must be an integer.Invalid value in 'valueType'.

3 権限不足 (Privilege Error) ※注１ Unauthorized to access the report.Unauthorized to access the cluster.

4 非対応HTTPメソッド(例：GET不可) (Invalid HTTP Method)5 セッション無し8 データーなし(Not Data Found) ※注２ The report does not exist.

The sheet does not exist.The cluster does not exist.

9 データー複数存在エラー ※注３ The report is duplicated.The cluster is duplicated.

※注１　APIログインユーザーが対象の帳票に対して"参照"権限、クラスターに対して参照以上の権限をもつ必要があります。※注２　該当クラスターが存在しない場合はこのエラーになります。※注３　検索結果で複数のクラスターが見つかった場合、このエラーとなります。

　レスポンス（正常）

■クラスター種別　画像、手書きフリーメモ、FreeDraw、手書きノート形式contentType=image/{画像フォーマット}ファイル名：image.{画像フォーマット}

■クラスター種別　上記以外contentType=text/plainファイル名：text.txt

※クラスター値が未入力の場合、空ファイルをレスポンスします。

　必要な権限

■帳票参照権限取得する帳票に対して参照権限が必要です。

クラスターindex指定="index"クラスター名称指定="name"

入力値取得：0 表示値取得：1※デフォルト:0


■クラスター参照権限（権限設定されているクラスターのみ）取得するクラスターに対して権限設定されている場合、クラスターに対する「編集可能」「参照のみ」の何れかの権限が必要です。


システムメンテナンスAPI


　グループ取得ＡＰＩ仕様


　　


■登録ＩＤ値説明コマンドcommand コマンドID RESTコマンド識別文字列 GetGrouptype ファイルタイプ xml:XMLファイル、csv:CSVファイル必須encoding コードページ値エンコード用コードページ値










グループ取得ＡＰＩ(GetGroup)


= GetGrouptype

グループCSV

HTTP Request

HTTP


グループ取得API呼び出し





group 1..*groupId 1 グループＩＤgroupName 1 グループ名称upperGroupId 1 親グループＩＤgroupIdPath 1 グループＩＤパスgroupNamePath 1 グループ名称パスroleMstRead 1 ロール（マスター参照） 0:権限なし、1:権限ありroleMstUpdate 1 ロール（マスター編集） 0:権限なし、1:権限ありroleMstCreate 1 ロール（マスター作成） 0:権限なし、1:権限ありroleMstDelete 1 ロール（マスター削除） 0:権限なし、1:権限ありroleDefRead 1 ロール（定義参照） 0:権限なし、1:権限ありroleDefUpdate 1 ロール（定義編集） 0:権限なし、1:権限ありroleDefCreate 1 ロール（定義作成） 0:権限なし、1:権限ありroleDefDelete 1 ロール（定義削除） 0:権限なし、1:権限ありroleRepRead 1 ロール（帳票参照） 0:権限なし、1:権限ありroleRepUpdate 1 ロール（帳票編集） 0:権限なし、1:権限ありroleRepCreate 1 ロール（帳票作成） 0:権限なし、1:権限ありroleRepDelete 1 ロール（帳票削除） 0:権限なし、1:権限ありgroupRemarks 1 グループ備考registTerm 1 登録端末registUser 1 登録者registTime 1 登録日時updateTerm 1 更新端末updateUser 1 更新者updateTime 1 更新日時



グループＩＤ数値グループ名称文字列親グループＩＤ数値グループＩＤパス文字列グループ名称パス文字列ロール（マスター参照） 0:権限なし、1:権限あり数値ロール（マスター編集） 0:権限なし、1:権限あり数値ロール（マスター作成） 0:権限なし、1:権限あり数値ロール（マスター削除） 0:権限なし、1:権限あり数値ロール（定義参照） 0:権限なし、1:権限あり数値ロール（定義編集） 0:権限なし、1:権限あり数値ロール（定義作成） 0:権限なし、1:権限あり数値ロール（定義削除） 0:権限なし、1:権限あり数値ロール（帳票参照） 0:権限なし、1:権限あり数値ロール（帳票編集） 0:権限なし、1:権限あり数値ロール（帳票作成） 0:権限なし、1:権限あり数値ロール（帳票削除） 0:権限なし、1:権限あり数値グループ備考文字列登録端末文字列登録者文字列登録日時日時更新端末文字列更新者文字列更新日時日時２４

１３１４１５１６１７１８１９２０２１２２２３

１２

１２３４５６７８９

１０１１


　グループ登録ＡＰＩ仕様


　　


■登録ＩＤ値説明コマンドcommand コマンドID RESTコマンド識別文字列 RegistGrouptype ファイルタイプ xml:XMLファイル、csv:CSVファイル必須encoding コードページ値エンコード用コードページ値dataFile データファイル登録用のXMLまたはCSVファイル必須


results 1result




グループ登録用ＸＭＬ

or



グループ登録ＡＰＩ(RegistGroup)


= RegistGrouptype

グループ登録用CSV

HTTP Request

HTTP

結果XML


グループ登録API呼び出し





group 1..*action 1 処理区分 ◎

groupId 1 グループＩＤ △ A:新規追加の場合は空で良いgroupName 1 グループ名称 △ A:新規追加の場合は必須upperGroupId 1 親グループＩＤroleMstRead 1 ロール（マスター参照） 0:権限なし、1:権限ありroleMstUpdate 1 ロール（マスター編集） 0:権限なし、1:権限ありroleMstCreate 1 ロール（マスター作成） 0:権限なし、1:権限ありroleMstDelete 1 ロール（マスター削除） 0:権限なし、1:権限ありroleDefRead 1 ロール（定義参照） 0:権限なし、1:権限ありroleDefUpdate 1 ロール（定義編集） 0:権限なし、1:権限ありroleDefCreate 1 ロール（定義作成） 0:権限なし、1:権限ありroleDefDelete 1 ロール（定義削除） 0:権限なし、1:権限ありroleRepRead 1 ロール（帳票参照） 0:権限なし、1:権限ありroleRepUpdate 1 ロール（帳票編集） 0:権限なし、1:権限ありroleRepCreate 1 ロール（帳票作成） 0:権限なし、1:権限ありroleRepDelete 1 ロール（帳票削除） 0:権限なし、1:権限ありgroupRemarks 1 グループ備考




グループＩＤ A:新規追加の場合は空で良い △ 数値グループ名称 A:新規追加の場合は必須 △ 文字列親グループＩＤ数値ロール（マスター参照） 0:権限なし、1:権限あり数値ロール（マスター編集） 0:権限なし、1:権限あり数値ロール（マスター作成） 0:権限なし、1:権限あり数値ロール（マスター削除） 0:権限なし、1:権限あり数値ロール（定義参照） 0:権限なし、1:権限あり数値ロール（定義編集） 0:権限なし、1:権限あり数値ロール（定義作成） 0:権限なし、1:権限あり数値ロール（定義削除） 0:権限なし、1:権限あり数値ロール（帳票参照） 0:権限なし、1:権限あり数値ロール（帳票編集） 0:権限なし、1:権限あり数値ロール（帳票作成） 0:権限なし、1:権限あり数値ロール（帳票削除） 0:権限なし、1:権限あり数値グループ備考文字列

１５１６１７

９１０１１１２１３１４

８



１



２３４５６７


　ユーザー取得ＡＰＩ仕様


　　


■登録ＩＤ値説明コマンドcommand コマンドID RESTコマンド識別文字列 GetUserencoding コードページ値エンコード用コードページ値type ファイルタイプ xml:XMLファイル、csv:CSVファイル必須







ユーザーＸＭＬ



ユーザー取得ＡＰＩ(GetUser)


= GetUsertype

ユーザーCSV

HTTP Request

HTTP


ユーザー取得API呼び出し





user 1..*userId 1 ユーザーＩＤuserName 1 ユーザー名称email 1 メールアカウントメールアカウント形式useStartTime 1 利用開始日時 yyyy/MM/dd HH:mm:ssuseEndTime 1 利用終了日時 yyyy/MM/dd HH:mm:ssapprovalSign 1 印影イメージ PNG形式base64エンコード文字列registTerm 1 登録端末registUser 1 登録者registTime 1 登録日時updateTerm 1 更新端末updateUser 1 更新者updateTime 1 更新日時



ユーザーＩＤ文字列ユーザー名称文字列メールアカウントメールアカウント形式文字列利用開始日時 yyyy/MM/dd HH:mm:ss 文字列利用終了日時 yyyy/MM/dd HH:mm:ss 文字列印影イメージ PNG形式base64エンコード文字列文字列登録端末文字列登録者文字列登録日時日時更新端末文字列更新者文字列更新日時日時１２

１２３４５６７８９

１０１１


　ユーザー登録ＡＰＩ仕様


　　


■登録ＩＤ値説明コマンドcommand コマンドID RESTコマンド識別文字列 RegistUsertype ファイルタイプ xml:XMLファイル、csv:CSVファイル必須encoding コードページ値エンコード用コードページ値dataFile データファイル登録用のXMLまたはCSVファイル必須


results 1result



00000 Success 正常終了10000 Record Error その他行エラー10010 Format Error １件分のデータ形式が不正10020 Databse Error データーベース登録に失敗10030 File Open Error アップロードファイルのオープンに失敗10040 File Read Error ファイルの読み込みに失敗11000 Field Error (columnName) その他項目エラー11010 No Value Error (columnName) 必須項目無し11020 Input Error (columnName) 入力値不正11030 Numeric Error (columnName) 数値エラー11040 DateTime Error (columnName) 日付書式エラー11050 Licence Error ユーザーライセンス数超過エラー

ユーザー登録用ＸＭＬ

or



ユーザー登録ＡＰＩ(RegistUser)


= RegistUsertype

ユーザー登録用CSV

HTTP Request

HTTP

結果XML


ユーザー登録API呼び出し





user 1..*action 1 処理区分 ◎

userId 1 ユーザーＩＤ ◎password 1 パスワード △ A:新規追加の場合は必須userName 1 ユーザー名称 △ A:新規追加の場合は必須email 1 メールアカウントメールアカウント形式useStartTime 1 利用開始日時 ◎ yyyy/MM/dd HH:mm:ssuseEndTime 1 利用終了日時 ◎ yyyy/MM/dd HH:mm:ssapprovalSign 1 印影イメージ PNG形式base64エンコード文字列




ユーザーＩＤ ◎ 文字列パスワード A:新規追加の場合は必須 △ 文字列ユーザー名称 A:新規追加の場合は必須 △ 文字列メールアカウントメールアカウント形式文字列利用開始日時 yyyy/MM/dd HH:mm:ss ◎ 文字列利用終了日時 yyyy/MM/dd HH:mm:ss ◎ 文字列印影イメージ PNG形式base64エンコード文字列文字列8



１



２３4567


　グループ所属取得ＡＰＩ仕様


　　


■登録ＩＤ値説明コマンドcommand コマンドID RESTコマンド識別文字列 GetGroupAffiliationtype ファイルタイプ xml:XMLファイル、csv:CSVファイル必須encoding コードページ値エンコード用コードページ値







グループ所属ＸＭＬ



グループ所属取得ＡＰＩ(GetGroupAffiliation)


= GetGroupAffiliation

グループ所属CSV

HTTP Request

HTTP


グループ所属取得API呼び





groupAffiliation 1..*groupId 1 グループＩＤuserId 1 ユーザーＩＤregistTerm 1 登録端末registUser 1 登録者registTime 1 登録日時updateTerm 1 更新端末updateUser 1 更新者updateTime 1 更新日時



グループＩＤ数値ユーザーＩＤ文字列登録端末文字列登録者文字列登録日時日時更新端末文字列更新者文字列更新日時日時

７８

１２３４５６


　グループ所属登録ＡＰＩ仕様


　　


■登録ＩＤ値説明コマンドcommand コマンドID RESTコマンド識別文字列 RegistGroupAffiliationtype ファイルタイプ xml:XMLファイル、csv:CSVファイル必須encoding コードページ値エンコード用コードページ値dataFile データファイル登録用のXMLまたはCSVファイル必須


results 1result




グループ所属登録用Ｘ

or



グループ所属登録ＡＰＩ(RegistGroupAffiliation)


= RegistGroupAffiliationtype

グループ所属登録用CSV

HTTP Request

HTTP

結果XML


グループ所属登録API呼び





groupAffiliation 1..*action 1 処理区分 ◎

groupId 1 グループＩＤ ◎userId 1 ユーザーＩＤ ◎




グループＩＤ ◎ 数値ユーザーＩＤ ◎ 文字列３



１



２


　定義ラベルマスター取得ＡＰＩ仕様


　　


■登録ＩＤ値説明コマンドcommand コマンドID RESTコマンド識別文字列 GetDefinitionLabelMastertype ファイルタイプ xml:XMLファイル、csv:CSVファイル必須encoding コードページ値エンコード用コードページ値







定義ラベルマスターＸＭ



定義ラベルマスター取得ＡＰＩ(GetDefenitionLabelMaster)


= GetDefenitionLabelMaster

定義ラベルマスターCSV

HTTP Request

HTTP


定義ラベルマスター取得





definitionLabelMaster 1..*labelId 1 ラベルＩＤupperLabelId 1 親ラベルＩＤlabelName 1 ラベル名称labelIconId 1 アイコンＩＤlabelRemarks 1 備考displayNumber 1 表示順registTerm 1 登録端末registUser 1 登録者registTime 1 登録日時updateTerm 1 更新端末updateUser 1 更新者updateTime 1 更新日時autoDelete 1 ラベル自動削除

labelRoleGroup 1 ラベル参照権限グループ空の場合は、参照権限設定なし



ラベルＩＤ A:新規追加の場合は空とする △ 数値親ラベルＩＤ数値ラベル名称 A:新規追加の場合は必須 △ 文字列アイコンＩＤ 1～10の範囲の整数を設定 ◎ 数値備考文字列表示順数値登録端末文字列登録者文字列登録日時日時更新端末文字列更新者文字列更新日時日時ラベルの自動削除数値

ラベル参照グループ文字列空の場合は、参照権限設定なし１４

ラベル参照可能なグループIDがセミコロン区切りで設定される。例）12;14;15

１２

１２３４５６７８９

１０１１

0:自動削除しない1:自動削除する

帳票定義削除時、このラベルに属する帳票定義が存在しない場合に自動で削除するかどうか

１３0:自動削除しない1:自動削除する

帳票定義削除時、このラベルに属する帳票定義が存在しない場合に自動で削除するかどうか



　定義ラベルマスター登録ＡＰＩ仕様


　　


■登録ＩＤ値説明コマンドcommand コマンドID RESTコマンド識別文字列 RegistDefinitionLabelMastertype ファイルタイプ xml:XMLファイル、csv:CSVファイル必須encoding コードページ値エンコード用コードページ値dataFile データファイル登録用のXMLまたはCSVファイル必須


results 1result



00000 Success 正常終了10000 Record Error その他行エラー10010 Format Error １件分のデータ形式が不正10020 Databse Error データーベース登録に失敗10030 File Open Error アップロードファイルのオープンに失敗10040 File Read Error ファイルの読み込みに失敗11000 Field Error (columnName) その他項目エラー11010 No Value Error (columnName) 必須項目無し11020 Input Error (columnName) 入力値不正11030 Numeric Error (columnName) 数値エラー11040 DateTime Error (columnName) 日付書式エラー11050 labelRoleGroup No Data ラベル参照権限に指定されたグループID不正

定義ラベルマスター登

or



定義ラベルマスター登録ＡＰＩ(RegistDefenitionLabelMaste


= RegistDefenitionLabelMaster

定義ラベルマスター登録用

HTTP Request

HTTP

結果XML


定義ラベルマスター登録





definitionLabelMaster 1..*action 1 処理区分 ◎

labelId 1 ラベルＩＤ ◎ A:新規追加の場合は空とするupperLabelId 1 親ラベルＩＤエレメントがない場合は、クリアlabelName 1 ラベル名称 ◎ A:新規追加の場合は必須labelIconId 1 アイコンＩＤ ◎ 1～10の範囲の整数を設定labelRemarks 1 備考エレメントがない場合は、クリアdisplayNumber 1 表示順 ◎autoDelete 1 ラベル自動削除設定

labelRoleGroup 0..1 ラベル参照権限グループ




ラベルＩＤ A:新規追加の場合は空とする △ 数値親ラベルＩＤ数値ラベル名称 A:新規追加の場合は必須 △ 文字列アイコンＩＤ 1～10の範囲の整数を設定 ◎ 数値備考文字列表示順 ◎ 数値ラベル参照グループ文字列

ラベル自動削除設定数値

　XML,CSVサンプル

ラベル参照グループのみ更新するには、更新対象外としたい各項目に｛ignore｝を指定します。

XMLサンプル CSVサンプル

４５６７

２

９

0：しない（既定）1：する

設定すると帳票定義削除時、このラベルに属する帳票定義が存在しない場合に自動で削除します。



１



ラベル参照可能なグループIDがセミコロン区切りで設定する。例）12;14;15※クリアしたい場合は、-1 を指定します。



８


・設定値なし　又は {ignore}の場合は、　何もしない。・処理区分がU:更新の場合は、又は　レコードが存在してマージ（更新）　の場合、権限情報は指定された　グループ内容で置き換えます。・参照権限のクリアのみ行いたい場合は、　値を”-1”固定とします。


３

ここまでは"カンマ"必須

<conmas><definitionLabelMaster><action>U</action><labelId>ラベルID</labelId><upperLabelId>{ignore}</upperLabelId><labelName>{ignore}</labelName><labelIconId>{ignore}</labelIconId><labelRemarks>{ignore}</labelRemarks><displayNumber>{ignore}</displayNumber><labelRoleGroup>グループIDを";"区切りで</labelRoleGroup>

</definitionLabelMaster></conmas>

U,ラベルID,{ignore},{ignore},{ignore},{ignore},{ignore},グループIDを";"区切りで


　帳票ラベルマスター取得ＡＰＩ仕様


　　


■登録ＩＤ値説明コマンドcommand コマンドID RESTコマンド識別文字列 GetReportLabelMastertype ファイルタイプ xml:XMLファイル、csv:CSVファイル必須encoding コードページ値エンコード用コードページ値







帳票ラベルマスターＸＭ



帳票ラベルマスター取得ＡＰＩ(GetReportLabelMaster)


= GetReportLabelMastertype

帳票ラベルマスターCSV

HTTP Request

HTTP


帳票ラベルマスター取得





reportLabelMaster 1..*labelId 1 ラベルＩＤupperLabelId 1 親ラベルＩＤlabelName 1 ラベル名称labelIconId 1 アイコンＩＤlabelRemarks 1 備考displayNumber 1 表示順registTerm 1 登録端末registUser 1 登録者registTime 1 登録日時updateTerm 1 更新端末updateUser 1 更新者updateTime 1 更新日時labelRoleGroup 1 ラベル参照権限グループ空の場合は、参照権限設定なし



ラベルＩＤ A:新規追加の場合は空とする △ 数値親ラベルＩＤ数値ラベル名称 A:新規追加の場合は必須 △ 文字列アイコンＩＤ 1～10の範囲の整数を設定 ◎ 数値備考文字列表示順数値登録端末文字列登録者文字列登録日時日時更新端末文字列更新者文字列更新日時日時ラベル参照グループ文字列空の場合は、参照権限設定なし


１３ラベル参照可能なグループIDがセミコロン区切りで設定される。例）12;14;15

１２

１２３４５６７８９

１０１１


　帳票ラベルマスター登録ＡＰＩ仕様


　　


■登録ＩＤ値説明コマンドcommand コマンドID RESTコマンド識別文字列 RegistReportLabelMastertype ファイルタイプ xml:XMLファイル、csv:CSVファイル必須encoding コードページ値エンコード用コードページ値dataFile データファイル登録用のXMLまたはCSVファイル必須


results 1result




帳票ラベルマスター登

or



定義ラベルマスター登録ＡＰＩ(RegistReportLabelMaster)


= RegistReportLabelMastertype

帳票ラベルマスター登録用

HTTP Request

HTTP

結果XML


帳票ラベルマスター登録





reportLabelMaster 1..*action 1 処理区分 ◎

labelId 1 ラベルＩＤ ◎ A:新規追加の場合は空とする

upperLabelId 1 親ラベルＩＤエレメントがない場合は、クリアlabelName 1 ラベル名称 ◎ A:新規追加の場合は必須labelIconId 1 アイコンＩＤ ◎ 1～10の範囲の整数を設定labelRemarks 1 備考エレメントがない場合は、クリアdisplayNumber 1 表示順 ◎ ”1”以上の値autoDelete 1 ラベル自動削除設定

labelRoleGroup 0..1 ラベル参照権限グループ




ラベルＩＤ A:新規追加の場合は空とする △ 数値

親ラベルＩＤ数値ラベル名称 A:新規追加の場合は必須 △ 文字列アイコンＩＤ 1～10の範囲の整数を設定 ◎ 数値備考文字列表示順 ◎ 数値 ”1”以上の値ラベル参照グループ文字列

ラベル自動削除設定数値

　XML,CSVサンプル

ラベル参照グループのみ更新するには、更新対象外としたい各項目に｛ignore｝を指定します。

　XMLサンプル　CSVサンプル


５６７

９


８



３４

２



１







システムキーモードONの場合はセット可能

ここまでは"カンマ"必須

<conmas><reportLabelMaster><action>U</action><labelId>ラベルID</labelId><upperLabelId>{ignore}</upperLabelId><labelName>{ignore}</labelName><labelIconId>{ignore}</labelIconId><labelRemarks>{ignore}</labelRemarks>

U,ラベルID,{ignore},{ignore},{ignore},{ignore},{ignore},グループIDを";"区切りで


　システムキーモード

以下を設定することで、アップロードXML,CSVのlabelId（ラベルID）を任意の値としてのシステムキーを指定することができますラベルIDが自動採番値であるのに対し、システムキーは任意のキーとなるため自動連携する際にi-Reporter内部からラベルIDを取得せずともシステムキーで連携できます

・ラベルAラベル名称

↑システムで自動採番 ↑お客様が任意で指定

■設定共通マスターキー共通キー：API_MODE共通項目名称：MST_LABEL_REP_KEY_MODE 0:通常 1:システムキーモード共通項目値：MST_GROUP_KEY_MODE 0:通常 1:システムキーモード

101 ラベルA… システムキー

A0001ラベルID

<labelRemarks>{ignore}</labelRemarks><displayNumber>{ignore}</displayNumber><labelRoleGroup>グループIDを";"区切りで</labelRoleGroup>

</reportLabelMaster></conmas>

連携プログラム帳票ラベルマスター登録API ラベルA

ラベルA

通常）ラベルIDを指定して更新

システムキーモード）

システムキーを指定して更新


　端末取得ＡＰＩ仕様


　　


■登録ＩＤ値説明コマンドcommand コマンドID RESTコマンド識別文字列 GetTerminaltype ファイルタイプ xml:XMLファイル、csv:CSVファイル必須encoding コードページ値エンコード用コードページ値







端末ＸＭＬ



端末取得ＡＰＩ(GetTerminal)


= GetTerminaltype

端末CSV

HTTP Request

HTTP


端末取得API呼び出し





terminal 1..*termId 1 端末ＩＤtermType 1 端末種別physicalId 1 端末物理ＩＤtermName 1 端末名称termRemarks 1 端末備考applicant 1 申請者ＩＤapplicantName 1 申請者名applicantDate 1 申請日applicantComment 1 申請コメントapprover 1 承認者ＩＤapproverName 1 承認者名approverDate 1 承認日registTerm 1 登録端末registUser 1 登録者registTime 1 登録日時updateTerm 1 更新端末updateUser 1 更新者updateTime 1 更新日時



端末ＩＤ数値端末種別文字列端末物理ＩＤ文字列端末名称文字列端末備考文字列申請者ＩＤ文字列申請者名文字列申請日日時申請コメント文字列承認者ＩＤ文字列承認者名文字列承認日日時登録端末文字列登録者文字列登録日時日時更新端末文字列更新者文字列更新日時日時１８

７８９

１０１１１２１３１４１５１６１７

６

１２３４５


URLスキーム取得


■URLスキーム取得ＩＤ値説明設定値command コマンドID RESTコマンド識別文字列 GetURLScheme



■カスタムURLスキーム情報ノード関係名称説明メモconmas ルート

urlScheme １カスタムURLスキーム i-R起動用カスタムURLスキーム jp.co.cimtops.ireporter:auth=XXXXXX


　ラベル削除ＡＰＩ仕様


　　

　機能説明

条件に合致したラベルを削除しますまた、"自動削除可能な設定になっているラベルの削除もおこなえます


ＩＤ値説明コマンドcommand コマンドID RESTコマンド識別文字列 DeleteLabel

labelType ラベルタイプ必須

labelId ラベルID 任意

labelName ラベル名称任意

labelNamePath ラベル名称パス任意

labelRemarks ラベル備考任意

registTimeFrom ラベルの作成日時（FROM）任意

registTimeTo ラベルの作成日時（TO）任意

updateTimeFrom ラベルの更新日時（FROM）任意

updateTimeTo ラベルの更新日時（TO）任意

childDelete 子ラベルの削除可否任意

削除するラベル種類を指定します。"def"：定義ラベル"rep"：帳票ラベル"common_document"：共通図書ラベル"report_document"：帳票別図書ラベル"image_document"：フリードロー用画像ラベル"common_custom_table"：カスタムマスターラベル

削除する対象ラベル備考※完全一致検索

削除するラベルのID※完全一致検索

0:削除対象となったラベル配下にラベルが存在すれば削除しない（規定）1:削除対象となったラベル配下のラベルもすべて削除する

削除するラベルの作成日時（FROM）"yyyy/MM/dd HH:mm:ss"フォーマット※時刻指定なし時は00:00:00固定

削除するラベルの作成日時（TO）"yyyy/MM/dd HH:mm:ss"フォーマット※時刻指定なし時は00:00:00固定

削除するラベルの更新日時（FROM）"yyyy/MM/dd HH:mm:ss"フォーマット※時刻指定なし時は00:00:00固定

削除するラベルの更新日時（TO）"yyyy/MM/dd HH:mm:ss"フォーマット※時刻指定なし時は00:00:00固定

削除する対象ラベル名称※完全一致検索

削除する対象ラベル名称パス※完全一致検索



帳票削除ＡＰＩ(DeleteLabel)


=DeleteLabel&（各種抽出条件）

HTTP Request

HTTP Response


ラベル削除ＡＰＩ呼び出し

結果XML


autoDelete ラベルの自動削除任意

executeCount 処理件数指定任意

削除処理を行うラベル件数を指定します。指定しない場合は制限なし。childDeleteを使用して削除した場合、子ラベル分はカウントされません。※要求タイムアウトエラー回避用

labelType:”rep かつ childDelete:”0"（規定）の場合のみ有効"1"を指定することで以下条件に一致した帳票ラベルを削除します。※"1"以外を指定しても本パラメーターは無視されます。削除対象となるラベル条件）・帳票が１つも紐づけられていない・子ラベルをもたない・ラベルの自動削除設定がON





remark 1..* 付帯情報ｎ executeCount="削除ラベル数"



　補足

■トランザクション1ラベル削除するごとにコミットします※childDeleteを指定して親ラベルを削除した場合でも１コミット

■リクエストパラメータ　executeCount（処理件数）について削除対象として検索された帳票IDの、”若い順から指定した処理件数分”だけ削除処理を行います。膨大な量の削除対象があったとしても、処理件数を指定した削除APIを連続してコールすることで確実にレスポンスが返ってきます。

■処理サンプル処理件数（executeCount）を指定し、レスポンスの ”successCount” が ”０” になるまで処理を継続することで削除可能なラベルが全て削除できます。

errorParameter="エラーコード：２のパラメーター異常の場合、パラメーター名を格納"


結果XML

API呼び出し

[レスポンス]executeCount = 0 か？

開始

終了

Yes

No


外部連携 web api i／f仕様書 - cimtops-support.com · 変更履歴 日付 変更内容...

Documents

外部連携 web api i／f仕様書 - cimtops-support.com · 変更履歴日付変更内容...