API Reason
Reads a Reason. If no parameters are passed then all Reasons will be returned. If the RsnCode is passed then only that Reason will be returned. If the RlsCode is returned then all Reasons for that Release will be returned.
Authentication: Windows
Privilege : Administrator , Moderator , Power User
Method: PxStat.System.Settings.Reason_API.Read
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
RsnCode |
String | null | Reason code |
RlsCode |
Int | 0 or empty | Release code |
Return: Array [ Reason ]
| Name | Type | Description |
|---|---|---|
RsnCode |
String | A code for the reason for a release |
RsnValueExternal |
String | An internal description of the reason for a release |
RsnValueInternal |
String | An external description of the reason for a release |
Creates a Reason
Authentication: Windows
Privilege : Administrator , Power User
Method: PxStat.System.Settings.Reason_API..Create
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
RsnCode |
String | A code for the reason for a release | |
RsnValueExternal |
String | An internal description of the reason for a release | |
RsnValueInternal |
String | An internal description of the reason for a release |
Return: success or error
Updates a Reason
Authentication: Windows
Privilege : Administrator , Power User
Method: PxStat.System.Settings.Reason_API.Update
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
RsnCode |
String | A code for the reason for a release | |
RsnValueExternal |
String | An internal description of the reason for a release | |
RsnValueInternal |
String | An internal description of the reason for a release |
Return: success or error
Deletes a Reason
Authentication: Windows
Privilege: Administrator , Power User
Method: PxStat.System.Settings.Reason_API.Delete
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
RsnCode |
String | A code for the Reason for a Release |
Return: success or error
