Document Format of Operation

Operation DTD

<?xml encoding="UTF-8"?>
 
<!ELEMENT operations (operation)*>
 
<!ELEMENT operation EMPTY>
<!ATTLIST operation
  actor CDATA #REQUIRED
  verb CDATA #REQUIRED
  object1 CDATA #IMPLIED
  object2 CDATA #IMPLIED
  comment CDATA #IMPLIED
  logtime CDATA #REQUIRED>

Example of Operation

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE operation SYSTEM "http://tech-ada.utt.fr/validator/dtd/operation.dtd">
<operations>
  <operation actor="guest" verb="UNLINK" object1="/actor/Folksonomie/" object2="/viewpoint/4/" comment="" logtime="2008-01-07 10:14:45.828"/>
</operations>

XML structure of Operation

Get Operation

Get all operations. Note: This method requires an HTTP GET request.

Example Request

GET /operation/

Example Response

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE operation SYSTEM "http://tech-ada.utt.fr/validator/dtd/operation.dtd">
<operations>
  <operation actor="guest" verb="UNLINK" object1="/actor/Folksonomie/" object2="/viewpoint/4/" comment="" logtime="2008-01-07 10:14:45.828"/>
</operations>

Status Codes

200: OK

The request has succeeded.

404: Not Found

The server has not found anything matching the Request-URI.

500: Internal Server Error

The server encountered an unexpected condition which prevented it from fulfilling the request.

503: Service currently unavailable

The requested service is temporarily unavailable.

Query Operation

Get operations by SQL like clause.

The clause should be encoded with RFC1738 encode.

Note: This method requires an HTTP GET request.

Example Request

GET /operation/set/actor='guest'/

Example Response

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE operation SYSTEM "http://tech-ada.utt.fr/validator/dtd/operation.dtd">
<operations>
  <operation actor="guest" verb="UNLINK" object1="/actor/Folksonomie/" object2="/viewpoint/4/" comment="" logtime="2008-01-07 10:14:45.828"/>
</operations>

Status Codes

200: OK

The request has succeeded.

500: Internal Server Error

The server encountered an unexpected condition which prevented it from fulfilling the request.

503: Service currently unavailable

The requested service is temporarily unavailable.

Operation Examples

Actor

Create an actor

Create the actor:

Actor ID: actorId
Actor Name: example
Viewpoints:
/viewpoint/1/@'reader'

Delete an actor

Delete the actor:

Actor ID: actorId
Actor Name: example
Viewpoints:
/viewpoint/1/@'reader'

Update an actor

Update the actor:

Actor ID: actorId 
Actor Name: example
Viewpoints:
/viewpoint/1/@'reader'
/viewpoint/2/@'reader'

The new actor:

Actor ID: actorId
Actor Name: new example
Viewpoints:
/viewpoint/2/@'owner'
/viewpoint/3/@'reader'

Viewpoint

Create a viewpoint

Create the viewpoint:

Viewpoint Name: example
Actors:
 /actor/actorId/@'reader'

Delete a viewpoint

Delete the viewpoint:

Viewpoint URI: /viewpoint/1/
Viewpoint Name: example
Actors:
 /actor/actorId/@'reader'
Topics:
 /viewpoint/1/topic/1/ includes /viewpoint/1/topic/2/, /entity/example/
 /viewpoint/1/topic/1/ includes /viewpoint/1/topic/3/
 /viewpoint/1/topic/2/ includes /viewpoint/1/topic/4/

Update a viewpoint

Update the Viewpoint:

Viewpoint URI: /viewpoint/1/ 
Viewpoint Name: example
Actors:
 /actor/actorId1/@'reader'
 /actor/actorId2/@'reader'

The new viewpoint:

Viewpoint URI: /viewpoint/1/ 
Viewpoint Name: example
Actors:
 /actor/actorId1/@'owner'
 /actor/actorId3/@'reader'

Topic

Create a topic

Create the topic:

Topic URI: /viewpoint/1/topic/1/
Topic Name: example
Related Topics:
 /viewpoint/1/topic/2/@'includes'
 /viewpoint/1/topic/3/@'includedIn'
Entities:
 /entity/example/

Delete a topic

Delete the topic:

Topic URI: /viewpoint/1/topic/1/
Topic Name: example
Related Topics:
 /viewpoint/1/topic/2/@'includes'
 /viewpoint/1/topic/3/@'includedIn'
Entities:
 /entity/example/

Update a topic

Update the Topic:

Topic URI: /viewpoint/1/topic/1/
Topic Name: example
Related Topics:
 /viewpoint/1/topic/2/@'includes'
 /viewpoint/1/topic/3/@'includedIn'
Entities:
 /entity/example/

The new topic:

Topic URI: /viewpoint/1/topic/1/
Topic Name: topic #1
Related Topics:
 /viewpoint/1/topic/2/@'includedIn'
 /viewpoint/1/topic/4/@'includedIn'
Entities:
 /entity/example/subitem/

Entity

Delete an entity

Delete the entity:

Entity URI: /entity/entityid/
Attributes:
 /attribute/name/value/
Resources:
 /resource/name/url/
Topics:
 /viewpoint/1/topic/1/

Create / Update an entity

Update the Entity:

Entity URI: /entity/entityid/
Attributes:
 /attribute/name/value/
Resources:
 /resource/name/url/
Topics:
 /viewpoint/1/topic/1/

The new Entity:

Entity URI: /entity/entityid/
Attributes:
 /attribute/name/value2/
 /attribute/name2/value2/
Resources:
 /resource/name2/url2/
Topics:
 /viewpoint/2/topic/2/