Create a new namespace.

Request payload

The request payload must be sent in application/json format with the following fields:

Response payload

The response payload will be sent in application/json format with the following fields:

POST /namespaces/test HTTP/1.1
Authorization: Basic XXXXXXXX
Content-Length: XXXXXXXX
Content-Type: application/json

{
 "description": "A namespace for tags that I'm using to add to people",
 "name": "people"
}

HTTP/1.1 201 Created
Content-Length: 110
Location: http://fluiddb.fluidinfo.com/namespaces/test/people
Date: Mon, 02 Aug 2010 12:40:41 GMT
Content-Type: application/json

{"id": "e9c97fa8-05ed-4905-9f72-8d00b7390f9b", 
 "URI": "http:\/\/fluiddb.fluidinfo.com\/namespaces\/test\/people"}

HTTP response status codes

The following HTTP response codes may occur:

Get information about the namespaces contained in a namespace.

URI arguments:

Response payload

The response payload will be sent in application/json format with the following fields:

GET /namespaces/test/people?returnDescription=True&returnNamespaces=True&returnTags=True HTTP/1.1
Authorization: Basic XXXXXXXX

HTTP/1.1 200 OK
Content-Length: 118
Date: Mon, 02 Aug 2010 12:43:05 GMT
Content-Type: application/json

{"tagNames": [], "namespaceNames": [], "id": "e9c97fa8-05ed-4905-9f72-8d00b7390f9b",
"description": "A namespace for tags I'm using to add to people"}

HTTP response status codes

The following HTTP response codes may occur:

Update a namespace.

Request payload

The request payload must be sent in application/json format with the following fields:

PUT /namespaces/test/people HTTP/1.1
Authorization: Basic XXXXXXXX
Content-Length: XXXXXXXX
Content-Type: application/json

{
  "description": "Contains tags used to annotate objects representing people"
}

HTTP/1.1 204 No Content
Date: Mon, 02 Aug 2010 12:46:38 GMT
Content-Type: text/html

HTTP response status codes

The following HTTP response codes may occur:

Delete a namespace.

DELETE /namespaces/test/people HTTP/1.1
Authorization: Basic XXXXXXXX

HTTP/1.1 204 No Content
Date: Mon, 02 Aug 2010 12:47:25 GMT
Content-Type: text/html

HTTP response status codes

The following HTTP response codes may occur:

Create a new object.

Request payload

The request payload must be sent in application/json format with the following fields:

Response payload

The response payload will be sent in application/json format with the following fields:

POST /objects HTTP/1.1
Authorization: Basic XXXXXXXX
Content-Length: XXXXXXXX
Content-Type: application/json

{
  "about": "book:Dune"
}

HTTP/1.1 201 Created
Content-Length: 134
Location: http://fluiddb.fluidinfo.com/objects/9c8e4b12-4b7d-40d2-865b-d5b1945350b1
Date: Mon, 02 Aug 2010 13:00:29 GMT
Content-Type: application/json

{"id": "9c8e4b12-4b7d-40d2-865b-d5b1945350b1",
"URI": "http:\/\/fluiddb.fluidinfo.com\/objects\/9c8e4b12-4b7d-40d2-865b-d5b1945350b1"}

POST /objects HTTP/1.1
Authorization: Basic XXXXXXXX
Content-Length: XXXXXXXX
Content-Type: application/json

HTTP/1.1 201 Created
Content-Length: 134
Location: http://fluiddb.fluidinfo.com/objects/741fdbcb-a8c5-449f-a3cf-50c89ee63cdb
Date: Mon, 02 Aug 2010 13:01:05 GMT
Content-Type: application/json

{"id": "741fdbcb-a8c5-449f-a3cf-50c89ee63cdb",
"URI": "http:\/\/fluiddb.fluidinfo.com\/objects\/741fdbcb-a8c5-449f-a3cf-50c89ee63cdb"}

HTTP response status codes

The following HTTP response codes may occur:

Search for objects that match a query.

URI arguments:

Response payload

The response payload will be sent in application/json format with the following fields:

GET /objects?query=has%20ntoll/met%20and%20has%20terrycojones/met HTTP/1.1
Authorization: Basic XXXXXXXX

HTTP/1.1 200 OK
Content-Length: 209
Date: Mon, 02 Aug 2010 13:14:32 GMT
Content-Type: application/json

{"ids": ["5a4823a4-26b4-495c-9a29-a1e830a1b153", "8b07a7ec-e5f7-46cd-9cd1-9a40c3137762",
"83f2ad81-43db-421a-adc4-974f3a8bca0d", "ac1e937e-dd76-426e-a2b5-06a439a708cc",
"52bc041d-e8f4-4f8d-a66a-a3b5ea5fa156"]}

HTTP response status codes

The following HTTP response codes may occur:

To request information on a particular object, include the object ID in the request URI. The return information will indicate which tags are present on the object, though not with the tag values.

URI arguments:

Response payload

The response payload will be sent in application/json format with the following fields:

GET /objects/5a4823a4-26b4-495c-9a29-a1e830a1b153?showAbout=True HTTP/1.1
Authorization: Basic XXXXXXXX

HTTP/1.1 200 OK
Content-Length: 1080
Date: Mon, 02 Aug 2010 13:16:09 GMT
Content-Type: application/json

{"about": "twitter.com:uid:5893972", "tagPaths": ["twitter.com\/friends\/fxn"]}

HTTP response status codes

The following HTTP response codes may occur:

Retrieve the value of a tag from an object. The value is returned in the payload of the response. Please see here for more details.

GET /objects/5a4823a4-26b4-495c-9a29-a1e830a1b153/twitter.com/users/screen_name HTTP/1.1
Authorization: Basic XXXXXXXX

HTTP/1.1 200 OK
Content-Length: 6
Date: Mon, 02 Aug 2010 13:20:31 GMT
Content-Type: application/vnd.fluiddb.value+json

"HD42"

GET /objects/366375a5-c811-4c59-a469-0a3efb602411/ntoll/fluidapp/tweetmeet/index.html HTTP/1.1
Authorization: Basic XXXXXXXX

HTTP/1.1 200 OK
Content-Length: 6666
Date: Mon, 02 Aug 2010 13:25:28 GMT
Content-Type: text/html

<html>
   <head>
          <title>Hello</title>
   </head>
   <body>
       Hello
   </body>
</html>

HTTP response status codes

The following HTTP response codes may occur:

Test for the existence of a tag on an object.

HEAD /objects/366375a5-c811-4c59-a469-0a3efb602411/ntoll/fluidapp/tweetmeet/index.html HTTP/1.1
Authorization: Basic XXXXXXXX

HTTP/1.1 200 OK
Content-Length: 0
Date: Mon, 02 Aug 2010 13:26:25 GMT
Content-Type: text/html

HTTP response status codes

The following HTTP response codes may occur:

Create or update a tag on an object. The tag value is sent in the payload of the request. See here for more details.

PUT /objects/5a4823a4-26b4-495c-9a29-a1e830a1b153/test/quz HTTP/1.1
Authorization: Basic XXXXXXXX
Content-Length: XXXXXXXX
Content-Type: application/vnd.fluiddb.value+json

"1.234"

HTTP/1.1 204 No Content
Date: Mon, 02 Aug 2010 14:31:47 GMT
Content-Type: text/html

PUT /objects/5a4823a4-26b4-495c-9a29-a1e830a1b153/test/quz HTTP/1.1
Authorization: Basic XXXXXXXX
Content-Length: XXXXXXXX
Content-Type: application/pdf

%PDF-1.4
1 0 obj
<< /Length 2 0 R
/Filter /FlateDecode
>>
stream
...

HTTP/1.1 204 No Content
Date: Mon, 02 Aug 2010 14:33:40 GMT
Content-Type: text/html

HTTP response status codes

The following HTTP response codes may occur:

Delete a tag from an object.

DELETE /objects/5a4823a4-26b4-495c-9a29-a1e830a1b153/test/quz HTTP/1.1
Authorization: Basic XXXXXXXX

HTTP/1.1 204 No Content
Date: Mon, 02 Aug 2010 14:56:52 GMT
Content-Type: text/html

HTTP response status codes

The following HTTP response codes may occur:

Get the permissions on a namespace: the open/closed policy, and the set of exceptions to the policy.

URI arguments:

Response payload

The response payload will be sent in application/json format with the following fields:

GET /permissions/namespaces/test?action=create HTTP/1.1
Authorization: Basic XXXXXXXX

HTTP/1.1 200 OK
Content-Length: 44
Date: Mon, 02 Aug 2010 14:58:28 GMT
Content-Type: application/json

{"policy": "closed", "exceptions": ["test"]}

HTTP response status codes

The following HTTP response codes may occur:

Get the permissions on a tag: the open/closed policy, and the set of exceptions to the policy.

URI arguments:

Response payload

The response payload will be sent in application/json format with the following fields:

GET /permissions/tags/test/quz?action=update HTTP/1.1
Authorization: Basic XXXXXXXX

HTTP/1.1 200 OK
Content-Length: 44
Date: Mon, 02 Aug 2010 14:59:22 GMT
Content-Type: application/json

{"policy": "closed", "exceptions": ["test"]}

HTTP response status codes

The following HTTP response codes may occur:

Get the permissions on the set of tag instances: the open/closed policy, and the set of exceptions to the policy.

URI arguments:

Response payload

The response payload will be sent in application/json format with the following fields:

GET /permissions/tag-values/test/quz?action=delete HTTP/1.1
Authorization: Basic XXXXXXXX

HTTP/1.1 200 OK
Content-Length: 36
Date: Mon, 02 Aug 2010 14:59:54 GMT
Content-Type: application/json

{"policy": "open", "exceptions": []}

HTTP response status codes

The following HTTP response codes may occur:

Update the permissions on a namespace: the open/closed policy, and the set of exceptions to the policy.

URI arguments:

Request payload

The request payload must be sent in application/json format with the following fields:

PUT /permissions/namespaces/test?action=create HTTP/1.1
Authorization: Basic XXXXXXXX
Content-Length: XXXXXXXX
Content-Type: application/json

{
  "policy": "closed",
  "exceptions": ["test", "ntoll"]
}

HTTP/1.1 204 No Content
Date: Mon, 02 Aug 2010 15:03:42 GMT
Content-Type: text/html

HTTP response status codes

The following HTTP response codes may occur:

Update the permissions on a tag: the open/closed policy, and the set of exceptions to the policy.

URI arguments:

Request payload

The request payload must be sent in application/json format with the following fields:

PUT /permissions/tags/test/quz?action=update HTTP/1.1
Authorization: Basic XXXXXXXX
Content-Length: XXXXXXXX
Content-Type: application/json

{
  "policy": "closed",
  "exceptions": ["test", "ntoll"]
}

HTTP/1.1 204 No Content
Date: Mon, 02 Aug 2010 15:04:39 GMT
Content-Type: text/html

HTTP response status codes

The following HTTP response codes may occur:

Update the permissions on a tag's instances: the open/closed policy, and the set of exceptions to the policy.

URI arguments:

Request payload

The request payload must be sent in application/json format with the following fields:

PUT /permissions/tag-values/test/quz?action=create HTTP/1.1
Authorization: Basic XXXXXXXX
Content-Length: XXXXXXXX
Content-Type: application/json

{
  "policy": "closed",
  "exceptions": ["test", "ntoll"]
}

HTTP/1.1 204 No Content
Date: Mon, 02 Aug 2010 15:08:44 GMT
Content-Type: text/html

HTTP response status codes

The following HTTP response codes may occur:

Get a user's default permission policy for a given category and action. These are the permissions that will be assigned to new tags and namespaces created by the user.

category must be one of 'namespaces', 'tags' or 'tag-values'. The actions available by category are as follows.

• For namespaces: 'create', 'update', 'delete', and 'list'.
• For tags: 'update' and 'delete'.
• For tag-values: 'see', 'create', 'read', and 'delete'.

Response payload

The response payload will be sent in application/json format with the following fields:

GET /policies/test/namespaces/create HTTP/1.1
Authorization: Basic XXXXXXXX

HTTP/1.1 200 OK
Content-Length: 44
Date: Mon, 02 Aug 2010 15:11:35 GMT
Content-Type: application/json

{"policy": "closed", "exceptions": ["test"]}

HTTP response status codes

The following HTTP response codes may occur:

Update a user's default permission policy for a given category and action. These are the permissions that will be assigned to new tags and namespaces created by the user.

The category and action components of the URI are as for GET.

Request payload

The request payload must be sent in application/json format with the following fields:

PUT /policies/test/namespaces/create HTTP/1.1
Authorization: Basic XXXXXXXX
Content-Length: XXXXXXXX
Content-Type: application/json

{
  "policy": "closed",
  "exceptions": ["test"]
}

HTTP/1.1 204 No Content
Date: Mon, 02 Aug 2010 15:12:40 GMT
Content-Type: text/html

HTTP response status codes

The following HTTP response codes may occur:

Add a tag name to a namespace.

Request payload

The request payload must be sent in application/json format with the following fields:

Response payload

The response payload will be sent in application/json format with the following fields:

POST /tags/test HTTP/1.1
Authorization: Basic XXXXXXXX
Content-Length: XXXXXXXX
Content-Type: application/json

{
  "description": "Indicates how I rate something on a scale of 1 (worst) to 10 (best).",
  "indexed": false,
  "name": "rating"
}

HTTP/1.1 201 Created
Content-Length: 110
Location: http://fluiddb.fluidinfo.com/tags/test/rating
Date: Mon, 02 Aug 2010 15:15:00 GMT
Content-Type: application/json

{"id": "56e0c31a-1a4c-4091-8a65-b37af769752a",
"URI": "http:\/\/fluiddb.fluidinfo.com\/tags\/test\/rating"}

HTTP response status codes

The following HTTP response codes may occur:

Retrieve information about the tag.

URI arguments:

Response payload

The response payload will be sent in application/json format with the following fields:

GET /tags/test/rating?returnDescription=True HTTP/1.1
Authorization: Basic XXXXXXXX

HTTP/1.1 200 OK
Content-Length: 108
Date: Mon, 02 Aug 2010 15:15:59 GMT
Content-Type: application/json

{"indexed": false, "id": "56e0c31a-1a4c-4091-8a65-b37af769752a",
"description": "Indicates how I rate something on a scale of 1 (worst) to 10 (best)."}

HTTP response status codes

The following HTTP response codes may occur:

Update information about a tag in a namespace.

Request payload

The request payload must be sent in application/json format with the following fields:

PUT /tags/test/rating HTTP/1.1
Authorization: Basic XXXXXXXX
Content-Length: XXXXXXXX
Content-Type: application/json

{
  "description": "Indicates rating from 1 (bad) -> 10 (good)"
}

HTTP/1.1 204 No Content
Date: Mon, 02 Aug 2010 15:16:59 GMT
Content-Type: text/html

HTTP response status codes

The following HTTP response codes may occur:

Delete a tag. The tag name is removed from its containing namespace and all occurences of the tag on objects are deleted.

DELETE /tags/test/rating HTTP/1.1
Authorization: Basic XXXXXXXX

HTTP/1.1 204 No Content
Date: Mon, 02 Aug 2010 15:17:38 GMT
Content-Type: text/html

HTTP response status codes

The following HTTP response codes may occur:

Return information about a particular user.

Response payload

The response payload will be sent in application/json format with the following fields:

GET /users/nto%CE%BB%CE%BB HTTP/1.1

HTTP/1.1 200 OK
Content-Length: 62
Date: Mon, 02 Aug 2010 15:18:17 GMT
Content-Type: application/json

{"name": "Nicholas To\u03bb\u03bbervey", "id": "42909deb-9854-47ae-a8f8-3f59d4fbe5a5"}

HTTP response status codes

The following HTTP response codes may occur: