API Reference

Client Environments

post
https://app.financekey.com/OData/ClientEnvironments

The ClientEnvironment table stores information pertaining to each client's local state of execution, such as installed applications, operating system, disk space, memory, processor, and any other hardware or software details. This table is used to provide an inventory of the environments where the application is running so that it can be quickly identified if any of these items require updates or if there are compatibility issues between versions of installed components.

Body Params
int32

The ClientEnvironmentId is an integer data type field found in the ClientEnvironment table. It stores a unique numerical identifier for each particular client environment record within the table.

int32

ClientId is an integer field in the ClientEnvironment table that stores a unique identifier for each client associated with a particular environment. Its value is automatically generated based on the client's information.

string
required
length between 1 and 256

EnvironmentId is a nvarchar field in the ClientEnvironment table that is used to uniquely identify an environment associated with a particular client. It has a maximum length of 256 characters.

int32

ResourceGroupId is an int field in a table called ClientEnvironment which is used to identify the resource group that a particular client environment is associated with. ResourceGroupId is used to join with other tables to retrieve additional resource group related information.

int32

DataBaseId is an integer field in a ClientEnvironment table. This field is used to store the unique identity of each client environment in the database.

int32

The AppServicePlanId field of type int in the ClientEnvironment table stores the ID of the App Service Plan that the environment runs on.

int32

WebAppId is an int field in the ClientEnvironment table used as a unique key to identify the client's web application, usually allocated when the web application is installed.

int32

The WebJobId field in the ClientEnvironment table is an integer which holds an automatically generated unique identifier for a particular web job that is being tracked by the database.

int32

StorageAccountId: This field contains the unique id number for a client's external storage account. It is an integer value used as an identifier in the ClientEnvironment table.

int32

A SubdomainId is an int data type field in the ClientEnvironment table used to store the unique identifier for each individual subdomain that belongs to a particular client environment. It is necessary to uniquely identify the subdomain for each client.

int32

AdClientCredentialId in the ClientEnvironment table is a field of data type int that stores a unique identifier for the credentials associated with the advertisement client.

string | null

AdTenantId is a field in the ClientEnvironment table that stores the Azure TenantId which is used when communicating from app to the client environment.

Response
200

OK

Updated over 2 years ago

Language
URL
Response 
Click Try It! to start a request and see the response here!
Updated over 2 years ago