Skip to content

API Reason

Robert Polak edited this page Jun 28, 2019 · 28 revisions

Read

Read - Details

Reads a Reason. If no parameters are passed then all Reasons will be returned. If the Reason Code RsnCode is passed then only that Reason will be returned. If the Reason Code 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

Create

Create - Details

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: String with value of success


Update

Update - Details

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: String with value of success


Delete

Delete - Details

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: String with value of success


Clone this wiki locally