API Config
Reads an API configuration value.
Authentication: Windows
Privilege : Administrator
Method: PxStat.Data.Config_API.ReadApi
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
version |
String | null | The version of the configuration. If null, the Version defaults to the current version. |
type |
String | null | The type of the configuration (API or APP). If null, the Type defaults to APP. |
name |
String | null | The name of the configuration. If null, returns all of the configuration. |
Return: Array [ Object ]
| Name | Type | Description |
|---|---|---|
result |
String | The configuration value. |
Reads an API or APP configuration value.
Authentication: Windows
Privilege : Administrator , Moderator , Power User
Method: PxStat.Data.Config_API.ReadApp
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
version |
String | null | The version of the configuration. If null, the Version defaults to the current version. |
type |
String | null | The type of the configuration (API or APP). If null, the Type defaults to APP. |
name |
String | The name of the configuration. |
Return: Array [ Object ]
| Name | Type | Description |
|---|---|---|
result |
String | The configuration value. |
Reads an APP schema value.
Authentication: Windows
Privilege : Administrator , Moderator , Power User
Method: PxStat.Data.Config_API.ReadSchema
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
Name |
String | The name of the file associated with the schema. |
Return: Array [ Object ]
| Name | Type | Description |
|---|---|---|
result |
String | The schema value. |
Creates an API or APP configuration value.
Authentication: Windows
Privilege : Administrator , Moderator , Power User
Method: PxStat.Data.Config_API.Create
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
version |
String | null | The version of the configuration. If null, the Version defaults to the current version. |
type |
String | null | The type of the configuration (API or APP).v If null, the Type defaults to APP. |
name |
String | The name of the configuration. | |
value |
String | The value of the configuration. | |
description |
String | null | The name of the configuration. If null, the Description defaults to a blank string. |
sensitive |
bool | false | The sensitive value of the configuration. |
Return: Array [ Object ]
| Name | Type | Description |
|---|---|---|
Version |
String | The current version. |
Updates an API or APP configuration value.
Authentication: Windows
Privilege : Administrator , Moderator , Power User
Method: PxStat.Data.Config_API.Create
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
version |
String | null | The version of the configuration. If null, the Version defaults to the current version. |
type |
String | null | The type of the configuration (API or APP).v If null, the Type defaults to APP. |
name |
String | The name of the configuration. | |
value |
String | The value of the configuration. | |
description |
String | null | The name of the configuration. If null, the Description defaults to a blank string. |
sensitive |
bool | false | The sensitive value of the configuration. |
Return: Array [ Object ]
| Name | Type | Description |
|---|---|---|
Version |
String | The current version. |
