REST API

/data

• /data/{id} PUT GET DELETE

/resources

• /resources POST GET
• /resources/resource/{id}[?full=true] PUT GET DELETE
  (query param full in GET method also returns attached storeddata)
• /resources/search POST GET
• /resources/search/{namelike} GET
• /resources/count/{namelike} GET
• /resources/resource/{id}/attributes GET
• /resources/resource/{id}/attributes/{name} GET
• /resources/resource/{id}/attributes/{name}/{value} PUT

/categories

• /categories POST GET
• /categories/category/{id} PUT GET DELETE
• /categories/count/{namelike} GET

/users

• /users/user/{id}

/misc

These calls simplify some client side operations, avoiding the use of XML filters to be POSTed and receiving all the needed params in the URL path.

• /misc/category/name/{cname}/resource/{rname} GET
  Get the full resource, completed with its data. May be computational and network heavy.
  Results:

  • 200 OK: one resource found
  • 404 NOT FOUND: no matching resource found
  • 409 CONFLICT: too many matching resources found
  • 500: other errors

• /misc/category/name/{cname}/resource/{rname}/data GET
  Get the resource data. May be computational and network heavy.
  Results:

  • 200 OK: one resource found
  • 404 NOT FOUND: no matching resource found
  • 409 CONFLICT: too many matching resources found
  • 500: other errors

• /misc/category/name/{cname}/resource/ GET
  Get the list of resources belonging to the Category with name cname.

  Results:

  • 200 OK: one or more resources
  • 404 NOT FOUND: no matching resource found
  • 500: other errors

• /misc/getdata?categoryname={cname}&resourcename={rname}

/backup

• /backup/full GET
  Not implemented yet.
• /backup/full PUT
  Not implemented yet.
• /backup/quick GET
  Return an XML document containing information about categories, resources, storedData.
  No info about users or authorization is returned.
• /backup/quick PUT
  Restore the info from an XML doc got with the GET method.
  • All existing categories and resources will be deleted.
  • Categories, resources and storeddata are created from the the XML document.
  • Users will not be modified. Security rules will not be added.
  • IDs are not preserved. Creation dates are recreated.
  • Returns the ok string if the procedure completed successfully.