Skip to main content

 

 

 

 

Template:OutSystems/Documentation_KB/Breadcrumb_New_Layout

 

 

Template:OutSystems/OSLanguageSwitcher

 

 

 

OutSystems

LifeTime API v2

LifeTime APIを使用すると、OutSystemsインフラのアプリケーション、モジュール、環境、デプロイを管理できます。このAPIのバージョン2では、デプロイメントゾーン、ユーザー、チーム、ロールのサポートが追加されています。

APIリクエストの認証については、「REST API認証」に示されているガイドラインに従ってください。

LifeTime APIを使用して一般的なタスクを実行する方法については、「LifeTime APIの例」をご覧ください。

LifeTime API v2用のSwaggerファイルは、ダウンロード領域にあるLifeTime管理コンソールの各バージョンの詳細ページ内にあります。

概要

ベースURL
/lifetimeapi/rest/v2
バージョン
v2
スキーマ
https

/applications

Endpoint 説明
GET /applications/ インフラ内に存在するアプリケーションのリストを返します。
GET /applications/{ApplicationKey}/ 指定されたアプリケーションの詳細を返します。
GET /applications/{ApplicationKey}/versions/ 指定されたアプリケーションのバージョンのリストを返します。
DELETE /applications/{ApplicationKey}/versions/{VersionKey}/ 可能な場合、アプリケーションバージョンを破棄します。実行中のバージョンやデプロイで使用されているバージョンは削除できません。
GET /applications/{ApplicationKey}/versions/{VersionKey}/ 指定されたアプリケーションの指定されたバージョンの詳細を返します。
GET /applications/{ApplicationKey}/versions/{VersionKey}/content/ 指定されたアプリケーションバージョンのバイナリファイルをダウンロードできる場所のリンクを返します。このリンクは60分で期限切れになります。

/environments

Endpoint 説明
GET /environments/ インフラ内のすべての環境をリスト化します。
GET /environments/{EnvironmentKey}/ 指定された環境の詳細を返します。
GET /environments/{EnvironmentKey}/applications/ 指定された環境内のすべてのアプリケーションの実行中のバージョンに関する情報を返します。
POST /environments/{EnvironmentKey}/applications/ 環境で新しいWebアプリケーションを作成します。
GET /environments/{EnvironmentKey}/applications/{ApplicationKey}/ 指定された環境内の指定されたアプリケーションの実行中のバージョンに関する情報を返します。
GET /environments/{EnvironmentKey}/applications/{ApplicationKey}/content/ 指定されたアプリケーションのバイナリファイルをダウンロードできる場所のリンクを返します。このリンクは60分で期限切れになります。
POST /environments/{EnvironmentKey}/applications/{ApplicationKey}/versions/ 現在実行中のアプリケーションに基づいて、アプリケーションの新しいバージョンを作成します。
GET /environments/{EnvironmentKey}/deploymentzones/ 指定された環境内で利用できるデプロイメントゾーンに関する情報を返します。
GET /environments/{EnvironmentKey}/templates/ 指定された環境内で利用できるテンプレートに関する情報を返します。

/deployments

Endpoint 説明
POST /deployments/ ターゲット環境へのデプロイを作成します。デプロイに含めるアプリケーションの任意指定のリストを指定できます。入力はデプロイオブジェクトのサブセットです。
GET /deployments/ デプロイの作成日順(最新から最古)のリストを返します。
DELETE /deployments/{DeploymentKey}/ 可能な場合、デプロイを破棄します。削除できるのは状態が「saved」のデプロイのみです。
PUT /deployments/{DeploymentKey}/ 指定されたデプロイを更新します。デプロイに含めるアプリケーションの任意指定のリストを指定できます。入力はデプロイオブジェクトのサブセットです。
GET /deployments/{DeploymentKey}/ 指定されたデプロイの詳細を返します。返される情報には、含まれるアプリケーションと、現在のアプリケーションのデプロイによって発生する可能性のある衝突が含まれます。
POST /deployments/{DeploymentKey}/{Command}/ 指定されたデプロイで指定されたコマンドを実行します。実行できるコマンドは「start」、「continue」、「abort」です。
GET /deployments/{DeploymentKey}/status/ デプロイステータスおよびメッセージを含む、指定されたデプロイ実行の詳細を返します。

/modules

Endpoint 説明
GET /modules/ インフラ内に存在するモジュールのリストを返します。
GET /modules/{ModuleKey}/ 指定されたモジュールの詳細を返します。
GET /modules/{ModuleKey}/versions/ 指定されたモジュールのバージョンのリストを返します。
GET /modules/{ModuleKey}/versions/{ModuleVersionKey}/ 指定されたモジュールバージョンの詳細を返します。

/roles

Endpoint 説明
GET /roles/ すべてのロールをリスト化します。
POST /roles/ 指定された権限を持つロールを作成します。
GET /roles/{RoleKey}/ 指定されたロールの詳細を返します。
PUT /roles/{RoleKey}/ 指定された権限を持つロールを更新します。
DELETE /roles/{RoleKey}/ ロールを削除します。
GET /roles/permissionlevels/ 利用できる権限レベルを取得します。

/teams

Endpoint 説明
GET /teams/ すべてのチームをリスト化します。
POST /teams/ 指定された詳細を持つチームを作成します。この操作によって作成されるのはチームのみです。特定のエンドポイントを使用してユーザーとアプリケーションを関連付ける必要があります。
GET /teams/{TeamKey}/ 指定されたチームの詳細を返します。
PUT /teams/{TeamKey}/
DELETE /teams/{TeamKey}/ 指定されたチームからアプリケーションを削除します。
POST /teams/{TeamKey}/applications/ 指定されたアプリケーションを指定されたチームに追加します。
DELETE /teams/{TeamKey}/applications/{ApplicationKey} 指定されたチームからアプリケーションを削除します。
POST /teams/{TeamKey}/users/ 指定されたロールを持つチームにユーザーを追加します。
DELETE /teams/{TeamKey}/users/{UserKey}/ 指定されたチームからユーザーを削除します。

/users

Endpoint 説明
GET /users/ すべてのユーザーをリスト化します。デフォルトではアクティブユーザーのみを表示します。
POST /users/ 指定された詳細を持つユーザーを作成します。この操作によって作成されるのはユーザーのみです。特定のエンドポイントを使用してチームとアプリケーションを関連付ける必要があります。
GET /users/{UserKey}/ 指定されたユーザーの詳細を返します。
PUT /users/{UserKey}/ 指定された詳細を持つユーザーを更新します。この操作によって更新されるのはユーザーの詳細のみです。特定のエンドポイントを使用してチームとアプリケーションを関連付ける必要があります。
POST /users/{UserKey}/setpassword/ 指定されたユーザーのパスワードの変更を可能にします。
POST /users/{UserKey}/applications/ 指定されたアプリケーションに対する指定されたロールをユーザーに付与します。
DELETE /users/{UserKey}/applications/{ApplicationKey}/ アプリケーション権限のユーザーのロールを取り消します。

Endpoints

GET /applications/

移動先: /applications

インフラ内に存在するアプリケーションのリストを返します。

IncludeModules

Trueに設定されている場合、モジュールも返されます。デフォルト値はFalseです。

クエリ boolean
IncludeEnvStatus

Trueに設定されている場合、各環境のアプリケーションのステータスも返されます。デフォルト値はFalseです。

クエリ boolean

application/json

200 OK

アプリケーションのリストが正常に取得されました。

Applicationレコードのリスト。リクエストされた場合はAppStatusInEnvサブリストを含みます。

Application
204 No Content

インフラ内に利用できるアプリケーションがありません。

400 Bad Request

IncludeModulesがリクエストされたがIncludeEnvStatusがリクエストされなかったため、またはすべてのアプリケーションをリスト化するときのリクエストが無効なため、アプリケーションを取得できませんでした。

500 Internal Server Error

アプリケーションをリスト化できませんでした。

GET /applications/{ApplicationKey}/

移動先: /applications

指定されたアプリケーションの詳細を返します。

ApplicationKey

目的のアプリケーションのキー。

パス string
IncludeModules

Trueに設定されている場合、モジュールの詳細も取得されます。デフォルト値はFalseです。

クエリ boolean
IncludeEnvStatus

Trueに設定されている場合、各環境のアプリケーションのステータスも返されます。デフォルト値はFalseです。

クエリ boolean

application/json

200 OK

Applicationレコード。リクエストされた場合はAppStatusInEnvサブリストを含みます。

400 Bad Request

IncludeModulesパラメータとIncludeEnvStatusパラメータが正しくなかったため、アプリケーションを取得できませんでした。

403 Forbidden

ユーザーの権限が不十分なため、すべてのアプリケーションをリスト化できませんでした。

404 Not Found

いずれかの環境が見つからなかったため、実行中のアプリケーションを取得できませんでした。

500 Internal Server Error

アプリケーションを取得できませんでした。

GET /applications/{ApplicationKey}/versions/

移動先: /applications

指定されたアプリケーションのバージョンのリストを返します。

ApplicationKey

目的のアプリケーションのキー。

パス string
ChangeLogFilter

オプションのフィルタ。存在する場合、変更ログにこの文字列が含まれるバージョンのみが返されます。

クエリ string
MaximumVersionsToReturn

返すバージョンの最大数。デフォルト値は5です。

クエリ integer (int32)

application/json

200 OK

アプリケーションバージョンのリストが正常に取得されました。

ApplicationVersionレコードのリスト。

ApplicationVersion_v2
400 Bad Request

返す最大バージョン(0未満)が無効なため、無効なリクエストです。

403 Forbidden

キー<ApplicationKey>のアプリケーションを取得できませんでした。ユーザーに必要な権限がありません。

404 Not Found

キー<ApplicationKey>のアプリケーションを取得できませんでした。

500 Internal Server Error

アプリケーションバージョンをリスト化できませんでした。

DELETE /applications/{ApplicationKey}/versions/{VersionKey}/

移動先: /applications

可能な場合、アプリケーションバージョンを破棄します。実行中のバージョンやデプロイで使用されているバージョンは削除できません。

ApplicationKey

バージョンを削除するアプリケーションのキー。

パス string
VersionKey

削除するアプリケーションバージョンのキー。

パス string
204 No Content

アプリケーションバージョンが正常に削除されました。

403 Forbidden

指定されたアプリケーションバージョンを削除する権限がサービスアカウントにありません。

404 Not Found

アプリケーションまたはアプリケーションバージョンが見つかりませんでした。

500 Internal Server Error

アプリケーションバージョン<VersionKey>を削除できませんでした。

GET /applications/{ApplicationKey}/versions/{VersionKey}/

移動先: /applications

指定されたアプリケーションの指定されたバージョンの詳細を返します。

ApplicationKey

バージョンがリクエストされているアプリケーションのキー。

パス string
IncludeModules

Trueに設定されている場合、モジュールの詳細も取得されます。デフォルト値はFalseです。

クエリ boolean
VersionKey

目的のアプリケーションバージョンのキー。

パス string

application/json

200 OK

ApplicationVersionレコード。

403 Forbidden

キー<ApplicationKey>のアプリケーションを取得できませんでした。ユーザーに必要な権限がありません。

404 Not Found

キー<ApplicationKey>のアプリケーションを取得できませんでした。

500 Internal Server Error

アプリケーションバージョンを取得できませんでした。

GET /applications/{ApplicationKey}/versions/{VersionKey}/content/

移動先: /applications

指定されたアプリケーションバージョンのバイナリファイルをダウンロードできる場所のリンクを返します。このリンクは60分で期限切れになります。

ApplicationKey

バイナリファイルのリンクを取得するアプリケーションのキー。

パス string
VersionKey

バイナリファイルのリンクを取得するアプリケーションバージョンのキー。

パス string

application/json

200 OK

アプリケーションのバイナリファイルのリンク。

Expires

返されるリンクの有効期限の日時。

string(date-time)
204 No Content

指定されたキーには利用できるバイナリがありません。

400 Bad Request

指定されたキー(Application:<ApplicationKey>; ApplicationVersionKey <ApplicationVersionKey>)に対するリクエストが無効です。

403 Forbidden

指定されたキー(Application:<ApplicationKey>; ApplicationVersionKey <ApplicationVersionKey>)に対する権限がユーザーにありません。

404 Not Found

キー<ApplicationKey>のアプリケーションまたはキー<ApplicationVersionKey>のアプリケーションバージョンを取得できませんでした。

500 Internal Server Error

アプリケーションバージョンのoapをダウンロードできませんでした。

GET /deployments/

移動先: /deployments

デプロイの作成日順(最新から最古)のリストを返します。

MinDate

返すデプロイの作成日の最小値。デフォルト値は現在の日付の1週間前です。

クエリ string (date)
MaxDate

返すデプロイの作成日の最大値。デフォルト値は現在の日付です。

クエリ string (date)
TargetEnvironmentKey

デプロイを返すターゲット環境のキー。ユーザーに環境にアクセスする権限がない場合、空のリストが返されます。環境キーが渡されなかった場合、リストはターゲット環境でフィルタリングされません。

クエリ string

application/json

200 OK

デプロイのリストが正常に取得されました。

Deploymentレコードのリスト。

Deployment_v2
204 No Content

環境キー<TargetEnvironmentKey>には、<MinDate><MaxDate>の間に作成されたデプロイがありません。

400 Bad Request

環境キー<TargetEnvironmentKey><MinDate><MaxDate>の間に作成されたデプロイのリストに対する無効なリクエストです。

403 Forbidden

ユーザーには環境にアクセスする権限がありません。

500 Internal Server Error

デプロイをリスト化できませんでした。

POST /deployments/

移動先: /deployments

ターゲット環境へのデプロイを作成します。デプロイに含めるアプリケーションの任意指定のリストを指定できます。入力はデプロイオブジェクトのサブセットです。

application/json


text/plain

200 OK

デプロイが正常に作成されました。

新しく作成されたデプロイのキー。

400 Bad Request

無効なリクエストです。

403 Forbidden

無効なユーザー権限です。

404 Not Found

ソース環境またはターゲット環境が見つかりません。

500 Internal Server Error

環境<SourceEnvironmentKey>から環境<TargetEnvironmentKey>へのデプロイを作成できませんでした。

DELETE /deployments/{DeploymentKey}/

移動先: /deployments

可能な場合、デプロイを破棄します。削除できるのは状態が「saved」のデプロイのみです。

DeploymentKey

削除するデプロイのキー。

パス string
204 No Content

デプロイが正常に削除されました。

400 Bad Request

キー<DeploymentKey>のデプロイを削除できません。

403 Forbidden

キー<DeploymentKey>のデプロイに対する権限がサービスアカウントにありません。

404 Not Found

キー<DeploymentKey>のデプロイが見つかりません。

500 Internal Server Error

デプロイ<DeploymentKey>を削除できませんでした。

GET /deployments/{DeploymentKey}/

移動先: /deployments

指定されたデプロイの詳細を返します。返される情報には、含まれるアプリケーションと、現在のアプリケーションのデプロイによって発生する可能性のある衝突が含まれます。

DeploymentKey

目的のデプロイのキー。

パス string

application/json

200 OK

デプロイの詳細が正常に取得されました。

403 Forbidden

キー<DeploymentKey>のデプロイに対する権限がユーザーにありません。

404 Not Found

キー<DeploymentKey>のデプロイが見つかりません。

500 Internal Server Error

キー<DeploymentKey>のデプロイの詳細にアクセスできませんでした。

PUT /deployments/{DeploymentKey}/

移動先: /deployments

指定されたデプロイを更新します。デプロイに含めるアプリケーションの任意指定のリストを指定できます。入力はデプロイオブジェクトのサブセットです。

application/json


DeploymentKey

更新するデプロイのキー。

パス string

application/json

200 OK

デプロイが正常に更新されました。

400 Bad Request

無効なリクエストです。

403 Forbidden

無効なユーザー権限です。

404 Not Found

デプロイ計画が見つかりません。

500 Internal Server Error

キー<DeploymentKey>のデプロイを更新できませんでした。

GET /deployments/{DeploymentKey}/status/

移動先: /deployments

デプロイステータスおよびメッセージを含む、指定されたデプロイ実行の詳細を返します。

DeploymentKey

ステータスがリクエストされているデプロイのキー。

パス string

application/json

200 OK

デプロイのステータスが正常に取得されました。

403 Forbidden

キー<DeploymentKey>のデプロイに対する権限がユーザーにありません。

404 Not Found

キー<DeploymentKey>のデプロイが見つかりません。

500 Internal Server Error

キー<DeploymentKey>のデプロイのステータスを取得できませんでした。

POST /deployments/{DeploymentKey}/{Command}/

移動先: /deployments

指定されたデプロイで指定されたコマンドを実行します。実行できるコマンドは「start」、「continue」、「abort」です。

DeploymentKey

コマンドが実行されるデプロイのキー。

パス string
Command

実行するコマンド。「start」、「continue」、「abort」のいずれかです。

パス string
RedeployOutdated

Trueの場合、ターゲット環境内の古いアプリケーションが再デプロイされます。

クエリ boolean
202 Accepted

デプロイ<DeploymentKey>に対してコマンド<Command>が正常に実行されました。

400 Bad Request

デプロイ<DeploymentKey>に対してコマンド<Command>を実行できません。

403 Forbidden

キー<DeploymentKey>のデプロイに対する権限がサービスアカウントにありません。

404 Not Found

キー<DeploymentKey>のデプロイが見つからないか、コマンドが見つかりません。

500 Internal Server Error

キー<DeploymentKey>のデプロイに対してコマンド<Command>を実行できませんでした。

GET /environments/

移動先: /environments

インフラ内のすべての環境をリスト化します。

application/json

200 OK

環境のリストが正常に取得されました。

Environmentレコードのリスト。

Environment
204 No Content

環境が見つかりませんでした。

500 Internal Server Error

環境をリスト化できませんでした。

GET /environments/{EnvironmentKey}/

移動先: /environments

指定された環境の詳細を返します。

EnvironmentKey

目的の環境のキー。

パス string

application/json

200 OK

環境の詳細が正常に取得されました。

403 Forbidden

次のキーの環境を取得できませんでした: <EnvironmentKey>.ユーザーに必要な権限がありません。

404 Not Found

次のキーの環境を取得できませんでした:<EnvironmentKey>

500 Internal Server Error

環境の詳細にアクセスできませんでした。

GET /environments/{EnvironmentKey}/applications/

移動先: /environments

指定された環境内のすべてのアプリケーションの実行中のバージョンに関する情報を返します。

EnvironmentKey

実行中のアプリケーションのリストがリクエストされている環境のキー。

パス string
IncludeModules

Trueに設定されている場合、モジュールの詳細も取得されます。デフォルト値はFalseです。

クエリ boolean
IncludeEnvStatus

Trueに設定されている場合、環境内のアプリケーションのステータス情報が結果に含まれます。デフォルト値はFalseです。

クエリ boolean

application/json

200 OK

指定された環境のアプリケーションのリストが正常に取得されました。

Applicationレコードのリスト。

Application
204 No Content

キー<EnvironmentKey>の環境内でアプリケーションが見つかりませんでした。

400 Bad Request

IncludeModulesパラメータとIncludeEnvStatusパラメータが正しくなかったため、またはキー<EnvironmentKey>の環境の実行中のアプリケーションを取得するときのリクエストが無効なため、環境内でパブリッシュされたアプリケーションを取得できませんでした。

403 Forbidden

キー<EnvironmentKey>の環境のユーザーの権限が不十分なため、実行中のアプリケーションを取得できませんでした。

404 Not Found

キー<EnvironmentKey>の環境が見つからなかったため、実行中のアプリケーションを取得できませんでした。

POST /environments/{EnvironmentKey}/applications/

移動先: /environments

環境で新しいWebアプリケーションを作成します。

新しいアプリケーションの名前、説明、その他のアトリビュートを保持するストラクチャ。


EnvironmentKey

アプリケーションを作成する環境のキー。

パス string

application/json

201 Created

新しく作成されたアプリケーションのキー。

400 Bad Request

アプリケーション名、ランタイムの種類、テンプレート、色、チームのいずれかが無効なため、アプリケーションを作成できませんでした。

403 Forbidden

ユーザーの権限が不十分なため、アプリケーションを作成できませんでした。

404 Not Found

キー<EnvironmentKey>の環境が見つからなかったため、アプリケーションを作成できませんでした。

500 Internal Server Error

内部エラーのため、アプリケーションを作成できませんでした。

GET /environments/{EnvironmentKey}/applications/{ApplicationKey}/

移動先: /environments

指定された環境内の指定されたアプリケーションの実行中のバージョンに関する情報を返します。

EnvironmentKey

実行中のアプリケーションの詳細を取得する環境のキー。

パス string
ApplicationKey

詳細がリクエストされているアプリケーションのキー。

パス string
IncludeEnvStatus

Trueに設定されている場合、環境内のアプリケーションのステータス情報が結果に含まれます。デフォルト値はFalseです。

クエリ boolean
IncludeModules

Trueに設定されている場合、モジュールの詳細も取得されます。デフォルト値はFalseです。

クエリ boolean

application/json

200 OK

アプリケーションの情報が正常に取得されました。

400 Bad Request

ステータスではなくモジュールを要求するリクエストです。

403 Forbidden

指定されたキー(EnvironmentKey:<EnvironmentKey>; Application:<ApplicationKey>)に対する権限がユーザーにありません。

404 Not Found

キー<EnvironmentKey>の環境またはキー<ApplicationKey>のアプリケーションを取得できませんでした。

500 Internal Server Error

アプリケーションの実行中のバージョンにアクセスできませんでした。

GET /environments/{EnvironmentKey}/applications/{ApplicationKey}/content/

移動先: /environments

指定されたアプリケーションのバイナリファイルをダウンロードできる場所のリンクを返します。このリンクは60分で期限切れになります。

EnvironmentKey

アプリケーションのバイナリファイルのリンクを取得する環境のキー。

パス string
ApplicationKey

バイナリファイルのリンクを取得するアプリケーションのキー。

パス string
Type

返すバイナリファイルのタイプ(該当する場合)。「oap」、「apk」、「ipa」のいずれかです。

クエリ string

application/json

200 OK

バイナリファイルのダウンロードリンクが正常に取得されました。

Expires

返されるリンクの有効期限の日時。

string (date-time)
204 No Content

指定されたタイプおよびキーには利用できるバイナリがありません。

400 Bad Request

指定されたキー(EnvironmentKey:<EnvironmentKey>; Application:<ApplicationKey>)に対して必要なタイプ<Type>が無効です。

403 Forbidden

指定されたキー(EnvironmentKey:<EnvironmentKey>; Application:<ApplicationKey>)に対する権限がユーザーにありません。

404 Not Found

キー<EnvironmentKey>の環境またはキー<ApplicationKey>のアプリケーションを取得できませんでした。

500 Internal Server Error

アプリケーションの<Type>をダウンロードできませんでした。

POST /environments/{EnvironmentKey}/applications/{ApplicationKey}/versions/

移動先: /environments

現在実行中のアプリケーションに基づいて、アプリケーションの新しいバージョンを作成します。

application/json

該当する場合、アプリケーションとそのネイティブアプリケーションの新しいバージョン名を保持するストラクチャ。


EnvironmentKey

アプリケーションを取得する環境のキー。

パス string
ApplicationKey

新しいバージョンを生成するアプリケーションのキー。

パス string

application/json

201 Created

アプリケーションバージョンが正常に作成されました。

400 Bad Request

無効なリクエストです。

403 Forbidden

無効なユーザー権限です。

404 Not Found

環境またはアプリケーションが見つかりません。

500 Internal Server Error

アプリケーションをタグ付けできなかったか、アプリケーション<ApplicationName>の新しいバージョンを作成できませんでした。

GET /environments/{EnvironmentKey}/deploymentzones/

移動先: /environments

指定された環境内で利用できるデプロイメントゾーンに関する情報を返します。

EnvironmentKey

実行中のアプリケーションの詳細を取得する環境のキー。

パス string

application/json

200 OK

デプロイメントゾーンの情報が正常に取得されました。

DeploymentZoneレコードのリスト。

DeploymentZone_v2
400 Bad Request

環境のデプロイメントゾーンにアクセスできませんでした。

403 Forbidden

環境<EnvironmentName>(キー: <EnvironmentKey>)のデプロイメントゾーンを取得できませんでした。エラー: ユーザーに必要な権限がないか、機能がライセンス付与されていません。

404 Not Found

次のキーの環境のデプロイメントゾーンを取得できませんでした:<EnvironmentKey>

500 Internal Server Error

環境のデプロイメントゾーンにアクセスできませんでした。

GET /environments/{EnvironmentKey}/templates/

移動先: /environments

指定された環境内で利用できるテンプレートに関する情報を返します。

EnvironmentKey

実行中のアプリケーションの詳細を取得する環境のキー。

パス string

application/json

200 OK

テンプレートのリストが正常に取得されました。

Templateレコードのリスト。

Template
400 Bad Request

環境ではテンプレートのリスト化がサポートされていません。

403 Forbidden

ユーザーには権限がありません。

404 Not Found

環境が見つかりません。

500 Internal Server Error

内部エラーが発生しました。

GET /modules/

移動先: /modules

インフラ内に存在するモジュールのリストを返します。

IncludeEnvStatus

Trueに設定されている場合、各環境のモジュールのステータスも返されます。デフォルト値はFalseです。

クエリ boolean

application/json

200 OK

モジュールのリストが正常に取得されました。

Moduleレコードのリスト。

Module
204 No Content

インフラ内でモジュールが見つかりませんでした。

500 Internal Server Error

モジュールをリスト化できませんでした。

GET /modules/{ModuleKey}/

移動先: /modules

指定されたモジュールの詳細を返します。

ModuleKey

詳細をリスト化するモジュールのキー。

パス string
IncludeEnvStatus

各環境のステータスを返す必要があるかどうかを示すBoolean。デフォルトはFalseです。

クエリ boolean

application/json

200 OK

モジュールの詳細が正常に取得されました。

403 Forbidden

次のキーのモジュールを取得できませんでした:<ModuleKey>。ユーザーに必要な権限がありません。

404 Not Found

次のキーのモジュールを取得できませんでした:<ModuleKey>

500 Internal Server Error

キー<ModuleKey>のモジュールを取得できませんでした。

GET /modules/{ModuleKey}/versions/

移動先: /modules

指定されたモジュールのバージョンのリストを返します。

ModuleKey

バージョンを取得するモジュール。

パス string
MaximumVersionsToReturn

返すバージョンの最大数。デフォルトは5です。

クエリ integer (int32)

application/json

200 OK

モジュールバージョンのリストが正常に取得されました。

ModuleVersionレコードのリスト。

ModuleVersion_v2
400 Bad Request

返す最大バージョン(0未満)が無効なため、無効なリクエストです。

403 Forbidden

次のキーのモジュールを取得できませんでした:<ModuleKey>。ユーザーに必要な権限がありません。

404 Not Found

次のキーのモジュールを取得できませんでした:<ModuleKey>

500 Internal Server Error

モジュールバージョンをリスト化できませんでした。

GET /modules/{ModuleKey}/versions/{ModuleVersionKey}/

移動先: /modules

指定されたモジュールバージョンの詳細を返します。

ModuleKey

バージョンを取得するモジュール。

パス string
ModuleVersionKey

返すモジュールバージョンのキー。

パス string

application/json

200 OK

モジュールバージョンの詳細が正常に取得されました。

403 Forbidden

次のキーのモジュールを取得できませんでした:s<ModuleKey>。ユーザーに必要な権限がありません。

404 Not Found

次のキーのモジュールを取得できませんでした:<ModuleKey>, or Failed to retrieve the module version with key: <ModuleKey>

500 Internal Server Error

モジュールバージョンの詳細にアクセスできませんでした。

GET /roles/

移動先: /roles

すべてのロールをリスト化します。

IncludeEnvPermissions

各ロールに対する環境の権限のリストを含めるかどうかを定義します。

クエリ boolean

application/json

200 OK

ロールのリスト。

403 Forbidden

ユーザーにはロールのリストを取得する権限がありません。

500 Internal Server Error

内部エラーが発生しました。

POST /roles/

移動先: /roles

指定された権限を持つロールを作成します。

application/json

作成するロール。


text/plain

201 Created

ロールが正常に作成されました。

新しく作成されたロールのキー。

400 Bad Request

ロール名が無効であるか、ロールが保護されているか、インフラと管理チームのフラグの組み合わせが正しくないか、すべての環境に対する権限が定義されていないまたは正しくないかのいずれかの理由のため、ロールを作成できませんでした。

403 Forbidden

新しいロールを作成する権限がありません。

500 Internal Server Error

内部エラーが発生しました。

GET /roles/permissionlevels/

移動先: /roles

利用できる権限レベルを取得します。

application/json

200 OK

権限レベルのリスト。

403 Forbidden

ユーザーとロールを管理する権限がありません。

500 Internal Server Error

内部エラー。

DELETE /roles/{RoleKey}/

移動先: /roles

ロールを削除します。

RoleKey

削除するロールのキー。

パス string
UsersNewRoleKey

削除するロールが割り当てられているユーザーに対して、このロールの代わりに割り当てるロールを示します(デフォルトでは、アプリケーションロールとチームロールの両方)。このロールが割り当てられているユーザーがいる場合に必要です。

クエリ boolean
204 No Content

ロールが正常に削除されました。

400 Bad Request

ロールが予約されているため削除できません。

403 Forbidden

ロールを削除する権限がありません。

404 Not Found

ロールが見つかりません。

500 Internal Server Error

内部エラーが発生しました。

GET /roles/{RoleKey}/

移動先: /roles

指定されたロールの詳細を返します。

RoleKey

取得するロールのキー。

パス string
IncludeEnvPermissions

ロールに対する環境の権限のリストを含めるかどうかを定義します。

クエリ boolean

application/json

200 OK

Roleのレコード。

403 Forbidden

ユーザーには権限がありません。

404 Not Found

ロールが見つかりません。

500 Internal Server Error

内部エラーが発生しました。

PUT /roles/{RoleKey}/

移動先: /roles

指定された権限を持つロールを更新します。

application/json

更新するロール。


RoleKey

更新するロールのキー。

パス string

text/plain

200 OK

ロールが正常に更新されました。

更新されたロールのキー。

400 Bad Request

ロール名が無効であるか、ロールが保護されているか、インフラと管理チームのフラグの組み合わせが正しくないか、すべての環境に対する権限が定義されていないまたは正しくないかのいずれかの理由のため、ロールを更新できませんでした。

403 Forbidden

ロールを更新する権限がありません。

404 Not Found

ロールが見つかりません。

500 Internal Server Error

内部エラーが発生しました。

GET /teams/

移動先: /teams

すべてのチームをリスト化します。

IncludeUsers

チームに属するユーザーのリストを含めるかどうかを定義します。

クエリ boolean
IncludeApplications

チームに属するアプリケーションのリストを含めるかどうかを定義します。

クエリ boolean

application/json

200 OK

チームのリストが正常に取得されました。

Teamレコードのリスト。リクエストされた場合はユーザーとアプリケーションのサブリストを含みます。

Team
204 No Content

チームが定義されていません。

403 Forbidden

ユーザーにはチームのリストを取得する権限がありません。

500 Internal Server Error

内部エラーが発生しました。

POST /teams/

移動先: /teams

指定された詳細を持つチームを作成します。この操作によって作成されるのはチームのみです。特定のエンドポイントを使用してユーザーとアプリケーションを関連付ける必要があります。

作成するチーム。


201 Created

チームが正常に作成されました。

400 Bad Request

チーム名が無効なため、チームを作成できませんでした。

403 Forbidden

新しいチームを作成する権限がありません。

500 Internal Server Error

内部エラーが発生しました。

DELETE /teams/{TeamKey}/

移動先: /teams

チームを削除します。

TeamKey

削除するチームのキー。

パス string
204 No Content

チームが正常に削除されました。

403 Forbidden

チームを削除する権限がありません。

404 Not Found

チームが見つかりません。

500 Internal Server Error

内部エラーが発生しました。

GET /teams/{TeamKey}/

移動先: /teams

指定されたチームの詳細を返します。

TeamKey

取得するチームのキー。

パス string
IncludeUsers

チームに属するユーザーのリストを含めるかどうかを定義します。

クエリ boolean
IncludeApplications

チームに属するアプリケーションのリストを含めるかどうかを定義します。

クエリ boolean
200 OK

Teamのレコード。

403 Forbidden

ユーザーには権限がありません。

404 Not Found

チームが見つかりません。

500 Internal Server Error

内部エラーが発生しました。

PUT /teams/{TeamKey}/

移動先: /teams

指定された詳細を持つチームを更新します。この操作によって影響を受けるのはチームの詳細のみです。特定のエンドポイントを使用してユーザーとアプリケーションを関連付けたり、関連付けを解除したりする必要があります。

更新するチーム。


TeamKey

更新するチームのキー。

パス string
200 OK

チームが正常に更新されました。

400 Bad Request

チーム名が無効なため、チームを更新できませんでした。

403 Forbidden

チームを更新する権限がありません。

404 Not Found

チームが見つかりません。

500 Internal Server Error

内部エラーが発生しました。

POST /teams/{TeamKey}/applications/

移動先: /teams

指定されたアプリケーションを指定されたチームに追加します。

追加するアプリケーションの情報。


TeamKey

アプリケーションを追加するチームのキー。

パス string
201 Created

アプリケーションが正常に追加されました。

400 Bad Request

アプリケーションが存在しないため、チームに追加できませんでした。

403 Forbidden

チームを更新する権限がありません。

404 Not Found

チームが見つかりません。

500 Internal Server Error

内部エラーが発生しました。

DELETE /teams/{TeamKey}/applications/{ApplicationKey}

移動先: /teams

指定されたチームからアプリケーションを削除します。

TeamKey

チームの一意の識別子。

パス string
ApplicationKey

アプリケーションの一意の識別子。

パス string
200 OK

アプリケーションが正常に削除されました。

400 Bad Request

アプリケーションが存在しないため、チームから削除できませんでした。

403 Forbidden

チームを更新する権限がありません。

404 Not Found

チームまたはアプリケーションが見つかりません。

500 Internal Server Error

内部エラーが発生しました。

POST /teams/{TeamKey}/users/

移動先: /teams

指定されたロールを持つチームにユーザーを追加します。

追加するユーザーとロールの情報。


TeamKey

ユーザーを追加するチームのキー。

パス string
201 Created

ユーザーが正常に追加されました。

400 Bad Request

ユーザーまたはロールが存在しないため、ユーザーをチームに追加できませんでした。

403 Forbidden

チームを更新する権限がありません。

404 Not Found

チームが見つかりません。

500 Internal Server Error

内部エラーが発生しました。

DELETE /teams/{TeamKey}/users/{UserKey}/

移動先: /teams

指定されたチームからユーザーを削除します。

TeamKey

ユーザーを削除するチームのキー。

パス string
UserKey

削除するユーザーのキー。

パス string
200 OK

ユーザーが正常に削除されました。

400 Bad Request

ユーザーまたはロールが存在しないため、ユーザーをチームから削除できませんでした。

403 Forbidden

チームを更新する権限がありません。

404 Not Found

チームまたはユーザーが見つかりません。

500 Internal Server Error

内部エラーが発生しました。

GET /users/

移動先: /users

すべてのユーザーをリスト化します。デフォルトではアクティブユーザーのみを表示します。

IncludeInactive

非アクティブユーザーのリストを含めるかどうかを定義します。

クエリ boolean
IncludeTeams

ユーザーが属するチームのリストを含めるかどうかを定義します。

クエリ boolean
IncludeApplicationRoles

ユーザーが関連付けられているアプリケーションのリストを含めるかどうかを定義します。

クエリ boolean

application/json

200 OK

ユーザーのリストが正常に取得されました。

Userレコードのリスト。

User
204 No Content

ユーザーが定義されていません。

403 Forbidden

ユーザーにはユーザーのリストを取得する権限がありません。

500 Internal Server Error

内部エラーが発生しました。

POST /users/

移動先: /users

指定された詳細を持つユーザーを作成します。この操作によって作成されるのはユーザーのみです。特定のエンドポイントを使用してチームとアプリケーションを関連付ける必要があります。

作成するユーザー。


201 Created

ユーザーが正常に作成されました。

新しく作成されたユーザーのキー。

400 Bad Request

ユーザー名、名前、ロールのいずれかが無効なため、ユーザーを作成できませんでした。

403 Forbidden

新しいユーザーを作成する権限がありません。

500 Internal Server Error

内部エラーが発生しました。

GET /users/{UserKey}/

移動先: /users

指定されたユーザーの詳細を返します。

UserKey

取得するユーザーのキー。

パス string
includeTeams

ユーザーが属するチームのリストを含めるかどうかを定義します。

クエリ boolean
includeApplicationRoles

ユーザーが関連付けられているアプリケーションのリストを含めるかどうかを定義します。

クエリ boolean

application/json

200 OK

Userのレコード。

403 Forbidden

ユーザーには権限がありません。

404 Not Found

ユーザーが見つかりません。

500 Internal Server Error

内部エラーが発生しました。

PUT /users/{UserKey}/

移動先: /users

指定された詳細を持つユーザーを更新します。この操作によって更新されるのはユーザーの詳細のみです。特定のエンドポイントを使用してチームとアプリケーションを関連付ける必要があります。

application/json

更新するユーザー。


UserKey

更新するユーザーのキー。

パス string

text/plain

200 OK

ユーザーが正常に更新されました。

更新されたユーザーのキー。

400 Bad Request

ユーザー名、名前、ロールのいずれかが無効なため、ユーザーを更新できませんでした。

403 Forbidden

ユーザーを更新する権限がありません。

404 Not Found

ユーザーが見つかりません。

500 Internal Server Error

内部エラーが発生しました。

POST /users/{UserKey}/applications/

移動先: /users

指定されたアプリケーションに対する指定されたロールをユーザーに付与します。

application/json

権限を付与するアプリケーションとロールのキー。


UserKey

権限を付与するユーザーのキー。

パス string

text/plain

201 Created

権限が正常に付与されました。

400 Bad Request

アプリケーションまたはロールが無効なため、アプリケーションをユーザーに追加できませんでした。

403 Forbidden

ユーザー権限を変更する権限がありません。

404 Not Found

ユーザーが見つかりません。

500 Internal Server Error

内部エラーが発生しました。

DELETE /users/{UserKey}/applications/{ApplicationKey}/

移動先: /users

アプリケーション権限のユーザーのロールを取り消します。

application/json


UserKey

権限を付与するユーザーのキー。

パス string
ApplicationKey

権限を付与するアプリケーションのキー。

パス string

text/plain

204 No Content

権限が正常に取り消されました。

403 Forbidden

ユーザー権限を変更する権限がありません。

404 Not Found

ユーザーまたは権限が見つかりません。

500 Internal Server Error

内部エラーが発生しました。

POST /users/{UserKey}/setpassword/

移動先: /users

指定されたユーザーのパスワードの変更を可能にします。

application/json

新しいパスワードの値。


UserKey

更新するユーザーのキー。

パス string

text/plain

200 OK

ユーザーパスワードが正常に更新されました。

400 Bad Request

パスワードが無効なため、変更できませんでした。

403 Forbidden

ユーザーパスワードを更新する権限がありません。

404 Not Found

ユーザーが見つかりません。

405 Method Not Allowed

外部認証プロバイダが使用中であるため、パスワードを変更できませんでした。

500 Internal Server Error

内部エラーが発生しました。

Structures

Application: object

アプリケーションとその詳細、およびアプリケーションが実行されている環境内でのそのステータス。

Key: string

アプリケーションの一意の識別子。

Name: string

アプリケーションの名前。

Kind: string

アプリケーションの種類を識別します。[Mobile|WebResponsive]

Team: string

アプリケーションを所有しているチーム。

Description: string

アプリケーションの説明。

URLPath: string

ホスト名から始まるアプリケーションの相対URLパス。

IconHash: string

アプリケーションアイコンのハッシュ。アプリケーションアイコンの変更を検出するために使用できます。

IconURL: string

アプリケーションアイコンのURL。

IsSystem: boolean

アプリケーションがAgilePlatformのビルトインコンポーネント(ServiceCenter、LifeTimeなど)であるかどうかを示します。

AppStatusInEnvs: object[]

アプリケーションが実行されている各環境内でのそのステータスに関する情報。


ApplicationConflict: object

デプロイの衝突。

Message: string

衝突の説明。

ProducerApplicationOperation: ApplicationOperation
ConsumerApplicationOperation: ApplicationOperation
ModuleConflict: ModuleConflict

ApplicationConflictListTextListDeployment_v2Record: object

Deployment: Deployment_v2
ApplicationsToRedeploy: string[]
string
ApplicationConflicts: object[]

ApplicationOperation: object

アプリケーションに対するデプロイで実行された操作。

ApplicationKey: string

アプリケーションの一意の識別子。

ApplicationVersionKey: string

アプリケーションバージョンの一意の識別子。

DeploymentOperation: string

実行される操作のラベル。例: Deploy 1.5。


ApplicationOperation_v2: object

アプリケーションに対するデプロイで実行された操作。

ApplicationKey: string

アプリケーションの一意の識別子。

ApplicationVersionKey: string

アプリケーションバージョンの一意の識別子。

DeploymentOperation: string

実行される操作のラベル。例: Deploy 1.5。

DeploymentZoneKey: string

デプロイメントゾーンの一意の識別子。


ApplicationRole: object

アプリケーションとロールのセットを表します。

applicationKey: string
applicationName: string
roleKey: string
roleName: string

ApplicationShortInfo: object

アプリケーションストラクチャの簡素化。

Key: string

アプリケーションの一意の識別子。

Name: string

アプリケーションの名前。


ApplicationVersion_v2: object

アプリケーションの特定のバージョンとそのモジュールのバージョンに関する情報。

Key: string

アプリケーションバージョンの一意の識別子。

ApplicationKey: string

アプリケーションの一意の識別子。

Version: string

アプリケーションのバージョン。

ChangeLog: string

このアプリケーションバージョンに関連付けられた変更ログ。

CreatedOn: string (date-time)

アプリケーションバージョンが作成された日時。

"2014-12-31T23:59:59.938Z"
InUse: boolean

アプリケーションバージョンが使用されているかどうかを定義します。

MobileVersions: object[]

モバイルバージョンのリスト。

PrimaryColor: string

アプリケーションのインターフェイスの初期色。

NativeHash: string

モバイルプラットフォームに関連するネイティブハッシュ。

ModuleVersions: object[]

モジュールバージョンのリスト。


ApplicationVersionCreate: object

該当する場合、アプリケーションとそのネイティブアプリケーションの新しいバージョン名を保持するストラクチャ。

ChangeLog: string

作成するバージョンの変更ログ。

Version: string

アプリケーションのバージョン。

MobileVersions: object[]

モバイルバージョンのリスト。

ModuleVersionKeys: string[]

[非推奨]アプリケーションの現在の状態がまだ期待されるものであるかどうかを検証するモジュールバージョンキーのリスト。このパラメータは、LifeTime Feb 2019 Releaseで非推奨になりました。モジュールバージョンキーを渡す必要はありません。ただし、モジュールバージョンキーが渡された場合は検証されます。

string

ApplicationVersionKeyDeploymentZoneKeyRecordListTextTextTextRecord: object

Notes: string
SourceEnvironmentKey: string
TargetEnvironmentKey: string
ApplicationOperations: object[]

AppStatusInEnv_v2: object

指定された環境内のアプリケーションのステータス。

EnvironmentKey: string

環境の一意の識別子。

BaseApplicationVersionKey: string

ベースアプリケーションバージョンの一意の識別子。環境内のアプリが変更されていない場合、これはデプロイされたアプリケーションバージョンです。

IsModified: boolean

最後のタグ付け以降にアプリケーションが変更されている場合はTrue、それ以外の場合はFalseです。

IsModifiedReason: string

アプリケーションのステータスを示します。

IsModifiedMessage: string

アプリケーションのステータスを示します。

ConsistencyStatus: string

アプリケーションの一貫性ステータスを示します。

ConsistencyStatusMessages: string

アプリケーションの一貫性ステータスに関するメッセージ。

MobileAppsStatus: object[]

環境内のモバイルアプリのステータス。

ModuleStatusInEnvs: object[]

環境内のモジュールのステータス。

DeploymentZoneKey: string

デプロイメントゾーンの一意の識別子。


Deployment_v2: object

デプロイの情報と実行された操作。

Key: string

デプロイの一意の識別子。

SourceEnvironmentKey: string

ソース環境の一意の識別子。

TargetEnvironmentKey: string

ターゲット環境の一意の識別子。

Notes: string

デプロイの注記。

CreatedOn: string (date-time)

デプロイ計画を作成した日時。

"2014-12-31T23:59:59.938Z"
CreatedBy: string

デプロイ計画を作成したユーザーの名前。

CreatedByUsername: string

デプロイ計画を作成したユーザーのユーザー名。

SavedOn: string (date-time)

デプロイ計画を保存した日時。

"2014-12-31T23:59:59.938Z"
SavedBy: string

デプロイ計画を最後に保存したユーザーの名前。

SavedByUsername: string

デプロイ計画を最後に保存したユーザーのユーザー名。

StartedOn: string (date-time)

デプロイを開始した日時。

"2014-12-31T23:59:59.938Z"
StartedBy: string

デプロイを開始したユーザーの名前。

StartedByUsername: string

デプロイを開始したユーザーのユーザー名。

AbortedOn: string (date-time)

デプロイを中止した日時。

"2014-12-31T23:59:59.938Z"
AbortedBy: string

デプロイを中止したユーザーの名前。

AbortedByUsername: string

デプロイを中止したユーザーのユーザー名。

ApplicationOperations: object[]

デプロイに含まれるアプリケーション操作のリスト。


DeploymentData_v2: object

デプロイの情報と実行された操作。

Key: string

デプロイの一意の識別子。

SourceEnvironmentKey: string

ソース環境の一意の識別子。

TargetEnvironmentKey: string

ターゲット環境の一意の識別子。

Notes: string

デプロイの注記。

CreatedOn: string (date-time)

デプロイ計画を作成した日時。

"2014-12-31T23:59:59.938Z"
CreatedBy: string

デプロイ計画を作成したユーザーの名前。

CreatedByUsername: string

デプロイ計画を作成したユーザーのユーザー名。

SavedOn: string (date-time)

デプロイ計画を保存した日時。

"2014-12-31T23:59:59.938Z"
SavedBy: string

デプロイ計画を最後に保存したユーザーの名前。

SavedByUsername: string

デプロイ計画を最後に保存したユーザーのユーザー名。

StartedOn: string (date-time)

デプロイを開始した日時。

"2014-12-31T23:59:59.938Z"
StartedBy: string

デプロイを開始したユーザーの名前。

StartedByUsername: string

デプロイを開始したユーザーのユーザー名。

AbortedOn: string (date-time)

デプロイを中止した日時。

"2014-12-31T23:59:59.938Z"
AbortedBy: string

デプロイを中止したユーザーの名前。

AbortedByUsername: string

デプロイを中止したユーザーのユーザー名。

ApplicationOperations: object[]

デプロイに含まれるアプリケーション操作のリスト。


DeploymentMessage: object

デプロイ操作ログのメッセージ。

Instant: string (date-time)

メッセージがログに記録された日時。

"2014-12-31T23:59:59.938Z"
Message: string

メッセージの詳細。


DeploymentMessageListTextTextRecord: object

DeploymentStatus: string
Info: string
DeploymentLog: object[]

DeploymentTechnology_v2: object

デプロイメントゾーンのデプロイホスティングテクノロジー。

Key: string

デプロイテクノロジーの一意の識別子。

Name: string

デプロイテクノロジーの名前


DeploymentZone_v2: object

環境のデプロイメントゾーン。

Key: string

デプロイメントゾーンの一意の識別子。

Name: string

デプロイメントゾーンの名前

IsDefault: boolean

デプロイメントゾーンが環境内のデフォルトのものである場合はTrueです。

DeploymentTechnology: DeploymentTechnology_v2


Environment: object

環境とその情報。

Key: string

環境の一意の識別子。

Name: string

環境の名前。

OSVersion: string

Platform Serverのバージョン。[X.X.X.X]

Order: integer (int32)

LifeTimeで登録されている環境の順序。

HostName: string

登録されている環境のホスト名。

UseHTTPS: boolean

環境への接続がHTTPSを使用して行われるかどうかを示します。

EnvironmentType: string

環境のタイプを示します。[Development | Test | Production]

NumberOfFrontEnds: integer (int32)

環境内のフロントエンドサーバーの数。

ApplicationServerType: string

アプリケーションサーバーのスタック。[.NET | JAVA]

ApplicationServer: string

使用中のアプリケーションサーバー。[IIS | JBoss | WebLogic]

DatabaseProvider: string

データベースプロバイダのタイプ。[SqlServer | Oracle]

IsCloudEnvironment: boolean

環境がクラウドサービスで実行されているかどうかを示します。

EnvironmentPermission: object

環境の権限の定義。

environmentKey: string

権限を参照する環境のキー。

environmentName: string

権限を参照する環境の名前。

level: integer

権限のレベル。

levelLabel: string

権限レベルの簡単な説明。

createApplications: boolean

新しいアプリケーションの作成を可能にします。

addDependenciesToSystem: boolean

システムアプリケーションへの依存関係の追加を可能にします。

Exception: object

Errors: string[]
string

エラーのすべての詳細。

StatusCode: integer 500

エラーで発生したステータスコード。

MobileAppStatusInEnv: object

指定された環境内のモバイルアプリケーションのステータス。

EnvironmentKey: string

環境の一意の識別子。

NativePlatform: string

ネイティブプラットフォームの名前。[Android | iOS]

VersionNumber: string

ネイティブビルドのバージョン番号(1.5.4など)。これを使用して、バージョンをAndroidまたはiOSストアのバージョンとマッピングできます。

HasBinaryAvailable: boolean

現在の構成でアプリケーションのバイナリが利用できる場合はTrueです。

IsConfigured: boolean

アプリケーションが構成されている場合はTrueです。

IsConfigurationChanged: boolean

環境内のモバイルアプリケーションの構成が変更されている場合はTrueです。

IsModified: boolean

モバイルアプリケーションのネイティブハッシュがAppVersionNativeBuildベースライン内のものと一致しない場合はTrueです。


MobileVersion: object

モバイルバージョンとその情報。

NativePlatform: string

ネイティブプラットフォームの名前。[Android | iOS]

VersionNumber: string

ネイティブビルドのバージョン番号(1.5.4など)。これを使用して、バージョンをAndroidまたはiOSストアのバージョンとマッピングできます。

VersionDescription: string

モバイルバージョンの説明。


Module: object

モジュールが実行されている環境内のモジュールの情報とそのステータス。

Key: string

モジュールの一意の識別子。

Name: string

モジュールの名前。

Description: string

モジュールの説明。

Kind: string

モジュールタイプ(eSpaceまたはExtension)。

ModuleStatusInEnv: object[]

環境内のモジュールのステータス。


ModuleConflict: object

モジュールの衝突。

ProducerModuleKey: string

プロデューサモジュールの一意の識別子。

ConsumerModuleKey: string

コンシューマモジュールの一意の識別子。

TotalRequiredElements: integer (int32)

必要な要素の合計数。

ConflictType: string

衝突のタイプ。[Producer Module Missing|Producer Element Missing|Producer Element Incompatible|Consumer Module Outdated|Newer Producer Module Available|IncompatiblePlatformServer|ConsumerModuleMoved|ProducerModuleMoved|NameColision]


ModuleStatusInEnv: object

指定された環境内のモジュールのステータス。

ApplicationKey: string

アプリケーションの一意の識別子。

EnvironmentKey: string

環境の一意の識別子。

ModuleVersionKey: string

モジュールバージョンの一意の識別子。

ConsistencyStatus: string

モジュールの一貫性ステータスを示します。

ConsistencyStatusMessages: string

モジュールの一貫性ステータスに関するメッセージ。


ModuleVersion_v2: object

モジュールバージョンとその情報。

Key: string

モジュールバージョンの一意の識別子。

ModuleKey: string

モジュールの一意の識別子。

CreatedOn: string (date-time)

モジュールバージョンの作成日時。

"2014-12-31T23:59:59.938Z"
CreatedBy: string

バージョンを作成したユーザーの名前。

CreatedByUsername: string

バージョンを作成したユーザーのユーザー名。

GeneralHash: string

モジュールバージョンの一意ではないハッシュ。2つのモジュールバージョンのセマンティックに違いがあるかどうかを検証するために使用できます。

DirectUpgradeFromHash: string

このモジュールバージョンが別のバージョンの直接アップグレードの結果である場合は、このフィールドにはそのバージョンのキーが含まれます。


NewApplication: object

TemplateKey: string
TeamKey: string
Name: string
Description: string
Color: string

Password: object

パスワードの定義。

password: string

パスワードの値。


PermissionLevels: object

level: integer

権限レベルを識別する値。

levelLabel: string

権限レベルの簡単な説明。

description: string

権限レベルの詳細な説明。


Role: object

ロールの詳細な定義。

key: string

ロールの識別子。

name: string

ロールの名前。

manageInfrastructure: boolean

インフラの管理を可能にします。

manageTeams: boolean

チームとロールの管理を可能にします。

environmentPermissions: object[]

各環境の権限レベルの定義。


Team: object

チームの定義。

key: string
name: string
description: string
users: object[]
applications: object[]

TeamRole: object

チームとロールの情報をペアにします。

TeamKey: string
TeamName: string
RoleKey: string
RoleName: string

Template: object

環境のテンプレート。

Key: string

テンプレートの一意の識別子。

Name: string

テンプレートの名前。

Description: string

テンプレートの説明。

ApplicationKind: string

アプリケーションのタイプ。[Web|Mobile|Service|Reactive]


TextRecord: object

ApplicationVersionKey: string

新しく作成されたアプリケーションバージョンのキー。


TextRecord2: object

ApplicationKey: string

TextTextRecord: object

ApplicationVersionKey: string
DeploymentZoneKey: string

User: object

ユーザーの定義。ユーザーが属するチームと特定のアプリケーションでのロールも含まれます。

Key: string

読み取り専用

Username: string
Name: string
Email: string
IsActive: boolean true
RoleKey: string
RoleName: string

読み取り専用

ApplicationRoles: object[]
Teams: object[]

UserRole: object

ユーザーとロールの情報をペアにします。

UserKey: string
Name: string
Username: string
RoleKey: string
RoleName: string

UserRoleShortInfo: object

ユーザーキーとロールキーの最小限の情報をペアにします。

userKey: string
roleKey: string

このセクションの記事

  • REST API認証
    OutSystemsサービスアカウントトークンを使用してREST APIメソッド呼び出しの認証を行います。
  • LifeTime APIの例
    LifeTime APIを使用して一般的なタスクを実行する方法を確認します。