Agilite (プレビュー)
Agilit-e を使用すると、ビジネス ロジックとプロセスを一元化し、それらをマイクロサービスとして新規または既存のアプリケーションに公開できます。 Agilit-e コネクタを使用すると、ビジネス プロセス管理 (BPM)、ロール、キーワード、テンプレートなど、多くのサービスにアクセスできます。
このコネクタは、次の製品とリージョンで使用できます。
| サービス | クラス | リージョン |
|---|---|---|
| コピロット スタジオ | Premium | 次を除くすべての Power Automate リージョン : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運営する China Cloud - 米国国防総省 (DoD) |
| ロジック アプリ | Standard | 次を除くすべての Logic Apps リージョン : - Azure Government リージョン - Azure China リージョン - 米国国防総省 (DoD) |
| Power Apps | Premium | 次を除くすべての Power Apps リージョン : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運営する China Cloud - 米国国防総省 (DoD) |
| Power Automate | Premium | 次を除くすべての Power Automate リージョン : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運営する China Cloud - 米国国防総省 (DoD) |
| お問い合わせ | |
|---|---|
| 名前 | Agilit-e サポート チーム |
| URL | https://agilite.io |
| support@agilite.io |
| コネクタ メタデータ | |
|---|---|
| Publisher | Agilit-e |
| Website | https://agilite.io |
| プライバシー ポリシー | https://agilite.io/privacy-policy/ |
接続を作成する
コネクタでは、次の認証の種類がサポートされています。
| デフォルト | 接続を作成するためのパラメーター。 | すべてのリージョン | 共有可能 |
デフォルト
適用対象: すべてのリージョン
接続を作成するためのパラメーター。
これは共有可能な接続です。 電源アプリが別のユーザーと共有されている場合は、接続も共有されます。 詳細については、 キャンバス アプリのコネクタの概要 - Power Apps |Microsoft Docs
| 名前 | タイプ | Description | 必須 |
|---|---|---|---|
| Agilit-e API Server URL を指定します。 (Agilit-e Cloud には "https://api.agilite.io" を使用します) | 文字列 | Agilit-e API Server URL を指定します。 (Agilit-e Cloud には "https://api.agilite.io" を使用します) | 正しい |
| API キー ([管理] の [https://portal.agilite.io] で生成) | securestring | API キー ([管理] の [https://portal.agilite.io] で生成) | 正しい |
調整制限
| 名前 | 呼び出し | 更新期間 |
|---|---|---|
| 接続ごとの API 呼び出し | 100 | 60 秒 |
アクション
| BPM レコードの登録 (BPM) |
新しい BPM レコードを登録します。 レコードは、レコードのライフ サイクルでレコード、進行状況、履歴、および状態を常に識別するために使用される recordID と共に割り当てられます。 |
| Get By Profile Key (BPM) |
プロセスの構成とオプションを含む完全な BPM プロファイルを取得します。 |
| グループ別のプロファイル キーの取得 (キーワード) |
指定された 'group-name' に基づいて、すべてのキーワード プロファイル キーを返します |
| プロファイル キーで取得 (キーワード) |
指定された 'profile-key' に基づいて、特定のキーワード プロファイルのキーと値のペアを返します。 |
| ラベルで値を取得する (キーワード) |
指定された 'profile-key' と 'label-key' に基づいてキーワード値を返します。 |
| レコード状態の取得 (BPM) |
レコードの現在の状態を含める 1 つ以上のレコードの BPM レコード状態の取得、レコードの責任者、ワークフロー履歴、およびレコードの現在の状態とルールを記述するその他の情報 |
| ロールの割り当て (ロール) |
特定のレコードに適用できるユーザー指定のロールを割り当てます。 たとえば、ドキュメントレビュー担当者や休暇承認者などです。 |
| ロールの取得 (ロール) |
Agilit-e 管理ポータルでロールに割り当てられている責任者を取得します。 これらのロールは、特定のレコードやビジネス プロセスに関連するだけでなく、組織内の会社全体の役割に使用されるのがより一般的です。 |
| 値によるラベルの取得 (キーワード) |
指定された 'profile-key' と 'value-key' に基づいてキーワード ラベルを返します。 |
| 割り当てられたロールの取得 (ロール) |
特定のレコードに対して以前に割り当てられたロールの責任者を取得する |
| 実行 (BPM) |
現在のワークフロー ステップでオプションを送信します。 ビジネス ルールに応じて、レコードはプロセスの次のステップに進み、次のステップに関する情報を呼び出し元 API に返します。 |
| 実行 (テンプレート) |
提供された 'profile-key' に基づいて、Agilit-e からテンプレートを処理して返します |
| 数値の生成 (番号付け) |
指定された 'profile-key' に基づいて一意の番号を生成します |
BPM レコードの登録 (BPM)
新しい BPM レコードを登録します。 レコードは、レコードのライフ サイクルでレコード、進行状況、履歴、および状態を常に識別するために使用される recordID と共に割り当てられます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
プロセス キー
|
process-key | True | string |
対象プロファイルの一意キー |
|
現在のユーザー
|
current-user | True | string |
レコードを登録しているユーザーの電子メール アドレス。 これは通常、API の呼び出し時にログインしているユーザーになります。 |
戻り値
- Body
- RegisterBPMRecord
Get By Profile Key (BPM)
プロセスの構成とオプションを含む完全な BPM プロファイルを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
プロファイル キー
|
profile-key | True | string |
対象プロファイルの一意キー |
戻り値
- Body
- GetBPMProfile
グループ別のプロファイル キーの取得 (キーワード)
指定された 'group-name' に基づいて、すべてのキーワード プロファイル キーを返します
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
グループ名
|
group-name | True | string |
キーワード プロファイルのグループ化に使用されるグループ名 |
|
ソート
|
sort | string |
返されたキー/値の結果を並べ替える省略可能なパラメーター |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
|
array of string |
プロファイル キーで取得 (キーワード)
指定された 'profile-key' に基づいて、特定のキーワード プロファイルのキーと値のペアを返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
プロファイル キー
|
profile-key | True | string |
対象プロファイルの一意キー |
|
ソート
|
sort | string |
返されたキー/値の結果を並べ替える省略可能なパラメーター |
戻り値
- アイテム
- KeywordValues
ラベルで値を取得する (キーワード)
指定された 'profile-key' と 'label-key' に基づいてキーワード値を返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
プロファイル キー
|
profile-key | True | string |
対象プロファイルの一意キー |
|
ラベル キー
|
label-key | True | string |
対象プロファイルのラベル/値リストの Label キー |
戻り値
- Body
- StdJSONResponse
レコード状態の取得 (BPM)
レコードの現在の状態を含める 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
ロールの割り当て (ロール)
特定のレコードに適用できるユーザー指定のロールを割り当てます。 たとえば、ドキュメントレビュー担当者や休暇承認者などです。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
プロセス キー
|
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 |
このロールに割り当てられているユーザーの電子メール アドレス - (コンマを使用して区切ります) |
戻り値
データ
- データ
- object
ロールの取得 (ロール)
Agilit-e 管理ポータルでロールに割り当てられている責任者を取得します。 これらのロールは、特定のレコードやビジネス プロセスに関連するだけでなく、組織内の会社全体の役割に使用されるのがより一般的です。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ロール名
|
role-names | True | string |
担当ユーザーを取得するロール名を指定します (コンマを使用して区切ります)。 |
|
条件付きレベル
|
conditional-levels | string |
ロールの適切な人物を決定するために使用できる追加のレベルを指定します。 レベルの例としては、部門名 (部門マネージャーを取得する場合) や製品名 (プロダクト マネージャーを取得する場合) があります (コンマを使用して区切ります)。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
responsibleUsers
|
responsibleUsers | array of string |
responsibleUsers |
値によるラベルの取得 (キーワード)
指定された 'profile-key' と 'value-key' に基づいてキーワード ラベルを返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
プロファイル キー
|
profile-key | True | string |
対象プロファイルの一意キー |
|
値キー
|
value-key | True | string |
対象プロファイルのラベル/値リストの Value キー |
戻り値
- Body
- StdJSONResponse
割り当てられたロールの取得 (ロール)
特定のレコードに対して以前に割り当てられたロールの責任者を取得する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
プロセス キー
|
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 | |
|
Email
|
users.email | string |
実行 (BPM)
現在のワークフロー ステップでオプションを送信します。 ビジネス ルールに応じて、レコードはプロセスの次のステップに進み、次のステップに関する情報を呼び出し元 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 |
戻り値
- Body
- ExecuteBPMResult
実行 (テンプレート)
提供された 'profile-key' に基づいて、Agilit-e からテンプレートを処理して返します
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
プロファイル キー
|
profile-key | True | string |
対象プロファイルの一意キー |
|
|
object |
戻り値
- Body
- StdJSONResponse
数値の生成 (番号付け)
指定された 'profile-key' に基づいて一意の番号を生成します
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
プロファイル キー
|
profile-key | True | string |
対象プロファイルの一意キー |
|
|
object |
戻り値
- Body
- 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 |
ステップ オプションを説明する簡単な説明 |
|
Step Option イベント スタンプ
|
stepOptions.eventStamp | array of string |
現在のステップ オプションのイベント スタンプ |
|
ステップ オプション名
|
stepOptions.name | string |
ステップ オプションの短い名前 |
|
次のステップ
|
stepOptions.nextStep | string |
ビジネス プロセスがルーティングされる次のステップ。 それ以上の手順がない場合は空のままにします |
|
ステップ オプションに関する注意事項
|
stepOptions.notes | string |
ステップ オプションのオプションに関する省略可能な注意事項 |
|
visibleObjects
|
stepOptions.visibleObjects | array of object | |
|
Step Option オブジェクト ID
|
stepOptions.visibleObjects.id | string |
UI で参照されるコンポーネントの ID |
|
choices
|
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 |
|
choices
|
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 | |
|
Step Option オブジェクト ID
|
processSteps.stepOptions.visibleObjects.id | string |
UI で参照されるコンポーネントの ID |
|
choices
|
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 |
|
choices
|
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 イベント スタンプ
|
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
|
roles | array of object | |
|
ロール名
|
roles.name | string |
ロールの名前 |
|
users
|
roles.users | array of object | |
|
ロールの電子メール
|
roles.users.email | string |
ロール名にリンクされている電子メール アドレス |
|
stepOptions
|
stepOptions | array of object | |
|
ステップ オプションの説明
|
stepOptions.description | string |
ステップ オプションを説明する簡単な説明 |
|
Step Option イベント スタンプ
|
stepOptions.eventStamp | array of string |
現在のステップ オプションのイベント スタンプ |
|
ステップ オプション名
|
stepOptions.name | string |
ステップ オプションの短い名前 |
|
次のステップ
|
stepOptions.nextStep | string |
ビジネス プロセスがルーティングされる次のステップ。 それ以上の手順がない場合は空のままにします |
|
ステップ オプションに関する注意事項
|
stepOptions.notes | string |
ステップ オプションのオプションに関する省略可能な注意事項 |
|
visibleObjects
|
stepOptions.visibleObjects | array of object | |
|
Step Option オブジェクト ID
|
stepOptions.visibleObjects.id | string |
UI で参照されるコンポーネントの ID |
|
choices
|
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 |
|
choices
|
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 | 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 イベント スタンプ
|
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
|
roles | array of object | |
|
ロール名
|
roles.name | string |
ロールの名前 |
|
users
|
roles.users | array of object | |
|
ロールの電子メール
|
roles.users.email | string |
ロール名にリンクされている電子メール アドレス |
|
stepOptions
|
stepOptions | array of object | |
|
ステップ オプションの説明
|
stepOptions.description | string |
ステップ オプションを説明する簡単な説明 |
|
Step Option イベント スタンプ
|
stepOptions.eventStamp | array of string |
現在のステップ オプションのイベント スタンプ |
|
ステップ オプション名
|
stepOptions.name | string |
ステップ オプションの短い名前 |
|
次のステップ
|
stepOptions.nextStep | string |
ビジネス プロセスがルーティングされる次のステップ。 それ以上の手順がない場合は空のままにします |
|
ステップ オプションに関する注意事項
|
stepOptions.notes | string |
ステップ オプションの省略可能な注意事項 |
|
visibleObjects
|
stepOptions.visibleObjects | array of object | |
|
Step Option オブジェクト ID
|
stepOptions.visibleObjects.id | string |
UI で参照されるコンポーネントの ID |
|
choices
|
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 |
|
choices
|
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 |
結果 |
オブジェクト
これは型 'object' です。