|
|
PO Object Functions |
|
|
|
||
|
PO Object Functions |
|
|
|
|
PO Object Functions
|
|
|
PO Object Functions |
|
|
|
||
|
PO Object Functions |
|
|
|
|
|
|
||
The PO (Portal) object contains functions for retrieving information (such as actions) from QPR Portal.
Functions available for the PO object:
SubObjects
Returns bookmarks, language definitions, booklet pages, booklet items, actions, action types, and action attributes.
Action, Actions([<recursion parameters>, <global parameters>])
Returns all action objects (if querying a product) or all "child actions" connected to action (if querying an action object).
ActionTypes([<global parameters>])
Returns a set of ActionType objects, one for each action type defined in actiontypes.ini. See the Supported Attributes section for a listing of attributes in ActionType objects.Note that by default (i.e. with an empty attributes parameter) only the following attributes are returned for action types: Id, Name, TypeName, and CustomAttributes.
Attachment, Attachments([keeporiginals=1, <global parameters>])
Returns all attachment objects (if querying a product) or all "child attachments" connected to action (if querying an action object).
<hierarchy name>
Valid hierarchies:
| • | Discussion: Discussion hierarchy. If used in HierarchyRoots, returns the "Discussion Forum" folder. |
<relation name>
Valid relations:
| • | Creator |
| • | Modifier |
| • | PublishForUsers |
| • | ParentObjects |
| • | ChildObjects |
| • | ResponsibleUsers |
| • | Owner |
| • | <action relation attribute name>: Name of action relation attribute (the comparison is case insensitive). For example "Parent actions", "Child actions", or "External parent objects". |
| • | <packed action relation attribute name>: Name of action relation attribute with spaces removed (the comparison is case insensitive). For example "ParentActions", "ChildActions", or "ExternalParentObjects". |
| • | CustomAttributes (for ActionTypes, returns all action attributes defined for the action type) |
Valid type names:
Product level:
| • | <association/action type group (corresponding attribute: typegroupname)> |
| • | Action, Attachment |
| • | ActionType |
| • | <association/action type (corresponding attribute: typename)> |
| • | EmbeddedAttachment |
| • | LinkedAttachment |
| • | Bookmark |
| • | Booklet |
| • | BookletTextItem |
| • | BookletPage |
| • | BookletItem |
| • | LanguageDefinition |
| • | <action type name defined in actiontypes.ini (e.g. "Comment")>: If the name contains spaces, you can omit those. For example Action Plan can be called as ActionPlan. |