QPR Knowledge Base 2014.1

GetProperty

GetProperty

Previous topic Next topic  

GetProperty

Previous topic Next topic JavaScript is required for the print function  

Revision history:

Introduced in QPR 7.5.1

Last changed in QPR 2012

 

Get the value of action’s property defined by PropertyName.

 

Synopsis:

 

Actions.GetProperty(ActionId, PropertyName, out value)

 

Parameters:

 

ActionId: Integer. ID of the action from which properties are queried.

PropertyName: String. One of the following properties (note that the actual selection of available properties depends on the type of action):

Id: Integer.

FullId: String. ID in external object ID format, i.e. <product_id>_0_<model id>_<object id>

Header: String.

Description: String.

Type: Integer.

TypeName: String.

ModifiedDate: DateTime.

CreatedDate: DateTime.

Creator.Id: Integer.

Creator.LoginName: String.

Creator.FullName: String.

Modifier.Id: Integer.

Modifier.LoginName: String.

Modifier.FullName: String.

PublishType: Integer. Defines the users for who the action is published. 0 (creator) = action's creator, 1 (parentelement) = parent element users, 2 (selected) = selected users, 3 (everyone) = all users.

PublishForUsers: Integer | String. Either an integer array or a comma-separated list of user IDs for who the action is published. This is valid only if PublishType is 2.

ParentActions: String. A comma-separated list of parent action IDs.

ChildActions: String

Category: String.

Owner.Id: Array of integer.

Owner.LoginName: Array of string.

Owner.FullName: Array of string.

AssignedTo.Id: Array of integer

AssignedTo.LoginName: Array of string.

AssignedTo.FullName: Array of string.

ApprovedBy.Id: Array of integer.

ApprovedBy.LoginName: Array of string

ApprovedBy.FullName: Array of string

StartDate: DateTime.

Deadline: DateTime.

Status: String.

Progress: Integer | Float.

Version: String.

EmbeddedData: String.

LinkedLocation: String.

ValidFrom: DateTime.

ValidTo: DateTime.

Severity: String.

IdentifiedBy.Id: Array of integer.

IdentifiedBy.LoginName: Array of string

IdentifiedBy.FullName: Array of string

Identified: DateTime.

Probability: String.

ImpactMinimization: String.

Mitigation: String.

Impact: String

Rating: String.

Notes: String.

ExternalParentObjects: String. A comma-separated list of external object IDs (<product_id>_0_<model id>_<object id>).

NameOfTheEmbeddedFile: String. Note that this property is empty for default action types as attachments are in fact child actions for the action they are attached to. In order to query attachments, use ActionTypes=EMBEDDEDATTACHMENT in the Actions.Find call.

MIMETypeOfTheEmbeddedFile: String. Note that this property is empty for default action types as attachments are in fact child actions for the action they are attached to. In order to query attachments, use ActionTypes=EMBEDDEDATTACHMENT in the Actions.Find call.

 

 NOTE: The listing above assumes that the default actiontypes.ini is used. With customized actiontypes.ini files some default properties can be missing or additional ones available.

 

out Value: Variant for storing the returned property.

 

Required Rights:

 

View rights to action defined by ActionId.

 

Return Values:

Below are listed the return values that this function can return:

 

RV_SUCCESS

RV_ASSOCIATION_NOT_FOUND

RV_UNKNOWN_ERROR

RV_PROPERTY_NOT_FOUND

RV_ACCESS_DENIED

RV_APPLICATION_QUIT_CALLED

RV_NOT_CONNECTED_TO_SERVER

RV_NOT_AUTHENTICATED

 

Example Procedure:

 

iRet = SCApplication.Actions.GetProperty(iId, "Description", sDescription)