Skip to main content

 

OutSystems 11オンラインヘルプ

 

OutSystems

LifeTime Deployment API v1

Deployment APIを使用すると、OutSystemsインフラのアプリケーション、モジュール、環境、デプロイを管理できます。

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

デプロイゾーンのサポートが追加されたDeployment API v2も利用できます。

概要

API ベースURL セキュリティ
v1 /lifetimeapi/rest/v1 SSL/TLS

v1

APIメソッド 説明
GET /applications/ インフラ内に存在するアプリケーションのリストを返します。
GET /applications/{ApplicationKey}/ 指定されたアプリケーションの詳細を返します。
GET /applications/{ApplicationKey}/versions/ 指定されたアプリケーションのバージョンのリストを返します。
GET /applications/{ApplicationKey}/versions/{VersionKey}/ 指定されたアプリケーションの指定されたバージョンの詳細を返します。
GET /deployments/ デプロイの作成日順(最新から最古)のリストを返します。
POST /deployments/ ターゲット環境へのデプロイを作成します。デプロイに含めるアプリケーションの任意指定のリストを指定できます。入力はデプロイオブジェクトのサブセットです。
GET /deployments/{DeploymentKey}/ 指定されたデプロイの詳細を返します。返される情報には、含まれるアプリケーションと、現在のアプリケーションのデプロイによって発生する可能性のある衝突が含まれます。
PUT /deployments/{DeploymentKey}/ 指定されたデプロイを更新します。デプロイに含めるアプリケーションの任意指定のリストを指定できます。入力はデプロイオブジェクトのサブセットです。
DELETE /deployments/{DeploymentKey}/ 可能な場合、デプロイを破棄します。削除できるのは状態が「saved」のデプロイのみです。
POST /deployments/{DeploymentKey}/{Command}/ 指定されたデプロイで指定されたコマンドを実行します。実行できるコマンドは「start」、「continue」、「abort」です。
GET /deployments/{DeploymentKey}/status/ デプロイステータスおよびメッセージを含む、指定されたデプロイ実行の詳細を返します。
GET /environments/ インフラ内のすべての環境をリスト化します。
GET /environments/ 指定された環境の詳細を返します。
GET /environments/{EnvironmentKey}/applications/ 指定された環境内のすべてのアプリケーションの実行中のバージョンに関する情報を返します。
GET /environments/{EnvironmentKey}/applications/{ApplicationKey}/ 指定された環境内の指定されたアプリケーションの実行中のバージョンに関する情報を返します。
GET /environments/{EnvironmentKey}/applications/{ApplicationKey}/content/ 指定されたアプリケーションのバイナリファイルをダウンロードできる場所のリンクを返します。このリンクは60分で期限切れになります。
POST /environments/{EnvironmentKey}/applications/{ApplicationKey}/versions/ 現在実行中のアプリケーションに基づいて、アプリケーションの新しいバージョンを作成します。
GET /modules/ インフラ内に存在するモジュールのリストを返します。
GET /modules/{ModuleKey}/ 指定されたモジュールの詳細を返します。
GET /modules/{ModuleKey}/versions/ 指定されたモジュールのバージョンのリストを返します。
GET /modules/{ModuleKey}/versions/{ModuleVersionKey}/ 指定されたモジュールバージョンの詳細を返します。

アクション

/applications

GET /applications/

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

完全なURL

GET /lifetimeapi/rest/v1/applications/

入力

IncludeModules
型: 任意。Boolean。
場所: URL内。
Trueに設定されている場合、モジュールも返されます。デフォルト値はFalseです。
IncludeEnvStatus
型: 任意。Boolean。
場所: URL内。
Trueに設定されている場合、各環境のアプリケーションのステータスも返されます。デフォルト値はFalseです。

出力

Applications
型: Application List。
場所: ボディ内。
Applicationレコードのリスト。リクエストされた場合はAppStatusInEnvサブリストを含みます。

戻りコード

200
アプリケーションのリストが正常に取得されました。
204
インフラ内に利用できるアプリケーションがありません。 Javaスタックでは、コード「204」ではなく、「200」が返されます。
400
IncludeModulesがリクエストされたがIncludeEnvStatusがリクエストされなかったため、またはすべてのアプリケーションをリスト化するときのリクエストが無効なため、アプリケーションを取得できませんでした。

GET /applications/{ApplicationKey}/

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

完全なURL

GET /lifetimeapi/rest/v1/applications/{ApplicationKey}/

入力

ApplicationKey
型: 必須。Text。
場所: URL内。
目的のアプリケーションのキー。
IncludeModules
型: 任意。Boolean。
場所: URL内。
Trueに設定されている場合、モジュールの詳細も取得されます。デフォルト値はFalseです。
IncludeEnvStatus
型: 任意。Boolean。
場所: URL内。
Trueに設定されている場合、各環境のアプリケーションのステータスも返されます。デフォルト値はFalseです。

出力

Application
型: Application
場所: ボディ内。
Applicationレコード。リクエストされた場合はAppStatusInEnvサブリストを含みます。

戻りコード

200
アプリケーションの詳細が正常に取得されました。
400
IncludeModulesパラメータとIncludeEnvStatusパラメータが正しくなかったため、アプリケーションを取得できませんでした。
403
ユーザーの権限が不十分なため、すべてのアプリケーションをリスト化できませんでした。
404
いずれかの環境が見つからなかったため、実行中のアプリケーションを取得できませんでした。

GET /applications/{ApplicationKey}/versions/

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

完全なURL

GET /lifetimeapi/rest/v1/applications/{ApplicationKey}/versions/

入力

ApplicationKey
型: 必須。Text。
場所: URL内。
目的のアプリケーションのキー。
MaximumVersionsToReturn
型: 任意。Integer。
場所: URL内。
返すバージョンの最大数。デフォルト値は5。

出力

ApplicationVersions
型: ApplicationVersion List。
場所: ボディ内。
ApplicationVersionレコードのリスト。

戻りコード

200
アプリケーションバージョンのリストが正常に取得されました。
400
返す最大バージョン(0未満)が無効なため、無効なリクエストです。
403
キー<ApplicationKey>のアプリケーションを取得できませんでした。ユーザーに必要な権限がありません。
404
キー<ApplicationKey>のアプリケーションを取得できませんでした。

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

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

完全なURL

GET /lifetimeapi/rest/v1/applications/{ApplicationKey}/versions/{VersionKey}/

入力

ApplicationKey
型: 必須。Text。
場所: URL内。
バージョンがリクエストされているアプリケーションのキー。
VersionKey
型: 必須。Text。
場所: URL内。
目的のアプリケーションバージョンのキー。
IncludeModules
型: 必須。Boolean。
場所: URL内。
Trueに設定されている場合、モジュールの詳細も取得されます。デフォルト値はFalseです。

出力

ApplicationVersion
型: ApplicationVersion
場所: ボディ内。
ApplicationVersionレコード。

戻りコード

200
アプリケーションバージョンの詳細が正常に取得されました。
403
キー<ApplicationKey>のアプリケーションを取得できませんでした。ユーザーに必要な権限がありません。
404
キー<ApplicationKey>のアプリケーションを取得できませんでした。

/deployments

GET /deployments/

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

完全なURL

GET /lifetimeapi/rest/v1/deployments/

入力

MinDate
型: 任意。Date。
場所: URL内。
返すデプロイの作成日の最小値。デフォルト値は現在の日付の1週間前です。
MaxDate
型: 任意。Date。
場所: URL内。
返すデプロイの作成日の最大値。デフォルト値は現在の日付です。

出力

Deployments
型: Deployment List。
場所: ボディ内。
Deploymentレコードのリスト。

戻りコード

200
デプロイのリストが正常に取得されました。
204
<MinDate><MaxDate>の間に作成されたデプロイがありません。 Javaスタックでは、コード「204」ではなく、「200」が返されます。
400
<MinDate><MaxDate>の間に作成されたデプロイのリストに対する無効なリクエストです。
403
<MinDate><MaxDate>の間に作成されたデプロイに関係するアプリケーションまたは環境へのアクセス権がユーザーにありません。

POST /deployments/

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

完全なURL

POST /lifetimeapi/rest/v1/deployments/

入力

ApplicationVersionKeys
型: オプション。Text List。
場所: ボディ内。
デプロイに含まれるアプリケーションバージョンのキーのリスト。
Notes
型: 任意。Text。
場所: ボディ内。
デプロイの注記。
SourceEnvironmentKey
型: 任意。Text。
場所: ボディ内。
ソース環境の一意の識別子。
TargetEnvironmentKey
型: 任意。Text。
場所: ボディ内。
ターゲット環境の一意の識別子。

出力

DeploymentKey
型: Text。
場所: ボディ内。
新しく作成されたデプロイのキー。

戻りコード

201
デプロイが正常に作成されました。
400
無効なリクエストです。
403
無効なユーザー権限です。
404
ソース環境またはターゲット環境が見つかりません。

リクエストボディの例

{
  "ApplicationVersionKeys": [
    "22dcc061-8767-46dd-8a6e-7991ee8112c7"
  ],
  "Notes": "WebPortal 1.1 - QA to PRD Deployment",
  "SourceEnvironmentKey": "10061715-16bb-491a-86bc-595b465eaffb",
  "TargetEnvironmentKey": "55c430ee-4783-43e6-a2d4-6eecfed1d90f"
}

GET /deployments/{DeploymentKey}/

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

完全なURL

GET /lifetimeapi/rest/v1/deployments/{DeploymentKey}/

入力

DeploymentKey
型: 必須。Text。
場所: URL内。
目的のデプロイのキー。

出力

ApplicationConflicts
型: ApplicationConflict List。
場所: ボディ内。
デプロイ内のアプリケーション間の衝突のリスト。
Deployment
型: Deployment
場所: ボディ内。
デプロイの詳細。

戻りコード

200
デプロイの詳細が正常に取得されました。
403
キー<DeploymentKey>のデプロイに対する権限がユーザーにありません。
404
キー<DeploymentKey>のデプロイが見つかりません。

PUT /deployments/{DeploymentKey}/

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

完全なURL

PUT /lifetimeapi/rest/v1/deployments/{DeploymentKey}/

入力

DeploymentKey
型: 必須。Text。
場所: URL内。
更新するデプロイのキー。
ApplicationVersionKeys
型: 任意。Text List。
場所: ボディ内。
デプロイに含めるアプリケーションバージョンのキーのリスト。
Notes
型: 任意。Text。
場所: ボディ内。
デプロイの注記。
SourceEnvironmentKey
型: 任意。Text。
場所: ボディ内。
ソース環境の一意の識別子。
TargetEnvironmentKey
型: 任意。Text。
場所: ボディ内。
ターゲット環境の一意の識別子。

出力

Deployment
型: Deployment
場所: ボディ内。
更新された情報を含むDeploymentレコード。

戻りコード

200
デプロイが正常に更新されました。
400
無効なリクエストです。
403
無効なユーザー権限です。
404
デプロイ計画が見つかりません。

リクエストボディの例

{
  "ApplicationVersionKeys": [
    "73b2a7a6-d893-42de-bd94-90276eac8374"
  ],
  "Notes": "WebPortal 1.1 - QA to PRD Deployment",
  "SourceEnvironmentKey": "10061715-16bb-491a-86bc-595b465eaffb",
  "TargetEnvironmentKey": "55c430ee-4783-43e6-a2d4-6eecfed1d90f"
}

DELETE /deployments/{DeploymentKey}/

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

完全なURL

DELETE /lifetimeapi/rest/v1/deployments/{DeploymentKey}/

入力

DeploymentKey
型: 必須。Text。
場所: URL内。
削除するデプロイのキー。

戻りコード

204
デプロイが正常に削除されました。 Javaスタックでは、コード「204」ではなく、「200」が返されます。
400
キー<DeploymentKey>のデプロイを削除できません。
403
キー<DeploymentKey>のデプロイにアクセスできませんでした。ユーザーに必要な権限がありません。
404
キー<DeploymentKey>のデプロイが見つかりません。

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

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

完全なURL

POST /lifetimeapi/rest/v1/deployments/{DeploymentKey}/{Command}/

入力

DeploymentKey
型: 必須。Text。
場所: URL内。
コマンドが実行されるデプロイのキー。
Command
型: 必須。Text。
場所: URL内。
実行するコマンド。「start」、「continue」、「abort」のいずれかです。

戻りコード

202
デプロイ<DeploymentKey>に対してコマンド<Command>が正常に実行されました。
400
デプロイ<DeploymentKey>に対してコマンド<Command>を実行できません。
403
キー<DeploymentKey>のデプロイにアクセスするための権限がユーザーにありません。
404
キー<DeploymentKey>のデプロイが見つからないか、コマンドが見つかりません。

GET /deployments/{DeploymentKey}/status/

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

完全なURL

GET /lifetimeapi/rest/v1/deployments/{DeploymentKey}/status/

入力

DeploymentKey
型: 必須。Text。
場所: URL内。
ステータスがリクエストされているデプロイのキー。

出力

DeploymentLog
型: DeploymentMessage List。
場所: ボディ内。
デプロイメッセージのリスト。
DeploymentStatus
型: Text。
場所: ボディ内。
デプロイのステータス。[saved | running | needs_user_intervention | aborted | aborting | finished_successful | finished_with_warnings | finished_with_errors]

戻りコード

200
デプロイのステータスが正常に取得されました。
403
キー<DeploymentKey>のデプロイに対する権限がユーザーにありません。
404
キー<DeploymentKey>のデプロイが見つかりません。

/environments

GET /environments/

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

完全なURL

GET /lifetimeapi/rest/v1/environments/

出力

Environments
型: Environment List。
場所: ボディ内。
Environmentレコードのリスト。

戻りコード

200
環境のリストが正常に取得されました。
204
環境が見つかりませんでした。 Javaスタックでは、コード「204」ではなく、「200」が返されます。

GET /environments/{EnvironmentKey}/

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

完全なURL

GET /lifetimeapi/rest/v1/environments/{EnvironmentKey}/

入力

EnvironmentKey
型: 必須。Text。
場所: URL内。
目的の環境のキー。

出力

Environment
型: Environment
場所: ボディ内。
Environmentレコード。

戻りコード

200
環境の詳細が正常に取得されました。
403
次のキーの環境を取得できませんでした: <EnvironmentKey>.ユーザーに必要な権限がありません。
404
キー<EnvironmentKey>の環境が見つかりませんでした。

GET /environments/{EnvironmentKey}/applications/

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

完全なURL

GET /lifetimeapi/rest/v1/environments/{EnvironmentKey}/applications/

入力

EnvironmentKey
型: 必須。Text。
場所: URL内。
実行中のアプリケーションのリストがリクエストされている環境のキー。
IncludeModules
型: 任意。Boolean。
場所: URL内。
Trueに設定されている場合、モジュールの詳細も取得されます。デフォルト値はFalseです。
IncludeEnvStatus
型: 任意。Boolean。
場所: URL内。
Trueに設定されている場合、環境内のアプリケーションのステータス情報が結果に含まれます。デフォルト値はFalseです。

出力

Applications
型: Application List。
場所: ボディ内。
Applicationレコードのリスト。

戻りコード

200
指定された環境のアプリケーションのリストが正常に取得されました。
204
キー<EnvironmentKey>の環境内でアプリケーションが見つかりませんでした。 Javaスタックでは、コード「204」ではなく、「200」が返されます。
400
IncludeModulesパラメータとIncludeEnvStatusパラメータが正しくなかったため、またはキー<EnvironmentKey>の環境の実行中のアプリケーションを取得するときのリクエストが無効なため、環境内でパブリッシュされたアプリケーションを取得できませんでした。
403
ユーザーの権限が不十分なため、キー<EnvironmentKey>の環境の実行中のアプリケーションを取得できませんでした。
404
キー<EnvironmentKey>の環境の実行中のアプリケーションが見つからなかったため、取得できませんでした。

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

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

完全なURL

GET /lifetimeapi/rest/v1/environments/{EnvironmentKey}/applications/{ApplicationKey}/

入力

EnvironmentKey
型: 必須。Text。
場所: URL内。
実行中のアプリケーションの詳細を取得する環境のキー。
ApplicationKey
型: 必須。Text。
場所: URL内。
詳細がリクエストされているアプリケーションのキー。
IncludeEnvStatus
型: 任意。Boolean。
場所: URL内。
Trueに設定されている場合、環境内のアプリケーションのステータス情報が結果に含まれます。デフォルト値はFalseです。
IncludeModules
型: 任意。Boolean。
場所: URL内。
Trueに設定されている場合、モジュールの詳細も取得されます。デフォルト値はFalseです。

出力

Application
型: Application
場所: ボディ内。
Applicationレコード。

戻りコード

200
アプリケーションの情報が正常に取得されました。
400
ステータスではなくモジュールを要求するリクエストです。
403
指定されたキー(EnvironmentKey:<EnvironmentKey>; Application:<ApplicationKey>)に対する権限がユーザーにありません。
404
キー<EnvironmentKey>の環境またはキー<ApplicationKey>のアプリケーションを取得できませんでした。

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

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

完全なURL

GET /lifetimeapi/rest/v1/environments/{EnvironmentKey}/applications/{ApplicationKey}/content/

入力

EnvironmentKey
型: 必須。Text。
場所: URL内。
アプリケーションのバイナリファイルのリンクを取得する環境のキー。
ApplicationKey
型: 必須。Text。
場所: URL内。
バイナリファイルのリンクを取得するアプリケーションのキー。
Type
型: 任意。Text。
場所: URL内。
返すバイナリファイルのタイプ(該当する場合)。[oap | apk | ipa]

出力

DownloadLink
型: DownloadLink
場所: ボディ内。
アプリケーションのバイナリファイルのリンク。
Expires
型: Date Time。
場所: ヘッダー内。
返されるリンクの有効期限の日時。

戻りコード

200
バイナリファイルのダウンロードリンクが正常に取得されました。
204
指定されたタイプおよびキーの利用できるバイナリがありません。 Javaスタックでは、コード「204」ではなく、「200」が返されます。
400
指定されたキー(EnvironmentKey:<EnvironmentKey>; Application:<ApplicationKey>)に対して必要なタイプ<Type>が無効です。
403
指定されたキー(EnvironmentKey:<EnvironmentKey>; Application:<ApplicationKey>)に対する権限がユーザーにありません。
404
キー<EnvironmentKey>の環境またはキー<ApplicationKey>のアプリケーションを取得できませんでした。

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

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

完全なURL

POST /lifetimeapi/rest/v1/environments/{EnvironmentKey}/applications/{ApplicationKey}/versions/

入力

EnvironmentKey
型: 必須。Text。
場所: URL内。
アプリケーションを取得する環境のキー。
ApplicationKey
型: 必須。Text。
場所: URL内。
新しいバージョンを生成するアプリケーションのキー。
ApplicationVersionCreate
型: 必須。ApplicationVersionCreate
場所: ボディ内。
該当する場合、アプリケーションとそのネイティブアプリケーションの新しいバージョン名を保持するストラクチャ。

出力

ApplicationVersionKey
型: Text。
場所: ボディ内。
新しく作成されたアプリケーションバージョンのキー。

戻りコード

201
アプリケーションバージョンが正常に作成されました。
400
無効なリクエストです。
403
無効なユーザー権限です。
404
環境またはアプリケーションが見つかりません。

リクエストボディの例

{
  "ChangeLog": "First release of iOS mobile app",
  "Version": "1.0.0",
  "MobileVersions": [
    {
      "NativePlatform": "iOS",
      "VersionNumber": "1.0.0",
      "VersionDescription": "First release"
    }
  ],
  "ModuleVersionKeys": [
    "63146a06-06d3-4f9e-a4ca-abc7bb6950e5"
  ]
}

/modules

GET /modules/

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

完全なURL

GET /lifetimeapi/rest/v1/modules/

入力

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

出力

ModuleList
型: Module List。
場所: ボディ内。
Moduleレコードのリスト。

戻りコード

200
モジュールのリストが正常に取得されました。
204
インフラ内でモジュールが見つかりませんでした。 Javaスタックでは、コード「204」ではなく、「200」が返されます。

GET /modules/{ModuleKey}/

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

完全なURL

GET /lifetimeapi/rest/v1/modules/{ModuleKey}/

入力

ModuleKey
型: 必須。Text。
場所: URL内。
詳細をリスト化するモジュールのキー。
IncludeEnvStatus
型: 任意。Boolean。
場所: URL内。
Trueに設定されている場合、各環境のモジュールのステータスも返されます。デフォルト値はFalseです。

出力

Module
型: Module
場所: ボディ内。
Moduleレコード。

戻りコード

200
モジュールの詳細が正常に取得されました。
403
次のキーのモジュールを取得できませんでした: <ModuleKey>.ユーザーに必要な権限がありません。
404
次のキーのモジュールを取得できませんでした: <ModuleKey>.

GET /modules/{ModuleKey}/versions/

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

完全なURL

GET /lifetimeapi/rest/v1/modules/{ModuleKey}/versions/

入力

ModuleKey
型: 必須。Text。
場所: URL内。
バージョンを取得するモジュール。
IncludePublicElements
型: 任意。Boolean。
場所: URL内。
公開要素を返す必要があるかどうかを示すBoolean。デフォルトはFalseです。
IncludeConsumedElements
型: 任意。Boolean。
場所: URL内。
利用中の要素を返す必要があるかどうかを示すBoolean。デフォルトはFalseです。
MaximumVersionsToReturn
型: 任意。Integer。
場所: URL内。
返すバージョンの最大数。デフォルトは5です。

出力

ModuleVersionList
型: ModuleVersion List。
場所: ボディ内。
ModuleVersionレコードのリスト。

戻りコード

200
モジュールバージョンのリストが正常に取得されました。
400
返す最大バージョン(0未満)が無効なため、無効なリクエストです。
403
次のキーのモジュールを取得できませんでした: <ModuleKey>.ユーザーに必要な権限がありません。
404
次のキーのモジュールを取得できませんでした: <ModuleKey>.

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

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

完全なURL

GET /lifetimeapi/rest/v1/modules/{ModuleKey}/versions/{ModuleVersionKey}/

入力

ModuleKey
型: 必須。Text。
場所: URL内。
バージョンを取得するモジュール。
ModuleVersionKey
型: 必須。Text。
場所: URL内。
返すモジュールバージョンのキー。
IncludePublicElements
型: 任意。Boolean。
場所: URL内。
公開要素を返す必要があるかどうかを示すBoolean。デフォルトはFalseです。
IncludeConsumedElements
型: 任意。Boolean。
場所: URL内。
利用中の要素を返す必要があるかどうかを示すBoolean。デフォルトはFalseです。

出力

ModuleVersion
型: ModuleVersion
場所: ボディ内。
ModuleVersionのレコード。

戻りコード

200
モジュールバージョンの詳細が正常に取得されました。
403
次のキーのモジュールを取得できませんでした: <ModuleKey>.ユーザーに必要な権限がありません。
404
次のキーのモジュールを取得できませんでした: <ModuleKey>。または、次のキーのモジュールバージョンを取得できませんでした: <ModuleKey>.

ストラクチャ

Application

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

アトリビュート

Key
型: Text。
アプリケーションの一意の識別子。
Name
型: Text (50)。
アプリケーションの名前。
Kind
型: RuntimeKind Identifier。
アプリケーションの種類を識別します。[Mobile | WebResponsive]
Team
型: Text (50)。
アプリケーションを所有しているチーム。
Description
型: Text (50)。
アプリケーションの説明。
URLPath
型: Text (50)。
ホスト名から始まるアプリケーションの相対URLパス。
IconHash
型: Text (50)。
アプリケーションアイコンのハッシュ。アプリケーションアイコンの変更を検出するために使用できます。
IconURL
型: Text (50)。
アプリケーションアイコンのURL。
IsSystem
型: Boolean。
アプリケーションがOutSystemsプラットフォームのビルトインコンポーネント(Service Center、LifeTimeなど)であるかどうかを示します。
AppStatusInEnvs
型: AppStatusInEnv List。
アプリケーションが実行されている各環境内でのそのステータスに関する情報。

ApplicationConflict

デプロイの衝突。

アトリビュート

メッセージ
型: Text。
衝突の説明。
ProducerApplicationOperation
型: ApplicationOperation
プロデューサアプリケーションに対して実行されたオペレーション。
ConsumerApplicationOperation
型: ApplicationOperation
利用中のアプリケーションに対して実行されたオペレーション。
ModuleConflict
型: ModuleConflict
モジュールの衝突の詳細。

ApplicationOperation

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

アトリビュート

ApplicationKey
型: Text。
アプリケーションの一意の識別子。
ApplicationVersionKey
型: Text。
アプリケーションバージョンの一意の識別子。
DeploymentOperation
型: Text。
実行されるオペレーションのラベル。例: Deploy 1.5。

ApplicationVersion

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

アトリビュート

Key
型: Text。
アプリケーションバージョンの一意の識別子。
ApplicationKey
型: Text。
アプリケーションの一意の識別子。
Version
型: Text (50)。
アプリケーションのバージョン。
MobileVersions
型: MobileVersion List。
モバイルバージョンのリスト。
PrimaryColor
型: Text (50)。
アプリケーションのインターフェイスの初期色。
NativeHash
型: Text (50)。
モバイルプラットフォームに関連するネイティブハッシュ。
ModuleVersions
型: ModuleVersion List。
モジュールバージョンのリスト。

ApplicationVersionCreate

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

アトリビュート

ChangeLog
型: Text。
作成するバージョンの変更ログ。
Version
型: Text (50)。
アプリケーションのバージョン。
MobileVersions
型: MobileVersion List。
モバイルバージョンのリスト。
ModuleVersionKeys
型: Text List。
アプリケーションの現在の状態がまだ期待されるものであるかどうかを検証するモジュールバージョンキーのリスト。

AppStatusInEnv

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

アトリビュート

EnvironmentKey
型: Text。
環境の一意の識別子。
BaseApplicationVersionKey
型: Text。
ベースアプリケーションバージョンの一意の識別子。環境内のアプリが変更されていない場合、これはデプロイされたアプリケーションバージョンです。
IsModified
型: Boolean。
最後のタグ付け以降にアプリケーションが変更されている場合はTrue、それ以外の場合はFalseです。
IsModifiedReason
型: Text。
アプリケーションのステータスを示します。
IsModifiedMessage
型: Text。
アプリケーションのステータスを示します。
ConsistencyStatus
型: Text (50)。
アプリケーションの一貫性ステータスを示します。
ConsistencyStatusMessages
型: Text (2000)。
アプリケーションの一貫性ステータスに関するメッセージ。
MobileAppsStatus
型: MobileAppStatusInEnv List。
環境内のモバイルアプリのステータス。
ModuleStatusInEnvs
型: ModuleStatusInEnv List。
環境内のモジュールのステータス。

Deployment

デプロイの情報と実行されたオペレーション。

アトリビュート

Key
型: Text。
デプロイの一意の識別子。
SourceEnvironmentKey
型: Text。
ソース環境の一意の識別子。
TargetEnvironmentKey
型: Text。
ターゲット環境の一意の識別子。
Notes
型: Text。
デプロイの注記。
CreatedOn
型: Date Time。
デプロイ計画を作成した日時。
CreatedBy
型: Text。
デプロイ計画を作成したユーザーの名前。
CreatedByUsername
型: Text。
デプロイ計画を作成したユーザーのユーザー名。
SavedOn
型: Date Time。
デプロイ計画を保存した日時。
SavedBy
型: Text。
デプロイ計画を最後に保存したユーザーの名前。
SavedByUsername
型: Text。
デプロイ計画を最後に保存したユーザーのユーザー名。
StartedOn
型: Date Time。
デプロイを開始した日時。
StartedBy
型: Text。
デプロイを開始したユーザーの名前。
StartedByUsername
型: Text。
デプロイを開始したユーザーのユーザー名。
AbortedOn
型: Date Time。
デプロイを中止した日時。
AbortedBy
型: Text。
デプロイを中止したユーザーの名前。
AbortedByUsername
型: Text。
デプロイを中止したユーザーのユーザー名。
ApplicationsVersionKeys
型: Text List。
デプロイに含まれるアプリケーションバージョンのリスト。

DeploymentMessage

デプロイオペレーションログのメッセージ。

アトリビュート

Instant
型: Date Time。
メッセージがログに記録された日時。
メッセージ
型: Text。
メッセージの詳細。

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

アトリビュート

url
型: Text。
アプリケーションのバイナリファイルのリンク。
expires
型: Date Time。
返されるリンクの有効期限の日時。

Environment

環境とその情報。

アトリビュート

Key
型: Text。
環境の一意の識別子。
Name
型: Text (50)。
環境の名前。
OSVersion
型: Text (50)。
Platform Serverのバージョン。[X.X.X.X]
Order
型: Integer。
Lifetimeで登録されている環境の順序。
HostName
型: Text (50)。
登録されている環境のホスト名。
UseHTTPS
型: Boolean。
環境への接続がHTTPSを使用して行われるかどうかを示します。
EnvironmentType
型: Text。
環境のタイプを示します。[Development | Test | Production]
NumberOfFrontEnds
型: Integer。
環境内のフロントエンドサーバーの数。
ApplicationServerType
型: Text (50)。
アプリケーションサーバーのスタック。[.NET | JAVA]
ApplicationServer
型: Text (50)。
使用中のアプリケーションサーバー。[IIS | JBoss | WebLogic]
DatabaseProvider
型: Text (50)。
データベースプロバイダのタイプ。[SqlServer | Oracle]
IsCloudEnvironment
型: Boolean。
環境がクラウドサービスで実行されているかどうかを示します。

MobileAppStatusInEnv

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

アトリビュート

EnvironmentKey
型: Text。
環境の一意の識別子。
NativePlatform
型: Text。
ネイティブプラットフォームの名前。[Android | iOS]
VersionNumber
型: Text。
ネイティブビルドのバージョン番号(1.5.4など)。これを使用して、バージョンをAndroidまたはiOSストアのバージョンとマッピングすることができます。
HasBinaryAvailable
型: Boolean。
現在の構成でアプリケーションのバイナリが利用できる場合はTrueです。
IsConfigured
型: Boolean。
アプリケーションが構成されている場合はTrueです。
IsConfigurationChanged
型: Boolean。
環境内のモバイルアプリケーションの構成が変更されている場合はTrueです。
IsModified
型: Boolean。
モバイルアプリケーションのネイティブハッシュがAppVersionNativeBuildベースライン内のものと一致しない場合はTrueです。

MobileVersion

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

アトリビュート

NativePlatform
型: Text。
ネイティブプラットフォームの名前。[Android | iOS]
VersionNumber
型: Text (50)。
ネイティブビルドのバージョン番号(1.5.4など)。これを使用して、バージョンをAndroidまたはiOSストアのバージョンとマッピングすることができます。
VersionDescription
型: Text。
モバイルバージョンの説明。

Module

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

アトリビュート

Key
型: Text。
モジュールの一意の識別子。
Name
型: Text (50)。
モジュールの名前。
Description
型: Text (50)。
モジュールの説明。
Kind
型: Text (50)。
モジュールタイプ(eSpaceまたはExtension)。
ModuleStatusInEnv
型: ModuleStatusInEnv List。
環境内のモジュールのステータス。

ModuleConflict

モジュールの衝突。

アトリビュート

ProducerModuleKey
型: Text。
プロデューサモジュールの一意の識別子。
ConsumerModuleKey
型: Text。
コンシューマモジュールの一意の識別子。
TotalRequiredElements
型: Integer。
必要な要素の合計数。
ConflictType
型: Text。
衝突のタイプ。[Producer Module Missing | Producer Element Missing | Producer Element Incompatible | Consumer Module Outdated | Newer Producer Module Available | IncompatiblePlatformServer | ConsumerModuleMoved | ProducerModuleMoved | NameColision]

ModuleElement

要素のバージョン情報(アクション、エンティティ、ストラクチャなど)。

アトリビュート

Key
型: Text。
モジュール要素の一意の識別子。
Name
型: Text (50)。
開発者によって指定された要素の名前。
ElementType
型: Text。
要素のタイプ(アクション、エンティティ、ストラクチャなど)。
CompatibilitySignatureHash
型: Text (50)。
要素のシグネチャのハッシュ。要素のバージョンが別のバージョンと互換性があり、参照が壊れていないかどうかを検証するために使用できます。
FullSignatureHash
型: Text (50)。
要素のハッシュ。要素のバージョンを一意に識別するために使用できます。
ModuleKey
型: Text。
要素が他のユーザーに公開されているモジュールの一意の識別子。

ModuleStatusInEnv

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

アトリビュート

EnvironmentKey
型: Text。
環境の一意の識別子。
ModuleVersionKey
型: Text。
モジュールバージョンの一意の識別子。
ConsistencyStatus
型: Text (50)。
モジュールの一貫性ステータスを示します。
ConsistencyStatusMessages
型: Text (2000)。
モジュールの一貫性ステータスに関するメッセージ。

ModuleVersion

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

アトリビュート

Key
型: Text。
モジュールバージョンの一意の識別子。
ModuleKey
型: Text。
モジュールの一意の識別子。
PublicElements
型: ModuleElement List。
モジュールバージョン別の公開されているモジュール要素のリスト。
ConsumedElements
型: ModuleElement List。
モジュールバージョン別の利用されているモジュール要素のリスト。