Agilite (プレビュー)

Agilit-e を使用すると、ビジネス ロジックとプロセスを一元化し、それらをマイクロサービスとして新規または既存のアプリケーションに公開できます。 Agilit-e コネクタを使用すると、ビジネス プロセス管理 (BPM)、ロール、キーワード、テンプレートなどの多くのサービスにアクセスできます。

このコネクタは、次の製品および地域で利用可能です。

Service	クラス	地域
Logic Apps	標準	以下を除くすべての Logic Apps 地域 :      -   Azure 政府の地域      -   Azure 中国の地域      -   国防総省 (DoD)
Power Automate	プレミアム	以下を除くすべての Power Automate 地域 :      -   米国政府 (GCC)      -   米国政府 (GCC High)      -   21Vianet が運用する中国のクラウド      -   国防総省 (DoD)
Power Apps	プレミアム	以下を除くすべての Power Apps 地域 :      -   米国政府 (GCC)      -   米国政府 (GCC High)      -   21Vianet が運用する中国のクラウド      -   米国国防総省 (DoD)

お問い合わせ先
件名	Agilit-e サポート チーム
[URL]	https://agilite.io
メール	support@agilite.io

Connector Metadata
発行者	Agilit-e
Web サイト	https://agilite.io
プライバシー ポリシー	https://agilite.io/privacy-policy/

接続の作成

コネクタは、次の認証タイプをサポートしています:

既定	接続を作成するためのパラメーター。	すべてのリージョン	共有可能

既定

適用できるもの: すべての領域

接続を作成するためのパラメーター。

これは共有可能な接続です。 Power App が他のユーザーと共有されている場合、接続も共有されます。 詳細については、キャンバス アプリのコネクタの概要 - Power Apps | Microsoft Docs を参照してください

件名	タイプ	内容	必要
Agilit-e API サーバーの URL を指定します。 (Agilit-e Cloud の場合、'https://api.agilite.io' を使用する)	文字列	Agilit-e API サーバーの URL を指定します。 (Agilit-e Cloud の場合、'https://api.agilite.io' を使用する)	真
API キー (管理の下の 'https://portal.agilite.io' で生成)	securestring	API キー (管理の下の 'https://portal.agilite.io' で生成)	True

調整制限

名前	呼び出し	更新期間
接続ごとの API 呼び出し	100	60 秒

アクション

BPM レコード (BPM) の登録	新しい BPM レコードを登録します。 レコードには、レコード、その進行状況、履歴、および状態を常に識別するためにレコードのライフ サイクルに使用される recordID が割り当てられる
グループでプロファイル キーを取得する (キーワード)	指定された 「グループ名」 に基づいてすべてのキーワード プロファイル キーを返す
プロファイル キー (BPM) で取得する	プロセスの構成とオプションを含む完全な BPM プロファイルを取得します。
プロファイル キー (キーワード) で取得する	提供された 「profile-key」 に基づいて、特定のキーワード プロファイルのキー/値のペアを返す
ラベルで値を取得 (キーワード)	提供された 「profile-key」 および 「value-key」 に基づいて、キーワード値を返す
レコードの状態の取得 (BPM)	1 つ以上のレコードの BPM レコードの状態を取得して、現在の状態、レコードの担当者、ワークフロー履歴、およびレコードの現在の状態とルールを説明するその他の情報を含める
値でラベルを取得 (キーワード)	提供された 「profile-key」 および 「value-key」 に基づいて、キーワード ラベルを返す
割り当てられたロール (ロール) を取得する	特定のレコードに対して以前に割り当てられたロールの担当者を取得する
単一のロール (複数のロール) の割り当て	特定のレコードに適用できるユーザー指定ロールを割り当てます。 この例として、ドキュメント レビューアーまたは休暇承認者がある
単一のロール (複数のロール) を取得	Agilit-e 管理ポータルでロールに割り当てられている担当者を取得します。 これらのロールは、特定のレコードまたはビジネス プロセスに関連するだけでなく、より一般的には組織内の全社的なロールに使用される
実行 (テンプレート)	提供された 「profile-key」 に基づいて、Agilit-e からテンプレートを処理して返します
実行する (BPM)	現在のワークフロー ステップでオプションを送信します。 ビジネス ルールに応じて、レコードはプロセスの次のステップに進み、次のステップに関する情報を呼び出し元の API に返す
番号の生成 (自動付番)	提供された 「profile-key」 に基づいて一意の番号を生成する

BPM レコード (BPM) の登録

操作 ID:

registerBPMRecord

新しい BPM レコードを登録します。 レコードには、レコード、その進行状況、履歴、および状態を常に識別するためにレコードのライフ サイクルに使用される recordID が割り当てられる

パラメーター

名前	キー	必須	型	説明
プロセス キー	process-key	True	string	ターゲット プロファイルの一意のキー
現在のユーザー	current-user	True	string	レコードを登録したユーザーのメール アドレスです。 これは通常、API の呼び出し時にログインしているユーザーになる

戻り値

本文​​

RegisterBPMRecord

グループでプロファイル キーを取得する (キーワード)

操作 ID:

getKeywordProfileKeysByGroup

指定された 「グループ名」 に基づいてすべてのキーワード プロファイル キーを返す

パラメーター

名前	キー	必須	型	説明
グループ名	group-name	True	string	キーワード プロファイルのグループ化に使用されるグループ名
並べ替え	sort		string	返されたキー/値の結果を並べ替えるためのオプションのパラメーター

戻り値

名前	パス	型	説明
		array of string

プロファイル キー (BPM) で取得する

操作 ID:

getBPMByProfileKey

プロセスの構成とオプションを含む完全な BPM プロファイルを取得します。

パラメーター

名前	キー	必須	型	説明
プロファイル キー	profile-key	True	string	ターゲット プロファイルの一意のキー

戻り値

本文​​

GetBPMProfile

プロファイル キー (キーワード) で取得する

操作 ID:

getKeywordsByProfileKey

提供された 「profile-key」 に基づいて、特定のキーワード プロファイルのキー/値のペアを返す

パラメーター

名前	キー	必須	型	説明
プロファイル キー	profile-key	True	string	ターゲット プロファイルの一意のキー
並べ替え	sort		string	返されたキー/値の結果を並べ替えるためのオプションのパラメーター

戻り値

項目

KeywordValues

ラベルで値を取得 (キーワード)

操作 ID:

getKeywordsValueByLabel

提供された 「profile-key」 および 「value-key」 に基づいて、キーワード値を返す

パラメーター

名前	キー	必須	型	説明
プロファイル キー	profile-key	True	string	ターゲット プロファイルの一意のキー
ラベル キー	label-key	True	string	ターゲット プロファイルのラベル/値の一覧のラベル キー

戻り値

本文​​

StdJSONResponse

レコードの状態の取得 (BPM)

操作 ID:

getBPMRecordState

1 つ以上のレコードの BPM レコードの状態を取得して、現在の状態、レコードの担当者、ワークフロー履歴、およびレコードの現在の状態とルールを説明するその他の情報を含める

パラメーター

名前	キー	必須	型	説明
プロセス キー	process-keys		string	レコードが返されるビジネス プロセスを識別するためのフィルターです。 このキーは、Agilit-e 管理ポータルの BPM プロファイルにある- (コンマ区切り)
BPM レコード ID	bpm-record-ids		string	特定の recordId を持つレコードのみを返すためにフィルターします。 recordId は、新しいレコードの registerBPMRecord API によって登録され、BPM API 応答の recordID プロパティにある - (コンマ区切り)
ステップ名	step-names		string	現在指定されたワークフロー ステップにあるレコードのみを返すようにフィルターする- (コンマ区切り)
担当ユーザー	responsible-users		string	現在特定のメール アドレスに指定されたレコードのみを返すようにフィルターする- (コンマ区切り)
関連ユーザー	relevant-users		string	現在特定のメール アドレスに関連したレコードのみを返すようにフィルターする- (コンマ区切り)
履歴を含める	include-history		boolean	履歴オブジェクトをレコード状態情報とともに返すかどうかを指定する
ステップ オプションを含む	include-step-options		boolean	ステップ オプションのオブジェクトをレコード状態情報とともに返すかどうか指定する
表示可能なオブジェクトを含める	include-visible-objects		boolean	表示可能なオブジェクトをレコード状態情報とともに返すかどうか指定する

戻り値

項目

GetBPMRecordState

値でラベルを取得 (キーワード)

操作 ID:

getKeywordsLabelByValue

提供された 「profile-key」 および 「value-key」 に基づいて、キーワード ラベルを返す

パラメーター

名前	キー	必須	型	説明
プロファイル キー	profile-key	True	string	ターゲット プロファイルの一意のキー
値キー	value-key	True	string	ターゲット プロファイルのラベル/値の一覧の値キー

戻り値

本文​​

StdJSONResponse

割り当てられたロール (ロール) を取得する

操作 ID:

getAssignedRoles

特定のレコードに対して以前に割り当てられたロールの担当者を取得する

パラメーター

名前	キー	必須	型	説明
プロセス キー	process-key	True	string	ターゲット プロファイルの一意のキー
BPM レコード ID	bpm-record-id	True	string	ロールが設定されるレコードを指定します。 ID は、新しいレコードの registerBPMRecord API によって登録され、BPM API 応答の recordID プロパティにある
ロール名	role-names	True	string	クエリを行うロール (コンマ区切り)

戻り値

名前	パス	型	説明
		array of object
件名	name	string
ユーザー	users	array of object
電子メール	users.email	string

単一のロール (複数のロール) の割り当て

操作 ID:

assignRole

特定のレコードに適用できるユーザー指定ロールを割り当てます。 この例として、ドキュメント レビューアーまたは休暇承認者がある

パラメーター

名前	キー	必須	型	説明
プロセス キー	process-key	True	string	ターゲット プロファイルの一意のキー
BPM レコード ID	bpm-record-id	True	string	ロールが設定されるレコードを指定します。 ID は、新しいレコードの registerBPMRecord API によって登録され、BPM API 応答の recordID プロパティにある
現在のユーザー	current-user	True	string	ロールを設定したユーザーのメール アドレスです。 これは通常、API の呼び出し時にログインしているユーザーになる
ロール名	role-name	True	string	割り当てられているロールの名前です。 例: 承認者またはレビューアー
担当ユーザー	responsible-users	True	string	このロールに割り当てられているユーザーの電子メールアドレス- (コンマ区切り)

戻り値

data

data

object

単一のロール (複数のロール) を取得

操作 ID:

getRole

Agilit-e 管理ポータルでロールに割り当てられている担当者を取得します。 これらのロールは、特定のレコードまたはビジネス プロセスに関連するだけでなく、より一般的には組織内の全社的なロールに使用される

パラメーター

名前	キー	必須	型	説明
ロール名	role-names	True	string	担当ユーザーを取得するロール名を指定する - (コンマ区切り)
条件付きレベル	conditional-levels		string	ロールに適した人物を決定するために使用できる追加のレベルを指定します。 レベルの例としては、部門名 (部門マネージャーを取得する場合)、または製品名 (製品マネージャーを取得する場合) などがある- (コンマ区切り)

戻り値

名前	パス	型	説明
responsibleUsers	responsibleUsers	array of string	responsibleUsers

実行 (テンプレート)

操作 ID:

executeTemplates

提供された 「profile-key」 に基づいて、Agilit-e からテンプレートを処理して返します

パラメーター

名前	キー	必須	型	説明
プロファイル キー	profile-key	True	string	ターゲット プロファイルの一意のキー
			object

戻り値

本文​​

StdJSONResponse

実行する (BPM)

操作 ID:

executeBPM

現在のワークフロー ステップでオプションを送信します。 ビジネス ルールに応じて、レコードはプロセスの次のステップに進み、次のステップに関する情報を呼び出し元の API に返す

パラメーター

名前	キー	必須	型	説明
プロセス キー	process-key	True	string	ターゲット プロファイルの一意のキー
BPM レコード ID	bpm-record-id	True	string	送信されたレコードを識別します。 ID は、新しいレコードの registerBPMRecord API によって登録され、BPM API 応答の recordID プロパティにある
選択されたオプション	option-selected	True	string	送信プロセスの一部として実行するためにユーザーが選択したオプションを識別します。 この値は、ワークフロー プロファイルの有効なステップ オプションに対応している必要がある
現在のユーザー	current-user	True	string	BPM ステップを送信したユーザーのメール アドレスです。 これは通常、API の呼び出し時にログインしているユーザーになる
ワークフロー ステップのコメント	comments		string	ワークフロー履歴にスタンプされる実行プロセスにコメントを渡します。 これは通常、ユーザーがステップを拒否する場合、または詳細情報を要求する場合に使用されます
			object

戻り値

本文​​

ExecuteBPMResult

番号の生成 (自動付番)

操作 ID:

generateNumber

提供された 「profile-key」 に基づいて一意の番号を生成する

パラメーター

名前	キー	必須	型	説明
プロファイル キー	profile-key	True	string	ターゲット プロファイルの一意のキー
			object

戻り値

本文​​

StdJSONResponse

定義

ExecuteBPMResult

名前	パス	型	説明
プロセス ステップの説明	description	string	プロセス ステップを説明する簡単な説明
SLA 期間 (時間)	duration	string	SLA 期間 (時間単位) です。 該当しない場合は 0 の値を指定する
プロセス ステップ イベント スタンプ	eventStamp	string	現在のプロセス ステップのイベント スタンプ
ステップの指示	instructions	string	ステップ中の担当ユーザーへの指示
プロセス ステップ キー	key	string	プロセス ステップを識別するための一意のキー
プロセス ステップ名	name	string	プロセス ステップの短い名前
BPM プロファイル キー	processKey	string	BPM プロファイルを識別するための一意のキー
プロセスのステージ	processStage	string	現在のステップのプロセス ステージを定義するキー
担当タイプ	responsibility	string	担当に基づくユーザー/ロール
プロセス ステップの担当ロール	responsibleRole	string	現在のプロセス ステップの担当ロール
プロセス ステップの担当ユーザー	responsibleUsers	array of string	現在のプロセス ステップの担当ユーザー
stepOptions	stepOptions	array of object
ステップ オプションの説明	stepOptions.description	string	ステップ オプションを説明する簡単な説明
ステップ オプションのイベント スタンプ	stepOptions.eventStamp	array of string	現在のステップ オプションのイベント スタンプ
ステップ オプション名	stepOptions.name	string	ステップ オプションの短い名前
次のステップ	stepOptions.nextStep	string	ビジネス プロセスがルーティングされる次のステップです。 それ以上のステップがない場合は空のままにする
ステップ オプションのメモ	stepOptions.notes	string	ステップ オプションに関するオプションのメモ
visibleObjects	stepOptions.visibleObjects	array of object
ステップ オプションのオブジェクト ID	stepOptions.visibleObjects.id	string	UI で参照されるコンポーネントの ID
選択肢(複数)	stepOptions.visibleObjects.inputOptions.choices	array of object
選択肢の種類のラベル	stepOptions.visibleObjects.inputOptions.choices.label	string	選択した選択肢のラベル
選択肢の種類の値	stepOptions.visibleObjects.inputOptions.choices.value	string	選択した選択肢の値
オプション ラベルを入力する	stepOptions.visibleObjects.inputOptions.label	string	入力フィールドまたは編集可能なコンポーネントを定義するラベル
入力オプション メッセージ	stepOptions.visibleObjects.inputOptions.messages	array of string	入力オプションの検証が失敗したときに使用されるメッセージ
入力オプションの種類	stepOptions.visibleObjects.inputOptions.type	string	使用する入力フィールドまたは編集可能なコンポーネントの種類を定義する
ステップ オプション オブジェクトは編集可能かどうか	stepOptions.visibleObjects.isEditable	boolean	参照されているコンポーネントは、ユーザー入力用に編集可能かどうか
ステップ オプションのオブジェクトは必須かどうか	stepOptions.visibleObjects.isMandatory	boolean	参照されているコンポーネントは、ユーザー入力が必要かどうか
visibleObjects	visibleObjects	array of object
プロセス ステップ オブジェクト ID	visibleObjects.id	string	UI で参照されるコンポーネントの ID
選択肢(複数)	visibleObjects.inputOptions.choices	array of object
選択肢の種類のラベル	visibleObjects.inputOptions.choices.label	string	選択した選択肢のラベル
選択肢の種類の値	visibleObjects.inputOptions.choices.value	string	選択した選択肢の値
オプション ラベルを入力する	visibleObjects.inputOptions.label	string	入力フィールドまたは編集可能なコンポーネントを定義するラベル
入力オプション メッセージ	visibleObjects.inputOptions.messages	array of string	入力オプションの検証が失敗したときに使用されるメッセージ
入力オプションの種類	visibleObjects.inputOptions.type	string	使用する入力フィールドまたは編集可能なコンポーネントの種類を定義する
プロセス ステップ オブジェクトは編集可能かどうか	visibleObjects.isEditable	boolean	参照されているコンポーネントは、ユーザー入力用に編集可能かどうか
プロセス ステップ オブジェクトは必須かどうか	visibleObjects.isMandatory	boolean	参照されているコンポーネントは、ユーザー入力が必要かどうか

GetBPMProfile

名前	パス	型	説明
appAdmin	appAdmin	array of object
アプリ管理者メール	appAdmin.email	string	現在の BPM プロファイルの管理者のメール アドレス
BPM アプリの URL	appUrl	string	現在の BPM プロファイルを利用するアプリのオプションの URL
BPM プロファイルの説明	description	string	BPM プロファイルを説明する簡単な説明
BPM プロファイル グループ名	groupName	string	BPM プロファイルのオプションのグループ化
BPM プロファイル キー	key	string	BPM プロファイルを識別するための一意のキー
BPM プロファイル名	name	string	BPM プロファイルの短い名前
BPM プロファイル メモ	notes	string	BPM プロファイルに関するオプションのメモ
processSteps	processSteps	array of object
プロセス ステップの説明	processSteps.description	string	プロセス ステップを説明する簡単な説明
SLA 期間 (時間)	processSteps.duration	string	SLA 期間 (時間単位) です。 該当しない場合は 0 の値を指定する
最初のステップかどうか	processSteps.firstStep	boolean	プロセス ステップ レコードがビジネス プロセスの最初のステップであるかどうかを指定する
ステップの指示	processSteps.instructions	string	ステップ中の担当ユーザーへの指示
プロセス ステップ キー	processSteps.key	string	プロセス ステップを識別するための一意のキー
プロセス ステップ名	processSteps.name	string	プロセス ステップの短い名前
プロセスのステージ	processSteps.processStage	string	現在のステップのプロセス ステージを定義するキー
プロセス ステップの参照 URL	processSteps.referenceUrl	string	プロセス ステップの参照 URL
担当タイプ	processSteps.responsibility	string	担当に基づくユーザー/ロール
プロセス ステップの担当ロール	processSteps.responsibleRole	string	現在のステップの担当ロール
roleLevels	processSteps.roleLevels	array of string	条件付きロール レベル
stepOptions	processSteps.stepOptions	array of object
ステップ オプションの説明	processSteps.stepOptions.description	string	ステップ オプションを説明する簡単な説明
ステップ オプション名	processSteps.stepOptions.name	string	ステップ オプションの短い名前
次のステップ	processSteps.stepOptions.nextStep	string	ビジネス プロセスがルーティングされる次のステップです。 それ以上のステップがない場合は空のままにする
ステップ オプションのメモ	processSteps.stepOptions.notes	string	ステップ オプションに関するオプションのメモ
visibleObjects	processSteps.stepOptions.visibleObjects	array of object
ステップ オプションのオブジェクト ID	processSteps.stepOptions.visibleObjects.id	string	UI で参照されるコンポーネントの ID
選択肢(複数)	processSteps.stepOptions.visibleObjects.inputOptions.choices	array of object
選択肢の種類のラベル	processSteps.stepOptions.visibleObjects.inputOptions.choices.label	string	選択した選択肢のラベル
選択肢の種類の値	processSteps.stepOptions.visibleObjects.inputOptions.choices.value	string	選択した選択肢の値
オプション ラベルを入力する	processSteps.stepOptions.visibleObjects.inputOptions.label	string	入力フィールドまたは編集可能なコンポーネントを定義するラベル
入力オプション メッセージ	processSteps.stepOptions.visibleObjects.inputOptions.messages	array of string	入力オプションの検証が失敗したときに使用されるメッセージ
入力オプションの種類	processSteps.stepOptions.visibleObjects.inputOptions.type	string	使用する入力フィールドまたは編集可能なコンポーネントの種類を定義する
ステップ オプション オブジェクトは編集可能かどうか	processSteps.stepOptions.visibleObjects.isEditable	boolean	参照されているコンポーネントは、ユーザー入力用に編集可能かどうか
ステップ オプションのオブジェクトは必須かどうか	processSteps.stepOptions.visibleObjects.isMandatory	boolean	参照されているコンポーネントは、ユーザー入力が必要かどうか
visibleObjects	processSteps.visibleObjects	array of object
プロセス ステップ オブジェクト ID	processSteps.visibleObjects.id	string	UI で参照されるコンポーネントの ID
選択肢(複数)	processSteps.visibleObjects.inputOptions.choices	array of object
選択肢の種類のラベル	processSteps.visibleObjects.inputOptions.choices.label	string	選択した選択肢のラベル
選択肢の種類の値	processSteps.visibleObjects.inputOptions.choices.value	string	選択した選択肢の値
オプション ラベルを入力する	processSteps.visibleObjects.inputOptions.label	string	入力フィールドまたは編集可能なコンポーネントを定義するラベル
入力オプション メッセージ	processSteps.visibleObjects.inputOptions.messages	array of string	入力オプションの検証が失敗したときに使用されるメッセージ
入力オプションの種類	processSteps.visibleObjects.inputOptions.type	string	使用する入力フィールドまたは編集可能なコンポーネントの種類を定義する
プロセス ステップ オブジェクトは編集可能かどうか	processSteps.visibleObjects.isEditable	boolean	参照されているコンポーネントは、ユーザー入力用に編集可能かどうか
プロセス ステップ オブジェクトは必須かどうか	processSteps.visibleObjects.isMandatory	boolean	参照されているコンポーネントは、ユーザー入力が必要かどうか
BPM プロファイル参照 URL	referenceUrl	string	現在の BPM プロファイルで参照できるオプションの URL

GetBPMRecordState

名前	パス	型	説明
プロセス ステップの説明	description	string	プロセス ステップを説明する簡単な説明
SLA 期間 (時間)	duration	string	SLA 期間 (時間単位) です。 該当しない場合は 0 の値を指定する
eventStampHistory	eventStampHistory	array of object
イベント スタンプの履歴名	eventStampHistory.eventName	string	イベント スタンプの名前
イベント スタンプ履歴のタイムスタンプ	eventStampHistory.timeStamp	date-time	イベント スタンプが発生したときのタイムスタンプ
履歴	history	array of object
履歴コメント	history.comments	string	履歴エントリの作成時に追加されたオプションのコメント
履歴の現在のロール	history.currentRole	string	履歴エントリ時の現在のロール
履歴の現在のユーザー	history.currentUser	string	履歴エントリ時の現在のユーザー
ステップ期間	history.duration	string	アクションが実行される前に、レコードが現在のプロセス ステップに存在していた時間 (分単位)
履歴のイベント スタンプ	history.eventStamp	array of string	履歴エントリ時に発生したイベント スタンプ
発生元のステップ	history.fromStep	string	履歴エントリの時点で BPM レコードが来たプロセス ステップのキー
発生元のステップ名	history.fromStepName	string	履歴エントリの時点で BPM レコードが来たプロセス ステップの名前
選択された履歴オプション	history.optionSelected	string	BPM レコードをアクションするときに選択されたオプション
履歴 BPM 処理キー	history.processKey	string	履歴エントリの一意の BPM プロセス キー
履歴処理ステージ	history.processStage	string	履歴エントリの時点でのプロセス ステージ
履歴 BPM レコード ID	history.recordId	string	BPM レコードの登録プロセス中に生成された BPM 関連レコードのレコード ID
履歴担当ロール	history.responsibleRole	string	履歴エントリの時点での BPM レコードの履歴担当ロール
履歴担当ユーザー	history.responsibleUsers	array of string	履歴エントリ時の担当ユーザー
履歴送信日	history.submissionDate	date-time	BPM レコードがアクションされた日時
プロセス ステージ	history.toProcessStage	string	履歴エントリの時点での BPM レコードのプロセス ステージ
ステップ	history.toStep	string	履歴エントリの時点での BPM レコードのプロセス ステップのキー
ステップ名	history.toStepName	string	履歴エントリの時点での BPM レコードのプロセス ステップの名前
ステップの指示	instructions	string	ステップ中の担当ユーザーへの指示
プロセス ステップ キー	key	string	プロセス ステップを識別するための一意のキー
プロセス ステップ名	name	string	プロセス ステップの短い名前
BPM プロファイル キー	processKey	string	BPM プロファイルを識別するための一意のキー
プロセスのステージ	processStage	string	現在のステップのプロセス ステージを定義するキー
BPM レコード ID	recordId	string	BPM レコードの登録時に BPM モジュールによって生成されるレコード ID
BPM レコード参照	recordRef	string	BPM レコードの登録時に自動付番モジュールを使用して BPM モジュールによって生成された読み取り可能な番号
プロセス ステップの参照 URL	referenceUrl	string	プロセス ステップの参照 URL
プロセス ステップの担当ロール	responsibleRole	string	現在のステップの担当ロール
プロセス ステップの担当ユーザー	responsibleUsers	array of string	現在のプロセス ステップの担当ユーザー
ロール	roles	array of object
ロール名	roles.name	string	ロールの名前
ユーザー	roles.users	array of object
ロール電子メール	roles.users.email	string	ロール名にリンクされているメール アドレス
stepOptions	stepOptions	array of object
ステップ オプションの説明	stepOptions.description	string	ステップ オプションを説明する簡単な説明
ステップ オプションのイベント スタンプ	stepOptions.eventStamp	array of string	現在のステップ オプションのイベント スタンプ
ステップ オプション名	stepOptions.name	string	ステップ オプションの短い名前
次のステップ	stepOptions.nextStep	string	ビジネス プロセスがルーティングされる次のステップです。 それ以上のステップがない場合は空のままにする
ステップ オプションのメモ	stepOptions.notes	string	ステップ オプションに関するオプションのメモ
visibleObjects	stepOptions.visibleObjects	array of object
ステップ オプションのオブジェクト ID	stepOptions.visibleObjects.id	string	UI で参照されるコンポーネントの ID
選択肢(複数)	stepOptions.visibleObjects.inputOptions.choices	array of object
選択肢の種類のラベル	stepOptions.visibleObjects.inputOptions.choices.label	string	選択した選択肢のラベル
選択肢の種類の値	stepOptions.visibleObjects.inputOptions.choices.value	string	選択した選択肢の値
オプション ラベルを入力する	stepOptions.visibleObjects.inputOptions.label	string	入力フィールドまたは編集可能なコンポーネントを定義するラベル
入力オプション メッセージ	stepOptions.visibleObjects.inputOptions.messages	array of string	入力オプションの検証が失敗したときに使用されるメッセージ
入力オプションの種類	stepOptions.visibleObjects.inputOptions.type	string	使用する入力フィールドまたは編集可能なコンポーネントの種類を定義する
ステップ オプション オブジェクトは編集可能かどうか	stepOptions.visibleObjects.isEditable	boolean	参照されているコンポーネントは、ユーザー入力用に編集可能かどうか
ステップ オプションのオブジェクトは必須かどうか	stepOptions.visibleObjects.isMandatory	boolean	参照されているコンポーネントは、ユーザー入力が必要かどうか
ステップに送信	submittedIntoStep	date-time	BPM レコードが現在のプロセス ステップに送信された日時
目標日時	targetTimeDuration	date-time	SLA 期間に基づいて BPM レコードを処理する必要がある日時
visibleObjects	visibleObjects	array of object
プロセス ステップ オブジェクト ID	visibleObjects.id	string	UI で参照されるコンポーネントの ID
選択肢(複数)	visibleObjects.inputOptions.choices	array of object
選択肢の種類のラベル	visibleObjects.inputOptions.choices.label	string	選択した選択肢のラベル
選択肢の種類の値	visibleObjects.inputOptions.choices.value	string	選択した選択肢の値
オプション ラベルを入力する	visibleObjects.inputOptions.label	string	入力フィールドまたは編集可能なコンポーネントを定義するラベル
入力オプション メッセージ	visibleObjects.inputOptions.messages	array of string	入力オプションの検証が失敗したときに使用されるメッセージ
入力オプションの種類	visibleObjects.inputOptions.type	string	使用する入力フィールドまたは編集可能なコンポーネントの種類を定義する
プロセス ステップ オブジェクトは編集可能かどうか	visibleObjects.isEditable	boolean	参照されているコンポーネントは、ユーザー入力用に編集可能かどうか
プロセス ステップ オブジェクトは必須かどうか	visibleObjects.isMandatory	boolean	参照されているコンポーネントは、ユーザー入力が必要かどうか

KeywordValues

名前	パス	型	説明
Label	label	string
値	value	string

RegisterBPMRecord

名前	パス	型	説明
プロセス ステップの説明	description	string	プロセス ステップを説明する簡単な説明
SLA 期間 (時間)	duration	string	SLA 期間 (時間単位) です。 該当しない場合は 0 の値を指定する
eventStampHistory	eventStampHistory	array of object
イベント スタンプの履歴名	eventStampHistory.eventName	string	イベント スタンプの名前
イベント スタンプ履歴のタイムスタンプ	eventStampHistory.timeStamp	date-time	イベント スタンプが発生したときのタイムスタンプ
履歴	history	array of object
履歴コメント	history.comments	string	履歴エントリの作成時に追加されたオプションのコメント
履歴の現在のロール	history.currentRole	string	履歴エントリ時の現在のロール
履歴の現在のユーザー	history.currentUser	string	履歴エントリ時の現在のユーザー
ステップ期間	history.duration	string	アクションが実行される前に、レコードが現在のプロセス ステップに存在していた時間 (分単位)
履歴のイベント スタンプ	history.eventStamp	array of string	履歴エントリ時に発生したイベント スタンプ
発生元のステップ	history.fromStep	string	履歴エントリの時点で BPM レコードが来たプロセス ステップのキー
発生元のステップ名	history.fromStepName	string	履歴エントリの時点で BPM レコードが来たプロセス ステップの名前
選択された履歴オプション	history.optionSelected	string	BPM レコードをアクションするときに選択されたオプション
履歴 BPM 処理キー	history.processKey	string	履歴エントリの一意の BPM プロセス キー
履歴処理ステージ	history.processStage	string	履歴エントリの時点でのプロセス ステージ
履歴 BPM レコード ID	history.recordId	string	BPM レコードの登録プロセス中に生成された BPM 関連レコードのレコード ID
履歴担当ロール	history.responsibleRole	string	履歴エントリの時点での BPM レコードの履歴担当ロール
履歴担当ユーザー	history.responsibleUsers	array of string	履歴エントリ時の担当ユーザー
履歴送信日	history.submissionDate	date-time	BPM レコードがアクションされた日時
プロセス ステージ	history.toProcessStage	string	履歴エントリの時点での BPM レコードのプロセス ステージ
ステップ	history.toStep	string	履歴エントリの時点での BPM レコードのプロセス ステップのキー
ステップ名	history.toStepName	string	履歴エントリの時点での BPM レコードのプロセス ステップの名前
ステップの指示	instructions	string	ステップ中の担当ユーザーへの指示
プロセス ステップ キー	key	string	プロセス ステップを識別するための一意のキー
プロセス ステップ名	name	string	プロセス ステップの短い名前
BPM プロファイル キー	processKey	string	BPM プロファイルを識別するための一意のキー
プロセスのステージ	processStage	string	現在のステップのプロセス ステージを定義するキー
BPM レコード ID	recordId	string	BPM レコードの登録時に BPM モジュールによって生成されるレコード ID
BPM レコード参照	recordRef	string	BPM レコードの登録時に自動付番モジュールを使用して BPM モジュールによって生成された読み取り可能な番号
プロセス ステップの参照 URL	referenceUrl	string	プロセス ステップの参照 URL
プロセス ステップの担当ロール	responsibleRole	string	現在のプロセス ステップの担当ロール
プロセス ステップの担当ユーザー	responsibleUsers	array of string	現在のプロセス ステップの担当ユーザー
ロール	roles	array of object
ロール名	roles.name	string	ロールの名前
ユーザー	roles.users	array of object
ロール電子メール	roles.users.email	string	ロール名にリンクされているメール アドレス
stepOptions	stepOptions	array of object
ステップ オプションの説明	stepOptions.description	string	ステップ オプションを説明する簡単な説明
ステップ オプションのイベント スタンプ	stepOptions.eventStamp	array of string	現在のステップ オプションのイベント スタンプ
ステップ オプション名	stepOptions.name	string	ステップ オプションの短い名前
次のステップ	stepOptions.nextStep	string	ビジネス プロセスがルーティングされる次のステップです。 それ以上のステップがない場合は空のままにする
ステップ オプションのメモ	stepOptions.notes	string	ステップ オプションに関するオプションのメモ
visibleObjects	stepOptions.visibleObjects	array of object
ステップ オプションのオブジェクト ID	stepOptions.visibleObjects.id	string	UI で参照されるコンポーネントの ID
選択肢(複数)	stepOptions.visibleObjects.inputOptions.choices	array of object
選択肢の種類のラベル	stepOptions.visibleObjects.inputOptions.choices.label	string	選択した選択肢のラベル
選択肢の種類の値	stepOptions.visibleObjects.inputOptions.choices.value	string	選択した選択肢の値
オプション ラベルを入力する	stepOptions.visibleObjects.inputOptions.label	string	入力フィールドまたは編集可能なコンポーネントを定義するラベル
入力オプション メッセージ	stepOptions.visibleObjects.inputOptions.messages	array of string	入力オプションの検証が失敗したときに使用されるメッセージ
入力オプションの種類	stepOptions.visibleObjects.inputOptions.type	string	使用する入力フィールドまたは編集可能なコンポーネントの種類を定義する
ステップ オプション オブジェクトは編集可能かどうか	stepOptions.visibleObjects.isEditable	boolean	参照されているコンポーネントは、ユーザー入力用に編集可能かどうか
ステップ オプションのオブジェクトは必須かどうか	stepOptions.visibleObjects.isMandatory	boolean	参照されているコンポーネントは、ユーザー入力が必要かどうか
visibleObjects	visibleObjects	array of object
プロセス ステップ オブジェクト ID	visibleObjects.id	string	UI で参照されるコンポーネントの ID
選択肢(複数)	visibleObjects.inputOptions.choices	array of object
選択肢の種類のラベル	visibleObjects.inputOptions.choices.label	string	選択した選択肢のラベル
選択肢の種類の値	visibleObjects.inputOptions.choices.value	string	選択した選択肢の値
オプション ラベルを入力する	visibleObjects.inputOptions.label	string	入力フィールドまたは編集可能なコンポーネントを定義するラベル
入力オプション メッセージ	visibleObjects.inputOptions.messages	array of string	入力オプションの検証が失敗したときに使用されるメッセージ
入力オプションの種類	visibleObjects.inputOptions.type	string	使用する入力フィールドまたは編集可能なコンポーネントの種類を定義する
プロセス ステップ オブジェクトは編集可能かどうか	visibleObjects.isEditable	boolean	参照されているコンポーネントは、ユーザー入力用に編集可能かどうか
プロセス ステップ オブジェクトは必須かどうか	visibleObjects.isMandatory	boolean	参照されているコンポーネントは、ユーザー入力が必要かどうか

StdJSONResponse

名前	パス	型	説明
結果	result	string	結果

オブジェクト

’オブジェクト’ という種類です。