API docs by Redocly

SmartDB REST API (v3)

Download OpenAPI specification:Download

SmartDB では HTTPアクセスで実行可能なREST API を利用することが可能です。

APIの実行形式

SmartDBのREST APIは、下記の形式で実行できます。

https://{SmartDBドメイン}/hibiki/rest/3/{対象API}

REST API実行時のセッションについて

REST APIの実行にはSmartDBのセッションが必要となります。
セッションの利用方法は下記の3パターンが考えられます。

  • バインダトークンを利用して実行する。※バインダAPIオプション限定

    管理画面の「バインダトークン」画面で発行したトークンを利用してREST APIを実行します。
    実行時には後述の形式でHTTP Headerにトークンを指定してください。
    バインダトークンを利用してAPIを実行する場合、下記の特徴を持ちます。

    • トークンを実行するためのロボットユーザとして実行されます。
      ※ロボットユーザのタイムゾーンは+0900
    • ParameterのcsrfTokenは不要です。
    • バインダを指定するAPIの場合、トークンを設定したバインダにのみ権限を持ちます。
      ※バインダ参照とlookupなどを利用する場合、参照先にもトークンを設定する必要があります。

    HTTPヘッダーに以下を指定してください。

    Authorization: Bearer {トークン}

  • SmartDBにログインしているブラウザから実行する。※DCS、オンプレミス限定

    画面操作などによって、すでにSmartDBにログインをしてセッションを保持している状態でREST APIを実行します。
    特定のWEBページなどからJavaScriptで実行したい場合などに利用します。
    実現するためにはログインした画面と同一のドメインでWEBページを用意する必要があり、オンプレミス環境などサーバにモジュールを配置できる環境での利用を想定しています。

  • post /sessionを実行して、セッションを作成する。※非推奨

    ID/PASSWORDを指定してsession APIを実行してセッションを作成します。
    ここで作成したセッションを利用して、その他のREST APIを実行します。バッチ処理などを特定ユーザで実行したい場合などに利用します。
    プログラム中にユーザのID/パスワードを記述する必要があるため、セキュリティの観点からも非推奨とします。

V3の型について

日付(Date)

シリアライズ値にUNIXエポックからの経過時間(時間単位: ミリ秒)を利用します。(以後「UNIXミリ秒」とする)

ACCOUNT

アカウントに関するAPI

アカウントの情報検索

アカウントのタイプおよびアカウント名より部分一致検索するアカウントのデータを返却します。

Authorizations:
(cookieAuthcsrfTokenAuth) binderTokenAuth
query Parameters
name
required
string
Example: name=サンプル組織

アカウント名

type
Array of integers
Items Enum: 1 2 3 4
Example: type=2&type=3&type=4

アカウントのタイプ

  • 1: ユーザ
  • 2: 組織
  • 3: プロジェクト
  • 4: 役職
matchMode
string
Default: "SUBSTRING"
Enum: "PREFIX" "SUBSTRING"
Example: matchMode=PREFIX

キーワード検索のマッチモード

  • PREFIX: 前方一致
  • SUBSTRING: 中間一致
status
Array of integers
Items Enum: 0 1 5 6 7 8
Example: status=0&status=1&status=2

アカウントのステータス

  • 0: ログイン可能なユーザ/有効なグループ
  • 1: ファイル共有限定ユーザ
  • 5: システム管理者（ユーザ）
  • 6: コラボレーター
  • 7: ログイン不能コラボレーター
  • 8: ログイン不能ユーザ/廃止グループ/未確定

Responses

Response samples

Content type
application/json
[
  • {
    }
]

アカウントの詳細情報取得

アカウントのMIDより、アカウントの詳細情報を取得する。

Authorizations:
(cookieAuthcsrfTokenAuth) binderTokenAuth
path Parameters
account
required
integer <int32>
Example: 1000000

ログインユーザのMID

Responses

Response samples

Content type
application/json
Example
{
  • "id": 1000028,
  • "name": "サンプルユーザ",
  • "status": 0,
  • "recognizeInfo": "string",
  • "profile": {},
  • "lang": {
    },
  • "email": "sample@dreamarts.co.jp",
  • "key": "sample@dreamarts.co.jp",
  • "type": 1,
  • "primary": 2000011,
  • "primaryGroupName": "サンプル組織"
}

ユーザ情報の取得

与えられたアクセストークンから、対応のSmartDBユーザ情報を取得します。
ログインしていない状態でも本操作を実行できます。

Authorizations:
aadAuth
header Parameters
X-DA-AuthType
required
string
Value: "AzureAD"

認証タイプ

Responses

Response samples

Content type
application/json
Example
{
  • "id": 1000028,
  • "name": "サンプルユーザ",
  • "status": 0,
  • "recognizeInfo": "string",
  • "profile": {},
  • "lang": {
    },
  • "email": "sample@dreamarts.co.jp",
  • "key": "sample@dreamarts.co.jp",
  • "type": 1,
  • "primary": 2000011,
  • "primaryGroupName": "サンプル組織"
}

ロール取得

指定したアカウントに対してロール（管理者設定）を取得する。

Authorizations:
(cookieAuthcsrfTokenAuth) binderTokenAuth
path Parameters
account
required
integer <int32>
Example: 1000000

ログインユーザのMID

query Parameters
direct
boolean
Default: true

所属グループの持つロールも継承して取得するか。

  • true: ロールを継承しない。
  • false: ロールを継承する。

Responses

Response samples

Content type
application/json
{
  • "account": {
    },
  • "roles": [
    ]
}

ロール追加

指定したアカウントに対してロールを追加する。
※Basicプランでは使用しないでください。

Authorizations:
(cookieAuthcsrfTokenAuth) binderTokenAuth
path Parameters
account
required
integer <int32>
Example: 1000000

ログインユーザのMID

Request Body schema: application/json
roles
required
string

追加するロールを指定。
カンマ区切りの文字列で複数指定できる。
指定可能なロール

  • smartdbAdmin : SmartDB全体管理者
  • processAdmin : 全体プロセス管理者
  • processDefinitionAdmin : 業務プロセス追加可能者
  • processProxyAdmin : 全体プロセス進行管理者
  • baasAdmin : Baas管理者
  • betaUser : β版利用ユーザ

※ baasAdmin、betaUserはDCS、オンプレミスでは利用されません。

Responses

Request samples

Content type
application/json
{
  • "roles": "smartdbAdmin,processAdmin,baasAdmin"
}

Response samples

Content type
application/json
{
  • "account": {
    },
  • "roles": [
    ]
}

ロール削除

指定したアカウントに対してロールを削除する。
※Basicプランでは使用しないでください。

Authorizations:
(cookieAuthcsrfTokenAuth) binderTokenAuth
path Parameters
account
required
integer <int32>
Example: 1000000

ログインユーザのMID

Request Body schema: application/json
roles
required
string

削除するロールを指定。
カンマ区切りの文字列で複数指定できる。
指定可能なロール

  • smartdbAdmin : SmartDB全体管理者
  • processAdmin : 全体プロセス管理者
  • processDefinitionAdmin : 業務プロセス追加可能者
  • processProxyAdmin : 全体プロセス進行管理者
  • baasAdmin : Baas管理者
  • betaUser : β版利用ユーザ

Responses

Request samples

Content type
application/json
{
  • "roles": "smartdbAdmin,processAdmin,baasAdmin"
}

Response samples

Content type
application/json
{
  • "account": {
    },
  • "roles": [
    ]
}

アカウントキャッシュ最終更新時間取得

アカウントキャッシュの最終更新時間を取得する。
リクエストには以下のいずれかが必要です。

  • Basicプランの場合
    • セッションユーザがシステム管理者である
  • DCS、オンプレミスの場合
    • リクエスト元がシステム設定 (hibiki.xml) のwebServiceHostsに指定されている
    • このエンドポイントがシステム初期値設定 (default.xml) のsystem.web-service-hosts.whitelistで指定されている
    • セッションユーザがシステム管理者である

Responses

Response samples

Content type
application/json
{
  • "lastUpdateDate": 1666058307000
}

アカウントキャッシュ同期

アカウントキャッシュを同期する。
リクエストには以下のいずれかが必要です。

  • Basicプランの場合
    • セッションユーザがシステム管理者である
  • DCS、オンプレミスの場合
    • リクエスト元がシステム設定 (hibiki.xml) のwebServiceHostsに指定されている
    • このエンドポイントがシステム初期値設定 (default.xml) のsystem.web-service-hosts.whitelistで指定されている
    • セッションユーザがシステム管理者である
Request Body schema: application/json

強制同期フラグ。

  • true:強制的に同期する。
  • false:アカウント情報に差分がある場合のみ同期する。
force
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "force": false
}

Response samples

Content type
application/json
{
  • "status": "synchronizing"
}

ROLE

ロールに関するAPI

ロール一覧取得

SmartDBの管理者ロールとメンバアカウントの一覧を取得します。

Authorizations:
(cookieAuthcsrfTokenAuth) binderTokenAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

ロールのアカウント取得

指定した管理者ロールとメンバアカウントを取得します。

Authorizations:
(cookieAuthcsrfTokenAuth) binderTokenAuth
path Parameters
role
required
string (role)
Enum: "smartdbAdmin" "processAdmin" "processDefinitionAdmin" "processProxyAdmin" "baasAdmin" "betaUser"

ロール

  • smartdbAdmin : SmartDB全体管理者
  • processAdmin : 全体プロセス管理者
  • processDefinitionAdmin : 業務プロセス追加可能者
  • processProxyAdmin : 全体プロセス進行管理者
  • baasAdmin : Baas管理者
  • betaUser : β版利用ユーザ

Responses

Response samples

Content type
application/json
{
  • "accounts": [
    ],
  • "role": "smartdbAdmin"
}

BINDER

バインダに関するAPI

バインダ一覧取得

バインダ一覧のデータを返却します。
バインダごとに基本的な情報を返却します。

Authorizations:
(cookieAuthcsrfTokenAuth) binderTokenAuth
query Parameters
parent
integer <int64>

検索対象の親キャビネットを指定。
指定したキャビネットの直下のみが検索対象となる。

type
Array of integers
Default: 1
Items Enum: 1 2

検索対象のバインダタイプ。
両方含める場合は二つとも指定する(type=1&type=2)

  • 1: バインダ
  • 2: キャビネット
keyword
string

バインダ名検索

favorite
boolean
Default: false

よく使うバインダのみ検索対象とするか

offset
integer <int32>
Default: 0

取得対象のうち、スキップする件数を指定する。
デフォルトは0となり、先頭から取得される。
例: 11件目以降を取得したい場合は10を指定する

limit
integer <int32>

取得数の上限。デフォルトは無制限

sort
string
Default: "BinderId:ASC"
Enum: "BinderId:ASC" "BinderId:DESC" "Name:ASC" "Name:DESC" "PhoneticName:ASC" "PhoneticName:DESC" "UpdateDate:ASC" "UpdateDate:DESC"

ソート

  • BinderId:ASC : バインダIDの昇順
  • BinderId:DESC : バインダIDの降順
  • Name:ASC : バインダ名の昇順
  • Name:DESC : バインダ名の降順
  • PhoneticName:ASC : バインダ名(かな)の昇順
  • PhoneticName:DESC : バインダ名(かな)の降順
  • UpdateDate:ASC : 更新日時の昇順
  • UpdateDate:DESC : 更新日時の降順
mobileAvailable
boolean
Default: false

ビュー定義にモバイルタイプを利用しているバインダのみか

Responses

Response samples

Content type
application/json
[
  • {
    }
]

バインダ詳細情報取得

指定されたバインダの詳細な情報を返却します。

Authorizations:
(cookieAuthcsrfTokenAuth) binderTokenAuth
path Parameters
required
整数値 (integer) or 文字列 (string)

バインダIDもしくはキー

Responses

Response samples

Content type
application/json
Example
{
  • "favorite": true,
  • "favoriteDate": 1618205903000,
  • "id": 10077,
  • "key": "binderKey",
  • "name": "サンプルバインダ",
  • "type": 1,
  • "description": "string",
  • "owner": {
    },
  • "parent_id": 0,
  • "created_at": 1597039620000,
  • "created": {
    },
  • "updated_at": 1597039620000,
  • "updated": {
    },
  • "restricted": false,
  • "template": false,
  • "draft": false,
  • "binderManagers": [
    ],
  • "formDesigners": [
    ],
  • "documentManagers": [
    ],
  • "icon": {
    },
  • "displayNewDocLink": true,
  • "used_at": 1618205903000,
  • "permission": {
    },
  • "items": [
    ]
}

部品定義情報取得

部品定義を取得します。

Authorizations:
(cookieAuthcsrfTokenAuth) binderTokenAuth
path Parameters
required
整数値 (integer) or 文字列 (string)

バインダIDもしくはキー

required
integer or string

部品IDもしくはキー

Responses

Response samples

Content type
application/json
Example
{
  • "type": "Text",
  • "id": 10001,
  • "key": "itemKey",
  • "name": "サンプル部品",
  • "mustInput": true,
  • "editable": true,
  • "reusable": true,
  • "description": "string",
  • "displayDescriptionForEditingOnly": false,
  • "decorator": {
    },
  • "readOnlyMode": false,
  • "defaultValue": "string",
  • "size": 25,
  • "targetBinderId": 0,
  • "refItemId": 0
}

よく使うバインダ一覧取得

よく使うバインダ一覧を取得する。

Authorizations:
(cookieAuthcsrfTokenAuth) binderTokenAuth
query Parameters
mobileAvailable
boolean
Default: false

ビュー定義にモバイルタイプを利用しているバインダのみか

Responses

Response samples

Content type
application/json
[
  • {
    }
]

よく使うバインダ一覧に追加

よく使う一覧に追加

Authorizations:
(cookieAuthcsrfTokenAuth) binderTokenAuth
path Parameters
required
整数値 (integer) or 文字列 (string)

バインダIDもしくはキー

Responses

Response samples

Content type
application/json
Example
{
  • "favorite": true,
  • "favoriteDate": 1618205903000,
  • "id": 10077,
  • "key": "binderKey",
  • "name": "サンプルバインダ",
  • "type": 1,
  • "description": "string",
  • "owner": {
    },
  • "parent_id": 0,
  • "created_at": 1597039620000,
  • "created": {
    },
  • "updated_at": 1597039620000,
  • "updated": {
    },
  • "restricted": false,
  • "template": false,
  • "draft": false,
  • "binderManagers": [
    ],
  • "formDesigners": [
    ],
  • "documentManagers": [
    ],
  • "icon": {
    },
  • "displayNewDocLink": true
}

よく使うバインダ一覧から削除

よく使う一覧から削除

Authorizations:
(cookieAuthcsrfTokenAuth) binderTokenAuth
path Parameters
required
整数値 (integer) or 文字列 (string)

バインダIDもしくはキー

Responses

Response samples

Content type
application/json
Example
{
  • "favorite": true,
  • "favoriteDate": 1618205903000,
  • "id": 10077,
  • "key": "binderKey",
  • "name": "サンプルバインダ",
  • "type": 1,
  • "description": "string",
  • "owner": {
    },
  • "parent_id": 0,
  • "created_at": 1597039620000,
  • "created": {
    },
  • "updated_at": 1597039620000,
  • "updated": {
    },
  • "restricted": false,
  • "template": false,
  • "draft": false,
  • "binderManagers": [
    ],
  • "formDesigners": [
    ],
  • "documentManagers": [
    ],
  • "icon": {
    },
  • "displayNewDocLink": true
}

ビュー一覧取得

ビュー一覧のデータを返却します。
ビューごとに基本的な情報を返却します。

Authorizations:
(cookieAuthcsrfTokenAuth) binderTokenAuth
path Parameters
required
整数値 (integer) or 文字列 (string)

バインダIDもしくはキー

Responses

Response samples

Content type
application/json
[
  • {
    }
]

ビュー詳細情報取得

ビューの詳細データを返却します。

Authorizations:
(cookieAuthcsrfTokenAuth) binderTokenAuth
path Parameters
required
整数値 (integer) or 文字列 (string)

バインダIDもしくはキー

required
integer or string

ビューIDもしくはキー

Responses

Response samples

Content type
application/json
Example
{
  • "id": 10001,
  • "name": "サンプルビュー",
  • "key": "viewKey",
  • "created_at": 1597039620000,
  • "created": {
    },
  • "updated_at": 1597039620000,
  • "updated": {
    },
  • "defaultSort": [
    ],
  • "defaultView": true,
  • "displayInfoIcon": true,
  • "columns": [
    ],
  • "useCacheTable": false,
  • "forDeletedDocument": false,
  • "group": "NORMAL_DOC_VIEW",
  • "viewType": "MOBILE",
  • "display": false,
  • "mobileProperty": {
    },
  • "permission": {
    }
}

DOCUMENT

文書に関するAPI

リスト型部品一覧取得

指定されたリスト型ブロックの全ての繰り返し行を取得する

Authorizations:
(cookieAuthcsrfTokenAuth) binderTokenAuth
path Parameters
required
整数値 (integer) or 文字列 (string)

バインダIDもしくはキー

document
required
integer <int64>

文書番号

required
整数値 (integer) or 文字列 (string)

ブロックIDもしくはキー

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "key": "string",
  • "name": "string",
  • "rows": [
    ]
}

リスト型部品削除

指定されたリスト型ブロックの全ての繰り返し行を削除する

Authorizations:
(cookieAuthcsrfTokenAuth) binderTokenAuth
path Parameters
required
整数値 (integer) or 文字列 (string)

バインダIDもしくはキー

document
required
integer <int64>

文書番号

required
整数値 (integer) or 文字列 (string)

ブロックIDもしくはキー

Responses

Response samples

Content type
application/json
{
  • "code": 400,
  • "message": "error message",
  • "messages": [
    ]
}

リスト型部品の行新規登録

行データを指定された値で登録します。
引数に指定しなかった部品は、部品定義で初期値に指定された値で登録します。

Authorizations:
(cookieAuthcsrfTokenAuth) binderTokenAuth
path Parameters
required
整数値 (integer) or 文字列 (string)

バインダIDもしくはキー

document
required
integer <int64>

文書番号

required
整数値 (integer) or 文字列 (string)

ブロックIDもしくはキー

query Parameters
deleteTempFile
boolean
Default: true

部品値に利用した一時ファイルを削除するか

Request Body schema: application/json
additional property
textLikeItemInput (string) or numberItemInput (number) or choiceLikeItemInput (string) or dateItemInput (string) or imageItemInput (string) or fileItemInput (string) or accountChoiceItemInput (string) or accountPulldownItemInput (number) or linkItemInput (string) or docLinkItemInput (string) or binderLinkItemInput (string) or dataRecordSelectorItemInput (number) or categoryItemInput (number)

Responses

Request samples

Content type
application/json
{
  • "property1": "string",
  • "property2": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "key": "string",
  • "name": "string",
  • "rows": [
    ]
}

リスト型部品の行更新

指定されたリスト型部品の行を更新します。
引数に指定しなかった部品の値は変更されません。

Authorizations:
(cookieAuthcsrfTokenAuth) binderTokenAuth
path Parameters
required
整数値 (integer) or 文字列 (string)

バインダIDもしくはキー

document
required
integer <int64>

文書番号

required
整数値 (integer) or 文字列 (string)

ブロックIDもしくはキー

row
required
integer <int64>

行番号

query Parameters
deleteTempFile
boolean
Default: true

部品値に利用した一時ファイルを削除するか

Request Body schema: application/json
additional property
textLikeItemInput (string) or numberItemInput (number) or choiceLikeItemInput (string) or dateItemInput (string) or imageItemInput (string) or fileItemInput (string) or accountChoiceItemInput (string) or accountPulldownItemInput (number) or linkItemInput (string) or docLinkItemInput (string) or binderLinkItemInput (string) or dataRecordSelectorItemInput (number) or categoryItemInput (number)

Responses

Request samples

Content type
application/json
{
  • "property1": "string",
  • "property2": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "key": "string",
  • "name": "string",
  • "rows": [
    ]
}

リスト型部品の行削除

指定されたリスト型部品の行を削除します。

Authorizations:
(cookieAuthcsrfTokenAuth) binderTokenAuth
path Parameters
required
整数値 (integer) or 文字列 (string)

バインダIDもしくはキー

document
required
integer <int64>

文書番号

required
整数値 (integer) or 文字列 (string)

ブロックIDもしくはキー

row
required
integer <int64>

行番号

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "key": "string",
  • "name": "string",
  • "rows": [
    ]
}

文書新規登録

文書を指定された値で登録します。
引数に指定しなかった部品は、部品定義で初期値に指定された値で登録します。
戻り値として部品のデータは返却されません。

Authorizations:
(cookieAuthcsrfTokenAuth) binderTokenAuth
path Parameters
required
整数値 (integer) or 文字列 (string)

バインダIDもしくはキー

query Parameters
skipItemControlCheck
boolean
Default: false

部品制御の入力チェック（必須入力制御、入力値チェック、重複チェック）をスキップするか。

docType
string
Default: "NORMAL"
Enum: "NORMAL" "DRAFT"

文書タイプを指定する

  • NORMAL: 正式文書
  • DRAFT: 下書き文書
deleteTempFile
boolean
Default: true

部品値に利用した一時ファイルを削除するか

Request Body schema: application/json
additional property
textLikeItemInput (string) or numberItemInput (number) or choiceLikeItemInput (string) or dateItemInput (string) or imageItemInput (string) or fileItemInput (string) or accountChoiceItemInput (string) or accountPulldownItemInput (number) or linkItemInput (string) or docLinkItemInput (string) or binderLinkItemInput (string) or dataRecordSelectorItemInput (number) or categoryItemInput (number)

Responses

Request samples

Content type
application/json
{
  • "property1": "string",
  • "property2": "string"
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "name": "string",
  • "created": {
    },
  • "created_at": 1648097168000,
  • "updated": {
    },
  • "updated_at": 1648097168000,
  • "cabinetId": 0,
  • "items": [
    ],
  • "commentCount": 0,
  • "counters": [
    ],
  • "permission": {
    }
}

文書詳細情報取得

指定された文書番号の文書データを返却します。
フォーム定義画面で配置されたすべての部品データが返却されます。

Authorizations:
(cookieAuthcsrfTokenAuth) binderTokenAuth
path Parameters
required
整数値 (integer) or 文字列 (string)

バインダIDもしくはキー

document
required
integer <int64>

文書番号

query Parameters
fields
string
Value: "form"

formが指定された場合、フォーム定義の情報を返却します。

docType
string
Value: "DRAFT"

下書き文書の情報を取得する場合はDRAFTを指定してください。

loadRefDoc
boolean
Default: false

バインダ参照ボタンの値である参照先文書の取得するか指定します。

  • true:参照先文書の値も取得する（性能懸念があるため非推奨）
  • false:取得しない（デフォルト）

制限事項：下記の情報は取得できません。

  • テキスト(1行)部品のバインダ参照
  • 参照先文書が持つリスト型部品の値
  • 参照先文書が持つバインダ参照部品の値
operation
string
Value: "reuse"

このパラメータを指定すると、指定された文書番号の文書データを再利用する場合の文書データを返します。
フォーム定義画面で配置されたすべての部品データが返却されます。
部品に「再利用しない」設定がされている場合は、部品の初期値を返します。

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "name": "string",
  • "created": {
    },
  • "created_at": 1648097168000,
  • "updated": {
    },
  • "updated_at": 1648097168000,
  • "cabinetId": 0,
  • "items": [
    ],
  • "commentCount": 0,
  • "counters": [
    ],
  • "permission": {
    },
  • "fields": {
    }
}

文書更新

指定された文書番号の文書を更新します。
引数に指定しなかった部品の値は変更されません。

Authorizations:
(cookieAuthcsrfTokenAuth) binderTokenAuth
path Parameters
required
整数値 (integer) or 文字列 (string)

バインダIDもしくはキー

document
required
integer <int64>

文書番号

query Parameters
skipItemControlCheck
boolean
Default: false

部品制御の入力チェック（必須入力制御、入力値チェック、重複チェック）をスキップするか。

docType
string
Default: "NORMAL"
Enum: "NORMAL" "DRAFT"

文書タイプを指定する

  • NORMAL: 正式文書
  • DRAFT: 下書き文書
deleteTempFile
boolean
Default: true

部品値に利用した一時ファイルを削除するか

updated_at
string <date-time>

文書更新の排他制御のため更新対象文書の最終更新日時を指定。
指定した日時と対象文書の最終更新日時が不一致の場合はエラーとなり更新できない。

func
string
Value: "undraft"

ドラフト文書を正式文書にする場合にdocType=draftと合わせて指定

Request Body schema: application/json
additional property
textLikeItemInput (string) or numberItemInput (number) or choiceLikeItemInput (string) or dateItemInput (string) or imageItemInput (string) or fileItemInput (string) or accountChoiceItemInput (string) or accountPulldownItemInput (number) or linkItemInput (string) or docLinkItemInput (string) or binderLinkItemInput (string) or dataRecordSelectorItemInput (number) or categoryItemInput (number)

Responses

Request samples

Content type
application/json
{
  • "property1": "string",
  • "property2": "string"
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "name": "string",
  • "created": {
    },
  • "created_at": 1648097168000,
  • "updated": {
    },
  • "updated_at": 1648097168000,
  • "cabinetId": 0,
  • "items": [
    ],
  • "commentCount": 0,
  • "counters": [
    ],
  • "permission": {
    }
}

文書削除

指定された文書番号の文書を削除します

Authorizations:
(cookieAuthcsrfTokenAuth) binderTokenAuth
path Parameters
required
整数値 (integer) or 文字列 (string)

バインダIDもしくはキー

document
required
integer <int64>

文書番号

query Parameters
docType
string
Value: "DRAFT"

下書きを削除する場合はDRAFTを指定してください。
注意：下書き削除はオーナーしかできません。オーナー以外のユーザで削除すると、404 Not Foundになります。

Responses

Response samples

Content type
application/json
{
  • "code": 400,
  • "message": "error message",
  • "messages": [
    ]
}

ブランチ文書取得

対象文書の対象ブランチ部品のブランチ文書を取得する

Authorizations:
(cookieAuthcsrfTokenAuth) binderTokenAuth
path Parameters
required
整数値 (integer) or 文字列 (string)

バインダIDもしくはキー

document
required
integer <int64>

文書番号

required
integer or string

ブランチ部品IDもしくはキー

query Parameters
pageNumber
integer <int32>
Default: 1
pageSize
integer <int32>

デフォルトはブランチ部品に指定されたビュー定義に従う

offset
integer <int32>

取得対象のうち、スキップする件数を指定する。
デフォルトは0となり、先頭から取得される。
例: 11件目以降を取得したい場合は10を指定する

pageNumber, pageSizeの指定がある場合はそちらが優先される

limit
integer <int32>

デフォルトはブランチ部品に指定されたビュー定義の「1ページの表示件数」に従う

Responses

Response samples

Content type
application/json
{
  • "pageNumber": 0,
  • "pageSize": 0,
  • "totalCount": 0,
  • "documents": [
    ]
}

自動再計算の履歴リスト取得

文書が起こった自動再計算の履歴リストを取得します。

Authorizations:
(cookieAuthcsrfTokenAuth) binderTokenAuth
path Parameters
required
整数値 (integer) or 文字列 (string)

バインダIDもしくはキー

document
required
integer <int64>

文書番号

query Parameters
status
string
Example: status=RUNNING

再計算の状態を指定できます。カンマ区切りで複数指定できます。

  • WAITING: 自動再計算の処理を受け付けました。
  • PREPARING: 自動再計算の対象文書を絞り込んでいます。
  • PREPARED: 自動再計算の対象文書情報を取得しました。
  • RUNNING: 自動再計算を実行しています。
  • COMPLETED: 自動再計算を完了しました。
  • SKIP: 対象文書がないので、自動再計算の処理をスキップしました。
  • ERROR: 異常状態になりました。

Responses

Response samples

Content type
application/json
[
  • {
    }
]

自動再計算の履歴取得

文書が起こった自動再計算の中に、一番近い方を取得します。

Authorizations:
(cookieAuthcsrfTokenAuth) binderTokenAuth
path Parameters
required
整数値 (integer) or 文字列 (string)

バインダIDもしくはキー

document
required
integer <int64>

文書番号

Responses

Response samples

Content type
application/json
{
  • "id": 2483,
  • "targetBinderId": 10243,
  • "targetDocNum": 2304,
  • "executedDocNum": 2304,
  • "status": "COMPLETED",
  • "createDate": 1679289272000,
  • "startDate": 1679289272000,
  • "endDate": 1679289272000,
  • "failedRecordIds": [
    ]
}

指定したビューの文書一覧取得

指定されたバインダ、およびビューで表示される文書一覧を返却します。
返却される文書の部品データはURLに指定したビューIDの表示項目にある部品のみです。
表示項目に指定されていない部品のデータは返却されません。

Authorizations:
(cookieAuthcsrfTokenAuth) binderTokenAuth
path Parameters
required
整数値 (integer) or 文字列 (string)

バインダIDもしくはキー

required
integer or string

ビューIDもしくはキー

query Parameters
pageNumber
integer <int32>
Default: 1

ページ番号

pageSize
integer <int32>
Example: pageSize=20

ページサイズ
デフォルトはビューの表示件数

offset
integer <int32>
Default: 0

取得対象のうち、スキップする件数を指定する。
デフォルトは0となり、先頭から取得される。
例: 11件目以降を取得したい場合は10を指定する

pageNumber, pageSizeの指定がある場合はそちらが優先される

limit
integer <int32>
Example: limit=20

取得する文書数の上限
デフォルトはビューの表示件数

sort
string
Example: sort=regDate:DESC,10003:ASC

ソート
項目名または部品IDと"ASC"か"DESC"を":"で結合した文字列
複数指定の場合はカンマ区切り

ソート可能な基本情報一覧：

  • RecordId:文書番号
  • RegDate:登録日時
  • RegAccount:登録者
  • LastUpdDate:更新日時
  • LastUpdAccount:更新者
  • Title:文書タイトル

ソート可能な部品一覧：

  • 文字列入力ボックス
  • 数値入力ボックス
  • 複数選択
  • 単一選択(項目)
  • 単一選択(メニュー)
  • 入力可能な単一選択(メニュー)
  • 日付選択
  • アカウント選択(ポップアップ)
  • アカウント選択(メニュー)
  • 自動採番
  • 自動更新部品
  • カテゴリ
object
Example: 10001=sample:EXACT&text_key=sample:EXACT

実際には"item_key"ではなく部品ID、部品キーを指定する
複数の部品を指定した場合はAND条件での検索になる
マッチモードを指定する場合は":"で区切ります

検索条件を指定できる部品一覧

  • 文字列入力ボックス: 文字サイズが480byteを超えている部品は検索対象外となります。
  • 数値部品: カンマ区切りで数値の範囲指定検索も可能です。
    • 指定した値と等しい 例 : 部品キー=3（数値部品の値は3と等しい文書を検索します。）
    • 指定した値以上 例 : 部品キー=3,（数値部品の値は3以上の文書を検索します。）
    • 指定した値以下 例 : 部品キー=,3（数値部品の値は3以下の文書を検索します。）
    • 指定した値の範囲内 例 : 部品キー=3,5（数値部品の値は3以上、5以下文書を検索します。）
  • 文書入力エリア: 文字サイズが480byteを超えている部品は検索対象外となります。
  • 複数選択部品（チェックボックス）: 対象の選択項目は選択項目定義のIDを指定して下さい。カンマ区切りで複数指定可能です。
    マッチモードのEXACTを指定した場合、指定した項目が過不足なく一致する文書が検索結果として返却されます。
  • 単一選択（項目）: 対象の選択項目は選択項目定義のIDを指定して下さい。カンマ区切りで複数指定可能です。
  • 単一選択（メニュー）: 対象の選択項目は選択項目定義のIDを指定して下さい。カンマ区切りで複数指定可能です。
  • 入力可能な単一選択（メニュー）: 検索条件には文字列を指定して下さい。選択項目定義のIDは指定できません。
  • 日付選択部品: カンマ区切りで範囲指定する必要があります。 （フォーマットと指定方法は文書一覧取得のパラメータRegDateを参照）
  • アカウント選択（ポップアップ）: 対象アカウントの内部ID（MID,GID）を指定して下さい。カンマ区切りで複数指定可能です。
  • アカウント選択（メニュー）: 対象アカウントの内部ID（MID,GIDを指定して下さい。カンマ区切りで複数指定可能です。
  • カテゴリ: 対象のカテゴリIDを指定して下さい。
  • 文書リンク部品: リンク先のバインダキーまたはバインダIDおよびリンク先の文書番号をハイフン区切りで指定して下さい。
    例：部品キー=10023-10（バインダID:10023、文書番号:10の文書をリンクしている文書を検索）
  • バインダ参照ボタン部品: 参照先文書の文書番号を指定して下さい。カンマ区切りで複数指定可能です。
  • 自動更新部品: テキスト型の場合は文字列入力ボックスと同じ、数値型の場合は数値部品と同じ指定の仕方となります。

部品検索におけるマッチモードで指定可能なパターン一覧

  • EXACT: 指定された条件に完全一致で検索します。
    対象部品:
    • 文字列入力ボックス
    • 文書入力エリア
    • 複数選択部品（チェックボックス）
    • 入力可能な単一選択（メニュー）
  • SUBSTRING: 指定された条件と部分一致で検索します。大文字小文字は区別しません。
    対象部品:
    • 文字列入力ボックス
    • 文書入力エリア
    • 入力可能な単一選択（メニュー）
  • PREFIX: 指定された条件と前方一致で検索します。大文字小文字は区別しません。
    対象部品:
    • 文字列入力ボックス
    • 文書入力エリア
    • 入力可能な単一選択（メニュー）
  • SUFFIX: 指定された条件と後方一致で検索します。大文字小文字は区別しません。
    対象部品:
    • 文字列入力ボックス
    • 文書入力エリア
    • 入力可能な単一選択（メニュー）
  • ONE_INCLUDE_CHILDREN: 指定された条件の所属ユーザや子グループなどの子要素も検索します。
    対象部品:
    • アカウント選択（ポップアップ）
    • アカウント選択（メニュー） OR検索、検索条件の子項目でもヒットする。
  • ONE_INCLUDE_PARENTS: 指定された条件の所属グループや親組織などの親要素も検索します。
    対象部品:
    • アカウント選択（ポップアップ）
    • アカウント選択（メニュー）
*
string <{keywords}:{matchMode}>
Example: *=検索 キーワード:ONE

部品を指定しない全文検索
複数キーワードを指定する場合は半角スペースで区切る

マッチモードは":"で区切って指定する

  • ONE: いずれかのキーワードに一致する
  • ALL: 全てのキーワードに一致する
RegAccount
string
Example: RegAccount=2000000,2000001

登録者のOR検索
アカウントMIDを指定
複数指定の場合はカンマ区切り

RegDate
string
Example: RegDate=2022-09-05,2022-10-05T11:30:00+9000

登録日時

指定可能なフォーマット

  • yyyy-MM-dd 年月日のみ指定(例. 2013-04-20)
  • yyyy-MM-dd'T'HH:mm:ss タイムゾーン指定なし、セッションユーザのタイムゾーンを利用する(例. 2013-04-20T16:47:42)
  • yyyy-MM-dd'T'HH:mm:ssZ タイムゾーン指定(例. 2013-04-20T16:47:42+0900)

範囲指定

  • {開始日時}, 例：2013-04-20,（更新日時が2013-04-20 00:00:00以後の文書を検索する。）
  • {開始日時},{終了日時} 例：2013-04-20,2017-06-16（登録日時が2013-04-20 00:00:00〜2017-06-016 23:59:59間の文書を検索する。）
  • ,{終了日時} 例：,2017-06-16（登録日時が2017-06-16 23:59:59以前の文書を検索する。）
LastUpdAccount
string
Example: LastUpdAccount=2000000,2000001

最終更新者のOR検索
アカウントMIDを指定
複数指定の場合はカンマ区切り

LastUpdDate
string
Example: LastUpdDate=2022-09-05,2022-10-05T11:30:00+9000

最終更新日時
指定方法はRegDate参照

loadRefDoc
boolean
Default: false

バインダ参照ボタンの値である参照先文書の取得するか指定します。

  • true: 参照先文書の値も取得する（性能懸念があるため非推奨）
  • false: 取得しない（デフォルト）

制限事項：下記の情報は取得できません。

  • テキスト(1行)部品のバインダ参照
  • 参照先文書が持つリスト型部品の値
  • 参照先文書が持つバインダ参照部品の値

Responses

Response samples

Content type
application/json
{
  • "documents": [
    ],
  • "totalCount": 100,
  • "pageSize": 20
}

指定したビューの文書詳細情報取得

指定された文書番号の文書データを返却します。
ビュー定義で「表示項目」に指定された部品のみが返却されます。
{view}にはビューID、ビューキー、ビュー名称のいずれかを指定してください。
ビュー名称が他のビューのビューID,またはビューキーと同一の文字列であった場合、ビューID,またはビューキーの値を優先して取得するため、該当ビュー名称のデータは返却されません。

Authorizations:
(cookieAuthcsrfTokenAuth) binderTokenAuth
path Parameters
required
整数値 (integer) or 文字列 (string)

バインダIDもしくはキー

required
integer or string

ビューIDもしくはキー

document
required
integer <int64>

文書番号

query Parameters
loadRefDoc
boolean
Default: false

バインダ参照ボタンの値である参照先文書の取得するか指定します。

  • true:参照先文書の値も取得する（性能懸念があるため非推奨）
  • false:取得しない（デフォルト）

制限事項：下記の情報は取得できません。

  • テキスト(1行)部品のバインダ参照
  • 参照先文書が持つリスト型部品の値
  • 参照先文書が持つバインダ参照部品の値

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "name": "string",
  • "created": {
    },
  • "created_at": 1648097168000,
  • "updated": {
    },
  • "updated_at": 1648097168000,
  • "cabinetId": 0,
  • "items": [
    ],
  • "commentCount": 0,
  • "counters": [
    ],
  • "permission": {
    }
}

部品値分布取得

指定されたバインダとビューで表示される一覧文書を対象に、パラメータのitemsで指定された部品に対して、部品の値と出現回数のペアを部品値の昇順リストで取得します。
指定可能な部品タイプは単一選択項目、単一選択メニュー、複数選択項目、入力可能な単一選択メニュー、アカウントポップアップ選択部品、アカウント選択メニュー、バインダ参照ボタン、カテゴリ部品、日付部品です。
対象部品はビューの表示項目に含まれていなくても問題ありません。
リスト型部品や、リスト型部品に含まれている部品はサポートしていません。

Authorizations:
(cookieAuthcsrfTokenAuth) binderTokenAuth
path Parameters
required
整数値 (integer) or 文字列 (string)

バインダIDもしくはキー

required
integer or string

ビューIDもしくはキー

query Parameters
items
required
string
Example: items=10001,someItemKey

部品データバリエーションの対象部品キーまたは部品番号を指定して下さい。
複数部品の指定はカンマ「,」区切りです。
戻り値は複数部品の場合はitemsパラメータの順番で並ぶ。

object
Example: 10001=sample:EXACT&text_key=sample:EXACT

実際には"item_key"ではなく部品ID、部品キーを指定する
詳細は文書一覧取得を参照

*
string <{keywords}:{matchMode}>
Example: *=検索 キーワード:ONE

部品を指定しない全文検索
複数キーワードを指定する場合は半角スペースで区切る

マッチモードは":"で区切って指定する

  • ONE: いずれかのキーワードに一致する
  • ALL: 全てのキーワードに一致する
RegAccount
string
Example: RegAccount=2000000,2000001

登録者のOR検索
アカウントMIDを指定
複数指定の場合はカンマ区切り

RegDate
string
Example: RegDate=2022-09-05,2022-10-05T11:30:00+9000

登録日時

指定可能なフォーマット

  • yyyy-MM-dd 年月日のみ指定(例. 2013-04-20)
  • yyyy-MM-dd'T'HH:mm:ss タイムゾーン指定なし、セッションユーザのタイムゾーンを利用する(例. 2013-04-20T16:47:42)
  • yyyy-MM-dd'T'HH:mm:ssZ タイムゾーン指定(例. 2013-04-20T16:47:42+0900)

範囲指定

  • {開始日時}, 例：2013-04-20,（更新日時が2013-04-20 00:00:00以後の文書を検索する。）
  • {開始日時},{終了日時} 例：2013-04-20,2017-06-16（登録日時が2013-04-20 00:00:00〜2017-06-016 23:59:59間の文書を検索する。）
  • ,{終了日時} 例：,2017-06-16（登録日時が2017-06-16 23:59:59以前の文書を検索する。）
LastUpdAccount
string
Example: LastUpdAccount=2000000,2000001

最終更新者のOR検索
アカウントMIDを指定
複数指定の場合はカンマ区切り

LastUpdDate
string
Example: LastUpdDate=2022-09-05,2022-10-05T11:30:00+9000

最終更新日時
指定方法はRegDate参照

Responses

Response samples

Content type
application/json
[
  • {
    }
]

文書一覧のCSV出力

同期モード(async=false)の場合、指定されたバインダ、およびビューで表示される文書一覧をMIME形式"text/csv"でダウンロードできるように返却します。
非同期モード(async=true)の場合、バックグラウンド実行されcsvファイルが作成されます。csvファイルは get /background/jobs/{jobId} で取得したファイルIDで get /attaches/{fileId} を実行することで取得可能です。

Authorizations:
(cookieAuthcsrfTokenAuth) binderTokenAuth
path Parameters
required
整数値 (integer) or 文字列 (string)

バインダIDもしくはキー

required
integer or string

ビューIDもしくはキー

query Parameters
charset
string (charset)
Default: "UTF-8"
Enum: "ShiftJIS" "UTF-8" "GB2312"

CSV出力の文字コード

async
boolean
Default: false

非同期モードで実行するか。
CSV出力のバックグラウンド設定がOFFの場合、非同期モードでは実行できない。

updateExportedFlagItem
boolean
Default: false

出力した文書に対して出力済フラグ部品を更新するか

includeFileAttachment
boolean
Default: false

ファイルと画像を含むか。
同期モード(async=false)、またはバインダ属性のCSV入出力定義でファイルと画像を許可していない場合は本指定に関わらずファイルと画面を含まない。

Responses

Response samples

Content type
No sample

CSV入力（新規）

メインフォームに対してCSVで文書を新規登録します。
リスト型とサブフォームをサポートしません。
非同期モード(async=true)の場合、バックグラウンド実行されます。実行結果の取得は get /background/jobs/{jobId} を参照してください。

Authorizations:
(cookieAuthcsrfTokenAuth) binderTokenAuth
path Parameters
required
整数値 (integer) or 文字列 (string)

バインダIDもしくはキー

Request Body schema: application/json

文書新規登録リクエスト

csv
required
string (csv)

Base64でエンコードしたCSV文字列

charset
string (charset)
Default: "UTF-8"
Enum: "ShiftJIS" "UTF-8" "GB2312"

CSVの文字コード

updateDynaItems
boolean
Default: false

CSV入力対象文書の自動再計算の指定。
関連文書にブランチ評価式がある場合、または自動再計算が必要な参照元バインダが存在する場合は本指定に関わらず再計算する。

async
boolean (async)
Default: false

非同期モードで実行するか。
同期モードで一回の最大の入力件数は1000件で超えるとエラーになります。

Responses

Request samples

Content type
application/json
{
  • "csv": "string",
  • "charset": "ShiftJIS",
  • "updateDynaItems": false,
  • "async": false
}

Response samples

Content type
application/json
Example
{
  • "importedRecords": [
    ],
  • "errors": [
    ],
  • "failedUpdateDynaItemsDocuments": [
    ]
}

CSV入力（更新）

メインフォームに対してCSVで文書を更新します。
リスト型とサブフォームをサポートしません。
非同期モード(async=true)の場合、バックグラウンド実行されます。実行結果の取得は get /background/jobs/{jobId} を参照してください。

Authorizations:
(cookieAuthcsrfTokenAuth) binderTokenAuth
path Parameters
required
整数値 (integer) or 文字列 (string)

バインダIDもしくはキー

Request Body schema: application/json

文書更新リクエスト

csv
required
string (csv)

Base64でエンコードしたCSV文字列

charset
string (charset)
Default: "UTF-8"
Enum: "ShiftJIS" "UTF-8" "GB2312"

CSVの文字コード

updateMode
string
Default: "UPDATE"
Enum: "UPDATE" "UPSERT" "REPLACE"

更新モード。
UPDATE: 単純な更新
UPSERT: 登録更新
REPLACE: 全量入替（CSVに存在しない文書は削除されます）

keyItemId
required
integer <int32>

文書キー部品の部品IDまたは部品キー。
-1を指定する場合、文書番号になります。
※CSV入力による文書更新をする際に、文書キーで文書を特定します。
※更新モードは登録更新または全量入替である場合、文書番号（-1）をサポートしません

updateDynaItems
boolean
Default: false

CSV入力対象文書の自動再計算の指定。
※関連文書にブランチ評価式がある場合、または自動再計算が必要な参照元バインダが存在する場合は本指定に関わらず再計算する。
※更新モードは登録更新または全量入替である場合、強制的に自動計算を行う。

async
boolean (async)
Default: false

非同期モードで実行するか。
同期モードで一回の最大の入力件数は1000件で超えるとエラーになります。

Responses

Request samples

Content type
application/json
{
  • "csv": "string",
  • "charset": "ShiftJIS",
  • "updateMode": "UPDATE",
  • "keyItemId": 10001,
  • "updateDynaItems": false,
  • "async": false
}

Response samples

Content type
application/json
Example
{
  • "importedRecords": [
    ],
  • "errors": [
    ],
  • "failedUpdateDynaItemsDocuments": [
    ],
  • "unchangedRecords": [
    ],
  • "deletedRecords": [
    ]
}

コンプレックスCSV入力（新規）

CSVで文書を新規登録します。
メインフォームとリスト型をサポートします。サブフォームはサポートしません。
また、非同期モードだけサポートします。実行結果の取得は get /background/jobs/{jobId} を参照してください。

Authorizations:
(cookieAuthcsrfTokenAuth) binderTokenAuth
path Parameters
required
整数値 (integer) or 文字列 (string)

バインダIDもしくはキー

Request Body schema: application/json

文書新規登録リクエスト

mainCsv
required
string

Base64でエンコードしたメインフォームのCSV文字列

commonKeyItemId
required
integer <int32>

共通キーの部品IDまたは部品キー。
-1を指定する場合、文書番号になります。
※共通キーとは、メインファイルとその関連ファイルのレコードを関連付けるデータです。メインファイルと関連ファイルそれぞれに記述する必要があります。

charset
string (charset)
Default: "UTF-8"
Enum: "ShiftJIS" "UTF-8" "GB2312"

CSVの文字コード

property name*
additional property
string

プロパティ名はlistCsv_{listBlockId}
{listBlockId}の部分はリスト型ブロックIDで置き換えてください。

Base64でエンコードしたリスト型のCSV文字列。
リスト型ブロックごとに指定可能です。
少なくとも一つ指定する必要があります。

例. listCsv_10005: {Base64エンコードされたCSV文字列}

Responses

Request samples

Content type
application/json
{
  • "mainCsv": "{Base64エンコードされたCSV文字列}",
  • "commonKeyItemId": -1,
  • "listCsv_10005": "{Base64エンコードされたCSV文字列}"
}

Response samples

Content type
application/json
{
  • "jobId": 0
}

リッチコメント一覧取得

指定された文書IDのコメント情報を返却します。

Authorizations:
(cookieAuthcsrfTokenAuth) binderTokenAuth
path Parameters
required
整数値 (integer) or 文字列 (string)

バインダIDもしくはキー

document
required
integer <int64>

文書番号

query Parameters
plainText
boolean
Default: false

レスポンスのcontent(コメントの本文)をプレーンテキストにするか。

  • true : プレーンテキストを返す
  • false : タグ入りのリッチテキストを返す

Responses

Response samples

Content type
application/json
{
  • "comments": [
    ],
  • "totalCount": 1
}

リッチコメントの投稿

指定された文書にコメントを投稿します。

Authorizations:
(cookieAuthcsrfTokenAuth) binderTokenAuth
path Parameters
required
整数値 (integer) or 文字列 (string)

バインダIDもしくはキー

document
required
integer <int64>

文書番号

query Parameters
plainText
boolean
Default: false

レスポンスのcontent(コメントの本文)をプレーンテキストにするか。

  • true : プレーンテキストを返す
  • false : タグ入りのリッチテキストを返す
Request Body schema: application/json
content
required
string

投稿するコメントの本文

Responses

Request samples

Content type
application/json
{
  • "content": "string"
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "content": "投稿されたテキスト",
  • "created": {
    },
  • "regDate": 1665470173000,
  • "updDate": 1665470173000,
  • "reactions": [
    ]
}

リッチコメントの詳細情報

指定されたコメントIDのコメントを返却します。

Authorizations:
(cookieAuthcsrfTokenAuth) binderTokenAuth
path Parameters
required
整数値 (integer) or 文字列 (string)

バインダIDもしくはキー

document
required
integer <int64>

文書番号

commentId
required
integer <int64>

コメントID

query Parameters
plainText
boolean
Default: false

レスポンスのcontent(コメントの本文)をプレーンテキストにするか。

  • true : プレーンテキストを返す
  • false : タグ入りのリッチテキストを返す

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "content": "投稿されたテキスト",
  • "created": {
    },
  • "regDate": 1665470173000,
  • "updDate": 1665470173000,
  • "reactions": [
    ]
}

リッチコメントの更新

指定されたコメントIDのコメントを更新します。

Authorizations:
(cookieAuthcsrfTokenAuth) binderTokenAuth
path Parameters
required
整数値 (integer) or 文字列 (string)

バインダIDもしくはキー

document
required
integer <int64>

文書番号

commentId
required
integer <int64>

コメントID

query Parameters
plainText
boolean
Default: false

レスポンスのcontent(コメントの本文)をプレーンテキストにするか。

  • true : プレーンテキストを返す
  • false : タグ入りのリッチテキストを返す
Request Body schema: application/json
content
required
string

更新するコメントの本文

Responses

Request samples

Content type
application/json
{
  • "content": "string"
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "content": "投稿されたテキスト",
  • "created": {
    },
  • "regDate": 1665470173000,
  • "updDate": 1665470173000,
  • "reactions": [
    ]
}

リッチコメントの削除

指定されたコメントIDのコメントを削除します。

Authorizations:
(cookieAuthcsrfTokenAuth) binderTokenAuth
path Parameters
required
整数値 (integer) or 文字列 (string)

バインダIDもしくはキー

document
required
integer <int64>

文書番号

commentId
required
integer <int64>

コメントID

query Parameters
plainText
boolean
Default: false

レスポンスのcontent(コメントの本文)をプレーンテキストにするか。

  • true : プレーンテキストを返す
  • false : タグ入りのリッチテキストを返す

Responses

Response samples

Content type
application/json
{
  • "code": 400,
  • "message": "error message",
  • "messages": [
    ]
}

リッチコメントのリアクション情報取得

指定されたコメントIDのリアクション情報を返却します。

Authorizations:
(cookieAuthcsrfTokenAuth) binderTokenAuth
path Parameters
required
整数値 (integer) or 文字列 (string)

バインダIDもしくはキー

document
required
integer <int64>

文書番号

commentId
required
integer <int64>

コメントID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

リッチコメントのリアクション更新

指定されたコメントIDのリアクション情報を更新します。
リアクションを投稿していない場合は投稿者リストに追加し、すでに投稿していた場合は投稿者リストから削除されます。

Authorizations:
(cookieAuthcsrfTokenAuth) binderTokenAuth
path Parameters
required
整数値 (integer) or 文字列 (string)

バインダIDもしくはキー

document
required
integer <int64>

文書番号

commentId
required
integer <int64>

コメントID

reactionId
required
integer [ 1 .. 70 ]

リアクションのid
範囲は1~70

Responses

Response samples

Content type
application/json
[
  • {
    }
]

文書一括操作

複数文書の登録・更新・削除を1トランザクションで実行します。

Authorizations:
(cookieAuthcsrfTokenAuth) binderTokenAuth
query Parameters
async
boolean
Default: false

非同期モードで実行するか

Request Body schema: application/json
required
Array of postAction (object) or putAction (object) or deleteAction (object)

文書操作アクション。配列の順に文書操作が実施される。

Responses

Request samples

Content type
application/json
{
  • "actions": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "results": [
    ]
}

文書既読・未読ユーザ数取得

指定された文書ID及び組織IDで文書の既読・未読フラグを取得します。

Authorizations:
(cookieAuthcsrfTokenAuth) binderTokenAuth
path Parameters
required
整数値 (integer) or 文字列 (string)

バインダIDもしくはキー

document
required
integer <int64>

文書番号

query Parameters
group
string
Example: group=1000000,1000015

既読・未読情報を取得する組織のGID。複数指定する場合は「,」で区切ってください。
省略した場合はトップ組織が指定されます。

pageNumber
integer <int32>
Default: 1

ページ番号を指定します。
省略した場合は1ページ目が表示されます。

pageSize
integer <int32>
Default: 20

1ページあたりのデータの表示数を指定します。
オンプレミスでご利用の場合、default.xml中のdefault-values.hibiki.brd.document-reading.info.page-sizeでデフォルト値の変更が可能です。

sort
string
Default: "group:DESC"
Enum: "group:ASC" "group:DESC"
Example: sort=group:ASC

ソートを指定します。

  • 「group:ASC」: 組織名の昇順
  • 「group:DESC」: 組織名の降順

Responses

Response samples

Content type
application/json
{
  • "totalCount": 1,
  • "pageSize": 20,
  • "readCounts": [
    ]
}

文書既読情報取得

指定された文書ID及び組織IDで文書の既読ユーザーを取得します。

Authorizations:
(cookieAuthcsrfTokenAuth) binderTokenAuth
path Parameters
required
整数値 (integer) or 文字列 (string)

バインダIDもしくはキー

document
required
integer <int64>

文書番号

query Parameters
group
string
Example: group=1000000,1000015

既読・未読情報を取得する組織のGID。複数指定する場合は「,」で区切ってください。
省略した場合はトップ組織が指定されます。

pageNumber
integer <int32>
Default: 1

ページ番号を指定します。
省略した場合は1ページ目が表示されます。

pageSize
integer <int32>
Default: 20

1ページあたりのデータの表示数を指定します。
オンプレミスでご利用の場合、default.xml中のdefault-values.hibiki.brd.document-reading.info.page-sizeでデフォルト値の変更が可能です。

sort
string
Default: "group:DESC"
Enum: "group:ASC" "group:DESC"
Example: sort=group:ASC

ソートを指定します。

  • 「group:ASC」: 組織名の昇順
  • 「group:DESC」: 組織名の降順

Responses

Response samples

Content type
application/json
{
  • "totalCount": 1,
  • "pageSize": 20,
  • "read": [
    ]
}

文書未読情報取得

指定された文書ID及び組織IDで文書の未読ユーザーを取得します。

Authorizations:
(cookieAuthcsrfTokenAuth) binderTokenAuth
path Parameters
required
整数値 (integer) or 文字列 (string)

バインダIDもしくはキー

document
required
integer <int64>

文書番号

query Parameters
group
string
Example: group=1000000,1000015

既読・未読情報を取得する組織のGID。複数指定する場合は「,」で区切ってください。
省略した場合はトップ組織が指定されます。

pageNumber
integer <int32>
Default: 1

ページ番号を指定します。
省略した場合は1ページ目が表示されます。

pageSize
integer <int32>
Default: 20

1ページあたりのデータの表示数を指定します。
オンプレミスでご利用の場合、default.xml中のdefault-values.hibiki.brd.document-reading.info.page-sizeでデフォルト値の変更が可能です。

sort
string
Default: "group:DESC"
Enum: "group:ASC" "group:DESC"
Example: sort=group:ASC

ソートを指定します。

  • 「group:ASC」: 組織名の昇順
  • 「group:DESC」: 組織名の降順

Responses

Response samples

Content type
application/json
{
  • "totalCount": 1,
  • "pageSize": 20,
  • "unread": [
    ]
}

文書既読・未読フラグ取得

指定されたバインダID及びアカウントIDで文書の既読・未読フラグを取得します。

Authorizations:
(cookieAuthcsrfTokenAuth) binderTokenAuth
path Parameters
required
整数値 (integer) or 文字列 (string)

バインダIDもしくはキー

query Parameters
documents
required
string
Example: documents=1,2,3

文書ID、複数指定する場合は「,」で区切る

account
integer <int32>

アカウントID、省略した場合はログインユーザーが指定される

Responses

Response samples

Content type
application/json
{
  • "totalCount": 1,
  • "readStatus": [
    ]
}

文書既読フラグ設定

指定された文書を既読・未読フラグへ設定する

Authorizations:
(cookieAuthcsrfTokenAuth) binderTokenAuth
path Parameters
required
整数値 (integer) or 文字列 (string)

バインダIDもしくはキー

document
required
integer <int64>

文書番号

Request Body schema: application/json

文書既読・未読フラグリクエスト

account
integer <int32>

アカウントID、省略した場合はログインユーザーが指定される

status
required
string
Enum: "read" "unread"

文書の既読・未読フラグ

  • read: 既読
  • unread: 未読

Responses

Request samples

Content type
application/json
{
  • "account": 1000028,
  • "status": "read"
}

Response samples

Content type
application/json
{
  • "recordId": 1,
  • "status": "read"
}

バックグラウンドジョブステータス取得

バックグラウンドジョブステータス取得

Authorizations:
(cookieAuthcsrfTokenAuth) binderTokenAuth
path Parameters
job
required
integer <int64>

ジョブID

Responses

Response samples

Content type
application/json
Example
{
  • "jobId": 0,
  • "executor": {
    },
  • "createDate": 0,
  • "jobType": "CSV_EXPORT",
  • "status": "WAITING",
  • "binder": {
    }
}

FILE

ファイルに関するAPI

添付ファイル一覧取得

ログインユーザが一時領域にアップロードしたファイル一覧を返却します。

Authorizations:
(cookieAuthcsrfTokenAuth) binderTokenAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

添付ファイル追加

指定されたファイルをSmartDBの一時領域にアップロードします。
戻り値として返却されたファイルIDは実際に文書にファイル情報を添付する際に必要となります。
また、一時領域はユーザごとに作成されるため、アップロードしたユーザと文書に添付するユーザは同一ユーザで実施する必要があります。
※アップロードから24時間経過した一時領域のファイルは日時処理で自動削除されます。

Authorizations:
(cookieAuthcsrfTokenAuth) binderTokenAuth
Request Body schema:

ファイルは複数アップロードできます。

file
required
string <binary>

Responses

Request samples

Content type
No sample

Response samples

Content type
application/json
[
  • {
    }
]

添付ファイル情報取得

指定したfileIdのファイル情報を返却します。
ファイルをダウンロードする場合はAcceptヘッダーにapplication/octet-streamを指定してください。

fileIdの種類

  • post /attachesでアップロードした一時ファイル: $$$で始まる文字列
  • 文書に登録されているファイル
    • ファイルフォルダ部品: {binderId}:{recordId}:{itemId}:{index}
    • ファイルフォルダ部品(リスト型部品内): {binderId}:{recordId}:{itemId}:{memberId}:{index}
    • 画像部品: {binderId}:{recordId}:{itemId}
    • 画像部品(サムネイル): {binderId}:{recordId}:{itemId}:thumb
  • バックグラウンドジョブで登録されたファイル: cjob_{jobId}_{index}
Authorizations:
(cookieAuthcsrfTokenAuth) binderTokenAuth
path Parameters
fileId
required
string
Example: $$$11793829246213435278.dat

Responses

Response samples

Content type
{
  • "name": "sample.txt",
  • "size": 818795,
  • "created_at": 1665715352622,
  • "id": "string"
}

添付ファイル削除

一時領域のファイルを削除します。

Authorizations:
(cookieAuthcsrfTokenAuth) binderTokenAuth
path Parameters
fileId
required
string
Example: $$$11793829246213435278.dat

Responses

Response samples

Content type
application/json
{
  • "code": 400,
  • "message": "error message",
  • "messages": [
    ]
}

CATEGORY

カテゴリ定義API

カテゴリ検索

カテゴリ定義を検索する。
検索方法は2通り

  • ツリー検索
    • 階層数を指定して取得可能
  • キーワード検索
Authorizations:
(cookieAuthcsrfTokenAuth) binderTokenAuth
query Parameters
ids
string

取得対象のカテゴリをカテゴリIDで指定する。カンマ区切りで複数指定が可能。
このクエリパラメータを指定した場合、他のクエリパラメータの指定は不要。

keyword
string

キーワード検索(部分一致)
取得対象のカテゴリをカテゴリ名の部分一致検索で指定する。
idsとは併用不可。
このクエリパラメータを指定した場合、他のクエリパラメータの指定は不要。

parent
integer <int64>
Default: 0

ツリー検索。
検索対象の親カテゴリIDを指定し、子カテゴリ定義を取得する。(デフォルトの親カテゴリはトップカテゴリ(parent=0))
また、取得する階層数をdepthで指定可能
ids、keywordとは併用不可。

depth
integer <int32>
Default: 1

ツリー検索で再起的に取得する子カテゴリの深さを指定する。
デフォルトは1階層(指定した親カテゴリの子のみ)
ids、keywordとは併用不可。

Responses

Response samples

Content type
application/json
[
  • {
    }
]

カテゴリ詳細取得

指定したカテゴリ定義を取得する。

Authorizations:
(cookieAuthcsrfTokenAuth) binderTokenAuth
path Parameters
category
required
integer <int64>

カテゴリ定義ID

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "name": "カテゴリA",
  • "parentId": 0
}

祖先カテゴリ一覧取得

指定したカテゴリの上位カテゴリをトップカテゴリから順にすべて取得する。
指定したカテゴリ自身は含まない。
トップカテゴリ(id=0)を指定した場合、空の配列を返す。

Authorizations:
(cookieAuthcsrfTokenAuth) binderTokenAuth
path Parameters
category
required
integer <int64>

カテゴリ定義ID

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

PROCESS

プロセスに関するAPI

開始可能業務一覧取得

開始可能業務プロセス一覧を検索します。
検索条件のパラメータが長過ぎて「GET」で正常に送信できない場合、「POST」で送信してください。

Authorizations:
(cookieAuthcsrfTokenAuth) binderTokenAuth
query Parameters
page
integer <int32>
Default: 1

ページ番号

sort
string <{name}:{order}>
Default: "Title:DESC"

ソート。
ソート項目と"ASC"か"DESC"を":"で結合した文字列。
ソート可能な項目一覧

  • Title: 業務名(かな)
  • Memo: 説明
  • UPDATE_DATE: 更新日時
  • Owner: 主管部署
processName
string

検索条件：業務名

Responses

Response samples

Content type
application/json
{
  • "count": 1,
  • "pageSize": 20,
  • "processes": [
    ]
}

よく使う業務一覧取得

開始可能業務プロセスのよく使う一覧を返却します。

Authorizations:
(cookieAuthcsrfTokenAuth) binderTokenAuth
query Parameters
page
integer <int32>
Default: 1

ページ番号

sort
string <{name}:{order}>
Default: "Title:DESC"

ソート。
ソート項目と"ASC"か"DESC"を":"で結合した文字列。
ソート可能な項目一覧

  • Title: 業務名(かな)
  • Memo: 説明
  • UPDATE_DATE: 更新日時
  • Owner: 主管部署

Responses

Response samples

Content type
application/json
{
  • "count": 1,
  • "pageSize": 20,
  • "processes": [
    ]
}

よく使う業務一覧に追加

指定したプロセス定義をよく使う業務一覧に追加します

Authorizations:
(cookieAuthcsrfTokenAuth) binderTokenAuth
path Parameters
processNumber
required
integer <int32>

プロセス定義番号

Responses

Response samples

Content type
application/json
Example
{
  • "id": 38,
  • "number": 150,
  • "name": "サンプルプロセス",
  • "key": "sampleProcessKey",
  • "memo": "説明文説明文説明文説明文説明文説明文",
  • "ownerGroup": {
    },
  • "regMid": 1000011,
  • "updMid": 1000011,
  • "regDate": 1664840541000,
  • "updDate": 1664842678000,
  • "canViewDefinitionFlag": true,
  • "favoriteFlag": true,
  • "useComment": true,
  • "usePriority": true,
  • "useDateLimit": true,
  • "binderId": 10600,
  • "displayWorkflowStartDialog": true,
  • "titleItemId": 10002,
  • "titleEditable": true,
  • "commentItemId": 10004,
  • "priorityItemId": 10005,
  • "priorityEditable": true,
  • "priorityMapping": [
    ],
  • "dateLimitItemId": 10003,
  • "dateLimitEditable": true,
  • "useCustomizedStatus": false
}

よく使う業務一覧から削除

指定したプロセス定義をよく使う業務一覧から削除します

Authorizations:
(cookieAuthcsrfTokenAuth) binderTokenAuth
path Parameters
processNumber
required
integer <int32>

プロセス定義番号

Responses

Response samples

Content type
application/json
Example
{
  • "id": 38,
  • "number": 150,
  • "name": "サンプルプロセス",
  • "key": "sampleProcessKey",
  • "memo": "説明文説明文説明文説明文説明文説明文",
  • "ownerGroup": {
    },
  • "regMid": 1000011,
  • "updMid": 1000011,
  • "regDate": 1664840541000,
  • "updDate": 1664842678000,
  • "canViewDefinitionFlag": true,
  • "favoriteFlag": true,
  • "useComment": true,
  • "usePriority": true,
  • "useDateLimit": true,
  • "binderId": 10600,
  • "displayWorkflowStartDialog": true,
  • "titleItemId": 10002,
  • "titleEditable": true,
  • "commentItemId": 10004,
  • "priorityItemId": 10005,
  • "priorityEditable": true,
  • "priorityMapping": [
    ],
  • "dateLimitItemId": 10003,
  • "dateLimitEditable": true,
  • "useCustomizedStatus": false
}

業務プロセス開始

業務プロセスを開始します。

Authorizations:
(cookieAuthcsrfTokenAuth) binderTokenAuth
Request Body schema: application/json

業務プロセス開始リクエスト

Any of
One of
processNumber
required
integer <int32>

プロセス定義番号

required
整数値 (integer) or 文字列 (string)

開始バインダIDもしくはキー

document
required
integer <int64>

開始文書ID

title
string

見出し

comment
string

コメント

priority
integer
Enum: 5 7 9

優先度

  • 5: 通常
  • 7: 優先
  • 9: 至急
dateLimit
string <date>

期限

processStartGroupId
integer <int32>

起案部署(GID)

Responses

Request samples

Content type
application/json
Example
{
  • "binder": 10600,
  • "document": 28,
  • "title": "サンプル見出し",
  • "comment": "サンプルコメント",
  • "priority": 5,
  • "dateLimit": "2022-11-11",
  • "processStartGroupId": 2000011,
  • "processNumber": 150
}

Response samples

Content type
application/json
{
  • "id": 38,
  • "name": "見出し",
  • "status": "WORKING",
  • "started_at": 0,
  • "started": {
    }
}

開始済み一覧取得

開始済み一覧を返却します。
検索条件のパラメータが長過ぎて「GET」で正常に送信できない場合、「POST」で送信してください。

Authorizations:
(cookieAuthcsrfTokenAuth) binderTokenAuth
query Parameters
page
integer <int32>
Default: 1

ページ番号

title
string

検索条件：タイトル（業務名と見出し）

processName
string

検索条件：業務名

processInstanceName
string

検索条件：見出し

sort
string <{name}:{order}>
Default: "ProcessStartDate:DESC"

ソート。
ソート項目と"ASC"か"DESC"を":"で結合した文字列。
ソート可能な項目一覧

  • ProcessInstanceName: 見出し
  • ActivityStartDate: アクティビティ開始日時
  • ProcessName: 業務名
  • ProcessStartDate: 業務開始日時
  • ProcessEndDate: 業務終了日時
  • ActivityName: 実施中のアクティビティ名
  • Status: プロセスのステータス
waitingActivityPrincipals
string
Example: waitingActivityPrincipals=100044,100051

検索条件：対象プロセスの現在の担当者
担当者をMIDで指定できます。カンマ区切りで複数指定できます。

waitingActivityProxies
string
Example: waitingActivityProxies=100044,100051

検索条件：対象プロセスの現在の代行者
代行者をMIDで指定できます。カンマ区切りで複数指定できます。

startDateFrom
string <yyyy-MM-dd HH:mm:ss>
Example: startDateFrom=2022-11-11 11:11:11

検索条件：業務開始日の起点
（ログインユーザのタイムゾーンを使用します。）

startDateTo
string <yyyy-MM-dd HH:mm:ss>
Example: startDateTo=2022-11-12 11:11:11

検索条件：業務開始日時の終点
（ログインユーザのタイムゾーンを使用します。）

endDateFrom
string <yyyy-MM-dd HH:mm:ss>
Example: endDateFrom=2022-11-11 11:11:11

検索条件：業務終了日時の起点
（ログインユーザのタイムゾーンを使用します。）

endDateTo
string <yyyy-MM-dd HH:mm:ss>
Example: endDateTo=2022-11-12 11:11:11

検索条件：業務終了日時の終点
（ログインユーザのタイムゾーンを使用します。）

status
string
Enum: "WORKING" "FINISHED" "BROKEN" "ABORTED"

検索条件：開始済みプロセスの状態。カンマ区切りで複数指定可能

  • WORKING: 現在動作中（ユーザの実施待ち）
  • FINISHED: 完了
  • BROKEN: 異常終了
  • ABORTED: 強制終了
searchTargetProcess
string
Value: "OnlyRootProcess"

検索条件：サブプロセスを除外するフラグ

  • OnlyRootProcess: サブプロセスを除外する

Responses

Response samples

Content type
application/json
{
  • "count": 1,
  • "pageSize": 20,
  • "startedProcesses": [
    ]
}

実施済一覧取得

実施済一覧を返却します。
検索条件のパラメータが長過ぎて「GET」で正常に送信できない場合、「POST」で送信してください。

Authorizations:
(cookieAuthcsrfTokenAuth) binderTokenAuth
query Parameters
page
integer <int32>
Default: 1

ページ番号

title
string

検索条件：タイトル（業務名と見出し）

processName
string

検索条件：業務名

processInstanceName
string

検索条件：見出し

sort
string <{name}:{order}>
Default: "ProcessStartDate:DESC"

ソート。
ソート項目と"ASC"か"DESC"を":"で結合した文字列。
ソート可能な項目一覧

  • ProcessInstanceName: 見出し
  • ActivityStartDate: アクティビティ開始日時
  • ProcessName: 業務名
  • ProcessStartDate: 業務開始日時
  • ProcessEndDate: 業務終了日時
  • ActivityName: 実施中のアクティビティ名
  • Status: プロセスのステータス
waitingActivityPrincipals
string
Example: waitingActivityPrincipals=100044,100051

検索条件：対象プロセスの現在の担当者
担当者をMIDで指定できます。カンマ区切りで複数指定できます。

waitingActivityProxies
string
Example: waitingActivityProxies=100044,100051

検索条件：対象プロセスの現在の代行者
代行者をMIDで指定できます。カンマ区切りで複数指定できます。

startDateFrom
string <yyyy-MM-dd HH:mm:ss>
Example: startDateFrom=2022-11-11 11:11:11

検索条件：業務開始日の起点
（ログインユーザのタイムゾーンを使用します。）

startDateTo
string <yyyy-MM-dd HH:mm:ss>
Example: startDateTo=2022-11-12 11:11:11

検索条件：業務開始日時の終点
（ログインユーザのタイムゾーンを使用します。）

endDateFrom
string <yyyy-MM-dd HH:mm:ss>
Example: endDateFrom=2022-11-11 11:11:11

検索条件：業務終了日時の起点
（ログインユーザのタイムゾーンを使用します。）

endDateTo
string <yyyy-MM-dd HH:mm:ss>
Example: endDateTo=2022-11-12 11:11:11

検索条件：業務終了日時の終点
（ログインユーザのタイムゾーンを使用します。）

status
string
Enum: "WORKING" "FINISHED" "BROKEN" "ABORTED"

検索条件：開始済みプロセスの状態。カンマ区切りで複数指定可能

  • WORKING: 現在動作中（ユーザの実施待ち）
  • FINISHED: 完了
  • BROKEN: 異常終了
  • ABORTED: 強制終了
starter
string
Example: starter=100044,100051

検索条件：業務開始者
業務開始者をMIDで指定できます。カンマ区切りで複数指定できます。

Responses

Response samples

Content type
application/json
{
  • "count": 1,
  • "pageSize": 20,
  • "finishedProcesses": [
    ]
}

履歴一覧取得

履歴一覧を返却します。
検索条件のパラメータが長過ぎて「GET」で正常に送信できない場合、「POST」で送信してください。

Authorizations:
(cookieAuthcsrfTokenAuth) binderTokenAuth
query Parameters
page
integer <int32>
Default: 1

ページ番号

title
string

検索条件：タイトル（業務名と見出し）

processName
string

検索条件：業務名

processInstanceName
string

検索条件：見出し

sort
string <{name}:{order}>
Default: "ProcessStartDate:DESC"

ソート。
ソート項目と"ASC"か"DESC"を":"で結合した文字列。
ソート可能な項目一覧

  • ProcessInstanceName: 見出し
  • ActivityStartDate: アクティビティ開始日時
  • ProcessName: 業務名
  • ProcessStartDate: 業務開始日時
  • ProcessEndDate: 業務終了日時
  • ActivityName: 実施中のアクティビティ名
  • Status: プロセスのステータス
waitingActivityPrincipals
string
Example: waitingActivityPrincipals=100044,100051

検索条件：対象プロセスの現在の担当者
担当者をMIDで指定できます。カンマ区切りで複数指定できます。

waitingActivityProxies
string
Example: waitingActivityProxies=100044,100051

検索条件：対象プロセスの現在の代行者
代行者をMIDで指定できます。カンマ区切りで複数指定できます。

startDateFrom
string <yyyy-MM-dd HH:mm:ss>
Example: startDateFrom=2022-11-11 11:11:11

検索条件：業務開始日の起点
（ログインユーザのタイムゾーンを使用します。）

startDateTo
string <yyyy-MM-dd HH:mm:ss>
Example: startDateTo=2022-11-12 11:11:11

検索条件：業務開始日時の終点
（ログインユーザのタイムゾーンを使用します。）

endDateFrom
string <yyyy-MM-dd HH:mm:ss>
Example: endDateFrom=2022-11-11 11:11:11

検索条件：業務終了日時の起点
（ログインユーザのタイムゾーンを使用します。）

endDateTo
string <yyyy-MM-dd HH:mm:ss>
Example: endDateTo=2022-11-12 11:11:11

検索条件：業務終了日時の終点
（ログインユーザのタイムゾーンを使用します。）

status
string
Enum: "WORKING" "FINISHED" "BROKEN" "ABORTED"

検索条件：開始済みプロセスの状態。カンマ区切りで複数指定可能

  • WORKING: 現在動作中（ユーザの実施待ち）
  • FINISHED: 完了
  • BROKEN: 異常終了
  • ABORTED: 強制終了
starter
string
Example: starter=100044,100051

検索条件：業務開始者
業務開始者をMIDで指定できます。カンマ区切りで複数指定できます。

searchTargetProcess
string
Value: "OnlyRootProcess"

検索条件：サブプロセスを除外するフラグ

  • OnlyRootProcess: サブプロセスを除外する
processNumber
integer <int32>

検索条件：プロセス番号

searchStatus
string
Value: "Running"

検索条件：履歴一覧のタイプ。指定のない場合は終了済の業務を取得する。

  • Running: 進行中の業務
searchTargetAdmin
string
Value: "CanAdminOnly"

検索条件：進行管理権のある業務プロセスのみに絞り込むフラグ。

  • CanAdminOnly: 進行管理権のある業務プロセスのみに絞り込む。
searchMeActvOwnerProxy
integer
Default: 0
Enum: 0 1

自分が担当者または代行者のアクティビティに絞り込むためのフラグ。

  • 0: 絞り込まない。
  • 1: 絞り込む。
mode
string
Value: "Admin"

検索モード。指定のない場合はユーザモード

  • Admin: 管理者モード

Responses

Response samples

Content type
application/json
{
  • "count": 1,
  • "pageSize": 20,
  • "historyProcesses": [
    ]
}

ワークリスト取得

担当者、代行者、全体プロセス進行管理者となっているアクティビティを返却します。
検索条件のパラメータが長過ぎて「GET」で正常に送信できない場合、「POST」で送信してください。

Authorizations:
(cookieAuthcsrfTokenAuth) binderTokenAuth
query Parameters
sort
string <{name}:{order}>
Default: "ActivityStartDate:DESC"

ソート。
ソート項目と"ASC"か"DESC"を":"で結合した文字列。
ソート可能な項目一覧

  • ActivityName: アクティビティ名
  • ProcessInstanceName: 見出し
  • ActivityStartDate: アクティビティ開始日時
  • ProcessName: 業務名
  • Starter: 業務開始者
  • ProcessStartDate: 業務開始日時
  • ProcessDateLimit: 業務承認期限
  • ProcessPriority: 業務優先度
page
integer <int32>
Default: 1

ページ番号

per
integer <int32>
Default: 20

1ページあたりのレコード数

title
string

検索条件：タイトル（業務名と見出し）

processName
string

検索条件：業務名

processInstanceName
string

検索条件：見出し

activityName
string

検索条件：アクテビティ名

starter
string
Example: starter=100044,100051

検索条件：業務開始者
業務開始者をMIDで指定できます。カンマ区切りで複数指定できます。

owner
string
Example: owner=100044,100051

検索条件：担当者
アクティビティの担当者をMIDで指定できます。カンマ区切りで複数指定できます。

startDate
string <yyyy-MM-dd HH:mm:ss>
Example: startDate=2022-11-11 11:11:11

検索条件：業務開始日時の起点
（ログインユーザのタイムゾーンを使用します。）

endDate
string <yyyy-MM-dd HH:mm:ss>
Example: endDate=2022-11-12 11:11:11

検索条件：業務開始日時の終点
（ログインユーザのタイムゾーンを使用します。）

activityStartDateFrom
string <yyyy-MM-dd HH:mm:ss>
Example: activityStartDateFrom=2022-11-12 11:11:11

検索条件：アクティビティ開始日時の起点
（ログインユーザのタイムゾーンを使用します。）

activityStartDateTo
string <yyyy-MM-dd HH:mm:ss>
Example: activityStartDateTo=2022-11-12 11:11:11

検索条件：アクティビティ開始日時の終点
（ログインユーザのタイムゾーンを使用します。）

prcNo
string
Example: prcNo=504,617

検索条件：プロセス定義番号
プロセス定義をIDで指定できます。カンマ区切りで複数指定できます。

subListType
string
Default: "meOwner"
Enum: "meOwner" "meProxy" "meGlobalProxy"

ワークリストのタイプ

  • meOwner: 自分が担当者
  • meProxy: 自分が代行者
  • meGlobalProxy: 自分がプロセス進行管理者

Responses

Response samples

Content type
application/json
{
  • "count": 1,
  • "pageSize": 20,
  • "activities": [
    ]
}

実施履歴取得

アクティビティ実施履歴を実施単位で返却します。
同じアクティビティで複数立場として実施した場合、それぞれ返却されます。

Authorizations:
(cookieAuthcsrfTokenAuth) binderTokenAuth
query Parameters
sort
string <{name}:{order}>
Default: "ExecuteDate:DESC"

ソート。
ソート項目と"ASC"か"DESC"を":"で結合した文字列。
ソート可能な項目一覧

  • ActivityName: アクティビティ名
  • ProcessInstanceName: 見出し
  • ProcessName: 業務名
  • ExecuteDate: 実施日時
page
integer <int32>
Default: 1

ページ番号

per
integer <int32>
Default: 20

1ページあたりのレコード数

withComment
boolean
Default: true

実施コメントを取得するか

executeType
string (executeType)
Enum: "NONE" "APPLY" "APPROVE" "DENY" "CONFIRM" "TURNDOWN" "REGAIN" "SANCTION" "COMMENT"

検索条件：処理種別

  • NONE: 未指定
  • APPLY: 申請
  • APPROVE: 承認
  • DENY: 否認
  • CONFIRM: 確認
  • TURNDOWN: 差戻し
  • REGAIN: 取戻し
  • SANCTION: 決裁
  • COMMENT: コメント依頼

Responses

Response samples

Content type
application/json
{
  • "count": 1,
  • "pageSize": 20,
  • "executedRows": [
    ]
}

アクティビティ詳細情報取得

指定されたアクティビティIDのアクティビティデータを返却します。

Authorizations:
(cookieAuthcsrfTokenAuth) binderTokenAuth
path Parameters
activity
required
integer <int64>

アクティビティID

query Parameters
fields
string
Example: fields=document,form

アクティビティの関連情報を追加で取得できます。
カンマ区切りで両方を指定することも可能です。

  • document: アクティビティで利用されている文書のデータを返却します。
  • form: アクティビティで利用されているバインダのフォーム定義情報を返却します。

Responses

Response samples

Content type
application/json
{
  • "id": 47,
  • "name": "sampleActivity",
  • "started_at": 1665304686000,
  • "startedGroup": {
    },
  • "processInstanceId": 38,
  • "processDefinitionName": "sampleProcess",
  • "processNumber": 150,
  • "processInstanceName": "見出し",
  • "processDateLimit": "2022-11-11",
  • "processPriority": 5,
  • "commentAskerStandPoint": [
    ],
  • "haveAsked": [
    ],
  • "totalCommenter": [
    ],
  • "binderId": 10600,
  • "documentId": 8,
  • "status": "RUNNABLE",
  • "executeType": "NONE",
  • "standPoints": [
    ],
  • "showCommentArea": true,
  • "requireComment": false,
  • "activityButton": [
    ],
  • "ended_at": 0,
  • "ended": {
    },
  • "fields": {
    }
}

アクティビティ実施

指定されたアクティビティIDのアクティビティを実施します。

Authorizations:
(cookieAuthcsrfTokenAuth) binderTokenAuth
path Parameters
activity
required
integer <int64>

アクティビティID

Request Body schema: application/json

アクティビティ実施情報

action
required
string

実施するアクティビティのボタン名またはボタンキーを指定して下さい。

comment
string

アクティビティを実施する際に付与するコメントを指定して下さい。

principalGroup
integer
Default: 1

対象担当グループ番号を指定して下さい。

Responses

Request samples

Content type
application/json
{
  • "action": "次へ",
  • "comment": "承認します",
  • "principalGroup": 1
}

Response samples

Content type
application/json
{
  • "code": 400,
  • "message": "error message",
  • "messages": [
    ]
}

文書情報に基づいて実行中アクティビティ情報取得

文書関連バインダIDと文書に紐づく、実行中のアクティビティの情報を取得する。
存在している担当者と代行者の情報も検出できて、アクティビティの情報の部分として返却する。

Authorizations:
(cookieAuthcsrfTokenAuth) binderTokenAuth
path Parameters
required
整数値 (integer) or 文字列 (string)

バインダIDもしくはキー

document
required
integer <int64>

文書番号

Responses

Response samples

Content type
application/json
[
  • {
    }
]

指定ユーザのすべての代行設定取得

指定ユーザのすべての代行設定を取得します。

Authorizations:
(cookieAuthcsrfTokenAuth) binderTokenAuth
query Parameters
account
integer <int32>

ユーザのMID。
指定されない場合、セッションユーザの代行設定を取得する。

Responses

Response samples

Content type
application/json
[
  • {
    }
]

代行設定新規作成

代行設定を新規作成します。

Authorizations:
(cookieAuthcsrfTokenAuth) binderTokenAuth
Request Body schema: application/json

代行設定

account
required
integer <int32>

代行されるユーザ

enabled
boolean
Default: false

代行設定が有効であるか

proxies
required
Array of integers <int32> non-empty [ items <int32 > ]

代行者のMIDの配列

beginDate
string <date>

代行期間。開始日時

endDate
string <date>

代行期間。終了日時

Responses

Request samples

Content type
application/json
{
  • "account": 1000011,
  • "enabled": true,
  • "proxies": [
    ],
  • "beginDate": "2022-11-11",
  • "endDate": "2022-11-12"
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "enabled": true,
  • "account": {
    },
  • "proxies": [
    ],
  • "beginDate": 1665500400000,
  • "endDate": 1665759599000,
  • "updAccount": {
    },
  • "updDate": 1665541574000
}

代行設定取得

代行設定を取得します。

Authorizations:
(cookieAuthcsrfTokenAuth) binderTokenAuth
path Parameters
proxyId
required
integer <int32>

代行設定ID

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "enabled": true,
  • "account": {
    },
  • "proxies": [
    ],
  • "beginDate": 1665500400000,
  • "endDate": 1665759599000,
  • "updAccount": {
    },
  • "updDate": 1665541574000
}

代行設定更新

代行設定を更新します。

Authorizations:
(cookieAuthcsrfTokenAuth) binderTokenAuth
path Parameters
proxyId
required
integer <int32>

代行設定ID

Request Body schema: application/json

代行設定

enabled
boolean
Default: false

代行設定が有効であるか

proxies
required
Array of integers <int32> non-empty [ items <int32 > ]

代行者のMIDの配列

beginDate
string <date>

代行期間。開始日時

endDate
string <date>

代行期間。終了日時

Responses

Request samples

Content type
application/json
{
  • "enabled": true,
  • "proxies": [
    ],
  • "beginDate": "2022-11-11",
  • "endDate": "2022-11-12"
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "enabled": true,
  • "account": {
    },
  • "proxies": [
    ],
  • "beginDate": 1665500400000,
  • "endDate": 1665759599000,
  • "updAccount": {
    },
  • "updDate": 1665541574000
}

代行設定削除

代行設定を削除します。

Authorizations:
(cookieAuthcsrfTokenAuth) binderTokenAuth
path Parameters
proxyId
required
integer <int32>

代行設定ID

Responses

Response samples

Content type
application/json
{
  • "code": 400,
  • "message": "error message",
  • "messages": [
    ]
}

LUXOR

全文検索に関するAPI

インデックス再構築

Luxorのインデックスを再構築する。
リクエストには以下のいずれかが必要です。

  • Basicプランの場合
    • セッションユーザがシステム管理者である
  • DCS、オンプレミスの場合
    • リクエスト元がシステム設定 (hibiki.xml) のwebServiceHostsに指定されている
    • このエンドポイントがシステム初期値設定 (default.xml) のsystem.web-service-hosts.whitelistで指定されている
    • セッションユーザがシステム管理者である
Request Body schema: application/json
One of
core
required
string
Enum: "binder" "process"

再構築対象のタイプ

  • binder: バインダ
  • process: プロセス
id
required
integer <int64>

対象オブジェクトのID

Responses

Request samples

Content type
application/json
Example
{
  • "core": "binder",
  • "id": 10100
}

Response samples

Content type
application/json
{
  • "status": "OK",
  • "message": "Update."
}

全文検索

全文検索を行う

Authorizations:
(cookieAuthcsrfTokenAuth) binderTokenAuth
query Parameters
keyword
required
string

検索のキーワード。
スペース区切りで複数指定できる。
検索方法(AND,OR)はsearchOperatorで指定する。

component
string
Default: "document"
Enum: "process" "binder" "document"

検索対象機能のタイプ

  • process: プロセス
  • binder: バインダ
  • document: 文書
start
integer <int32>

ページングの際、取得のデータの起点

rows
integer <int32>

ページングの際、取得のデータの数

searchField
string
Default: "title,content"
Enum: "title" "title,content"

検索対象の項目

  • title: タイトルのみで検索(プロセス名、バインダ名、文書タイトルなど)
  • title,content: タイトルと内容から検索
searchOperator
boolean
Default: false
  • true: OR条件
  • false: AND条件
sort
string
Default: "score:desc"
Enum: "score:desc" "score:asc" "upd_date:desc" "upd_date:asc"

ソート

  • score:desc : スコアの降順
  • score:asc : スコアの昇順
  • upd_date:desc : 最終更新日の降順
  • upd_date:asc : 最終更新日の昇順

Responses

Response samples

Content type
application/json
{
  • "result": [
    ],
  • "status": {
    }
}

SESSION

RestAPI実行に必要なセッションに関するAPI

ログイン

ログインを実行します。
既にログイン済みの場合、既存のセッションを継続して使用します。
ログインに成功した場合は、セッションにHIBIKIクッキーがセットされます。
戻り値として、ログインしたユーザのセッション情報を返却します。

Request Body schema: application/json

ログインユーザ情報

loginid
required
string

ユーザID

password
required
string

パスワード(平文)

Responses

Request samples

Content type
application/json
{
  • "loginid": "sample@dreamarts.co.jp",
  • "password": "password"
}

Response samples

Content type
application/json
{
  • "cookie": {
    },
  • "csrfToken": "string",
  • "key": "sample@dreamarts.co.jp",
  • "created_at": 1663216389782,
  • "updated_at": 1663216389782,
  • "expired_at": 1663302789782,
  • "id": 1000028,
  • "account": {
    },
  • "locale": {
    },
  • "timezone": {
    }
}

ログアウト

ログアウトを実行します。

Authorizations:
(cookieAuthcsrfTokenAuth)

Responses

Response samples

Content type
application/json
{
  • "code": 400,
  • "message": "error message",
  • "messages": [
    ]
}

ログインユーザ情報の取得

既にログイン済みのユーザの情報を返却します。

Authorizations:
(cookieAuthcsrfTokenAuth)

Responses

Response samples

Content type
application/json
{
  • "cookie": {
    },
  • "csrfToken": "string",
  • "key": "sample@dreamarts.co.jp",
  • "created_at": 1663216389782,
  • "updated_at": 1663216389782,
  • "expired_at": 1663302789782,
  • "id": 1000028,
  • "account": {
    },
  • "locale": {
    },
  • "timezone": {
    }
}

OTHERS

その他API

SmartDBバージョン取得

SmartDBのバージョンを取得します。

Responses

Response samples

Content type
application/json
{
  • "value": "5.3.0",
  • "build": "e8a47be",
  • "lastModified": 1648097168000
}

統計情報取得

バインダと文書の統計情報を取得します。統計情報が存在しない場合、status=notExistが返却されます。
リクエストには以下のいずれかが必要です。

  • Basicプランの場合
    • セッションユーザがシステム管理者である
  • DCS、オンプレミスの場合
    • リクエスト元がシステム設定 (hibiki.xml) のwebServiceHostsに指定されている
    • このエンドポイントがシステム初期値設定 (default.xml) のsystem.web-service-hosts.whitelistで指定されている
    • セッションユーザがシステム管理者である

Responses

Response samples

Content type
application/json
Example
{
  • "binderCount": 19,
  • "docCount": 2416,
  • "binderTokenRefCount": 0,
  • "createDate": 1664893286000,
  • "status": "exist"
}

統計情報更新

バインダと文書の統計情報を統計します。
リクエストには以下のいずれかが必要です。

  • Basicプランの場合
    • セッションユーザがシステム管理者である
  • DCS、オンプレミスの場合
    • リクエスト元がシステム設定 (hibiki.xml) のwebServiceHostsに指定されている
    • このエンドポイントがシステム初期値設定 (default.xml) のsystem.web-service-hosts.whitelistで指定されている
    • セッションユーザがシステム管理者である

Responses

Response samples

Content type
application/json
{
  • "status": "running"
}

カレンダキャッシュ最終更新時間取得

カレンダキャッシュの最終更新時間を取得します。

Authorizations:
(cookieAuthcsrfTokenAuth) binderTokenAuth

Responses

Response samples

Content type
application/json
{
  • "lastUpdateDate": 1664894484214
}

カレンダキャッシュ同期

カレンダキャッシュを同期します。

Authorizations:
(cookieAuthcsrfTokenAuth) binderTokenAuth

Responses

Response samples

Content type
application/json
{
  • "status": "synchronizing"
}