How can we help?

Searching:

0 results found

Applications/Post

POST /odata/Applications/

Description

To create a new Axonize Application.

See the following for request and response details ‒

See Also

Request ‒ Applications/Post

Property Type Description Mandatory
name String The name of this Application – free text. Y
tenantId String The ID of the Axonize Tenant to which this Application belongs. This identifier is automatically generated by Axonize and is returned in response to the Tenants/Post endpoint. Y
active Boolean Not in use. Specifies whether the Application is active, meaning that it can be used – True/False.
uniqueIdentifier String The unique part of the URL of the Application.

The default URL of an Application is tenantname.axonize.com. The uniqueIdentifier is added to the default URL at the end of the string, following a slash. For example, if the uniqueIdentifier is abc, then the URL is tenantname.axonize.com/abc.

parentId String Specifies the parent Application of this Application. This property enables you to define Sub‑applications. Leave this field empty if this Application does not have a parent. Y if the Application has a Parent, otherwise N.
allowedApplications List of Strings For Internal use.

Specifies a list of Application Ids on which this Application has permission to perform API actions.

usersContainerDatabase String The ID of the database used to store the users of this Application.
diagram String A link to a resource file that is a diagram that can be used in this Application instead of Google Maps.
enableMultiFactorAuthentication Boolean Enables/disables Multi-factor Authentication for the Application.
logo String Not in use (deprecated). A link to the logo representing the Application to be used in the Axonize Portal.
cultureInfo String Not in use (deprecated). Default localization information of the Application. These standard options include the language of the Application and are described at https://msdn.microsoft.com/en-us/library/system.globalization.cultureinfo(vs.71).aspx.
phoneCountryCode String Not in use (deprecated). Specifies the default country code of the phone numbers of the users of this Application.

“phoneCountryCode”: +49″

retention Integer Not in use (deprecated). The number of days to keep the audits of this Application in the Axonize database (cyclic buffer). The default is 15 days.
timezone String Not in use (deprecated). The default timezone of the Application.

https://en.wikipedia.org/wiki/List_of_tz_database_time_zones

“timezone”:”Asia/Jerusalem”

passwordPolicy Object Not in use (deprecated). The password policy for logging into this Application. See below.

If no password policy is defined for the Application, the password policy of the Tenant or Sub‑tenant to which it belongs is used.

passwordPolicy /maxPasswordLength Integer Not in use (deprecated). The maximum length of the password.
passwordPolicy /minPasswordLength Integer Not in use (deprecated). The minimum length of the password.
passwordPolicy /numberOfDifferentCharTypes Integer Not in use (deprecated). The minimum number of characters in the password that must be different from each other.
passwordPolicy /mustBeDifferentFromUserName Boolean Not in use (deprecated). True if the password must be different than the user name.
templateId String Specifies the ID of the Application Manifest (template) used by the Application.

If no value is specified, the default value is automatically used.

settings Object Specifies the settings to be applied in the Application Manifest (template). These settings override the values in the Application Manifest (template) assigned to the Application.
settings/appLogo String A link to the logo representing the Application to be used in the Axonize Portal.
settings/appDarkLogo String A link to the logo representing the Application to be used in the Axonize Portal when in Dark Theme mode.
settings/cultureInfo String Default localization information of the Application. These standard options include the language of the Application and are described at https://msdn.microsoft.com/en-us/library/system.globalization.cultureinfo(vs.71).aspx.
settings/timezone String The default timezone of the Application.

https://en.wikipedia.org/wiki/List_of_tz_database_time_zones

“timezone”:”Asia/Jerusalem”

settings/phoneCountryCode String Specifies the default country code of the phone numbers of the users of this Application.

“phoneCountryCode”: +49″

settings/passwordPolicy Object The password policy for logging into this Application. See above.

If no password policy is defined for the Application, the password policy of the Tenant or Sub‑tenant to which it belongs is used.

settings/retention Integer The number of days to keep the audits of this Application in the Axonize database (cyclic buffer). The default is 15 days.
settings/format String The application date/time format.
settings/mapLayout Object Sets whether the default dashboard widget displays a map view or list view.
settings/mapOverlay Map Overlay Object Enables an image or diagram to be pinned over a map using an array of latitude and longitude coordinates.
settings/mapOverlay/mapOverlay.image String The overlay image.
settings/mapOverlay/mapOverlay.positions List of Objects The overlay position coordinates.
settings/mapOverlay/mapOverlay.positions/lat Double The latitude position coordinate.
settings/mapOverlay/mapOverlay.positions/long Double The latitude position coordinate.
settings/viewMode String Indicates whether the application presents Devices over a map or diagram.
settings/defaultLocation Object The application’s default latitude and longitude location.
settings/featureSetId String The ID of the feature set object that contains all the features permitted for a user.

 

Example JSON Applications/Post Request

curl -X POST \

https://api.stg.axonize.com/odata/application/ \

-H ‘Authorization: Token’ \

-H ‘Content-Type: application/json’ \

-H ‘appId: 801A048A-9F23-429F-BF0D-B6D35B22771E’ \

-d ‘{

“name”:”app name”,

“tenantId”:”5851631d4e41925b98f01234″,

}

Response ‒ Applications/Post

All the same properties in the request are returned in the response. In addition, the response that is returned also contains the following properties –

Property Type Description
id String A unique identifier for this Application that is automatically generated. Please note that this ID is only intended for internal use by Axonize.
appId String A unique identifier that is automatically generated by Axonize for this Application.

This property is used to link between other entities (such as Users and Devices) and this Application.

createDate, createUser, updateDate,
updateUser
See Common Response Properties.

Example JSON Applications/Post Response

Status 201 – Created

{

“@odata.context”: “http://stg-axonizeapi-axonize.stg-ase-axonize.p.azurewebsites.net/odata/$metadata#Applications/$entity”,

“name”: “app name”,

“tenantId”: “5851631d4e41925b98f01234”,

“active”: false,

“logo”: null,

“cultureInfo”: “en”,

“uniqueIdentifier”: “app-name”,

“parentId”: “be517433-c4b8-4788-9258-1ba220431234”,

“allowedApplications”: [ ],

“usersContainerDatabase”: null,

“phoneCountryCode”: +49″

“diagram”: null,

“retention”: 15,

“timezone”:”Asia/Jerusalem”

“usersContainerDatabase”: “ABCD”,

“id”: “585166654e41925b98f01234”,

“appId”: “801A048A-9F23-429F-BF0D-B6D35B22771E”,

“createDate”: “0001-01-01T00:00:00Z”,

“createUser”: null,

“updateDate”: “0001-01-01T00:00:00Z”,

“updateUser”: null,

“passwordPolicy”: null,

}