Reference : REST XML API reference : Service documents
  
Service documents
The service document has the high level resources for workspace, module, views that a user has access to. Only users with workspace administrator rights can access modules.
The resource URI for the service document is:
http://focalpointserver/fp/resources/
GET method
Accept header: application/xml
Response body:
<fp:service xsi:schemaLocation="http://schema.example.com/focalpoint/resources https://fpserver.com:9443/fp/dtd/service.xsd"> <fp:workspace> <fp:title>SmartCloud</fp:title> <fp:alias>625ca8ed-d4c6-40a0-b8a2-ccc0319726a5</fp:alias> <fp:modules> <fp:collection addable="true"> <fp:title>Elements</fp:title> <fp:alias>0f615fdc-ed3d-4ce5-9eff-4f9b625986e8</fp:alias> <fp:indexList href="https://fpserver.com:9443/fp/resources/workspaces/2/modules/1/elements/"/> <fp:indexTree href="https://fpserver.com:9443/fp/resources/workspaces/2/modules/1/elements/?tree=true"/> <fp:fullList href="https://fpserver.com:9443/fp/resources/workspaces/2/modules/1/elements/?includeAttributes=true"/> <fp:fullTree href="https://fpserver.com:9443/fp/resources/workspaces/2/modules/1/elements/?tree=true&includeAttributes=true"/> </fp:collection>
Service document description
Each module and view contains an element collection. You can view the element collection in these ways in the service document:
 
Link
Visualization
indexList
A list of elements that includes only the title and URI of each element. If a sort attribute is defined, the elements are sorted accordingly.
indexTree
A tree structure of elements that includes only the title and URI of each element. The title and not the URI of folders that not are displayed is included.
fullList
A list of elements that includes all attribute values for the attributes in the view or module. If a sort attribute is defined, the elements are sorted accordingly.
fullTree
A tree structure of elements that includes the attribute values for the attributes in the view or module.
For details and annotations of the XML format for the service document, see the XML Schema document. The URI for the schema is in the schemaLocation XML attribute of the service document.
Go up to
REST XML API reference