Request URI: /path/to/some/resource
Methods: GET, POST, PUT, PATCH, DELETE, MOVE, COPY
Retrieve all triples for the resource
Query Parameters:
By default, we include triples for all member resources, in addition to triples about the given node. Setting this to true will exclude member resources from the result.
Pagination control for member resources
Pagination control for member resources
Request Headers:
text/turtle, text/rdf+n3, application/n3, text/n3, application/rdf+xml, application/json+rdf, application/n-triples, text/html
Example (1):
curl -H "Accept: text/turtle" "http://localhost:8080/rest/" |
Response:
Status: 200 OK Headers: Content-Type: text/turtle Cache-Control: Last-Modified-At: 2013-01-01T01:23:45Z Link: http://localhost:8080/rest/?offset=0&limit=10;rel="first" Link: http://www.w3.org/ns/ldp/Resource;rel="type" Accept-Patch: application/sparql-update Body: <http://localhost:8080/rest/> a <http://www.w3.org/ns/ldp#Container> , <http://www.w3.org/ns/ldp#Page> ; <http://www.w3.org/ns/ldp#membersInlined> "true" ; <http://www.w3.org/ns/ldp#membershipObject> <http://www.w3.org/ns/ldp#MemberSubject> ; <http://www.w3.org/ns/ldp#membershipPredicate> <http://fedora.info/definitions/v4/repository#hasChild> ; <http://www.w3.org/ns/ldp#membershipSubject> <http://localhost:8080/rest/> ; <http://www.w3.org/ns/ldp#pageOf> <http://localhost:8080/rest/> ; <http://fedora.info/definitions/v4/rest-api#exportsAs> <http://localhost:8080/rest//fcr:export?format=jcr/xml> ; <http://fedora.info/definitions/v4/rest-api#hasNamespaces> <http://localhost:8080/rest/fcr:namespaces> ; <http://fedora.info/definitions/v4/rest-api#hasTransactionProvider> <http://localhost:8080/rest/fcr:tx> ; <http://fedora.info/definitions/v4/rest-api#hasWorkspaces> <http://localhost:8080/rest/fcr:workspaces> ; <http://microformats.org/wiki/rel-sitemap> <http://localhost:8080/rest/sitemap> ; |
Example (2):
curl -H "Accept: text/turtle" "http://localhost:8080/rest/path/to/resource" |
Response:
Status: 200 OK Headers: ETag: "d98e86c48a3e31857f5311f51ad7a2e13a7cedee" Content-Type: text/turtle Cache-Control: must-revalidate Last-Modified: Fri, 15 Nov 2013 23:31:07 +0000 Link: http://localhost:8080/rest/path/to/resource/?offset=0&limit=10;rel="first" Link: http://www.w3.org/ns/ldp/Resource;rel="type" Accept-Patch: application/sparql-update Body: <http://localhost:8080/rest/path/to/resource> a <http://fedora.info/definitions/v4/rest-api#resource> , <http://fedora.info/definitions/v4/rest-api#object> , <http://www.w3.org/ns/ldp#Container> , <http://www.w3.org/ns/ldp#Page> ; <http://fedora.info/definitions/v4/repository#uuid> "e8baa85c-f05a-49e8-9578-9adef92ac60d"^^<http://www.w3.org/2001/XMLSchema#string> ; <http://www.w3.org/ns/ldp#inlinedResource> <http://localhost:8080/rest/path/to> ; <http://www.w3.org/ns/ldp#membersInlined> "true" ; <http://www.w3.org/ns/ldp#pageOf> <http://localhost:8080/rest/path/to/resource> . <http://fedora.info/definitions/v4/rest-api#exportsAs> <http://localhost:8080/rest/path/to/resource/fcr:export?format=jcr/xml> ; <http://fedora.info/definitions/v4/rest-api#hasVersions> <http://localhost:8080/rest/path/to/resource/fcr:versions> ; <http://fedora.info/definitions/v4/repository#created> "2013-11-15T23:31:07.275Z"^^<http://www.w3.org/2001/XMLSchema#dateTime> ; <http://fedora.info/definitions/v4/repository#createdBy> "bypassAdmin"^^<http://www.w3.org/2001/XMLSchema#string> ; <http://fedora.info/definitions/v4/repository#hasParent> <http://localhost:8080/rest/path/to> ; <http://fedora.info/definitions/v4/repository#lastModified> "2013-11-15T23:31:07.268Z"^^<http://www.w3.org/2001/XMLSchema#dateTime> ; |
Status:
OK
Not Modified
Not Found
Create a new node at the given path
Create a new node at the given path, and recursively create any missing parent elements.
Query Parameters:
(Optional; values: fedora:object, fedora:datastream) Explicitly create an object or datastream, instead of inferring it from the request body
Example (1):
curl -X POST "http://localhost:8080/rest/some/path/to/a/new/resource" |
Response:
Status: 201 Created Headers: Location: http://localhost:8080/rest/path/to/a/new/resource |
Example (2):
curl -X POST "http://localhost:8080/rest/some/path/to/a/new/resource?mixin=fedora:datastream" # Create a fedora:datastream |
Status:
Created
Create a new node as a child of the given node
If the given resource path exists, a POST to that path will create a new node as a child of the given resource using a generated identifier.
Request Headers:
Use the slug header when creating the new resource (see AtomPub slug header). If no slug is provided, the identifier will be automatically generated.
The slug you provide does not guarantee the location of the created node. Clients must check the Location header for the path to the created resource. For full control over the generated path, see POST Create a new node at the given path. |
Query Parameters:
(Optional; values: fedora:object, fedora:datastream) Explicitly create an object or datastream, instead of inferring it from the request body
Example (1):
curl -X POST "http://localhost:8080/rest/this/node/already/exists" |
Response:
Status: 201 Created Headers: Location: http://localhost:8080/rest/this/node/already/exists/some/generated/identifier |
Example (2):
curl -X POST -H "Slug: new-node-name" "http://localhost:8080/rest/this/node/already/exists" |
Response:
Status: 201 Created Headers: Location: http://localhost:8080/rest/this/node/already/exists/new/node/name |
Status:
Created
Create a new node and populate some properties
In addition to creating a new node, add the given properties to the object
An RDF payload can be combined with any of the above forms. |
RDF will be interpreted using the current resource as the base URI (e.g. <> will be expanded to the current URI) |
Request Headers:
text/turtle
Query Parameters:
Example:
curl -X POST -H "Content-Type: text/turtle" "http://localhost:8080/rest/node/to/create" -d "@body.rdf" Request Body: <> dc:title "some-resource-title" |
Response:
Status: 201 Created Headers: Location: http://localhost:8080/rest/node/to/create |
Status:
Created
Create a new node and execute a SPARQL-Update query
In addition to creating a new node, execute a SPARQL-Update query against the newly created node.
Request Headers:
application/sparql-update
Query Parameters:
RDF will be interpreted using the current resource as the base URI (e.g. <> will be expanded to the current URI) |
Example:
curl -X POST -H "Content-Type: application/sparql-update" "http://localhost:8080/rest/node/to/create" -d "@body.rdf" Request Body: INSERT { <> dc:title "some-resource-title" . } WHERE { } |
Response:
Status: 201 Created Headers: Location: http://localhost:8080/rest/node/to/create |
Status:
Created
Create a new resource with binary content
If the binary content is RDF or a SPARQL-Update query, see Binary Content for an alternative way to create content |
Query Parameters:
Checksum of the binary content (in the form urn:sha1:<sha-hash>). If the checksum doesn't match, an error will be returned.
Header Parameters:
The filename provided in the content disposition header will be stored in a premis:hasOriginalName property.
Example (1):
curl -X POST "http://localhost:8080/rest/binary/resource/to/create" -d "@picture.jpg" |
Response:
Status: 201 Created Headers: Location: http://localhost:8080/rest/binary/resource/to/create/fcr:content |
Example (2):
curl -X POST "http://localhost:8080/rest/binary/resource/to/create?checksum=urn:sha1:cb1a576f22e8e3e110611b616e3e2f5ce9bdb941" -d "@picture.jpg" |
Response:
Status: 201 Created Headers: Location: http://localhost:8080/rest/binary/resource/to/create/fcr:content |
Example (3):
curl -X POST "http://localhost:8080/rest/binary/resource/to/create?checksum=urn:sha1:checksumdoesntmatch" -d "@picture.jpg" |
Response:
Status: 409 Conflict Error: Checksum Mismatch of cb1a576f22e8e3e110611b616e3e2f5ce9bdb941 and urn:sha1:checksumdoesntmatch |
By convention, binary content is accessed using the REST endpoint path/to/resource/fcr:content. |
Status:
Created
Conflict
Modify the triples associated with the resource
Replace the existing triples for a resource with the triples provided in the request body.
Some resource properties are repository managed and cannot be removed or modified. Any attempt to do so may result in a 4xx error. |
RDF will be interpreted using the current resource as the base URI (e.g. <> will be expanded to the current URI) |
Request Headers:
text/turtle, text/rdf+n3, application/n3, text/n3, application/rdf+xml, application/json+rdf, application/n-triples, text/html
Query Parameters:
Checksum of the binary content (in the form urn:sha1:<sha-hash>). If the checksum doesn't match, an error will be returned.
Example:
curl -X POST -H "Content-Type: text/turtle" "http://localhost:8080/rest/node/to/update" -d "@new-triples.rdf" Request Body: <> dc:title "some-resource-title" . |
Response:
Status: 204 No Content |
Status:
No Content
Precondition Failed
with SPARQL-Update
Request Headers:
Example:
curl -X PATCH -H "Content-Type: application/sparql-update" "http://localhost:8080/rest/node/to/update" -d "@body.rdf" Request Body: INSERT { <> dc:title "some-resource-title" . } WHERE { } |
Response:
Status: 204 No Content |
Status:
No Content
Precondition Failed
Delete a resource
Example:
curl -X DELETE "http://localhost:8080/rest/node/to/delete" |
Response:
Status: 204 No Content |
Status:
No Content
Move a resource (and its subtree) to a new location
Example (1):
curl -X MOVE -H "Destination: http://localhost:8080/rest/new/path/to/node" "http://localhost:8080/rest/path/to/node" |
Response:
Status: 201 Created Headers: Location: http://localhost:8080/rest/new/path/to/node |
Example (2):
curl -X MOVE -H "Destination: http://duraspace.org/some/path" "http://localhost:8080/rest/path/to/node" |
Response:
Status: 502 Bad Gateway |
Status:
Created
Source path doesn't exists
Destination path already exists
Destination URI isn't a valid resource path
Copy a resource (and its subtree) to a new location
Example:
curl -X COPY -H "Destination: http://localhost:8080/rest/new/path/to/node" "http://localhost:8080/rest/path/to/node" |
Response:
Status: 201 Created Headers: Location: http://localhost:8080/rest/new/path/to/node |
Status:
Created
Source path doesn't exists
Destination path already exists
Destination URI isn't a valid resource path