Skip to main content

Reference

 

OutSystems

LifeTime Deployment API v2

The Deployment API allows you to manage applications, modules, environments and deployments of your OutSystems infrastructure.OutSystems infrastructure. Version 2 of the API adds support for deployment zones.

Follow the guidelines presented in REST API Authentication to authenticate your API requests.

Summary

API Base URL Security
Deployment API v2 /lifetimeapi/rest/v2 SSL/TLS

Deployment API v2

API Method Description
GET /applications/ Returns a list of applications that exist in the infrastructure.
GET /applications/{ApplicationKey}/ Returns the details of a given application.
GET /applications/{ApplicationKey}/versions/ Returns a list of versions of a given application.
GET /applications/{ApplicationKey}/versions/{VersionKey}/ Returns the details of a given version of the specified application.
GET /deployments/ Returns a list of deployments ordered by creation date, from newest to oldest.
POST /deployments/ Creates a deployment to a target environment. An optional list of applications to include in the deployment can be specified. The input is a subset of deployment object.
GET /deployments/{DeploymentKey}/ Returns the details of a given deployment, validating if there are any conflicts. The returned information contains the applications included in the deployment plan and the possible conflicts that can arise from the deployment of the selected applications.
PUT /deployments/{DeploymentKey}/ Updates a given deployment. An optional list of applications to include in the deployment can be specified. The input is a subset of deployment object.
DELETE /deployments/{DeploymentKey}/ Discards a deployment, if possible. Only deployments whose state is “saved” can be deleted.
POST /deployments/{DeploymentKey}/{Command}/ Executes the given command in a specified deployment. The initiation of a deployment plan will check if it's valid. The applications to redeploy, if applicable, will also be included in the deployment plan.
GET /deployments/{DeploymentKey}/status/ Returns the details of a given deployment execution, including the deployment status and messages.
GET /environments/ Lists all the environments in the infrastructure.
GET /environments/{EnvironmentKey}/ Returns the details of a given environment.
GET /environments/{EnvironmentKey}/applications/ Returns information about the running versions of all applications in a given environment.
GET /environments/{EnvironmentKey}/applications/{ApplicationKey}/ Returns information about the running version of the specified application in a given environment.
GET /environments/{EnvironmentKey}/applications/{ApplicationKey}/content/ Returns a link where the binary file for a given application can be downloaded. The link will expire in 60 minutes.
POST /environments/{EnvironmentKey}/applications/{ApplicationKey}/versions/ Creates a new version of the application based on the current running application.
GET /environments/{EnvironmentKey}/deploymentzones/ Returns information about the deployment zones available in a given environment.
GET /modules/ Returns a list of modules that exist in the infrastructure.
GET /modules/{ModuleKey}/ Returns the details of a given module.
GET /modules/{ModuleKey}/versions/ Returns a list of versions of a given module.
GET /modules/{ModuleKey}/versions/{ModuleVersionKey}/ Returns the details of a given module version.

Actions

/applications

GET /applications/

Returns a list of applications that exist in the infrastructure.

Full URL

GET /lifetimeapi/rest/v2/applications/

Inputs

IncludeModules
Type: optional, Boolean
Located in: URL.
When set to true, the modules are also returned. The default value is false.
IncludeEnvStatus
Type: optional, Boolean
Located in: URL.
When set to true, the application status per environment is also returned. The default value is false.

Outputs

Applications
Type: Application List
Located in: Body.
A list of Application records including AppStatusInEnv sub-lists, if requested.

Return Codes

200
Application list successfully retrieved.
204
No applications available in the infrastructure.
400
Failed to retrieve applications because IncludeModules was requested but IncludeEnvStatus was not, or invalid request when listing all applications.
500
Failed to list the applications.

GET /applications/{ApplicationKey}/

Returns the details of a given application.

Full URL

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

Inputs

ApplicationKey
Type: mandatory, Text
Located in: URL.
The key of the desired application.
IncludeModules
Type: optional, Boolean
Located in: URL.
When set to true, the modules details are also retrieved. The default value is false.
IncludeEnvStatus
Type: optional, Boolean
Located in: URL.
When set to true, the application status per environment is also returned. The default value is false.

Outputs

Application
Type: Application
Located in: Body.
An Application record including an AppStatusInEnv sub-list, if requested.

Return Codes

200
Application details successfully retrieved.
400
Failed to retrieve applications because IncludeModules and IncludeEnvStatus parameters were incorrect.
403
Failed listing all applications because user has insufficient permissions.
404
Failed getting running applications because one of the environments was not found.

GET /applications/{ApplicationKey}/versions/

Returns a list of versions of a given application.

Full URL

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

Inputs

ApplicationKey
Type: mandatory, Text
Located in: URL.
The key of the desired application.
MaximumVersionsToReturn
Type: optional, Integer
Located in: URL.
The maximum number of versions to return. The default value is 5.

Outputs

ApplicationVersions
Type: ApplicationVersion List
Located in: Body.
A list of ApplicationVersion records.

Return Codes

200
List of application versions successfully retrieved.
400
Invalid request due to invalid max versions to return (less than 0).
403
Failed to retrieve the application with key <ApplicationKey>. The user does not have the required permissions.
404
Failed to retrieve the application with key <ApplicationKey>.
500
Failed to list the application versions.

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

Returns the details of a given version of the specified application.

Full URL

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

Inputs

ApplicationKey
Type: mandatory, Text
Located in: URL.
The key of the application whose version is being requested.
IncludeModules
Type: mandatory, Boolean
Located in: URL.
When set to true, the modules details are also retrieved. The default value is false.
VersionKey
Type: mandatory, Text
Located in: URL.
The key of the desired application version.

Outputs

ApplicationVersions
Type: ApplicationVersion
Located in: Body.
An ApplicationVersion record.

Return Codes

200
Application version details successfully retrieved.
403
Failed to retrieve the application with key <ApplicationKey>. The user does not have the required permissions.
404
Failed to retrieve the application with key <ApplicationKey>.
500
Failed to retrieve the application version.

/deployments

GET /deployments/

Returns a list of deployments ordered by creation date, from newest to oldest.

Full URL

GET /lifetimeapi/rest/v2/deployments/

Inputs

MinDate
Type: optional, Date
Located in: URL.
The minimum creation date of the deployments to return. The default value is 1 week before the current date.
MaxDate
Type: optional, Date
Located in: URL.
The maximum creation date of the deployments to return. The default value is the current date.

Outputs

Deployments
Type: Deployment List
Located in: Body.
A list of Deployment records.

Return Codes

200
Deployments list successfully retrieved.
204
There are no deployments created between <MinDate> and <MaxDate>.
400
Invalid request for list of deployments created between <MinDate> and <MaxDate>.
403
User doesn't have access to any application or environment involved in the deployments created between <MinDate> and <MaxDate>.
500
Failed to list the deployments.

POST /deployments/

Creates a deployment to a target environment. An optional list of applications to include in the deployment can be specified. The input is a subset of deployment object.

Full URL

POST /lifetimeapi/rest/v2/deployments/

Inputs

ApplicationOperations
Type: ApplicationOperation List
Located in: Body.
List of Application Operations included in the deployment.
You should only supply the ApplicationVersionKey and DeploymentZoneKey structure attributes of the ApplicationOperation structure. To deploy an application to the default deployment zone, provide an empty string in the DeploymentZoneKey attribute.
Notes
Type: optional, Text
Located in: Body.
Deployment notes.
SourceEnvironmentKey
Type: optional, Text
Located in: Body.
Source environment unique identifier.
TargetEnvironmentKey
Type: optional, Text
Located in: Body.
Target environment unique identifier.

Outputs

DeploymentKey
Type: Text
Located in: Body.
The key of the newly created deployment.

Return Codes

201
Deployment successfully created.
400
Invalid request.
403
Invalid user permissions.
404
Source or target environment not found.
500
Failed to create deployment from environment <SourceEnvironmentKey> to environment <TargetEnvironmentKey>.

Example Request Body

{
  "ApplicationOperations": [
    {
      "ApplicationVersionKey": "702df59d-3700-41b8-907e-a629e05a68f1",
      "DeploymentZoneKey": "d91a7e60-dea3-4150-8da2-39593a780507"
    }
  ],
  "Notes": "WebPortal 1.1 - QA to PRD Deployment",
  "SourceEnvironmentKey": "10061715-16bb-491a-86bc-595b465eaffb",
  "TargetEnvironmentKey": "55c430ee-4783-43e6-a2d4-6eecfed1d90f"
}

GET /deployments/{DeploymentKey}/

Returns the details of a given deployment, validating if there are any conflicts. The returned information contains the applications included in the deployment plan and the possible conflicts that can arise from the deployment of the selected applications.

Full URL

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

Inputs

DeploymentKey
Type: mandatory, Text
Located in: URL.
The key of the desired deployment.

Outputs

ApplicationConflicts
Type: ApplicationConflict List
Located in: Body.
List of conflicts between applications in the deployment.
ApplicationsToRedeploy
Type: Text List
Located in: Body.
List of applications that will be redeployed.
Deployment
Type: Deployment
Located in: Body.
The deployment details.

Return Codes

200
Deployment details successfully retrieved.
403
User doesn't have permissions to the deployment with key <DeploymentKey>.
404
Deployment with key <DeploymentKey> not found.
500
Failed to access the details of deployment with key <DeploymentKey>.

PUT /deployments/{DeploymentKey}/

Updates a given deployment. An optional list of applications to include in the deployment can be specified. The input is a subset of deployment object.

Full URL

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

Inputs

DeploymentKey
Type: mandatory, Text
Located in: URL.
The key of the deployment to update.
ApplicationOperations
Type: optional, ApplicationOperation List.
Located in: Body.
List of Application Operations included in the deployment.
You should only supply the ApplicationVersionKey and DeploymentZoneKey structure attributes of the ApplicationOperation structure. To deploy an application to the default deployment zone, provide an empty string in the DeploymentZoneKey attribute.
Notes
Type: optional, Text
Located in: Body.
Deployment notes.
SourceEnvironmentKey
Type: optional, Text
Located in: Body.
Source environment unique identifier.
TargetEnvironmentKey
Type: optional, Text
Located in: Body.
Target environment unique identifier.

Outputs

Deployment
Type: DeploymentData
Located in: Body.
A DeploymentData record containing the updated information.

Return Codes

200
Deployment successfully updated.
400
Invalid request.
403
Invalid user permissions.
404
Deployment plan not found.
500
Failed to update deployment with key <DeploymentKey>.

Example Request Body

{
  "ApplicationOperations": [
    {
      "ApplicationVersionKey": "702df59d-3700-41b8-907e-a629e05a68f1",
      "DeploymentZoneKey": "d91a7e60-dea3-4150-8da2-39593a780507"
    }
  ],
  "Notes": "WebPortal 1.1 - QA to PRD Deployment",
  "SourceEnvironmentKey": "10061715-16bb-491a-86bc-595b465eaffb",
  "TargetEnvironmentKey": "55c430ee-4783-43e6-a2d4-6eecfed1d90f"
}

DELETE /deployments/{DeploymentKey}/

Discards a deployment, if possible. Only deployments whose state is “saved” can be deleted.

Full URL

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

Inputs

DeploymentKey
Type: mandatory, Text
Located in: URL.
The key of the deployment to delete.

Return Codes

204
Deployment successfully deleted.
400
Deployment with key <DeploymentKey> cannot be deleted
403
Service Account doesn't have permissions to the deployment with key <DeploymentKey>.
404
Deployment with key <DeploymentKey> not found.
500
Failed to delete deployment <DeploymentKey>.

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

Executes the given command in a specified deployment. The initiation of a deployment plan will check if it's valid. The applications to redeploy, if applicable, will also be included in the deployment plan.

Full URL

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

Inputs

DeploymentKey
Type: mandatory, Text
Located in: URL.
The key of the deployment where the command will be executed.
Command
Type: mandatory, Text
Located in: URL.
The command to execute. One of “start”, “continue” or “abort”.
RedeployOutdated
Type: optional, Boolean
Located in: URL.
If True, outdated applications in the target environment will be redeployed.

Return Codes

202
Command <Command> executed successfully for deployment <DeploymentKey>.
400
Command <Command> can't be executed for deployment <DeploymentKey>.
403
Service Account doesn't have permissions to the deployment with key <DeploymentKey>.
404
Deployment with key <DeploymentKey> not found, or command not found.
500
Failed to execute command <Command> for deployment with key <DeploymentKey>.

GET /deployments/{DeploymentKey}/status/

Returns the details of a given deployment execution, including the deployment status and messages.

Full URL

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

Inputs

DeploymentKey
Type: mandatory, Text
Located in: URL.
The key of the deployment whose status is being requested.

Outputs

DeploymentLog
Type: DeploymentMessage List
Located in: Body.
List of deployment messages.
DeploymentStatus
Type: Text
Located in: Body.
Status of the deployment. [saved | running | needs_user_intervention | aborted | aborting | finished_successful | finished_with_warnings | finished_with_errors]
Info
Type: Text
Located in: Body.
Contains more information on the kind of user intervention needed when the DeploymentStatus value is "needs_user_intervention". For every other status, Info will contain an empty string (""). [business_process_impact | deploy_prepared | needs_configuration_or_confirmation | deployment_suspended].

Return Codes

200
Deployment status successfully retrieved.
403
User doesn't have permissions to the deployment with key <DeploymentKey>.
404
Deployment with key <DeploymentKey> not found.
500
Failed to retrieve the status of the deployment with key <DeploymentKey>.

/environments

GET /environments/

Lists all the environments in the infrastructure.

Full URL

GET /lifetimeapi/rest/v2/environments/

Outputs

Environments
Type: Environment List
Located in: Body.
A list of Environment records.

Return Codes

200
Environments list successfully retrieved.
204
No environments found.
500
Failed to list the environments.

GET /environments/{EnvironmentKey}/

Returns the details of a given environment.

Full URL

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

Inputs

EnvironmentKey
Type: mandatory, Text
Located in: URL.
The key of the desired environment.

Outputs

Environment
Type: Environment
Located in: Body.
An Environment record.

Return Codes

200
Environment details successfully retrieved.
403
Failed to retrieve the environment with key: <EnvironmentKey>. The user does not have the required permissions.
404
Failed to retrieve the environment with key: <EnvironmentKey>.
500
Failed to access the details of environment.

GET /environments/{EnvironmentKey}/applications/

Returns information about the running versions of all applications in a given environment.

Full URL

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

Inputs

EnvironmentKey
Type: mandatory, Text
Located in: URL.
The key of the environment whose list of running applications is being requested.
IncludeModules
Type: optional, Boolean
Located in: URL.
When set to true, the modules details are also retrieved. The default value is false.
IncludeEnvStatus
Type: optional, Boolean
Located in: URL.
When set to true, the applications’ status information in the environment is included in the result. The default value is false.

Outputs

Applications
Type: Application List
Located in: Body.
A list of Application records.

Return Codes

200
Applications list for the given environment successfully retrieved
204
No applications found in environment with key <EnvironmentKey>.
400
Failed to retrieve applications published in environment because IncludeModules and IncludeEnvStatus parameters were incorrect, or Invalid request when getting running applications for environment with key <EnvironmentKey>.
403
Failed to retrieve the running applications for environment with key <EnvironmentKey> because user has insufficient permissions.
404
Failed to retrieve running applications for environment with key <EnvironmentKey> because it was not found.

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

Returns information about the running version of the specified application in a given environment.

Full URL

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

Inputs

EnvironmentKey
Type: mandatory, Text
Located in: URL.
The key of the environment from which to get the running application details.
ApplicationKey
Type: mandatory, Text
Located in: URL.
The key of the application whose details are being requested.
IncludeEnvStatus
Type: optional, Boolean
Located in: URL.
When set to true, the applications’ status information in the environment is included in the result. The default value is false.
IncludeModules
Type: optional, Boolean
Located in: URL.
When set to true, the modules details are also retrieved. The default value is false.

Outputs

Application
Type: Application
Located in: Body.
An Application record.

Return Codes

200
Application information successfully retrieved.
400
Request asked for Modules but not for Status.
403
User doesn’t have permissions for the given keys (EnvironmentKey:<EnvironmentKey>; Application:<ApplicationKey>).
404
Failed to retrieve the environment with key <EnvironmentKey> or the application with key <ApplicationKey>.
500
Failed to access the running version of an application.

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

Returns a link where the binary file for a given application can be downloaded. The link will expire in 60 minutes.

Full URL

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

Inputs

EnvironmentKey
Type: mandatory, Text
Located in: URL.
The key of the environment from which to get the application binary file link.
ApplicationKey
Type: mandatory, Text
Located in: URL.
The key of the application for which to get the binary file link.
Type
Type: optional, Text
Located in: URL.
The type of binary file to return, when applicable. One of “oap”, “apk” or “ipa”.

Outputs

DownloadLink
Type: DownloadLink
Located in: Body.
The link for the application binary file.
Expires
Type: Date Time
Located in: Header.
The expiration date and time of the returned link.

Return Codes

200
Binary file download link successfully retrieved.
204
No binary available for given type and keys.
400
The required type <Type> is invalid for given keys (EnvironmentKey:<EnvironmentKey>; Application:<ApplicationKey>).
403
User doesn’t have permissions for the given keys (EnvironmentKey:<EnvironmentKey>; Application:<ApplicationKey>).
404
Failed to retrieve the environment with key <EnvironmentKey> or the application with key <ApplicationKey>.
500
Failed to download <Type> of an application.

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

Creates a new version of the application based on the current running application.

Full URL

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

Inputs

EnvironmentKey
Type: mandatory, Text
Located in: URL.
The key of the environment from which to get the application.
ApplicationKey
Type: mandatory, Text
Located in: URL.
The key of the application for which to generate a new version.
ApplicationVersionCreate
Type: mandatory, ApplicationVersionCreate
Located in: Body.
A structure holding the new version name for the application and for its native applications, if applicable.

Outputs

ApplicationVersionKey
Type: Text
Located in: Body.
The key of the newly created application version.

Return Codes

201
Application version successfully created.
400
Invalid request.
403
Invalid user permissions.
404
Environment or application not found.
500
Failed to tag an application, or Failed to create a new version for application <ApplicationName>.

Example Request Body

{
  "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"
  ]
}

GET /environments/{EnvironmentKey}/deploymentzones/

Returns information about the deployment zones available in a given environment.

Full URL

GET /lifetimeapi/rest/v2/environments/{EnvironmentKey}/deploymentzones/

Inputs

EnvironmentKey
Type: mandatory, Text
Located in: URL.
The key of the environment from which to get the running application details.

Outputs

DeploymentZones
Type: DeploymentZone List
Located in: Body.
A list of Deployment Zones.

Return Codes

200
Deployment zone information successfully retrieved.
400
Failed to access the deployment zones of environment.
403
Failed to retrieve the deployment zones of environment <EnvironmentName> (key: <EnvironmentKey>). Error: The user does not have the required permissions, or Feature not Licensed.
404
Failed to retrieve the deployment zones of environment with key: <EnvironmentKey>.
500
Failed to access the deployment zones of environment.

/modules

GET /modules/

Returns a list of modules that exist in the infrastructure.

Full URL

GET /lifetimeapi/rest/v2/modules/

Inputs

IncludeEnvStatus
Type: optional, Boolean
Located in: URL.
When set to true, the module status per environment is also returned. The default value is false.

Outputs

ModuleList
Type: Module List
Located in: Body.
List of Module records.

Return Codes

200
Modules list successfully retrieved.
204
No modules found in the infrastructure.
500
Failed to list modules.

GET /modules/{ModuleKey}/

Returns the details of a given module.

Full URL

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

Inputs

ModuleKey
Type: mandatory, Text
Located in: URL.
Key of the module to list the details from.
IncludeEnvStatus
Type: optional, Boolean
Located in: URL.
Boolean to indicate if status per env should be returned. Default is false.

Outputs

Module
Type: Module
Located in: Body.
Module record.

Return Codes

200
Module details successfully retrieved.
403
Failed to retrieve the module with key: <ModuleKey>. The user does not have the required permissions.
404
Failed to retrieve the module with key: <ModuleKey>.
500
Failed to retrieve the module with key <ModuleKey>.

GET /modules/{ModuleKey}/versions/

Returns a list of versions of a given module.

Full URL

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

Inputs

ModuleKey
Type: mandatory, Text
Located in: URL.
The module from where to retrieve the versions from.
MaximumVersionsToReturn
Type: optional, Integer
Located in: URL.
Maximum number of versions to return. Default is 5.

Outputs

ModuleVersionList
Type: ModuleVersion List
Located in: Body.
List of ModuleVersion records.

Return Codes

200
List of module versions successfully retrieved.
400
Invalid request due to invalid max versions to return (less than 0).
403
Failed to retrieve the module with key: <ModuleKey>. The user does not have the required permissions.
404
Failed to retrieve the module with key: <ModuleKey>.
500
Failed to list module versions.

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

Returns the details of a given module version.

Full URL

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

Inputs

ModuleKey
Type: mandatory, Text
Located in: URL.
The module from where to retrieve the versions from.
ModuleVersionKey
Type: mandatory, Text
Located in: URL.
Key of the module version to return.

Outputs

ModuleVersion
Type: ModuleVersion
Located in: Body.
Record of ModuleVersion.

Return Codes

200
Module version details successfully retrieved.
403
Failed to retrieve the module with key: <ModuleKey>. The user does not have the required permissions.
404
Failed to retrieve the module with key: <ModuleKey>, or Failed to retrieve the module version with key: <ModuleKey>.
500
Failed to access the details of a module version.

Structures

Application

An application with its details and its status in the environments were it is running.

Attributes

Key
Type: Text.
Application unique identifier.
Name
Type: Text (50).
Name of the application.
Kind
Type: RuntimeKind Identifier.
Identifies the kind of application. [Mobile | WebResponsive]
Team
Type: Text (50).
The team that owns the application.
Description
Type: Text (50).
Description of the application.
URLPath
Type: Text (50).
Relative URL path of the application, starting from the hostname.
IconHash
Type: Text (50).
Hash of the application icon. Can be used to detect changes in the application icon.
IconURL
Type: Text (50).
The URL for the application icon.
IsSystem
Type: Boolean.
Indicates if the application is a built-in component of the OutSystems platform (e.g. ServiceCenter, LifeTime, ...).
AppStatusInEnvs
Type: AppStatusInEnv List.
Information about the status of the application in each environment it is running.

ApplicationConflict

A deployment conflict.

Attributes

Message
Type: Text.
Description of the conflict.
ProducerApplicationOperation
Type: ApplicationOperation.
Operation executed over producer application.
ConsumerApplicationOperation
Type: ApplicationOperation.
Operation executed over consumed application.
ModuleConflict
Type: ModuleConflict.
Details of the module conflict.

ApplicationOperation

Operation executed in the deployment over the application.

Attributes

ApplicationKey
Type: Text.
Application unique identifier.
ApplicationVersionKey
Type: Text.
Application Version unique identifier.
DeploymentOperation
Type: Text.
Label of the operation to be performed. Example: Deploy 1.5.
DeploymentZoneKey
Type: Text.
Deployment Zone unique identifier.

ApplicationVersion

Information about a specific version of an application and the versions of its modules.

Attributes

Key
Type: Text.
Application version unique identifier.
ApplicationKey
Type: Text.
Application unique identifier.
Version
Type: Text (50).
Version of the application.
CreatedOn
Type: Date Time.
When was the Application Version created.
InUse
Type: Boolean.
Defines if the Application Version is being used.
MobileVersions
Type: MobileVersion List.
List of mobile versions.
PrimaryColor
Type: Text (50).
The primary color of the application interface.
NativeHash
Type: Text (50).
The native hash relative to the mobile platform.
ModuleVersions
Type: ModuleVersion List.
List of module versions.

ApplicationVersionCreate

A structure holding the new version name for the application and for its native applications, if applicable.

Attributes

ChangeLog
Type: Text.
Change log of the version to be created.
Version
Type: Text (50).
Version of the application.
MobileVersions
Type: MobileVersion List.
List of mobile versions.
ModuleVersionKeys
Type: Text List.
List of module version keys to validate if the current state of the application is still the expected one.

AppStatusInEnv

Status of application in a given environment.

Attributes

EnvironmentKey
Type: Text.
Environment unique identifier.
BaseApplicationVersionKey
Type: Text.
Base application version unique identifier. If app is not modified in environment, this is the application version deployed.
IsModified
Type: Boolean.
True if the application has been changed since the last tag, false otherwise.
IsModifiedReason
Type: Text.
Indicates the application status.
IsModifiedMessage
Type: Text.
Indicates the application status.
ConsistencyStatus
Type: Text (50).
Indicates the application consistency status.
ConsistencyStatusMessages
Type: Text (2000).
Messages regarding the consistency status of the application.
MobileAppsStatus
Type: MobileAppStatusInEnv List.
Status of mobile apps in environment.
ModuleStatusInEnvs
Type: ModuleStatusInEnv List.
Status of modules in environment.
DeploymentZoneKey
Type: Text.
Deployment Zone unique identifier

Deployment

Deployment information with the operations executed.

Attributes

Key
Type: Text.
Deployment unique identifier.
SourceEnvironmentKey
Type: Text.
Source environment unique identifier.
TargetEnvironmentKey
Type: Text.
Target environment unique identifier.
Notes
Type: Text.
Deployment notes.
CreatedOn
Type: Date Time.
Date and time when the deployment plan was created.
CreatedBy
Type: Text.
Name of the user who created the deployment plan.
CreatedByUsername
Type: Text.
Username of the user who created the deployment plan.
SavedOn
Type: Date Time.
The date and time when the deployment plan was saved.
SavedBy
Type: Text.
Name of the user who last saved the deployment plan.
SavedByUsername
Type: Text.
Username of the user who last saved the deployment plan.
StartedOn
Type: Date Time.
The date and time when the deployment started.
StartedBy
Type: Text.
Name of the user who started the deployment.
StartedByUsername
Type: Text.
Username of the user who started the deployment.
AbortedOn
Type: Date Time.
The date and time when the deployment was aborted.
AbortedBy
Type: Text.
Name of the user who aborted the deployment.
AbortedByUsername
Type: Text.
Username of the user who aborted the deployment.
ApplicationOperations
Type: ApplicationOperation List.
List of Application Operations included in the deployment.

DeploymentData

Deployment information with the operations executed.

Attributes

Key
Type: Text.
Deployment unique identifier.
SourceEnvironmentKey
Type: Text.
Source environment unique identifier.
TargetEnvironmentKey
Type: Text.
Target environment unique identifier.
Notes
Type: Text.
Deployment notes.
CreatedOn
Type: Date Time.
Date and time when the deployment plan was created.
CreatedBy
Type: Text.
Name of the user who created the deployment plan.
CreatedByUsername
Type: Text.
Username of the user who created the deployment plan.
SavedOn
Type: Date Time.
The date and time when the deployment plan was saved.
SavedBy
Type: Text.
Name of the user who last saved the deployment plan.
SavedByUsername
Type: Text.
Username of the user who last saved the deployment plan.
StartedOn
Type: Date Time.
The date and time when the deployment started.
StartedBy
Type: Text.
Name of the user who started the deployment.
StartedByUsername
Type: Text.
Username of the user who started the deployment.
AbortedOn
Type: Date Time.
The date and time when the deployment was aborted.
AbortedBy
Type: Text.
Name of the user who aborted the deployment.
AbortedByUsername
Type: Text.
Username of the user who aborted the deployment.
ApplicationOperations
Type: ApplicationOperation List.
List of Application Operations included in the deployment.
Note: Only the ApplicationVersionKey and DeploymentZoneKey attributes are used.

DeploymentMessage

Message from a deployment operation log.

Attributes

Instant
Type: Date Time.
Date and time when the message was logged.
Message
Type: Text.
Details of the message.

DeploymentTechnology

Deployment Hosting technology of the Deployment Zone.

Attributes

Key
Type: Text.
Deployment Technology unique identifier.
Name
Type: Text.
Name of deployment technology

DeploymentZone

Deployment Zone of an environment.

Attributes

Key
Type: Text.
Deployment Zone unique identifier.
Name
Type: Text.
Name of deployment zone
IsDefault
Type: Boolean.
True if the deployment zone is the default one in the environment
DeploymentTechnology
Type: DeploymentTechnology.
The deployment techonology of the current deployment zone.

The link for the application binary file.

Attributes

url
Type: Text.
The link for the application binary file.
expires
Type: Date Time.
The expiration date and time of the returned link.

Environment

An environment and its information.

Attributes

Key
Type: Text.
Unique identifier of the environment.
Name
Type: Text (50).
Name of the environment.
OSVersion
Type: Text (50).
Platform Server version. [X.X.X.X]
Order
Type: Integer.
The order of the environment as registered in Lifetime.
HostName
Type: Text (50).
Hostname of the environment as registered.
UseHTTPS
Type: Boolean.
Indicates if connections to the environment are made using HTTPS.
EnvironmentType
Type: Text.
Indicates the type of the environment. [Development | Test | Production]
NumberOfFrontEnds
Type: Integer.
Number of front-end servers in the environment.
ApplicationServerType
Type: Text (50).
Stack of the application server. [.NET | JAVA]
ApplicationServer
Type: Text (50).
Application server in use. [IIS | JBoss | WebLogic]
DatabaseProvider
Type: Text (50).
Type of database provider. [SqlServer | Oracle]
IsCloudEnvironment
Type: Boolean.
Indicates if the environment is running on a cloud service.

MobileAppStatusInEnv

Status of mobile application in a given environment.

Attributes

EnvironmentKey
Type: Text.
Environment unique identifier.
NativePlatform
Type: Text.
Name of native platform. [Android | iOS]
VersionNumber
Type: Text.
The version number, like for example 1.5.4, of the native build. It is used to be able to map the version to the version in the Android or iOS store.
HasBinaryAvailable
Type: Boolean.
True if the binary of the application is available for the current configuration.
IsConfigured
Type: Boolean.
True if the application is configured.
IsConfigurationChanged
Type: Boolean.
True if the configuration of the Mobile Application has changed in the environment.
IsModified
Type: Boolean.
True if the Native Hash of the Mobile Application does not match the one in the AppVersionNativeBuild baseline.

MobileVersion

A mobile version and its information.

Attributes

NativePlatform
Type: Text.
Name of native platform. [Android | iOS]
VersionNumber
Type: Text (50).
The version number, like for example 1.5.4, of the native build. It is used to be able to map the version to the version in the Android or iOS store.
VersionDescription
Type: Text.
The description of the mobile version.

Module

Module information and the status in the environments where the modules are running.

Attributes

Key
Type: Text.
Module unique identifier.
Name
Type: Text (50).
Name of the module.
Description
Type: Text (50).
Description of the module.
Kind
Type: Text (50).
Module type (eSpace or Extension).
ModuleStatusInEnv
Type: ModuleStatusInEnv List.
Status of the module in environments.

ModuleConflict

A module conflict.

Attributes

ProducerModuleKey
Type: Text.
Producer Module unique identifier.
ConsumerModuleKey
Type: Text.
Consumer Module unique identifier.
TotalRequiredElements
Type: Integer.
Total number of required elements.
ConflictType
Type: Text.
Type of conflict. [Producer Module Missing | Producer Element Missing | Producer Element Incompatible | Consumer Module Outdated | Newer Producer Module Available | IncompatiblePlatformServer | ConsumerModuleMoved | ProducerModuleMoved | NameColision]

ModuleElement

Element version information, such as action, entity, structure, among others.

Attributes

Key
Type: Text.
Module element unique identifier.
Name
Type: Text (50).
Name of the element as specified by the developer.
ElementType
Type: Text.
Type of the element, such as action, entity, structure.
CompatibilitySignatureHash
Type: Text (50).
Hash of the element signature. Can be used to validate if the element version is compatible with another version, not producing a broken reference.
FullSignatureHash
Type: Text (50).
Hash of the element. Can be used to uniquely identify an element version.
ModuleKey
Type: Text.
Unique identifier of the module where the element is publicly supplied, among others.

ModuleStatusInEnv

Status of module in a given environment.

Attributes

ApplicationKey
Type: Text.
Application unique identifier.
EnvironmentKey
Type: Text.
Environment unique identifier.
ModuleVersionKey
Type: Text.
Module version unique identifier.
ConsistencyStatus
Type: Text (50).
Indicates the module consistency status.
ConsistencyStatusMessages
Type: Text (2000).
Messages regarding the consistency status of the module.

ModuleVersion

A module version and its information.

Attributes

Key
Type: Text.
Module version unique identifier.
ModuleKey
Type: Text.
Module unique identifier.
CreatedOn
Type: Date Time.
Date and time of the module version creation.
CreatedBy
Type: Text (50).
Name of the user that created the version.
CreatedByUsername
Type: Text (50).
Username of the user that created the version.
GeneralHash
Type: Text (100).
Non-unique hash of the module version. Can be used to validate if two module versions have semantic differences.
DirectUpgradeFromHash
Type: Text (100).
If this module version is the result of a direct upgrade of another version, then this field contains the key of that version

Articles in this Section