1 / 14

Overview of CollectionSpace RESTful APIs and Their Functionalities

This presentation provides an introduction to REST-based APIs proposed for the CollectionSpace services layer. It outlines how resources are mapped via identifiers like URLs to facilitate interactions with server-side state. The API allows for creating, reading, updating, and deleting collection items through specific endpoints. Additionally, it defines how to handle search operations and status codes, alongside error responses. Feedback from users is encouraged to enhance consistency and collaboration surrounding these RESTful APIs for effective data management.

oksana
Télécharger la présentation

Overview of CollectionSpace RESTful APIs and Their Functionalities

An Image/Link below is provided (as is) to download presentation Download Policy: Content on the Website is provided to you AS IS for your information and personal use and may not be sold / licensed / shared on other websites without getting consent from its author. Content is provided to you AS IS for your information and personal use only. Download presentation by click this link. While downloading, if for some reason you are not able to download a presentation, the publisher may have deleted the file from their server. During download, if you can't get a presentation, the file might be deleted by the publisher.

E N D

Presentation Transcript

  1. CollectionSpace ServiceREST-based APIs June 2009 Face-to-face Aron Roberts U.C. Berkeley IST/Data Services

  2. Agenda • Overview: REST in 3 slides • Summary: REST-based APIsproposed for the Services Layer • Request: Feedback (later-on) CollectionSpace

  3. REST … in 1 slide … • “… resources are just consistent mappings from an identifier [such as a URL path] to some set of views on server-side state. • “If one view doesn’t suit your needs, then feel free to create a different resource that provides a better view … • “These views need not have anything to do with how the information is stored on the server … [They just need] to be understandable (and actionable) by the recipient.” – Roy T. Fielding CollectionSpace

  4. REST … in 2 slides … Every resource is URL-addressable: /collectionobjects/collectionobjects/{id}  /loans You can get creative! /collectionobjects/moviescripts /loans/overdue CollectionSpace

  5. REST … in 3 slides … To change system state, simply change a resource. Within the /collectionobjects “bucket”, you can: • Create an item • Update an item with new data • Delete an item CollectionSpace

  6. RESTful APIs (proposed) Create  POST a new item to a “bucket” POST /collectionobjects Read  GET an item by its ID GET /collectionobjects/{id} Read (multiple)  GET the items in a “bucket” GET /collectionobjects CollectionSpace

  7. RESTful APIs (proposed) Read (multiple)  GET the items in a “bucket” GET /collectionobjects Need to define details of: • IDs – CSIDs, museum numbers • Filtering – child resources, query parameters • Paging • Formats returned – URLs, full records CollectionSpace

  8. RESTful APIs (proposed) Update  PUT a fully updated item to an ID PUT /collectionobjects/{id} (Partial updates not REST-defined, however.) Delete  DELETE an item by its ID DELETE /collectionobjects/{id} Resource discovery  GET info about resource GET /collectionobjects/schema GET /collectionobjects/description CollectionSpace

  9. RESTful APIs (proposed) Search  Not REST-defined. Often: GET /collectionobjects?q=term Need to define: • “Simple” search • Fully-specified search – Resource-oriented – Query parameters – Forms submission CollectionSpace

  10. RESTful APIs (proposed) Search  (cont’d) If we model searches as resources: Create POST a new search POST /searches Read GET search results GET /searches/{id}/results Searches might thus be saved, shared … CollectionSpace

  11. Status Codes HTTP status codes returned in the response header: • 200 OK The resource was read, updated, or deleted. • 201 Created  The resource was created. • 400 Bad Request  The data sent in the request was bad. • 403 Not Authorized  The Principal named in the request was not authorized to perform this action. • 404 Not Found  The resource does not exist. • 409 Conflict  A duplicate resource could not be created. • 500 Internal Server Error  A service error occurred. CollectionSpace

  12. Error Responses Response in body when a 4xx or 5xx status is returned: <error> <code>{Mandatory code}</code> <message>{Optional message}</message> <resource-id>{Resource ID, if available}</resource-id> <request-uri>{URI of request}</request-uri> </error> CollectionSpace

  13. More info REST-based APIs http://wiki.collectionspace.org/x/yYD8 Common System Specific Elements http://wiki.collectionspace.org/x/iID8 (payloads, error messages, and more!) CollectionSpace

  14. Feedback • Eagerly invited. (Probably later on!) • We seek consistency, and to share ideas, with other CollectionSpace teams re REST-based APIs. CollectionSpace

More Related