LifeTime Services API

Role_ChangeName

プラットフォームロールの名前を更新します。

入力

Authentication

型: 必須。WebServiceSimpleAuthentication。
このAPIを使用するために必要な認証。有効なプラットフォームのユーザー名とパスワードを指定するか、AuthenticationService APIを使用してセッショントークンを取得します。

OldRoleName

型: 必須。Text。
名前を変更するプラットフォームロールの名前。

NewRoleName

型: 必須。Text。
プラットフォームロールの新しい名前。

出力

Success

型: Boolean。
メソッドが成功の場合はTrue、それ以外の場合はFalseになります。

Status

型: APIStatus。
このAPIの呼び出しのステータス。このステータスには、エラーコードと人間が読めるエラーメッセージが含まれます。

Role_CreateOrUpdate

新しいプラットフォームロールを作成するか、既存のプラットフォームロールを更新します。

入力

Authentication

型: 必須。WebServiceSimpleAuthentication。
このAPIを使用するために必要な認証。有効なプラットフォームのユーザー名とパスワードを指定するか、AuthenticationService APIを使用してセッショントークンを取得します。

RoleName

型: 必須。Text。
プラットフォームロールの名前。このロールがプラットフォーム内に存在しない場合はロールが作成され、それ以外の場合はロールが更新されます。

CanConfigureInfrastructure

型: 必須。Boolean。
プラットフォームロールがインフラを構成する権限を持つかどうかを指定します。

RoleDescription

型: 必須。Text。
プラットフォームロールの説明。

出力

Success

型: Boolean。
メソッドが成功の場合はTrue、それ以外の場合はFalseになります。

Status

型: APIStatus。
このAPIの呼び出しのステータス。このステータスには、エラーコードと人間が読めるエラーメッセージが含まれます。

PlatformRole

型: PlatformRole。
プラットフォームロールとその情報。

Role_Delete

既存のプラットフォームロールを削除します。プラットフォームではITユーザーがプラットフォームロールを1つ持っている必要があるため、削除するロールが現在設定されているユーザーに付与する新しいプラットフォームロールを指定する必要があります。

入力

Authentication

型: 必須。WebServiceSimpleAuthentication。
このAPIを使用するために必要な認証。有効なプラットフォームのユーザー名とパスワードを指定するか、AuthenticationService APIを使用してセッショントークンを取得します。

RoleName

型: 必須。Text。
プラットフォームロールの名前。

UsersNewRoleName

型: 必須。Text。
削除されるプラットフォームロールを持つユーザーに付与するプラットフォームロール。

出力

Success

型: Boolean。
メソッドが成功の場合はTrue、それ以外の場合はFalseになります。

Status

型: APIStatus。
このAPIの呼び出しのステータス。このステータスには、エラーコードと人間が読めるエラーメッセージが含まれます。

AffectedPlatformUsers

型: PlatformUser List。
削除されるプラットフォームロールが関連付けられているITユーザーのリスト。

Role_GetPermissions

プラットフォームで登録されている環境内でプラットフォームロールが持つ権限のリストを返します。

入力

Authentication

型: 必須。WebServiceSimpleAuthentication。
このAPIを使用するために必要な認証。有効なプラットフォームのユーザー名とパスワードを指定するか、AuthenticationService APIを使用してセッショントークンを取得します。

RoleName

型: 必須。Text。
プラットフォームロールの名前。

出力

Success

型: Boolean。
メソッドが成功の場合はTrue、それ以外の場合はFalseになります。

Status

型: APIStatus。
このAPIの呼び出しのステータス。このステータスには、エラーコードと人間が読めるエラーメッセージが含まれます。

PlatformRolePermissions

型: EnvironmentPermissionForRole List。
プラットフォームロールがプラットフォームで登録されている環境に対して持つ権限のリスト。

Role_List

すべてのプラットフォームロールとそれぞれの情報を返します。

入力

Authentication

型: 必須。WebServiceSimpleAuthentication。
このAPIを使用するために必要な認証。有効なプラットフォームのユーザー名とパスワードを指定するか、AuthenticationService APIを使用してセッショントークンを取得します。

出力

Success

型: Boolean。
メソッドが成功の場合はTrue、それ以外の場合はFalseになります。

Status

型: APIStatus。
このAPIの呼び出しのステータス。このステータスには、エラーコードと人間が読めるエラーメッセージが含まれます。

PlatformRoles

型: PlatformRole List。
プラットフォームロールのリスト。

Role_UpdatePermission

指定された環境内でプラットフォームロールが持つ権限を更新します。

入力

Authentication

型: 必須。WebServiceSimpleAuthentication。
このAPIを使用するために必要な認証。有効なプラットフォームのユーザー名とパスワードを指定するか、AuthenticationService APIを使用してセッショントークンを取得します。

RoleName

型: 必須。Text。
プラットフォームロールの名前。

EnvironmentKey

型: 必須。Text。
環境の一意の識別子。

NewPermissionLevelId

型: 必須。EnvironmentPermissionLevel Identifier。
プラットフォームロールが持つ新しい権限レベルへの参照。

出力

Success

型: Boolean。
メソッドが成功の場合はTrue、それ以外の場合はFalseになります。

Status

型: APIStatus。
このAPIアクションの呼び出しのステータス。エラーの場合、エラーコードと人間が読めるエラーメッセージが含まれます。

Authentication_GetToken

5分間有効な認証トークンを返します。

入力

Username

型: 必須。Text。
プラットフォームのユーザー名。

Password

型: 必須。Text。
プラットフォームのパスワード。

出力

Success

型: Boolean。
メソッドが成功の場合はTrue、それ以外の場合はFalseになります。

Status

型: APIStatus。
このAPIの呼び出しのステータス。このステータスには、エラーコードと人間が読めるエラーメッセージが含まれます。

Token

型: Text。
セッショントークン。このトークンは作成されてから5分後に期限切れになります。

Team_AddUser

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

入力

Authentication

型: 必須。WebServiceSimpleAuthentication。
このAPIを使用するために必要な認証。有効なユーザー名とパスワードを指定するか、AuthenticationService APIを使用してセッショントークンを取得します。

TeamName

型: 必須。Text。
チームの名前。

Username

型: 必須。Text。
ユーザーのユーザー名。

RoleName

型: 必須。Text。
ユーザーに割り当てるロールの名前。

出力

Success

型: Boolean。
メソッドが成功の場合はTrue、それ以外の場合はFalseになります。

Status

型: APIStatus。
このAPIアクションの呼び出しのステータス。エラーの場合、エラーコードと人間が読めるエラーメッセージが含まれます。

Team_AssignApplication

アプリケーションをチームに割り当て、以前の割り当てを置き換えます。チームに割り当てることができるアプリケーションは一度に1つのみです。

入力

Authentication

型: 必須。WebServiceSimpleAuthentication。
このAPIを使用するために必要な認証。有効なユーザー名とパスワードを指定するか、AuthenticationService APIを使用してセッショントークンを取得します。

TeamName

型: 必須。Text。
チームの名前。

ApplicationKey

型: 必須。Text。
アプリケーションの一意の識別子。

出力

Success

型: Boolean。
メソッドが成功の場合はTrue、それ以外の場合はFalseになります。

Status

型: APIStatus。
このAPIアクションの呼び出しのステータス。エラーの場合、エラーコードと人間が読めるエラーメッセージが含まれます。

Team_CreateOrUpdate

新しいチームを作成するか、既存のチームを更新します。

入力

Authentication

型: 必須。WebServiceSimpleAuthentication。
このAPIを使用するために必要な認証。有効なユーザー名とパスワードを指定するか、AuthenticationService APIを使用してセッショントークンを取得します。

TeamName

型: 必須。Text。
チームの名前。

説明

型: 必須。Text。
チームの説明。

出力

Success

型: Boolean。
メソッドが成功の場合はTrue、それ以外の場合はFalseになります。

Status

型: APIStatus。
このAPIアクションの呼び出しのステータス。エラーの場合、エラーコードと人間が読めるエラーメッセージが含まれます。

PlatformTeam

型: PlatformTeam。
作成または更新されたチーム。

Team_Delete

チームを削除します。

入力

Authentication

型: 必須。WebServiceSimpleAuthentication。
このAPIを使用するために必要な認証。有効なユーザー名とパスワードを指定するか、AuthenticationService APIを使用してセッショントークンを取得します。

TeamName

型: 必須。Text。
チームの名前。

出力

Success

型: Boolean。
メソッドが成功の場合はTrue、それ以外の場合はFalseになります。

Status

型: APIStatus。
このAPIアクションの呼び出しのステータス。エラーの場合、エラーコードと人間が読めるエラーメッセージが含まれます。

Team_GetDetails

チームの詳細と、そのユーザーとアプリケーションを返します。

入力

Authentication

型: 必須。WebServiceSimpleAuthentication。
このAPIを使用するために必要な認証。有効なユーザー名とパスワードを指定するか、AuthenticationService APIを使用してセッショントークンを取得します。

TeamName

型: 必須。Text。
チームの名前。

出力

Success

型: Boolean。
メソッドが成功の場合はTrue、それ以外の場合はFalseになります。

Status

型: APIStatus。
このAPIアクションの呼び出しのステータス。エラーの場合、エラーコードと人間が読めるエラーメッセージが含まれます。

PlatformTeam

型: PlatformTeam。
チームの詳細。

Team_List

チームのリストを返します。

入力

Authentication

型: 必須。WebServiceSimpleAuthentication。
このAPIを使用するために必要な認証。有効なユーザー名とパスワードを指定するか、AuthenticationService APIを使用してセッショントークンを取得します。

出力

Success

型: Boolean。
メソッドが成功の場合はTrue、それ以外の場合はFalseになります。

Status

型: APIStatus。
このAPIアクションの呼び出しのステータス。エラーの場合、エラーコードと人間が読めるエラーメッセージが含まれます。

PlatformTeams

型: PlatformTeam List。
チームのリスト。返される各チームのApplicationListアトリビュートとUserListアトリビュートは空になります。チームのアプリケーションとユーザーのリストを取得するには、Team_GetDetailsアクションを呼び出します。

Team_RemoveApplication

アプリケーションをチームから削除します。

入力

Authentication

型: 必須。WebServiceSimpleAuthentication。
このAPIを使用するために必要な認証。有効なユーザー名とパスワードを指定するか、AuthenticationService APIを使用してセッショントークンを取得します。

TeamName

型: 必須。Text。
チームの名前。

ApplicationKey

型: 必須。Text。
アプリケーションの一意の識別子。

出力

Success

型: Boolean。
メソッドが成功の場合はTrue、それ以外の場合はFalseになります。

Status

型: APIStatus。
このAPIアクションの呼び出しのステータス。エラーの場合、エラーコードと人間が読めるエラーメッセージが含まれます。

Team_RemoveUser

ユーザーをチームから削除します。

入力

Authentication

型: 必須。WebServiceSimpleAuthentication。
このAPIを使用するために必要な認証。有効なユーザー名とパスワードを指定するか、AuthenticationService APIを使用してセッショントークンを取得します。

TeamName

型: 必須。Text。
チームの名前。

Username

型: 必須。Text。
ユーザーのユーザー名。

出力

Success

型: Boolean。
メソッドが成功の場合はTrue、それ以外の場合はFalseになります。

Status

型: APIStatus。
このAPIアクションの呼び出しのステータス。エラーの場合、エラーコードと人間が読めるエラーメッセージが含まれます。

Environment_List

環境のリストと、それぞれの名前、OutSystemsのバージョン、アプリケーションサーバーなどの情報を返します。

入力

Authentication

型: 必須。WebServiceSimpleAuthentication。
このAPIを使用するために必要な認証。有効なプラットフォームのユーザー名とパスワードを指定するか、AuthenticationService APIを使用してセッショントークンを取得します。

出力

Success

型: Boolean。
メソッドが成功の場合はTrue、それ以外の場合はFalseになります。

Status

型: APIStatus。
このAPIの呼び出しのステータス。このステータスには、エラーコードと人間が読めるエラーメッセージが含まれます。

Environments

型: EnvironmentInfo List。
環境のリストと、それぞれの情報。

EnvironmentPermissionLevel_List

プラットフォームユーザーが環境に対して持つ権限レベルをリスト化します。

入力

Authentication

型: 必須。WebServiceSimpleAuthentication。
このAPIを使用するために必要な認証。有効なプラットフォームのユーザー名とパスワードを指定するか、LoginService APIを使用してセッショントークンを取得します。

出力

Success

型: Boolean。
メソッドが成功の場合はTrue、それ以外の場合はFalseになります。

Status

型: APIStatus。
このAPIの呼び出しのステータス。このステータスには、エラーコードと人間が読めるエラーメッセージが含まれます。

RolePermissionLevels

型: EnvironmentPermissionLevel List。
プラットフォームで構成された、ITユーザーが環境に対して持つ権限。

IPAddress_GetLockedStatus

入力

Authentication

型: 必須。WebServiceSimpleAuthentication。
このAPIを使用するために必要な認証。有効なプラットフォームのユーザー名とパスワードを指定するか、AuthenticationService APIを使用してセッショントークンを取得します。

IPAddress

型: 任意。Text。
ロック情報（存在する場合）が属するIPアドレス。このパラメータが空の場合、ロックされたすべてのIPアドレスの情報が返されます。

EnvironmentKey

型: 任意。Text。
ロック情報を検索する環境の一意の識別子。このパラメータが空の場合、すべてのアクティブな環境に関する情報が返されます。

出力

Success

型: Boolean。
メソッドが成功の場合はTrue、それ以外の場合はFalseになります。

Status

型: APIStatus。
このAPIの呼び出しのステータス。このステータスには、エラーコードと人間が読めるエラーメッセージが含まれます。

PlatformLoginAttempts

型: PlatformLoginAttempt List。
指定された環境（またはすべてのアクティブな環境）の指定されたIPアドレス（またはすべてのIPアドレス）に関するログイン試行のリスト。

IPAddress_Unlock

入力

Authentication

型: 必須。WebServiceSimpleAuthentication。
このAPIを使用するために必要な認証。有効なプラットフォームのユーザー名とパスワードを指定するか、AuthenticationService APIを使用してセッショントークンを取得します。

IPAddress

型: 必須。Text。
指定された環境でロック解除するIPアドレス。

EnvironmentKey

型: 任意。Text。
IPアドレスをロック解除する環境の一意の識別子。

出力

Success

型: Boolean。
メソッドが成功の場合はTrue、それ以外の場合はFalseになります。

Status

型: APIStatus。
このAPIの呼び出しのステータス。このステータスには、エラーコードと人間が読めるエラーメッセージが含まれます。

User_GetLockedStatus

入力

Authentication

型: 必須。WebServiceSimpleAuthentication。
このAPIを使用するために必要な認証。有効なプラットフォームのユーザー名とパスワードを指定するか、AuthenticationService APIを使用してセッショントークンを取得します。

Username

型: 必須。Text。
ロック情報（存在する場合）が属するユーザー名。

EnvironmentKey

型: 任意。Text。
ロック情報を検索する環境の一意の識別子。このパラメータが空の場合、すべてのアクティブな環境に関する情報が返されます。

出力

Success

型: Boolean。
メソッドが成功の場合はTrue、それ以外の場合はFalseになります。

Status

型: APIStatus。
このAPIの呼び出しのステータス。このステータスには、エラーコードと人間が読めるエラーメッセージが含まれます。

PlatformLoginAttempts

型: PlatformLoginAttempt List。
指定された環境（またはすべてのアクティブな環境）の指定されたユーザー名に関するログイン試行のリスト。

User_Unlock

入力

Authentication

型: 必須。WebServiceSimpleAuthentication。
このAPIを使用するために必要な認証。有効なプラットフォームのユーザー名とパスワードを指定するか、AuthenticationService APIを使用してセッショントークンを取得します。

Username

型: 必須。Text。
指定された環境（またはすべての環境）でロック解除するユーザー名。

IPAddress

型: 任意。Text。
指定されたユーザー名をロック解除するIPアドレス。

EnvironmentKey

型: 任意。Text。
ユーザー名をロック解除する環境の一意の識別子。

出力

Success

型: Boolean。
メソッドが成功の場合はTrue、それ以外の場合はFalseになります。

Status

型: APIStatus。
このAPIの呼び出しのステータス。このステータスには、エラーコードと人間が読めるエラーメッセージが含まれます。

DbConnection_Create

新しいデータベース接続を作成します。

入力

Authentication

型: 必須。WebServiceSimpleAuthentication。
このAPIを使用するために必要な認証。有効なプラットフォームのユーザー名とパスワードを指定するか、LoginService APIを使用してセッショントークンを取得します。

EnvironmentKey

型: 必須。Text。
環境の一意の識別子。

名前

型: 必須。Text。
新しいデータベース接続の名前。

ProviderKey

型: 必須。Text。
新しいデータベース接続に関連付けられたデータベースプロバイダのキー。DBConnection_ListProvidersメソッドをご覧ください。

説明

型: 必須。Text。
新しいデータベース接続の説明。

DBUsername

型: 必須。Text。
外部データベースにログインするためのユーザー名。

DBPassword

型: 必須。Text。
外部データベースにログインするためのパスワード。

DBConfigParams

型: 必須。Text。
接続文字列のパラメータ。「;」を使用して区切ります。

TestConnection

型: 必須。Boolean。
Trueの場合、テストが成功した後にのみデータベース接続が作成されます。

出力

DbConnection

型: 。
作成されたデータベース接続。

Success

型: Boolean。
データベース接続が作成された場合はTrueになります。

Status

型: APIStatus。
このAPIの呼び出しのステータス。このステータスには、エラーコードと人間が読めるエラーメッセージが含まれます。

DbConnection_Delete

指定された名前のデータベース接続を削除します。

入力

Authentication

型: 必須。WebServiceSimpleAuthentication。
このAPIを使用するために必要な認証。有効なプラットフォームのユーザー名とパスワードを指定するか、LoginService APIを使用してセッショントークンを取得します。

EnvironmentKey

型: 必須。Text。
環境の一意の識別子。

DbConnectionName

型: 必須。Text。
データベース接続の名前。

出力

Success

型: Boolean。
データベース接続が削除された場合はTrueになります。

Status

型: APIStatus。
このAPIの呼び出しのステータス。このステータスには、エラーコードと人間が読めるエラーメッセージが含まれます。

DbConnection_Edit

データベース接続の構成を更新します。

入力

Authentication

型: 必須。WebServiceSimpleAuthentication。
このAPIを使用するために必要な認証。有効なプラットフォームのユーザー名とパスワードを指定するか、LoginService APIを使用してセッショントークンを取得します。

EnvironmentKey

型: 必須。Text。
環境の一意の識別子。

DbConnectionName

型: 必須。Text。
データベース接続の名前。

ProviderKey

型: 必須。Text。
新しいデータベース接続に関連付けられたデータベースプロバイダのキー。DBConnection_ListProvidersメソッドをご覧ください。

説明

型: 必須。Text。
データベース接続の説明。

DBUsername

型: 必須。Text。
外部データベースにログインするためのユーザー名。

DBPassword

型: 必須。Text。
外部データベースにログインするためのパスワード。

DBConfigParams

型: 必須。Text。
接続文字列のパラメータ。「;」を使用して区切ります。

TestConnection

型: 必須。Boolean。
Trueの場合、テストが成功した後にのみデータベース接続が更新されます。

出力

Success

型: Boolean。
データベース接続が変更された場合はTrueになります。

Status

型: APIStatus。
このAPIの呼び出しのステータス。このステータスには、エラーコードと人間が読めるエラーメッセージが含まれます。

DbConnection_Get

データベース接続を返します。

入力

Authentication

型: 必須。WebServiceSimpleAuthentication。
このAPIを使用するために必要な認証。有効なプラットフォームのユーザー名とパスワードを指定するか、LoginService APIを使用してセッショントークンを取得します。

EnvironmentKey

型: 必須。Text。
環境の一意の識別子。

DbConnectionName

型: 必須。Text。
データベース接続の名前。

出力

DbConnection

型: 。
データベース接続。

Success

型: Boolean。
データベース接続が取得された場合はTrueになります。

Status

型: APIStatus。
このAPIの呼び出しのステータス。このステータスには、エラーコードと人間が読めるエラーメッセージが含まれます。

DbConnection_GetRoleAccess

データベース接続を使用するためのロール権限を返します。

入力

Authentication

型: 必須。WebServiceSimpleAuthentication。
このAPIを使用するために必要な認証。有効なプラットフォームのユーザー名とパスワードを指定するか、LoginService APIを使用してセッショントークンを取得します。

EnvironmentKey

型: 必須。Text。
環境の一意の識別子。

DbConnectionName

型: 必須。Text。
データベース接続の名前。

RoleName

型: 必須。Text。
ロールの名前。

出力

PermissionLevel

型: 。
ロールの権限レベル。

Success

型: Boolean。
権限が取得された場合はTrueになります。

Status

型: APIStatus。
このAPIの呼び出しのステータス。このステータスには、エラーコードと人間が読めるエラーメッセージが含まれます。

DbConnection_GetUserAccess

データベース接続を使用するためのユーザー権限を返します。

入力

Authentication

型: 必須。WebServiceSimpleAuthentication。
このAPIを使用するために必要な認証。有効なプラットフォームのユーザー名とパスワードを指定するか、LoginService APIを使用してセッショントークンを取得します。

EnvironmentKey

型: 必須。Text。
環境の一意の識別子。

DbConnectionName

型: 必須。Text。
データベース接続の名前。

Username

型: 必須。Text。
ユーザーのユーザー名。

出力

PermissionLevel

型: 。
ユーザーの権限レベル。

Success

型: Boolean。
権限が取得された場合はTrueになります。

Status

型: APIStatus。
このAPIの呼び出しのステータス。このステータスには、エラーコードと人間が読めるエラーメッセージが含まれます。

DbConnection_GrantRoleAccess

データベース接続を使用するための権限レベルをロールに付与します。

入力

Authentication

型: 必須。WebServiceSimpleAuthentication。
このAPIを使用するために必要な認証。有効なプラットフォームのユーザー名とパスワードを指定するか、LoginService APIを使用してセッショントークンを取得します。

EnvironmentKey

型: 必須。Text。
環境の一意の識別子。

DbConnectionName

型: 必須。Text。
データベース接続の名前。

RoleName

型: 必須。Text。
権限を付与するユーザーのロールの名前。

PermissionLevelId

型: 必須。DbConnectionPermissionLevel Identifier。
付与する権限レベル。DbConnection_PermissionLevel_Listメソッドをご覧ください。

出力

Success

型: Boolean。
権限が付与された場合はTrueになります。

Status

型: APIStatus。
このAPIの呼び出しのステータス。このステータスには、エラーコードと人間が読めるエラーメッセージが含まれます。

DbConnection_GrantUserAccess

データベース接続を使用するための権限レベルをユーザーに付与します。

入力

Authentication

型: 必須。WebServiceSimpleAuthentication。
このAPIを使用するために必要な認証。有効なプラットフォームのユーザー名とパスワードを指定するか、LoginService APIを使用してセッショントークンを取得します。

EnvironmentKey

型: 必須。Text。
環境の一意の識別子。

DbConnectionName

型: 必須。Text。
データベース接続の名前。

Username

型: 必須。Text。
権限を付与するユーザーのユーザー名。

PermissionLevelId

型: 必須。DbConnectionPermissionLevel Identifier。
付与する権限レベル。DbConnection_PermissionLevel_Listメソッドをご覧ください。

出力

Success

型: Boolean。
権限が付与された場合はTrueになります。

Status

型: APIStatus。
このAPIの呼び出しのステータス。このステータスには、エラーコードと人間が読めるエラーメッセージが含まれます。

DbConnection_ListAll

すべてのデータベース接続のリストを返します。

入力

Authentication

型: 必須。WebServiceSimpleAuthentication。
このAPIを使用するために必要な認証。有効なプラットフォームのユーザー名とパスワードを指定するか、LoginService APIを使用してセッショントークンを取得します。

EnvironmentKey

型: 必須。Text。
環境の一意の識別子。

出力

DbConnections

型: DatabaseConnectionリスト。
すべてのデータベース接続のリスト。

Success

型: Boolean。
データベース接続のリストが入力された場合はTrueになります。

Status

型: APIStatus。
このAPIの呼び出しのステータス。このステータスには、エラーコードと人間が読めるエラーメッセージが含まれます。

DbConnection_ListProviders

ユーザーがデータベース接続に関連付けることができるデータベースプロバイダのリスト。

入力

Authentication

型: 必須。WebServiceSimpleAuthentication。
このAPIを使用するために必要な認証。有効なプラットフォームのユーザー名とパスワードを指定するか、LoginService APIを使用してセッショントークンを取得します。

出力

Providers

型: DbProvider List。
許可されるデータベースプロバイダのリスト。

Success

型: Boolean。
認証が成功してプロバイダのリストが返された場合はTrueになります。

Status

型: APIStatus。
このAPIの呼び出しのステータス。このステータスには、エラーコードと人間が読めるエラーメッセージが含まれます。

DbConnection_PermissionLevel_List

権限レベルのリストを返します。

入力

Authentication

型: 必須。WebServiceSimpleAuthentication。
このAPIを使用するために必要な認証。有効なプラットフォームのユーザー名とパスワードを指定するか、LoginService APIを使用してセッショントークンを取得します。

出力

Success

型: Boolean。
認証が成功して権限レベルのリストが返された場合はTrueになります。

Status

型: APIStatus。
このAPIの呼び出しのステータス。このステータスには、エラーコードと人間が読めるエラーメッセージが含まれます。

DbConnectionPermissionLevels

型: DbConnectionPermissionLevel List。
権限レベルのリスト。

DbConnection_Rename

データベース接続の名前を変更します。これは、このデータベース接続を使用するすべての実行中のアプリケーションに影響を及ぼす可能性があります。

入力

Authentication

型: 必須。WebServiceSimpleAuthentication。
このAPIを使用するために必要な認証。有効なプラットフォームのユーザー名とパスワードを指定するか、LoginService APIを使用してセッショントークンを取得します。

EnvironmentKey

型: 必須。Text。
環境の一意の識別子。

CurrentName

型: 必須。Text。
データベース接続の現在の名前。

NewName

型: 必須。Text。
データベース接続の新しい名前。

出力

Success

型: Boolean。
データベース接続の名前が変更された場合はTrueになります。

Status

型: APIStatus。
このAPIの呼び出しのステータス。このステータスには、エラーコードと人間が読めるエラーメッセージが含まれます。

DbConnection_RevokeRoleAccess

データベース接続を使用するためのロール権限を取り消します。

入力

Authentication

型: 必須。WebServiceSimpleAuthentication。
このAPIを使用するために必要な認証。有効なプラットフォームのユーザー名とパスワードを指定するか、LoginService APIを使用してセッショントークンを取得します。

EnvironmentKey

型: 必須。Text。
環境の一意の識別子。

DbConnectionName

型: 必須。Text。
データベース接続の名前。

RoleName

型: 必須。Text。
権限を取り消すロールの名前。

出力

Success

型: Boolean。
権限が取り消された場合はTrueになります。

Status

型: APIStatus。
このAPIの呼び出しのステータス。このステータスには、エラーコードと人間が読めるエラーメッセージが含まれます。

DbConnection_RevokeUserAccess

データベース接続を使用するためのユーザー権限を取り消します。

入力

Authentication

型: 必須。WebServiceSimpleAuthentication。
このAPIを使用するために必要な認証。有効なプラットフォームのユーザー名とパスワードを指定するか、LoginService APIを使用してセッショントークンを取得します。

EnvironmentKey

型: 必須。Text。
環境の一意の識別子。

DbConnectionName

型: 必須。Text。
データベース接続の名前。

Username

型: 必須。Text。
権限を取り消すユーザーのユーザー名。

出力

Success

型: Boolean。
権限が取り消された場合はTrueになります。

Status

型: APIStatus。
このAPIの呼び出しのステータス。このステータスには、エラーコードと人間が読めるエラーメッセージが含まれます。

DbConnection_TestConnection

指定されたパラメータでデータベース接続をテストします。

入力

Authentication

型: 必須。WebServiceSimpleAuthentication。
このAPIを使用するために必要な認証。有効なプラットフォームのユーザー名とパスワードを指定するか、LoginService APIを使用してセッショントークンを取得します。

EnvironmentKey

型: 必須。Text。
環境の一意の識別子。

ProviderKey

型: 必須。Text。
新しいデータベース接続に関連付けられたデータベースプロバイダのキー。DBConnection_ListProvidersメソッドをご覧ください。

DBUsername

型: 必須。Text。
外部データベースにログインするためのユーザー名。

DBPassword

型: 必須。Text。
外部データベースにログインするためのパスワード。

DBConfigParams

型: 必須。Text。
接続文字列のパラメータ。「;」を使用して区切ります。

出力

Success

型: Boolean。
接続が成功した場合はTrueになります。

Status

型: APIStatus。
このAPIの呼び出しのステータス。このステータスには、エラーコードと人間が読めるエラーメッセージが含まれます。

User_ChangePassword

プラットフォームユーザーのパスワードを変更します。

入力

Authentication

型: 必須。WebServiceSimpleAuthentication。
このAPIを使用するために必要な認証。有効なプラットフォームのユーザー名とパスワードを指定するか、AuthenticationService APIを使用してセッショントークンを取得します。

Username

型: 必須。Text。
プラットフォームユーザーのユーザー名。

NewPassword

型: 必須。Text。
新しいパスワード。

EncryptPassword

型: 必須。Boolean。
プラットフォームユーザーのパスワードを暗号化するかどうかを指定します。

出力

Success

型: Boolean。
メソッドが成功の場合はTrue、それ以外の場合はFalseになります。

Status

型: APIStatus。
このAPIの呼び出しのステータス。このステータスには、エラーコードと人間が読めるエラーメッセージが含まれます。

User_ChangeUsername

プラットフォームユーザーのユーザー名を変更します。

入力

Authentication

型: 必須。WebServiceSimpleAuthentication。
このAPIを使用するために必要な認証。有効なプラットフォームのユーザー名とパスワードを指定するか、AuthenticationService APIを使用してセッショントークンを取得します。

OldUsername

型: 必須。Text。
プラットフォームユーザーのユーザー名。

NewUsername

型: 必須。Text。
新しいユーザー名。

出力

Success

型: Boolean。
メソッドが成功の場合はTrue、それ以外の場合はFalseになります。

Status

型: APIStatus。
このAPIの呼び出しのステータス。このステータスには、エラーコードと人間が読めるエラーメッセージが含まれます。

User_CreateOrUpdate

新規のプラットフォームユーザーを作成するか、既存のプラットフォームユーザーを更新します。これにより、プラットフォームでユーザーが有効化されます。

入力

Authentication

型: 必須。WebServiceSimpleAuthentication。
このAPIを使用するために必要な認証。有効なプラットフォームのユーザー名とパスワードを指定するか、AuthenticationService APIを使用してセッショントークンを取得します。

Username

型: 必須。Text。
プラットフォームユーザーのユーザー名。

Password

型: 必須。Text。
プラットフォームユーザーのパスワード。

EncryptPassword

型: 必須。Boolean。
プラットフォームユーザーのパスワードを暗号化するかどうかを指定します。

名前

型: 必須。Text。
プラットフォームユーザーの名前。

メールアドレス

型: 必須。Email。
プラットフォームユーザーのメール。

RoleName

型: 必須。Text。
プラットフォームユーザーに付与するプラットフォームロール。

出力

Success

型: Boolean。
メソッドが成功の場合はTrue、それ以外の場合はFalseになります。

Status

型: APIStatus。
このAPIの呼び出しのステータス。このステータスには、エラーコードと人間が読めるエラーメッセージが含まれます。

PlatformUser

型: PlatformUser。
プラットフォームユーザー。

User_DeleteApplicationPermission

プラットフォームユーザーが特定のアプリケーションに対して持つ権限を削除します。この操作の実行後、アプリケーションに対するユーザー権限はプラットフォームユーザーが持つプラットフォームロールによって定義されます。

入力

Authentication

型: 必須。WebServiceSimpleAuthentication。
このAPIを使用するために必要な認証。有効なプラットフォームのユーザー名とパスワードを指定するか、AuthenticationService APIを使用してセッショントークンを取得します。

Username

型: 必須。Text。
プラットフォームユーザーのユーザー名。

ApplicationKey

型: 必須。Text。
アプリケーションの一意の識別子。

出力

Success

型: Boolean。
メソッドが成功の場合はTrue、それ以外の場合はFalseになります。

Status

型: APIStatus。
このAPIの呼び出しのステータス。このステータスには、エラーコードと人間が読めるエラーメッセージが含まれます。

User_GetAllPermissions

インフラ内の各環境において、プラットフォームユーザーが既存の各アプリケーションに対して持つ権限と、プラットフォームユーザーのプラットフォームロールの権限を返します。

入力

Authentication

型: 必須。WebServiceSimpleAuthentication。
このAPIを使用するために必要な認証。有効なプラットフォームのユーザー名とパスワードを指定するか、AuthenticationService APIを使用してセッショントークンを取得します。

Username

型: 必須。Text。
プラットフォームユーザーのユーザー名。

出力

Success

型: Boolean。

Status

型: APIStatus。
このAPIの呼び出しのステータス。このステータスには、エラーコードと人間が読めるエラーメッセージが含まれます。

ApplicationPermissions

型: ApplicationPermissions、ApplicationShortInfo List。
プラットフォームで登録されている各環境内でプラットフォームユーザーが各アプリケーションに対して持つ権限のリスト。

PlatformRolePermissions

型: ApplicationPermissions。
プラットフォームで登録されている各環境でのプラットフォームロールを考慮した、プラットフォームユーザーが持つ権限のリスト。

User_GetApplicationPermissions

インフラ内の各環境において、プラットフォームユーザーがアプリケーションに対して持つ権限を返します。または、アプリケーションの特定の権限が指定されなかった場合、プラットフォームユーザーのプラットフォームロールの権限を返します。

入力

Authentication

型: 必須。WebServiceSimpleAuthentication。
このAPIを使用するために必要な認証。有効なプラットフォームのユーザー名とパスワードを指定するか、AuthenticationService APIを使用してセッショントークンを取得します。

Username

型: 必須。Text。
プラットフォームユーザーのユーザー名。

ApplicationKey

型: 必須。Text。
アプリケーションの一意の識別子。

出力

Success

型: Boolean。
メソッドが成功の場合はTrue、それ以外の場合はFalseになります。

Status

型: APIStatus。
このAPIの呼び出しのステータス。このステータスには、エラーコードと人間が読めるエラーメッセージが含まれます。

ArePlatformRolePermissions

型: Boolean。
権限がユーザーのロールから付与されるか、またはユーザーがアプリケーションに対して構成された権限を持つかを指定します。

ApplicationPermissions

型: ApplicationPermissions。
プラットフォームで登録されている各環境内でプラットフォームユーザーがアプリケーションに対して持つ権限のリスト。

User_List

プラットフォームユーザーのリストと、それぞれのユーザー名、メール、プラットフォームロールなどの情報を返します。

入力

Authentication

型: 必須。WebServiceSimpleAuthentication。
このAPIを使用するために必要な認証。有効なプラットフォームのユーザー名とパスワードを指定するか、AuthenticationService APIを使用してセッショントークンを取得します。

ShowInactive

型: 必須。Boolean。
Trueの場合、非アクティブに設定されたユーザーを返します。Falseの場合、アクティブなユーザーのみを返します。

出力

Success

型: Boolean。
メソッドが成功の場合はTrue、それ以外の場合はFalseになります。

Status

型: APIStatus。
このAPIの呼び出しのステータス。このステータスには、エラーコードと人間が読めるエラーメッセージが含まれます。

PlatformUsers

型: PlatformUser List。
プラットフォームユーザーのリスト。

User_SetActive

プラットフォームでユーザーを有効化し、プラットフォームユーザーに関連付けられたすべての権限を復元します。

入力

Authentication

型: 必須。WebServiceSimpleAuthentication。
このAPIを使用するために必要な認証。有効なプラットフォームのユーザー名とパスワードを指定するか、AuthenticationService APIを使用してセッショントークンを取得します。

Username

型: 必須。Text。
プラットフォームユーザーのユーザー名。

出力

Success

型: Boolean。
メソッドが成功の場合はTrue、それ以外の場合はFalseになります。

Status

型: APIStatus。
このAPIの呼び出しのステータス。このステータスには、エラーコードと人間が読めるエラーメッセージが含まれます。

User_SetApplicationRole

プラットフォームユーザーが指定されたキーのアプリケーションに対して持つロールを更新します。

入力

Authentication

型: 必須。WebServiceSimpleAuthentication。
このAPIを使用するために必要な認証。有効なプラットフォームのユーザー名とパスワードを指定するか、AuthenticationService APIを使用してセッショントークンを取得します。

Username

型: 必須。Text。
プラットフォームユーザーのユーザー名。

ApplicationKey

型: 必須。Text。
アプリケーションの一意の識別子。

RoleName

型: 必須。Text。
ロール名。

出力

Success

型: Boolean。
メソッドが成功の場合はTrue、それ以外の場合はFalseになります。

Status

型: APIStatus。
このAPIの呼び出しのステータス。このステータスには、エラーコードと人間が読めるエラーメッセージが含まれます。

User_SetInactive

プラットフォームでユーザーを無効化します。ユーザーは認証が必要なすべての操作にアクセスできなくなります。

入力

Authentication

型: 必須。WebServiceSimpleAuthentication。
このAPIを使用するために必要な認証。有効なプラットフォームのユーザー名とパスワードを指定するか、AuthenticationService APIを使用してセッショントークンを取得します。

Username

型: 必須。Text。
プラットフォームユーザーのユーザー名。

出力

Success

型: Boolean。
メソッドが成功の場合はTrue、それ以外の場合はFalseになります。

Status

型: APIStatus。
このAPIの呼び出しのステータス。このステータスには、エラーコードと人間が読めるエラーメッセージが含まれます。

User_UpdateApplicationPermission

[DEPRECATED] User_SetApplicationRoleを使用します。プラットフォームユーザーが特定の環境で実行しているアプリケーションに対して持つ権限を更新します。

入力

Authentication

型: 必須。WebServiceSimpleAuthentication。
このAPIを使用するために必要な認証。有効なプラットフォームのユーザー名とパスワードを指定するか、AuthenticationService APIを使用してセッショントークンを取得します。

Username

型: 必須。Text。
プラットフォームユーザーのユーザー名。

ApplicationKey

型: 必須。Text。
アプリケーションの一意の識別子。

EnvironmentKey

型: 必須。Text。
環境の一意の識別子。

PermissionLevelId

型: 必須。ApplicationPermissionLevel Identifier。
プラットフォームユーザーが特定の環境で実行しているアプリケーションに対して持つ権限レベルを参照します。

出力

Success

型: Boolean。
メソッドが成功の場合はTrue、それ以外の場合はFalseになります。

Status

型: APIStatus。
このAPIの呼び出しのステータス。このステータスには、エラーコードと人間が読めるエラーメッセージが含まれます。

Application_DownloadRunningVersion

特定の環境で実行している特定のアプリケーションのバイナリをダウンロードします。

入力

Authentication

型: 必須。WebServiceSimpleAuthentication。
このAPIを使用するために必要な認証。有効なプラットフォームのユーザー名とパスワードを指定するか、AuthenticationService APIを使用してセッショントークンを取得します。

EnvironmentKey

型: 必須。Text。
環境の一意の識別子。

ApplicationKey

型: 必須。Text。
アプリケーションの一意の識別子。

出力

Success

型: Boolean。
メソッドが成功の場合はTrue、それ以外の場合はFalseになります。

Status

型: APIStatus。
このAPIの呼び出しのステータス。このステータスには、エラーコードと人間が読めるエラーメッセージが含まれます。

ApplicationFile

型: バイナリデータ。
アプリケーションを含むファイル。

Application_List

プラットフォーム内で認証プラットフォームユーザーに表示されるアプリケーションのリストと、それぞれの情報を返します。

入力

Authentication

型: 必須。WebServiceSimpleAuthentication。
このAPIを使用するために必要な認証。有効なプラットフォームのユーザー名とパスワードを指定するか、AuthenticationService APIを使用してセッショントークンを取得します。

出力

Success

型: Boolean。
メソッドが成功の場合はTrue、それ以外の場合はFalseになります。

Status

型: APIStatus。
このAPIの呼び出しのステータス。このステータスには、エラーコードと人間が読めるエラーメッセージが含まれます。

Applications

型: ApplicationInfo List。
プラットフォームで提示されたアプリケーションのリスト。

Application_SetTag

特定の環境内の各アプリケーションのタグを設定します。

入力

Authentication

型: 必須。WebServiceSimpleAuthentication。
このAPIを使用するために必要な認証。有効なユーザー名とパスワードを指定するか、AuthenticationService APIを使用してセッショントークンを取得します。

EnvironmentApplicationsForTag

型: 必須。EnvironmentApplicationTagList.。
アプリケーションタグのリスト。

出力

Success

型: Boolean。
メソッドが成功の場合はTrue、それ以外の場合はFalseになります。

Status

型: APIStatus。
このAPIアクションの呼び出しのステータス。エラーの場合、エラーコードと人間が読めるエラーメッセージが含まれます。

ApplicationPermissionLevel_List

プラットフォームユーザーがアプリケーションに対して持つ権限レベルをリスト化します。

入力

Authentication

型: 必須。WebServiceSimpleAuthentication。
このAPIを使用するために必要な認証。有効なプラットフォームのユーザー名とパスワードを指定するか、AuthenticationService APIを使用してセッショントークンを取得します。

出力

Success

型: Boolean。
メソッドが成功の場合はTrue、それ以外の場合はFalseになります。

Status

型: APIStatus。
このAPIの呼び出しのステータス。このステータスには、エラーコードと人間が読めるエラーメッセージが含まれます。

ApplicationPermissionLevels

型: ApplicationPermissionLevel List。
プラットフォームで構成された、ITユーザーがアプリケーションに対して持つ権限。