MarkLogic 12 Product Documentation

POST /v1/graphs

Summary

Merge quads into the triple store, or merge other types of triples into a named graph or the default graph.

Response

Upon success, MarkLogic Server returns status 201 (Created) or status 204 (Updated). If there are errors in the payload, the response body contains further information about the errors. If the request body is in an unsupported format, MarkLogic Server returns status 415 (Unsupported Media Type).

Required Privileges

http://marklogic.com/xdmp/privileges/rest-writer

Usage Notes

You can use this method in the following ways:

• To merge quads into the graphs identified by the URIs embedded in each quad, omit the default and graph parameters. If a quad includes a graph URI, the triple is merged into that graph. If a quad does not include a graph URI, the triple is merged into the default graph. The request content type must be application/n-quads or application/trig.
• To merge data into a specific graph or the default graph, include either the default or graph parameter (but not both). The specified graph is created from the input data. If the input data is quads, the graph URIs in the quads are ignored.
• To add permissions to a specific graph, include either the default or graph parameter (but not both), and category=permissions or category=metadata. The request content type must be application/xml or application/json. The data in the request body must be either a well-formed document metadata XML element or JSON object, or just the permissions component of such an element. For details, see Managing Graph Permissions in the Semantic Graph Developer's Guide.

If you use this method to merge data into a graph that does not exist, the graph will be created.

When used with the default or graph parameters, this interface implements the POST method of the W3C Graph Store HTTP Protocol; for details, see http://www.w3.org/TR/sparql11-http-rdf-update/.

Supplying an empty graph is a no-op if the input data MIME type is not application/n-quads or application/trig.

NOTE: The collection lexicon must be enabled on your database when using this method. You can check the configuration from the Admin Interface.

Additional capabilities are available through the XQuery API and the mlcp command line tool. For details, see Updating Triples in the Semantic Graph Developer's Guide.

See Also

• Loading Triples Using the REST API in the Semantic Graph Developer's Guide
• Managing Graph Permissions in the Semantic Graph Developer's Guide

Example

NOTE: Be sure to use --data-binary rather than -d if extracting
the request body from a file with curl, as shown below.

$ curl --anyauth --user user:password -i -X POST \
    --data-binary @./example.nq -H "Content-type: application/n-quads" \
    http://localhost:8000/v1/graphs

==> The N-Quad data in example.nq is merged into the graphs specified
    by each quad. MarkLogic Server responds with output similar to 
    the following:

HTTP/1.1 204 Updated
Location:
Server: MarkLogic
Content-Length: 0
Connection: Keep-Alive
Keep-Alive: timeout=5
  

Example

NOTE: Be sure to use --data-binary rather than -d if extracting
the request body from a file with curl, as shown below.

$ curl --anyauth --user user:password -i -X POST \
    --data-binary @./example.ttl -H "Content-type: text/turtle" \
    'http://localhost:8000/v1/graphs?graph=/my/named/graph&perm:myrole=read'

==> The Turtle data in example.ttl is merged into the graph with the
    URI /my/named/graph and the permissions for the graph are updated.
    MarkLogic Server responds with output similar to the following:

HTTP/1.1 204 Updated
Location:
Server: MarkLogic
Content-Length: 0
Connection: Keep-Alive
Keep-Alive: timeout=5
  

Example

NOTE: Be sure to use --data-binary rather than -d if extracting
the request body from a file with curl, as shown below.

$ curl --anyauth --user user:password -i -X POST \
    --data-binary @./example.nq -H "Content-type: application/n-quads" \
    http://localhost:8000/v1/graphs

==> The N-Quads in the input file are added to the graphs specified in
    the data. MarkLogic responds with output similar to the following:

HTTP/1.1 204 Updated
Server: MarkLogic
Content-Length: 0
Connection: Keep-Alive
Keep-Alive: timeout=5
  

Example

$ curl --anyauth --user user:password -i -X POST \
    -d '{"permissions":[{"role-name":"readers","capabilities":["read"]}]}' \
    -H "Content-type: application/json" \
    'http://localhost:8000/v1/graphs?default&category=permissions'

==> The permissions specified in the request are added to the permissions
    of the default graph. MarkLogic responds with output similar to the 
    following:

HTTP/1.1 204 Updated
Server: MarkLogic
Content-Length: 0
Connection: Keep-Alive
Keep-Alive: timeout=5