Reference : REST XML API reference : Elements
  
Elements
An element contains all the attribute values of the element.
GET method
Use the GET method to retrieve the element details. You can use the View parameter to filter the attributes.
URL: https://fpserver.com:9443/fp/resources/workspaces/2/modules/1/elements/001.xml
Accept header: application/xml
Response body:
<ns:Element xsi:schemaLocation="https://fpserver.com:9443/fp/namespace/workspaces/2/modules/1/element https://fpserver.com:9443/fp/resources/workspaces/2/modules/1/elements/element.xsd"> <ns:attributes> <ns:ID writable="false"> <ns:uniqueId value=""/> <ns:alias>799af0ed-6316-4116-8749-ce2353e80ac5</ns:alias> </ns:ID> <ns:Title writable="true"> <ns:text></ns:text> <ns:alias>7d5c25cb-e2a2-4d94-8b03-1cf603d2833b</ns:alias> <ns:editLink href="https://fpserver.com:9443/fp/resources/workspaces/2/modules/1/elements/1/attributes/2"/> </ns:Title> <ns:Description writable="true"></ns:Description> <ns:type_is_a_folder wr itable="true"></ns:type_is_a_folder> <ns:check_boxes_are_selected_in_the_chart writable="true"></ns:check_boxes_are_selected_in_the_chart> <ns:Element_Information writable="false"/> <ns:Owner writable="true"></ns:Owner> <ns:Creator writable="false"></ns:Creator> <ns:Created_Date writable="false"></ns:Created_Date> <ns:Last_Changed_By writable="false"></ns:Last_Changed_By> <ns:Last_Changed_Date writable="false"></ns:Last_Changed_Date> <ns:Parent_Folder writable="true"></ns:Parent_Folder> <ns:Text_List writable="true"></ns:Text_List> </ns:attributes> <ns:selfLink href="https://fpserver.com:9443/fp/resources/workspaces/2/modules/1/elements/1"/> <ns:mspLink href="https://fpserver.com:9443/fp/resources/workspaces/2/modules/1/elements/1?format=mspxml"/> <ns:htmlLink href="https://fpserver.com:9443/fp/servlet/Login?go=2,1"/> <ns:alias>7602dc18-d64c-4360-8098-de0b0a385bf8</ns:alias> </ns:Element>
Supported parameters for the GET method
The following parameters can be used with the GET method:
▪ view
Use the view parameter to specify the view ID for retrieving the attributes that are in the view.
Type: Integer
▪ filter
The filter parameter must be used with the view parameter. Use the filter parameter to pass the filter ID for retrieving attributes based on the filter criteria.
Type: Integer
For example, view=14&filter=1.
▪ metadata
Set the metadata parameter to schema to retrieve the schema of the XML document for the element.
For example, metadata=schema.
▪ fields
Use the fields parameter to pass an XPath expression to retrieve specific set of attributes.
Type: String
For example, fields=attributes/(ID|Title|Owner).
▪ includeHistoryOfAttribute, start, end
Set the includeHistoryOfAttribute parameter to true and specify the start and end date parameters to retrieve the history of the attributes. The following formats are supported for the date parameters.
yyyy-MM-dd'T'HH:mm:ss
yyyy-MM-dd'T'HH:mm
yyyy-MM-dd
yyyy-MM-dd HH:mm:ss
yyyy-MM-dd HH:mm
Types: includeHistoryOfAttributes: Boolean, start: Date or Date Time, end: Date or Date time
For example:
includeHistoryOfAttributes=true&start=2011-03-22T12:00:00+01:00&end=2011-06- 22T12:00:00+01:00
includeHistoryOfAttributes=true&start=2011-03-22T12:00+GMT+01:00&end=2011-06-22T12:00+GMT+01:00
▪ genericTimeGrid
Set the genericTimeGrid parameter to true to retrieve the time grid attribute sheets in a generic format. This can be used for reporting by using Rational Insight.
Note The user can also supply generictimegrid as a parameter.
Type: Boolean
▪ optimize
Set the optimize parameter to true to optimize the content. If the optimize parameter is set to true, the response does not include rich text and formula information of the attributes. Also alternate URLs to the element are not provided in the response.
Type: Boolean
▪ includeLinkTable
Set the includeLinkTable parameter to true to include attributes from the link targets in the response. The view should have a link table defined for the Link or LinkList attributes. All visible attributes that are shown in the link table set up will be part of the Link or LinkList attribute response.
Type: Boolean
Go up to
REST XML API reference