This wiki is locked. Future workgroup activity and specification development must take place at
our new wiki
. For more information, see
this blog post about the new governance model
and
this post about changes to the website
.
TWiki
>
Main Web
>
MainOslcCommonArchitecture
>
ReportingHome
>
ResourceFormat
(revision 2) (raw view)
---+ Resource Format %TOC% ---++ ---++ Overview The goal of this document is to define extra requirements on the data returned by the RESTful service to enable reporting, details about resources in specific domain will be described in specification for each domain separately. ---++ Resource request and response A reporting consumer will construct a query to the service provider, and then consume data in the query resultset. Details about the query request and overall structure of the response will be covered in resource query sessions. ---++ Identifying properties in the resultset A reporting consumer will use knowledge acquired from the resource schema to identify data in the resultset and map to internal data model in the reporting system. That means, for a service provider, in order to expose data in a way that can be identified as separate property in reporting system, the data SHOULD be uniquely identifiable in the resulset with knowledge acquired from the resource schema. Take a concrete example: If there is a piece of XML in the resultset like this: <literal><pre><attribute></pre><pre> <name>att1</name></pre><pre> <value>value1</value></pre><pre></attribute></pre><pre><attribute></pre><pre> <name>att2</name></pre><pre> <value>value2</value></pre><pre></attribute> <br></br></pre></literal> And assuming the resource schema is XML Schema. In this case, the reporting system won't be able to map "attribute"s with "name" to be "att1" as one property and map "attribute"s with "name" as "att2" to be another property in the reporting system. ---++ Extracting data from the resultset The reporting consumer should be able to extract real content for the properties from the resultset directly. That means, the service provider should return real content for properties in the resultset and the reporting consumer shouldn't be forced to follow URLs to retrieve real content for properties. ---++ Identifier for resource In the resultset, each resource MUST have a identifier which can uniquely identify this resource globally. Choices for identifier: 1. URI for the resource ... (other choices?) ---++ Resource links ---++ Multi-valued properties ---++ Comments Add your comments here: %COMMENT% -- Main.XiangDongHu - 03 Nov 2009
Edit
|
Attach
|
P
rint version
|
H
istory
:
r6
|
r4
<
r3
<
r2
<
r1
|
B
acklinks
|
V
iew topic
|
Raw edit
|
More topic actions...
Topic revision: r2 - 05 Nov 2009 - 11:32:15 -
XiangDongHu
Main
Main Web
Create New Topic
Index
Search
Changes
Notifications
RSS Feed
Statistics
Preferences
Webs
Main
Sandbox
TWiki
Български
Cesky
Dansk
Deutsch
English
Español
Français
Italiano
日本語
Nederlands
Polski
Português
Русский
Svenska
简体中文
簡體中文
Copyright � by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Contributions are governed by our
Terms of Use
Ideas, requests, problems regarding this site?
Send feedback