Searching:
0 results found
BackapplicationTemplates/Post
POST /odata/applicationTemplates
Description
To create a new Application Manifest (template).
See the following for request and response details ‒
See Also
Request ‒ applicationTemplates/Post
| Property | Type | Description | Mandatory |
| name | String | The name of this Application Manifest (template). | Y |
| 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.
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/passwordPolicy /maxPasswordLength | Integer | The maximum length of the password. | |
| settings/passwordPolicy /minPasswordLength | Integer | The minimum length of the password. | |
| settings/passwordPolicy /numberOfDifferentCharTypes | Integer | The minimum number of characters in the password that must be different from each other. | |
| settings/passwordPolicy /mustBeDifferentFromUserName | Boolean | True if the password must be different than the user name. | |
| 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 | Date | The date format used in the Application. | |
| settings/mapLayout | Object | Sets whether the default dashboard widgetdisplays a map view or list view. | |
| settings/mapOverlay | String | The image resource that is rendered over the map in a predefined position. | |
| settings/viewMode | String | Specifies whether the view that displays is a Google map or an image diagram. | |
| settings/defaultLocation | Complex Object | The latitude and longitude coordinates of the default location of the Device or Group of Devices on the map. | |
| settings/defaultLocation/lat | Double | The latitude of the location. | |
| settings/defaultLocation/lng | Double | The longitude of the location. | |
| settings/featureSetId | String | The ID of the Feature Set object that contains all the Features permitted for the user. | |
| additionalProperties | Array | The additionalProperties property enables you to extend the Axonize schema model by adding your own properties for each Device type. For example, you can add a property named Firmware Version that specifies the version of the Device’s firmware.
additionalProperties are defined per Application. Once defined, they are available in the Axonize API and Axonize Portal. These properties can also be used as keywords, as described on page 499. |
|
| additionalProperties/ displayName |
String | The name to appear in the Axonize Portal for this additional property. | |
| additionalProperties/name | String | The internal logical name to be used for this property. This name must match the additional property’s name on the Device itself. | Y |
| additionalProperties/ dataType |
String | The data type of this property. Valid values are –
|
Y |
| additionalProperties/ defaultValue |
String | The default value of the additional property. | |
| additionalProperties/uiType | String | See commands/arguments/uiType. | Y |
| additionalProperties/icon | Not in use. | ||
| additionalProperties/groupName | Not in use. | ||
| additionalProperties/ allowedValueRange |
String | If the data type (dataType described above) is Number, then you can enter a minimum and maximum value, as well as set a Step for this value. For example, if the Minimum is 10, the Maximum is 20 and this Step is 2, then the following values can be entered ‒ 10, 12, 14, 16, 18, 20. | |
| additionalProperties/servicePropertyType | Not in use. |
Example JSON applicationTemplates/Post Request
curl -X POST \
https://api.dev.axonize.com/odata/applicationTemplates \
-H ‘Accept: application/json, text/plain, */*’ \
-H ‘Content-Type: application/json’ \
-H ‘cache-control: no-cache’ \
-H ‘appId: 1aaf017c-b987-4f53-94d6-ad9afb8e4767’ \
-d ‘{
“name”: “Paz App”,
“settings”: {
“appLogo”: null,
“appDarkLogo”: null,
“cultureInfo”: null,
“timezone”: null,
“phoneCountryCode”: null,
“retention”: 15,
“format”: null,
“mapLayout”: null,
“viewMode”: null,
“featureSetId”: “5ca3503fe3b0cc12109ce8a4”,
“passwordPolicy”: null,
“mapOverlay”: null,
“defaultLocation”: null
},
“additionalProperties”: [
{
“displayName”: “msg_line_code”,
“name”: “lineCode”,
“extra”: null,
“datatype”: “Text”,
“defaultValue”: null,
“unit”: null,
“uiType”: “Undefined”,
“required”: true,
“icon”: null,
“groupName”: null,
“servicePropertyType”: null,
“allowedValueRange”: null
},
{
“displayName”: “msg_customer_number”,
“name”: “customerNumber”,
“extra”: null,
“datatype”: “Text”,
“defaultValue”: null,
“unit”: null,
“uiType”: “Undefined”,
“required”: false,
“icon”: null,
“groupName”: null,
“servicePropertyType”: null,
“allowedValueRange”: null
}
]
}’
Response ‒ applicationTemplates/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 Manifest 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 applicationTemplates/Post Response
Status 201 – Created
{
“@odata.context”: “https://10.9.0.103/odata/$metadata#ApplicationTemplates/$entity”,
“name”: “Paz App”,
“id”: “5ca35040e3b0cc12109ce8a5”,
“appId”: “cbdd360a-4dee-409c-88e7-41221ad9d4a8”,
“createDate”: “2019-03-30T13:03:19.671Z”,
“createUser”: null,
“updateDate”: “2019-03-30T13:03:19.671Z”,
“updateUser”: null,
“settings”: {
“appLogo”: null,
“appDarkLogo”: null,
“cultureInfo”: null,
“timezone”: null,
“phoneCountryCode”: null,
“retention”: 15,
“format”: null,
“mapLayout”: null,
“viewMode”: null,
“featureSetId”: “5ca3503fe3b0cc12109ce8a4”,
“passwordPolicy”: null,
“mapOverlay”: null,
“defaultLocation”: null
},
“additionalProperties”: [
{
“displayName”: “msg_line_code”,
“name”: “lineCode”,
“extra”: null,
“datatype”: “Text”,
“defaultValue”: null,
“unit”: null,
“uiType”: “Undefined”,
“required”: true,
“icon”: null,
“groupName”: null,
“servicePropertyType”: null,
“allowedValueRange”: null
},
{
“displayName”: “msg_customer_number”,
“name”: “customerNumber”,
“extra”: null,
“datatype”: “Text”,
“defaultValue”: null,
“unit”: null,
“uiType”: “Undefined”,
“required”: false,
“icon”: null,
“groupName”: null,
“servicePropertyType”: null,
“allowedValueRange”: null
}
]
}