API Release
Reads a Release. The view is restricted based on User Group membership. If a version of the matrix exists in the LngIsoCode parameter, the matrix title will be returned in that language. Otherwise the default language version is returned.
Authentication: Windows
Privilege : Administrator , Moderator , Power User
Method: Pxstat.Data.Release_API.Read
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
RlsCode |
Integer | Release Code | |
LngIsoCode |
String | Iso Language Code |
*This default may vary depending on API configuration
Return: Object
| 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 |
RlsExceptionalFlag |
Boolean | Flag to indicate an Exceptional 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 |
RqsCode |
String | Request Code |
RqsValue |
String | Request Value |
RspCode |
String | Response Code |
RspValue |
String | Response Value |
SgnCode |
String | Signoff Code |
SgnValue |
String | Signoff Value |
Tests if a live release has an associated Work In Progress release.
Authentication: Windows
Privilege : Administrator , Moderator , Power User
Method: PxStat.Data.Release_API.ReadHasWipForLive
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
RlsCode |
Integer | Release Code |
*This default may vary depending on API configuration
Return: Boolean
Returns the list of releases for a given Matrix Code. The view is restricted based on User Group membership. If a version of the matrix exists in the LngIsoCode parameter, the matrix title will be returned in that language. Otherwise the default language version is returned.
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 | |
LngIsoCode |
String | Iso Language Code |
Return: Array [ Object ]
| 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 |
RlsExperimentalFlag |
Boolean | Flag to indicate Experimental |
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 |
RlsExceptionalFlag |
Boolean | Flag to indicate an Exceptional Release |
RlsLiveDatetimeFrom |
Datetime | Start of Release period |
MtrTitle |
String | Matrix title |
RqsCode |
String | Request Code |
RqsValue |
String | Request Value |
RspCode |
String | Response Code |
RspValue |
String | Response Value |
SgnCode |
String | Signoff Code |
SgnValue |
String | Signoff Value |
Reads the previous Release to the code supplied. The view is restricted based on User Group membership. If a version of the matrix exists in the LngIsoCode parameter, the matrix title will be returned in that language. Otherwise the default language version is returned.
Authentication: Windows
Privilege : Administrator , Moderator , Power User
Method: Pxstat.Data.Release_API.ReadPrevious
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
RlsCode |
Integer | Release Code | |
LngIsoCode |
String | Iso Language Code |
*This default may vary depending on API configuration
Return: Object
| Name | Type | Description |
|---|---|---|
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 |
RlsExceptionalFlag |
Boolean | Flag to indicate an Exceptional 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 |
MtrCode |
String | Code of Matrix associated with this Release |
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 |
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
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
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
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
