API Release

Read

Read- Details

Reads a Release. The view is restricted based on User Group membership.

Authentication: Windows

Privilege : Administrator , Moderator , Power User

Method: Pxstat.Data.Release_API.Read

Parameters:

Name	Type	Default	Description
RlsCode	Integer		Release code
language	String	en*	LngIsoCode e.g. "en"
CcnUsername	String	System User	System User

*This default may vary depending on API configuration

Return: Release Object

Return - Details

Name	Type	Description
MtrCode	String	Code of the Matrix associated with this Release
RlsCode	Int	Release code
RlsVersion	Int	Release Version
RlsRevision	Int	Release Revision
RlsLiveFlag	Boolean	Indicates this is a Live Release
RlsLiveDatetimeFrom	Datetime	Start of Release period
RlsLiveDatetimeTo	Datetime	End of Release period
RlsDependencyFlag	Boolean	Flag to indicate a Dependency
RlsEmergencyFlag	Boolean	Flag to indicate an Emergency Release
RlsReservationFlag	Boolean	Flag to indicate Reservation
RlsArchiveFlag	Boolean	Flag to indicate Archive
RlsAnalyticalFlag	Boolean	Flag to indicate Analytical
RlsAlertFlag	Boolean	Flag to indicate an Alert
GrpCode	String	Code of Group to which this Release is assigned
GrpName	String	Name of Group to which this Release is assigned
CmmCode	Int	Code to identify the Comment associated with this Release
CmmValue	String	The Comment associated with this Release
SbjCode	String	Code to identify the Subject of this Release
SbjValue	String	Name of the Subject of this Release
PrcCode	String	Code to identify the Product of this Release
PrcValue	String	Name of the Product of this Release

---

Read List

Read List- Details

Returns the list of releases for a given matrix code. The view is restricted based on User Group membership.

Authentication: Windows

Privilege : Administrator , Moderator , Power User

Method: Pxstat.Data.Release_API.ReadList

Parameters:

Name	Type	Default	Description
MtrCode	String		Code of the Matrix associated with this Release

Return: Array [ Release ]

Return - Details

Name	Type	Description
MtrCode	String	Code of the Matrix associated with this Release
RlsCode	Int	Release code
RlsAlertFlag	Boolean	Flag to indicate an Alert
RlsAnalyticalFlag	Boolean	Flag to indicate Analytical
RlsArchiveFlag	Boolean	Flag to indicate Archive
RlsLiveFlag	Boolean	Indicates this is a Live Release
RlsLiveDatetimeTo	Datetime	End of Release period
RlsReservationFlag	Boolean	Flag to indicate Reservation
RlsRevision	Int	Release Revision
RlsVersion	Int	Release Version
RlsDependencyFlag	Boolean	Flag to indicate a Dependency
RlsEmergencyFlag	Boolean	Flag to indicate an Emergency Release
RlsLiveDatetimeFrom	Datetime	Start of Release period

---

Read ListBy Product

Reads a list of Releases that are associated with a given Product

Authentication: Windows

Privilege : Administrator , Power User

Method: Pxstat.Data.Release_API.ReadListByProduct

Parameters:

Name	Type	Default	Description
PrcCode	Int		Code to identify the Product

Return: Array [ Release ]

Name	Type	Description
MtrCode	String	Code of the Matrix associated with this Release
RlsCode	Int	Release code
RlsRevision	Int	Release Revision
RlsVersion	Int	Release Version

---

Update Analytical Flag

Updates the value of the Release Analytical flag

Authentication: Windows

Privilege : Administrator , Power User

Method: Pxstat.Data.Release_API.UpdateAnalyticalFlag

Parameters:

Name	Type	Default	Description
RlsCode	Int		Release code
RlsAnalyticalFlag	Boolean		Flag to indicate Analytical

Return: String with value of success or error

---

Update Dependency Flag

Updates the value of the Dependency Flag

Authentication: Windows

Privilege : Administrator , Power User

Method: Pxstat.Data.Release_API.UpdateDependencyFlag

Parameters:

Name	Type	Default	Description
RlsCode	Int		Release code
RlsDependencyFlag	Boolean		RlsDependencyFlag

Return: String with value of success or error

---

Update Product

Updates the Product associated with the Release

Authentication: Windows

Privilege : Administrator , Power User

Method: Pxstat.Data.Release_API.UpdateProduct

Parameters:

Name	Type	Default	Description
RlsCode	Int		Release code
PrcCode	Int		Product code

Return: String with value of success or error

---

Update Comment

Updates the Comment of a Release

Authentication: Windows

Privilege :Administrator , Power User

Method: Pxstat.Data.Release_API.UpdateComment

Parameters:

Name	Type	Default	Description
RlsCode	Int		Release code
CmmValue	String		Comment string

Return: String with value of success or error

---

Delete Comment

Deletes a Release Comment

Authentication: Windows

Privilege : Administrator , Power User

Method: Pxstat.Data.Release_API.DeleteComment

Parameters:

Name	Type	Default	Description
RlsCode	Int		Release code

Return: String with value of success or error