Skip to content

Instantly share code, notes, and snippets.

@dothebart

dothebart/api-docs.json

Created February 20, 2018 13:34
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save dothebart/7c2fd526698037c73d434677b9f37329 to your computer and use it in GitHub Desktop.
Save dothebart/7c2fd526698037c73d434677b9f37329 to your computer and use it in GitHub Desktop.
Download ZIP
Raw
api-docs.json
This file has been truncated, but you can view the full file.
{
"basePath": "/",
"definitions": {
"HTTP_API_TRAVERSAL": {
"properties": {
"direction": {
"description": "direction for traversal\n- *if set*, must be either *\"outbound\"*, *\"inbound\"*, or *\"any\"*\n- *if not set*, the *expander* attribute must be specified\n\n",
"type": "string"
},
"edgeCollection": {
"description": "name of the collection that contains the edges.\n\n",
"type": "string"
},
"expander": {
"description": "body (JavaScript) code of custom expander function\n*must* be set if *direction* attribute is **not** set\nfunction signature: *(config, vertex, path) -> array*\nexpander must return an array of the connections for *vertex*\neach connection is an object with the attributes *edge* and *vertex*\n\n",
"type": "string"
},
"filter": {
"description": "default is to include all nodes:\nbody (JavaScript code) of custom filter function\nfunction signature: *(config, vertex, path) -> mixed*\ncan return four different string values:\n- *\"exclude\"* -> this vertex will not be visited.\n- *\"prune\"* -> the edges of this vertex will not be followed.\n- *\"\"* or *undefined* -> visit the vertex and follow its edges.\n- *Array* -> containing any combination of the above.\n If there is at least one *\"exclude\"* or *\"prune\"* respectivly\n is contained, it's effect will occur.\n\n",
"type": "string"
},
"graphName": {
"description": "name of the graph that contains the edges.\nEither *edgeCollection* or *graphName* has to be given.\nIn case both values are set the *graphName* is prefered.\n\n",
"type": "string"
},
"init": {
"description": "body (JavaScript) code of custom result initialization function\nfunction signature: *(config, result) -> void*\ninitialize any values in result with what is required\n\n",
"type": "string"
},
"itemOrder": {
"description": "item iteration order can be *\"forward\"* or *\"backward\"*\n\n",
"type": "string"
},
"maxDepth": {
"description": "ANDed with any existing filters visits only nodes in at most the given depth\n\n",
"type": "string"
},
"maxIterations": {
"description": "Maximum number of iterations in each traversal. This number can be\nset to prevent endless loops in traversal of cyclic graphs. When a traversal performs\nas many iterations as the *maxIterations* value, the traversal will abort with an\nerror. If *maxIterations* is not set, a server-defined value may be used.\n\n",
"type": "string"
},
"minDepth": {
"description": "ANDed with any existing filters):\nvisits only nodes in at least the given depth\n\n",
"type": "string"
},
"order": {
"description": "traversal order can be *\"preorder\"*, *\"postorder\"* or *\"preorder-expander\"*\n\n",
"type": "string"
},
"sort": {
"description": "body (JavaScript) code of a custom comparison function\nfor the edges. The signature of this function is\n*(l, r) -> integer* (where l and r are edges) and must\nreturn -1 if l is smaller than, +1 if l is greater than,\nand 0 if l and r are equal. The reason for this is the\nfollowing: The order of edges returned for a certain\nvertex is undefined. This is because there is no natural\norder of edges for a vertex with multiple connected edges.\nTo explicitly define the order in which edges on the\nvertex are followed, you can specify an edge comparator\nfunction with this attribute. Note that the value here has\nto be a string to conform to the JSON standard, which in\nturn is parsed as function body on the server side. Furthermore\nnote that this attribute is only used for the standard\nexpanders. If you use your custom expander you have to\ndo the sorting yourself within the expander code.\n\n",
"type": "string"
},
"startVertex": {
"description": "id of the startVertex, e.g. *\"users/foo\"*.\n\n",
"type": "string"
},
"strategy": {
"description": "traversal strategy can be *\"depthfirst\"* or *\"breadthfirst\"*\n\n",
"type": "string"
},
"uniqueness": {
"description": "specifies uniqueness for vertices and edges visited.\nIf set, must be an object like this:\n\n`\"uniqueness\": {\"vertices\": \"none\"|\"global\"|\"path\", \"edges\": \"none\"|\"global\"|\"path\"}`\n\n",
"type": "string"
},
"visitor": {
"description": "body (JavaScript) code of custom visitor function\nfunction signature: *(config, result, vertex, path, connected) -> void*\nThe visitor function can do anything, but its return value is ignored. To\npopulate a result, use the *result* variable by reference. Note that the\n*connected* argument is only populated when the *order* attribute is set\nto *\"preorder-expander\"*.\n\n",
"type": "string"
}
},
"required": [
"startVertex"
],
"type": "object",
"x-filename": "Graph Traversal - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph Traversal/HTTP_API_TRAVERSAL.md"
},
"JSA_get_api_collection_figures_rc_200": {
"properties": {
"count": {
"description": "The number of documents currently present in the collection.\n\n",
"format": "int64",
"type": "integer"
},
"figures": {
"$ref": "#/definitions/collection_figures"
},
"journalSize": {
"description": "The maximal size of a journal or datafile in bytes.\n\n",
"format": "int64",
"type": "integer"
}
},
"required": [
"count",
"journalSize"
],
"type": "object",
"x-filename": "Collections - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_load.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_rename.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/delete_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/post_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_truncate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_unload.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_rotate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_load_indexes_in_memory.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/get_api_collections.md"
},
"JSA_put_api_simple_any": {
"properties": {
"collection": {
"description": "The identifier or name of the collection to query.\n\nReturns a JSON object with the document stored in the attribute\n*document* if the collection contains at least one document. If\nthe collection is empty, the *document* attrbute contains null.\n\n",
"type": "string"
}
},
"required": [
"collection"
],
"type": "object",
"x-filename": "Simple Queries - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md"
},
"JSA_put_api_simple_by_example": {
"properties": {
"batchSize": {
"description": "maximum number of result documents to be transferred from\nthe server to the client in one roundtrip. If this attribute is\nnot set, a server-controlled default value will be used. A *batchSize* value of\n*0* is disallowed.\n\n",
"format": "int64",
"type": "integer"
},
"collection": {
"description": "The name of the collection to query.\n\n",
"type": "string"
},
"example": {
"description": "The example document.\n\n",
"type": "string"
},
"limit": {
"description": "The maximal amount of documents to return. The *skip*\nis applied before the *limit* restriction. (optional)\n\n",
"type": "string"
},
"skip": {
"description": "The number of documents to skip in the query (optional).\n\n",
"type": "string"
}
},
"required": [
"collection",
"example",
"skip",
"limit"
],
"type": "object",
"x-filename": "Simple Queries - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md"
},
"JSA_put_api_simple_first_example": {
"properties": {
"collection": {
"description": "The name of the collection to query.\n\n",
"type": "string"
},
"example": {
"description": "The example document.\n\n",
"type": "string"
}
},
"required": [
"collection",
"example"
],
"type": "object",
"x-filename": "Simple Queries - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md"
},
"JSA_put_api_simple_fulltext": {
"properties": {
"attribute": {
"description": "The attribute that contains the texts.\n\n",
"type": "string"
},
"collection": {
"description": "The name of the collection to query.\n\n",
"type": "string"
},
"index": {
"description": "The identifier of the fulltext-index to use.\n\n",
"type": "string"
},
"limit": {
"description": "The maximal amount of documents to return. The *skip*\nis applied before the *limit* restriction. (optional)\n\n",
"type": "string"
},
"query": {
"description": "The fulltext query. Please refer to [Fulltext queries](../../Manual/Appendix/Deprecated/SimpleQueries/FulltextQueries.html)\n for details.\n\n",
"type": "string"
},
"skip": {
"description": "The number of documents to skip in the query (optional).\n\n",
"type": "string"
}
},
"required": [
"collection",
"attribute",
"query",
"skip",
"limit",
"index"
],
"type": "object",
"x-filename": "Simple Queries - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md"
},
"JSA_put_api_simple_near": {
"properties": {
"collection": {
"description": "The name of the collection to query.\n\n",
"type": "string"
},
"distance": {
"description": "If given, the attribute key used to return the distance to\nthe given coordinate. (optional). If specified, distances are returned in meters.\n\n",
"type": "string"
},
"geo": {
"description": "If given, the identifier of the geo-index to use. (optional)\n\n",
"type": "string"
},
"latitude": {
"description": "The latitude of the coordinate.\n\n",
"type": "string"
},
"limit": {
"description": "The maximal amount of documents to return. The *skip* is\napplied before the *limit* restriction. The default is 100. (optional)\n\n",
"type": "string"
},
"longitude": {
"description": "The longitude of the coordinate.\n\n",
"type": "string"
},
"skip": {
"description": "The number of documents to skip in the query. (optional)\n\n",
"type": "string"
}
},
"required": [
"collection",
"latitude",
"longitude",
"distance",
"skip",
"limit",
"geo"
],
"type": "object",
"x-filename": "Simple Queries - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md"
},
"JSA_put_api_simple_range": {
"properties": {
"attribute": {
"description": "The attribute path to check.\n\n",
"type": "string"
},
"closed": {
"description": "If *true*, use interval including *left* and *right*,\notherwise exclude *right*, but include *left*.\n\n",
"format": "",
"type": "boolean"
},
"collection": {
"description": "The name of the collection to query.\n\n",
"type": "string"
},
"left": {
"description": "The lower bound.\n\n",
"type": "string"
},
"limit": {
"description": "The maximal amount of documents to return. The *skip*\nis applied before the *limit* restriction. (optional)\n\n",
"format": "int64",
"type": "integer"
},
"right": {
"description": "The upper bound.\n\n",
"type": "string"
},
"skip": {
"description": "The number of documents to skip in the query (optional).\n\n",
"type": "string"
}
},
"required": [
"collection",
"attribute",
"left",
"right",
"closed",
"skip"
],
"type": "object",
"x-filename": "Simple Queries - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md"
},
"JSA_put_api_simple_remove_by_example": {
"properties": {
"collection": {
"description": "The name of the collection to remove from.\n\n",
"type": "string"
},
"example": {
"description": "An example document that all collection documents are compared against.\n\n",
"type": "string"
},
"options": {
"$ref": "#/definitions/put_api_simple_remove_by_example_opts"
}
},
"required": [
"collection",
"example"
],
"type": "object",
"x-filename": "Simple Queries - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md"
},
"JSA_put_api_simple_replace_by_example": {
"properties": {
"collection": {
"description": "The name of the collection to replace within.\n\n",
"type": "string"
},
"example": {
"description": "An example document that all collection documents are compared against.\n\n",
"type": "string"
},
"newValue": {
"description": "The replacement document that will get inserted in place\nof the \"old\" documents.\n\n",
"type": "string"
},
"options": {
"$ref": "#/definitions/put_api_simple_replace_by_example_options"
}
},
"required": [
"collection",
"example",
"newValue"
],
"type": "object",
"x-filename": "Simple Queries - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md"
},
"JSA_put_api_simple_update_by_example": {
"properties": {
"collection": {
"description": "The name of the collection to update within.\n\n",
"type": "string"
},
"example": {
"description": "An example document that all collection documents are compared against.\n\n",
"type": "string"
},
"newValue": {
"additionalProperties": {},
"description": "A document containing all the attributes to update in the found documents.\n\n",
"type": "object"
},
"options": {
"$ref": "#/definitions/put_api_simple_update_by_example_options"
}
},
"required": [
"collection",
"example",
"newValue"
],
"type": "object",
"x-filename": "Simple Queries - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md"
},
"JSA_put_api_simple_within": {
"properties": {
"collection": {
"description": "The name of the collection to query.\n\n",
"type": "string"
},
"distance": {
"description": "If given, the attribute key used to return the distance to\nthe given coordinate. (optional). If specified, distances are returned in meters.\n\n",
"type": "string"
},
"geo": {
"description": "If given, the identifier of the geo-index to use. (optional)\n\n",
"type": "string"
},
"latitude": {
"description": "The latitude of the coordinate.\n\n",
"type": "string"
},
"limit": {
"description": "The maximal amount of documents to return. The *skip* is\napplied before the *limit* restriction. The default is 100. (optional)\n\n",
"type": "string"
},
"longitude": {
"description": "The longitude of the coordinate.\n\n",
"type": "string"
},
"radius": {
"description": "The maximal radius (in meters).\n\n",
"type": "string"
},
"skip": {
"description": "The number of documents to skip in the query. (optional)\n\n",
"type": "string"
}
},
"required": [
"collection",
"latitude",
"longitude",
"radius",
"distance",
"skip",
"limit",
"geo"
],
"type": "object",
"x-filename": "Simple Queries - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md"
},
"JSA_put_api_simple_within_rectangle": {
"properties": {
"collection": {
"description": "The name of the collection to query.\n\n",
"type": "string"
},
"geo": {
"description": "If given, the identifier of the geo-index to use. (optional)\n\n",
"type": "string"
},
"latitude1": {
"description": "The latitude of the first rectangle coordinate.\n\n",
"type": "string"
},
"latitude2": {
"description": "The latitude of the second rectangle coordinate.\n\n",
"type": "string"
},
"limit": {
"description": "The maximal amount of documents to return. The *skip* is\napplied before the *limit* restriction. The default is 100. (optional)\n\n",
"type": "string"
},
"longitude1": {
"description": "The longitude of the first rectangle coordinate.\n\n",
"type": "string"
},
"longitude2": {
"description": "The longitude of the second rectangle coordinate.\n\n",
"type": "string"
},
"skip": {
"description": "The number of documents to skip in the query. (optional)\n\n",
"type": "string"
}
},
"required": [
"collection",
"latitude1",
"longitude1",
"latitude2",
"longitude2",
"skip",
"limit",
"geo"
],
"type": "object",
"x-filename": "Simple Queries - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md"
},
"PostApiQueryProperties": {
"properties": {
"query": {
"description": "To validate a query string without executing it, the query string can be\npassed to the server via an HTTP POST request.\n\n",
"type": "string"
}
},
"required": [
"query"
],
"type": "object",
"x-filename": "AQL - /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/get_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/post_api_explain.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/post_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/delete_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md"
},
"PutApiQueryCacheProperties": {
"properties": {
"maxResults": {
"description": "the maximum number of query results that will be stored per database-specific cache.\n\n\n",
"format": "int64",
"type": "integer"
},
"mode": {
"description": " the mode the AQL query cache should operate in. Possible values are *off*, *on* or *demand*.\n\n",
"type": "string"
}
},
"required": [
"mode",
"maxResults"
],
"type": "object",
"x-filename": "AQL - /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/get_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/post_api_explain.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/post_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/delete_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md"
},
"PutApiQueryProperties": {
"properties": {
"enabled": {
"description": "If set to *true*, then queries will be tracked. If set to\n*false*, neither queries nor slow queries will be tracked.\n\n",
"format": "",
"type": "boolean"
},
"maxQueryStringLength": {
"description": "The maximum query string length to keep in the list of queries.\nQuery strings can have arbitrary lengths, and this property\ncan be used to save memory in case very long query strings are used. The\nvalue is specified in bytes.\n\n",
"format": "int64",
"type": "integer"
},
"maxSlowQueries": {
"description": "The maximum number of slow queries to keep in the list\nof slow queries. If the list of slow queries is full, the oldest entry in\nit will be discarded when additional slow queries occur.\n\n",
"format": "int64",
"type": "integer"
},
"slowQueryThreshold": {
"description": "The threshold value for treating a query as slow. A\nquery with a runtime greater or equal to this threshold value will be\nput into the list of slow queries when slow query tracking is enabled.\nThe value for *slowQueryThreshold* is specified in seconds.\n\n",
"format": "int64",
"type": "integer"
},
"trackBindVars": {
"description": "If set to *true*, then the bind variables used in queries will be tracked \nalong with queries.\n\n",
"format": "",
"type": "boolean"
},
"trackSlowQueries": {
"description": "If set to *true*, then slow queries will be tracked\nin the list of slow queries if their runtime exceeds the value set in\n*slowQueryThreshold*. In order for slow queries to be tracked, the *enabled*\nproperty must also be set to *true*.\n\n",
"format": "",
"type": "boolean"
}
},
"required": [
"enabled",
"trackSlowQueries",
"trackBindVars",
"maxSlowQueries",
"slowQueryThreshold",
"maxQueryStringLength"
],
"type": "object",
"x-filename": "AQL - /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/get_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/post_api_explain.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/post_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/delete_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md"
},
"REST_DOCUMENT_READ_ALL": {
"properties": {
"collection": {
"description": "The name of the collection. This is only for backward compatibility.\nIn ArangoDB versions < 3.0, the URL path was */_api/document* and\nthis was passed in via the query parameter \"collection\".\nThis combination was removed.\n\n",
"type": "string"
},
"type": {
"description": "The type of the result. The following values are allowed:\n\n - *id*: returns an array of document ids (*_id* attributes)\n - *key*: returns an array of document keys (*_key* attributes)\n - *path*: returns an array of document URI paths. This is the default.\n\n",
"type": "string"
}
},
"type": "object",
"x-filename": "Documents - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_HEAD.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_CREATE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE_MULTI.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_ALL.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE_MULTI.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE_MULTI.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ.md"
},
"RestLookupByKeys": {
"properties": {
"collection": {
"description": "The name of the collection to look in for the documents\n\n",
"type": "string"
},
"keys": {
"description": "array with the _keys of documents to remove.\n\n",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"collection",
"keys"
],
"type": "object",
"x-filename": "Simple Queries - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md"
},
"RestRemoveByKeys": {
"properties": {
"collection": {
"description": "The name of the collection to look in for the documents to remove\n\n",
"type": "string"
},
"keys": {
"description": "array with the _keys of documents to remove.\n\n",
"items": {
"type": "string"
},
"type": "array"
},
"options": {
"$ref": "#/definitions/put_api_simple_remove_by_keys_opts"
}
},
"required": [
"collection",
"keys"
],
"type": "object",
"x-filename": "Simple Queries - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md"
},
"UserHandling_create": {
"properties": {
"active": {
"description": "An optional flag that specifies whether the user is active. If not\nspecified, this will default to true\n\n",
"format": "boolean",
"type": "boolean"
},
"extra": {
"additionalProperties": {},
"description": "An optional JSON object with arbitrary extra data about the user.\n\n",
"type": "object"
},
"passwd": {
"description": "The user password as a string. If no password is specified, the empty string\nwill be used. If you pass the special value *ARANGODB_DEFAULT_ROOT_PASSWORD*,\nthen the password will be set the value stored in the environment variable\n`ARANGODB_DEFAULT_ROOT_PASSWORD`. This can be used to pass an instance\nvariable into ArangoDB. For example, the instance identifier from Amazon.\n\n",
"type": "string"
},
"user": {
"description": "The name of the user as a string. This is mandatory.\n\n",
"type": "string"
}
},
"required": [
"user",
"passwd"
],
"type": "object",
"x-filename": "User Management - /home/willi/src/devel/Documentation/DocuBlocks/Rest/User Management/README.md"
},
"UserHandling_grantCollection": {
"properties": {
"grant": {
"description": "Use \"rw\" to set the collection level access to *Read/Write*.\n\nUse \"ro\" to set the collection level access to *Read Only*.\n\nUse \"none\" to set the collection level access to *No access*.\n\n",
"type": "string"
}
},
"required": [
"grant"
],
"type": "object",
"x-filename": "User Management - /home/willi/src/devel/Documentation/DocuBlocks/Rest/User Management/README.md"
},
"UserHandling_grantDatabase": {
"properties": {
"grant": {
"description": "Use \"rw\" to set the database access level to *Administrate* .\n\nUse \"ro\" to set the database access level to *Access*.\n\nUse \"none\" to set the database access level to *No access*.\n\n",
"type": "string"
}
},
"required": [
"grant"
],
"type": "object",
"x-filename": "User Management - /home/willi/src/devel/Documentation/DocuBlocks/Rest/User Management/README.md"
},
"UserHandling_modify": {
"properties": {
"active": {
"description": "An optional flag that specifies whether the user is active. If not\nspecified, this will default to true\n\n",
"format": "boolean",
"type": "boolean"
},
"extra": {
"additionalProperties": {},
"description": "An optional JSON object with arbitrary extra data about the user.\n\n",
"type": "object"
},
"passwd": {
"description": "The user password as a string. Specifying a password is mandatory, but\nthe empty string is allowed for passwords\n\n",
"type": "string"
}
},
"required": [
"passwd"
],
"type": "object",
"x-filename": "User Management - /home/willi/src/devel/Documentation/DocuBlocks/Rest/User Management/README.md"
},
"UserHandling_replace": {
"properties": {
"active": {
"description": "An optional flag that specifies whether the user is active. If not\nspecified, this will default to true\n\n",
"format": "boolean",
"type": "boolean"
},
"extra": {
"additionalProperties": {},
"description": "An optional JSON object with arbitrary extra data about the user.\n\n",
"type": "object"
},
"passwd": {
"description": "The user password as a string. Specifying a password is mandatory, but\nthe empty string is allowed for passwords\n\n",
"type": "string"
}
},
"required": [
"passwd"
],
"type": "object",
"x-filename": "User Management - /home/willi/src/devel/Documentation/DocuBlocks/Rest/User Management/README.md"
},
"aql_userfunction_struct": {
"description": "",
"properties": {
"code": {
"description": "A string representation of the function body\n\n",
"type": "string"
},
"isDeterministic": {
"description": "an optional boolean value to indicate whether the function\nresults are fully deterministic (function return value solely depends on\nthe input value and return value is the same for repeated calls with same\ninput). The *isDeterministic* attribute is currently not used but may be\nused later for optimisations.\n\n\n",
"type": "boolean"
},
"name": {
"description": "The fully qualified name of the user function\n\n",
"type": "string"
}
},
"type": "object"
},
"collection_figures": {
"description": "metrics of the collection\n\n",
"properties": {
"alive": {
"$ref": "#/definitions/collection_figures_alive"
},
"compactionStatus": {
"$ref": "#/definitions/compactionStatus_attributes"
},
"compactors": {
"$ref": "#/definitions/collection_figures_compactors"
},
"datafiles": {
"$ref": "#/definitions/collection_figures_datafiles"
},
"dead": {
"$ref": "#/definitions/collection_figures_dead"
},
"documentReferences": {
"description": "The number of references to documents in datafiles that JavaScript code \ncurrently holds. This information can be used for debugging compaction and \nunload issues.\n\n",
"format": "int64",
"type": "integer"
},
"indexes": {
"$ref": "#/definitions/collection_figures_indexes"
},
"journals": {
"$ref": "#/definitions/collection_figures_journals"
},
"lastTick": {
"description": "The tick of the last marker that was stored in a journal\nof the collection. This might be 0 if the collection does not yet have\na journal.\n\n",
"format": "int64",
"type": "integer"
},
"readcache": {
"$ref": "#/definitions/collection_figures_readcache"
},
"revisions": {
"$ref": "#/definitions/collection_figures_revisions"
},
"uncollectedLogfileEntries": {
"description": "The number of markers in the write-ahead\nlog for this collection that have not been transferred to journals or datafiles.\n\n",
"format": "int64",
"type": "integer"
},
"waitingFor": {
"description": "An optional string value that contains information about which object type is at the \nhead of the collection's cleanup queue. This information can be used for debugging \ncompaction and unload issues.\n\n",
"type": "string"
}
},
"required": [
"figures",
"alive",
"dead",
"datafiles",
"journals",
"compactors",
"readcache",
"revisions",
"indexes"
],
"type": "object",
"x-filename": "Collections - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_load.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_rename.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/delete_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/post_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_truncate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_unload.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_rotate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_load_indexes_in_memory.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/get_api_collections.md"
},
"collection_figures_alive": {
"description": "the currently active figures\n\n",
"properties": {
"count": {
"description": "The number of currently active documents in all datafiles\nand journals of the collection. Documents that are contained in the\nwrite-ahead log only are not reported in this figure.\n\n",
"format": "int64",
"type": "integer"
},
"size": {
"description": "The total size in bytes used by all active documents of\nthe collection. Documents that are contained in the write-ahead log only are\nnot reported in this figure.\n\n",
"format": "int64",
"type": "integer"
}
},
"type": "object",
"x-filename": "Collections - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_load.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_rename.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/delete_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/post_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_truncate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_unload.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_rotate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_load_indexes_in_memory.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/get_api_collections.md"
},
"collection_figures_compactors": {
"description": "\n",
"properties": {
"count": {
"description": "The number of compactor files.\n\n",
"format": "int64",
"type": "integer"
},
"fileSize": {
"description": "The total filesize of all compactor files (in bytes).\n\n",
"format": "int64",
"type": "integer"
}
},
"type": "object",
"x-filename": "Collections - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_load.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_rename.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/delete_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/post_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_truncate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_unload.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_rotate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_load_indexes_in_memory.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/get_api_collections.md"
},
"collection_figures_datafiles": {
"description": "Metrics regarding the datafiles\n\n",
"properties": {
"count": {
"description": "The number of datafiles.\n\n",
"format": "int64",
"type": "integer"
},
"fileSize": {
"description": "The total filesize of datafiles (in bytes).\n\n",
"format": "int64",
"type": "integer"
}
},
"type": "object",
"x-filename": "Collections - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_load.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_rename.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/delete_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/post_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_truncate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_unload.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_rotate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_load_indexes_in_memory.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/get_api_collections.md"
},
"collection_figures_dead": {
"description": "the items waiting to be swept away by the cleaner\n\n",
"properties": {
"count": {
"description": "The number of dead documents. This includes document\nversions that have been deleted or replaced by a newer version. Documents\ndeleted or replaced that are contained the write-ahead log only are not reported\nin this figure.\n\n",
"format": "int64",
"type": "integer"
},
"deletion": {
"description": "The total number of deletion markers. Deletion markers\nonly contained in the write-ahead log are not reporting in this figure.\n\n",
"format": "int64",
"type": "integer"
},
"size": {
"description": "The total size in bytes used by all dead documents.\n\n",
"format": "int64",
"type": "integer"
}
},
"type": "object",
"x-filename": "Collections - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_load.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_rename.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/delete_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/post_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_truncate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_unload.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_rotate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_load_indexes_in_memory.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/get_api_collections.md"
},
"collection_figures_indexes": {
"description": "",
"properties": {
"count": {
"description": "The total number of indexes defined for the collection, including the pre-defined\nindexes (e.g. primary index).\n\n",
"format": "int64",
"type": "integer"
},
"size": {
"description": "The total memory allocated for indexes in bytes.\n\n",
"format": "int64",
"type": "integer"
}
},
"type": "object",
"x-filename": "Collections - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_load.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_rename.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/delete_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/post_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_truncate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_unload.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_rotate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_load_indexes_in_memory.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/get_api_collections.md"
},
"collection_figures_journals": {
"description": "Metrics regarding the journal files\n\n",
"properties": {
"count": {
"description": "The number of journal files.\n\n",
"format": "int64",
"type": "integer"
},
"fileSize": {
"description": "The total filesize of all journal files (in bytes).\n\n",
"format": "int64",
"type": "integer"
}
},
"type": "object",
"x-filename": "Collections - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_load.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_rename.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/delete_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/post_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_truncate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_unload.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_rotate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_load_indexes_in_memory.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/get_api_collections.md"
},
"collection_figures_readcache": {
"description": "\n",
"properties": {
"count": {
"description": "The number of revisions of this collection stored in the document revisions cache.\n\n",
"format": "int64",
"type": "integer"
},
"size": {
"description": "The memory used for storing the revisions of this collection in the document \nrevisions cache (in bytes). This figure does not include the document data but \nonly mappings from document revision ids to cache entry locations.\n\n",
"format": "int64",
"type": "integer"
}
},
"type": "object",
"x-filename": "Collections - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_load.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_rename.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/delete_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/post_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_truncate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_unload.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_rotate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_load_indexes_in_memory.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/get_api_collections.md"
},
"collection_figures_revisions": {
"description": "\n",
"properties": {
"count": {
"description": "The number of revisions of this collection managed by the storage engine.\n\n",
"format": "int64",
"type": "integer"
},
"size": {
"description": "The memory used for storing the revisions of this collection in the storage \nengine (in bytes). This figure does not include the document data but only mappings \nfrom document revision ids to storage engine datafile positions.\n\n",
"format": "int64",
"type": "integer"
}
},
"type": "object",
"x-filename": "Collections - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_load.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_rename.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/delete_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/post_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_truncate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_unload.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_rotate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_load_indexes_in_memory.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/get_api_collections.md"
},
"compactionStatus_attributes": {
"description": "",
"properties": {
"message": {
"description": "The action that was performed when the compaction was last run for the collection. \nThis information can be used for debugging compaction issues.\n\n",
"type": "string"
},
"time": {
"description": "The point in time the compaction for the collection was last executed. \nThis information can be used for debugging compaction issues.\n\n",
"type": "string"
}
},
"type": "object",
"x-filename": "Collections - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_load.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_rename.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/delete_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/post_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_truncate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_unload.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_rotate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_load_indexes_in_memory.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/get_api_collections.md"
},
"delete_api_aqlfunction_rc_200": {
"properties": {
"code": {
"description": "the HTTP status code\n\n",
"format": "int64",
"type": "integer"
},
"deletedCount": {
"description": "The number of deleted user functions, always `1` when `group` is set to *false*. \nAny number `>= 0` when `group` is set to *true*\n\n\n",
"format": "int64",
"type": "integer"
},
"error": {
"description": "boolean flag to indicate whether an error occurred (*false* in this case)\n\n",
"format": "",
"type": "boolean"
}
},
"required": [
"error",
"code",
"deletedCount"
],
"type": "object",
"x-filename": "AQL - /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/get_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/post_api_explain.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/post_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/delete_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md"
},
"delete_api_aqlfunction_rc_400": {
"properties": {
"code": {
"description": "the HTTP status code\n\n",
"format": "int64",
"type": "integer"
},
"error": {
"description": "boolean flag to indicate whether an error occurred (*true* in this case)\n\n",
"format": "",
"type": "boolean"
},
"errorMessage": {
"description": "a descriptive error message\n\n\n",
"type": "string"
},
"errorNum": {
"description": "the server error number\n\n",
"format": "int64",
"type": "integer"
}
},
"required": [
"error",
"code",
"errorNum",
"errorMessage"
],
"type": "object",
"x-filename": "AQL - /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/get_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/post_api_explain.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/post_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/delete_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md"
},
"delete_api_aqlfunction_rc_404": {
"properties": {
"code": {
"description": "the HTTP status code\n\n",
"format": "int64",
"type": "integer"
},
"error": {
"description": "boolean flag to indicate whether an error occurred (*true* in this case)\n\n",
"format": "",
"type": "boolean"
},
"errorMessage": {
"description": "a descriptive error message\n\n\n",
"type": "string"
},
"errorNum": {
"description": "the server error number\n\n",
"format": "int64",
"type": "integer"
}
},
"required": [
"error",
"code",
"errorNum",
"errorMessage"
],
"type": "object",
"x-filename": "AQL - /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/get_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/post_api_explain.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/post_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/delete_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md"
},
"explain_options": {
"description": "Options for the query\n\n",
"properties": {
"allPlans": {
"description": "if set to *true*, all possible execution plans will be returned.\nThe default is *false*, meaning only the optimal plan will be returned.\n\n",
"type": "boolean"
},
"maxNumberOfPlans": {
"description": "an optional maximum number of plans that the optimizer is \nallowed to generate. Setting this attribute to a low value allows to put a\ncap on the amount of work the optimizer does.\n\n",
"format": "int64",
"type": "integer"
},
"optimizer.rules": {
"description": "an array of to-be-included or to-be-excluded optimizer rules\ncan be put into this attribute, telling the optimizer to include or exclude\nspecific rules. To disable a rule, prefix its name with a `-`, to enable a rule, prefix it\nwith a `+`. There is also a pseudo-rule `all`, which will match all optimizer rules.\n\n",
"format": "string",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object",
"x-filename": "AQL - /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/get_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/post_api_explain.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/post_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/delete_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md"
},
"general_graph_create_http_examples": {
"properties": {
"edgeDefinitions": {
"description": "An array of definitions for the edge\n\n",
"type": "string"
},
"isSmart": {
"description": "Define if the created graph should be smart.\nThis only has effect in Enterprise version.\n\n",
"format": "boolean",
"type": "boolean"
},
"name": {
"description": "Name of the graph.\n\n",
"type": "string"
},
"options": {
"$ref": "#/definitions/post_api_gharial_create_opts"
},
"orphanCollections": {
"description": "An array of additional vertex collections.\n\n",
"type": "string"
}
},
"required": [
"name"
],
"type": "object",
"x-filename": "Graph - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_list_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_definition_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_list_edge_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_replace_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_collection_add_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_replace_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_collection_remove_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_delete_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_definition_remove_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_delete_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_list_vertex_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_definition_add_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_drop_http_examples.md"
},
"general_graph_edge_definition_add_http_examples": {
"properties": {
"collection": {
"description": "The name of the edge collection to be used.\n\n",
"type": "string"
},
"from": {
"description": "One or many vertex collections that can contain source vertices.\n\n",
"items": {
"type": "string"
},
"type": "array"
},
"to": {
"description": "One or many vertex collections that can contain target vertices.\n\n",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"collection",
"from",
"to"
],
"type": "object",
"x-filename": "Graph - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_list_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_definition_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_list_edge_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_replace_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_collection_add_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_replace_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_collection_remove_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_delete_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_definition_remove_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_delete_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_list_vertex_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_definition_add_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_drop_http_examples.md"
},
"general_graph_edge_definition_modify_http_examples": {
"properties": {
"collection": {
"description": "The name of the edge collection to be used.\n\n",
"type": "string"
},
"from": {
"description": "One or many vertex collections that can contain source vertices.\n\n",
"items": {
"type": "string"
},
"type": "array"
},
"to": {
"description": "One or many vertex collections that can contain target vertices.\n\n",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"collection",
"from",
"to"
],
"type": "object",
"x-filename": "Graph - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_list_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_definition_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_list_edge_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_replace_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_collection_add_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_replace_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_collection_remove_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_delete_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_definition_remove_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_delete_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_list_vertex_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_definition_add_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_drop_http_examples.md"
},
"get_admin_log_rc_200": {
"properties": {
"level": {
"description": "A list of the loglevels for all log entries.\n\n",
"type": "string"
},
"lid": {
"description": "a list of log entry identifiers. Each log message is uniquely\nidentified by its @LIT{lid} and the identifiers are in ascending\norder.\n\n",
"items": {
"type": "string"
},
"type": "array"
},
"text": {
"description": "a list of the texts of all log entries\n\n",
"type": "string"
},
"timestamp": {
"description": "a list of the timestamps as seconds since 1970-01-01 for all log\nentries.\n\n",
"items": {
"type": "string"
},
"type": "array"
},
"topic": {
"description": "a list of the topics of all log entries\n\n",
"type": "string"
},
"totalAmount": {
"description": "the total amount of log entries before pagination.\n\n",
"format": "int64",
"type": "integer"
}
},
"required": [
"lid",
"level",
"timestamp",
"text",
"topic",
"totalAmount"
],
"type": "object",
"x-filename": "Administration - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_long_echo.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_statistics_description.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_time.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_tasks_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_server_role.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_database_version.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_statistics.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_modules_flush.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_server_id.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_cluster_endpoints.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_return.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_endpoint.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/post_admin_execute.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/post_admin_test.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/put_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_initiate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/post_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_engine.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/delete_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_echo.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_routing_reloads.md"
},
"get_api_aqlfunction_rc_200": {
"properties": {
"code": {
"description": "the HTTP status code\n\n",
"format": "int64",
"type": "integer"
},
"error": {
"description": "boolean flag to indicate whether an error occurred (*false* in this case)\n\n",
"format": "",
"type": "boolean"
},
"result": {
"description": "All functions, or the ones matching the *namespace* parameter \n\n",
"items": {
"$ref": "#/definitions/aql_userfunction_struct"
},
"type": "array"
}
},
"required": [
"error",
"code",
"result"
],
"type": "object",
"x-filename": "AQL - /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/get_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/post_api_explain.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/post_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/delete_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md"
},
"get_api_aqlfunction_rc_400": {
"properties": {
"code": {
"description": "the HTTP status code\n\n",
"format": "int64",
"type": "integer"
},
"error": {
"description": "boolean flag to indicate whether an error occurred (*true* in this case)\n\n",
"format": "",
"type": "boolean"
},
"errorMessage": {
"description": "a descriptive error message\n\n\n",
"type": "string"
},
"errorNum": {
"description": "the server error number\n\n",
"format": "int64",
"type": "integer"
}
},
"required": [
"error",
"code",
"errorNum",
"errorMessage"
],
"type": "object",
"x-filename": "AQL - /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/get_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/post_api_explain.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/post_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/delete_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md"
},
"get_api_database_new": {
"properties": {
"name": {
"description": "Has to contain a valid database name.\n\n",
"type": "string"
},
"users": {
"description": "Has to be an array of user objects to initially create for the new database.\nUser information will not be changed for users that already exist.\nIf *users* is not specified or does not contain any users, a default user\n*root* will be created with an empty string password. This ensures that the\nnew database will be accessible after it is created.\nEach user object can contain the following attributes:\n\n",
"items": {
"$ref": "#/definitions/get_api_database_new_USERS"
},
"type": "array"
}
},
"required": [
"name"
],
"type": "object",
"x-filename": "Database - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Database/get_api_database_new.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Database/get_api_database_user.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Database/get_api_database_delete.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Database/get_api_database_current.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Database/get_api_database_list.md"
},
"get_api_database_new_USERS": {
"description": "",
"properties": {
"active": {
"description": "A flag indicating whether the user account should be activated or not.\nThe default value is *true*. If set to *false*, the user won't be able to\nlog into the database.\n\n",
"type": "boolean"
},
"extra": {
"description": "A JSON object with extra user information. The data contained in *extra*\nwill be stored for the user but not be interpreted further by ArangoDB.\n\n",
"format": "",
"type": "object"
},
"passwd": {
"description": "The user password as a string. If not specified, it will default to an empty string.\n\n",
"type": "string"
},
"username": {
"description": "Loginname of the user to be created\n\n",
"type": "string"
}
},
"type": "object"
},
"get_api_return_rc_200": {
"properties": {
"details": {
"additionalProperties": {},
"description": "an optional JSON object with additional details. This is\nreturned only if the *details* query parameter is set to *true* in the\nrequest.\n\n",
"type": "object"
},
"server": {
"description": "will always contain *arango*\n\n",
"type": "string"
},
"version": {
"description": "the server version string. The string has the format\n\"*major*.*minor*.*sub*\". *major* and *minor* will be numeric, and *sub*\nmay contain a number or a textual version.\n\n",
"type": "string"
}
},
"required": [
"server",
"version"
],
"type": "object",
"x-filename": "Administration - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_long_echo.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_statistics_description.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_time.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_tasks_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_server_role.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_database_version.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_statistics.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_modules_flush.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_server_id.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_cluster_endpoints.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_return.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_endpoint.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/post_admin_execute.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/post_admin_test.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/put_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_initiate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/post_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_engine.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/delete_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_echo.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_routing_reloads.md"
},
"get_engine_rc_200": {
"properties": {
"name": {
"description": "will be *mmfiles* or *rocksdb*\n\n",
"type": "string"
}
},
"required": [
"name"
],
"type": "object",
"x-filename": "Administration - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_long_echo.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_statistics_description.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_time.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_tasks_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_server_role.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_database_version.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_statistics.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_modules_flush.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_server_id.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_cluster_endpoints.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_return.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_endpoint.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/post_admin_execute.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/post_admin_test.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/put_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_initiate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/post_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_engine.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/delete_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_echo.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_routing_reloads.md"
},
"patch_api_view_link_props": {
"description": "The link properties. If specified, then *properties*\nshould be a JSON object containing the following attributes:\n\n",
"properties": {
"[field-name]": {
"$ref": "#/definitions/patch_api_view_link_props_field_props"
},
"analyzers": {
"description": "The list of analyzers to be used for indexing of string values (default: [\"identity\"]).\n\n",
"format": "string",
"items": {
"type": "string"
},
"type": "array"
},
"includeAllFields": {
"description": "The flag determines whether or not to index all fields on a particular level of depth (default: false).\n\n",
"type": "boolean"
},
"trackListPositions": {
"description": "The flag determines whether or not values in a lists should be treated separate (default: false).\n\n",
"type": "boolean"
}
},
"type": "object",
"x-filename": "Views - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/put_api_view_properties_iresearch.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/JSA_get_api_view_name.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/get_api_views.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/post_api_view_iresearch.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/patch_api_view_properties_iresearch.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/put_api_view_rename.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/delete_api_view.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/JSA_get_api_view_properties.md"
},
"patch_api_view_link_props_field_props": {
"description": "The field properties. If specified, then *properties*\nshould be a JSON object containing the following attributes:\n\n",
"properties": {
"[field-name]": {
"description": "Specify properties for nested fields here\n\n",
"type": "string"
},
"analyzers": {
"description": "The list of analyzers to be used for indexing of string values (default: [\"identity\"]).\n\n",
"format": "string",
"items": {
"type": "string"
},
"type": "array"
},
"includeAllFields": {
"description": "The flag determines whether or not to index all fields on a particular level of depth (default: false).\n\n",
"type": "boolean"
},
"trackListPositions": {
"description": "The flag determines whether or not values in a lists should be treated separate (default: false).\n\n",
"type": "boolean"
}
},
"type": "object",
"x-filename": "Views - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/put_api_view_properties_iresearch.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/JSA_get_api_view_name.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/get_api_views.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/post_api_view_iresearch.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/patch_api_view_properties_iresearch.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/put_api_view_rename.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/delete_api_view.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/JSA_get_api_view_properties.md"
},
"patch_api_view_links": {
"description": "The set of collection names associated with the properties.\n\n",
"properties": {
"collection-name": {
"$ref": "#/definitions/patch_api_view_link_props"
}
},
"type": "object",
"x-filename": "Views - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/put_api_view_properties_iresearch.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/JSA_get_api_view_name.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/get_api_views.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/post_api_view_iresearch.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/patch_api_view_properties_iresearch.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/put_api_view_rename.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/delete_api_view.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/JSA_get_api_view_properties.md"
},
"patch_api_view_properties_iresearch": {
"properties": {
"commit": {
"$ref": "#/definitions/patch_api_view_props_commit"
},
"dataPath": {
"description": "The filesystem path where to store persisted index data (default: *\"<ArangoDB database path>/iresearch-<index id>\"*).\n\n",
"type": "string"
},
"links": {
"$ref": "#/definitions/patch_api_view_links"
},
"locale": {
"description": "The default locale used for queries on analyzed string values (default: *C*).\n\n",
"type": "string"
},
"threadMaxIdle": {
"description": "Maximum idle number of threads for single-run tasks (default: 5).\nFor the case where there are a lot of short-lived asynchronous tasks, a lower value will cause a lot of thread creation/deletion calls.\nFor the case where there are no short-lived asynchronous tasks, a higher value will only waste memory.\n\n",
"format": "uint64",
"type": "integer"
},
"threadMaxTotal": {
"description": "Maximum total number of threads (>0) for single-run tasks (default: 5).\nFor the case where there are a lot of parallelizable tasks and an abundance of resources, a lower value would limit performance.\nFor the case where there are limited resources CPU/memory, a higher value will negatively impact performance.\n\n",
"format": "uint64",
"type": "integer"
}
},
"type": "object",
"x-filename": "Views - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/put_api_view_properties_iresearch.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/JSA_get_api_view_name.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/get_api_views.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/post_api_view_iresearch.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/patch_api_view_properties_iresearch.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/put_api_view_rename.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/delete_api_view.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/JSA_get_api_view_properties.md"
},
"patch_api_view_props_commit": {
"description": "Commit options for regular operations.\n\n",
"properties": {
"commitIntervalMsec": {
"description": "Wait at least this many milliseconds between committing index data changes and\nmaking them visible to queries (default: 60000, to disable use: 0).\nFor the case where there are a lot of inserts/updates, a lower value, until commit, will cause the index not to account for them and\nmemory usage would continue to grow.\nFor the case where there are a few inserts/updates, a higher value will impact performance and waste disk space for each\ncommit call without any added benefits.\n\n",
"format": "uint64",
"type": "integer"
},
"consolidate": {
"$ref": "#/definitions/patch_api_view_props_consolidation"
}
},
"type": "object",
"x-filename": "Views - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/put_api_view_properties_iresearch.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/JSA_get_api_view_name.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/get_api_views.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/post_api_view_iresearch.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/patch_api_view_properties_iresearch.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/put_api_view_rename.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/delete_api_view.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/JSA_get_api_view_properties.md"
},
"patch_api_view_props_consolidation": {
"description": "\n",
"properties": {
"bytes": {
"$ref": "#/definitions/patch_api_view_props_consolidation_bytes"
},
"bytes_accum": {
"$ref": "#/definitions/patch_api_view_props_consolidation_bytes_accum"
},
"count": {
"$ref": "#/definitions/patch_api_view_props_consolidation_count"
},
"fill": {
"$ref": "#/definitions/patch_api_view_props_consolidation_fill"
}
},
"type": "object"
},
"patch_api_view_props_consolidation_bytes": {
"description": "Use empty object for default values, i.e. {}\n\n",
"properties": {
"segmentThreshold": {
"description": "Apply consolidation policy IFF {segmentThreshold} >= #segments (default: 300, to disable use: 0)\n\n",
"format": "uint64",
"type": "integer"
},
"threshold": {
"description": "Consolidate IFF {threshold} > segment_bytes / (all_segment_bytes / #segments) (default: 0.85)\n\n",
"format": "uint64",
"type": "integer"
}
},
"type": "object",
"x-filename": "Views - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/put_api_view_properties_iresearch.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/JSA_get_api_view_name.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/get_api_views.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/post_api_view_iresearch.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/patch_api_view_properties_iresearch.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/put_api_view_rename.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/delete_api_view.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/JSA_get_api_view_properties.md"
},
"patch_api_view_props_consolidation_bytes_accum": {
"description": "Use empty object for default values, i.e. {}\n\n",
"properties": {
"segmentThreshold": {
"description": "Apply consolidation policy IFF {segmentThreshold} >= #segments (default: 300, to disable use: 0)\n\n",
"format": "uint64",
"type": "integer"
},
"threshold": {
"description": "Consolidate IFF {threshold} > (segment_bytes + sum_of_merge_candidate_segment_bytes) / all_segment_bytes (default: 0.85)\n\n",
"format": "uint64",
"type": "integer"
}
},
"type": "object",
"x-filename": "Views - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/put_api_view_properties_iresearch.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/JSA_get_api_view_name.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/get_api_views.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/post_api_view_iresearch.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/patch_api_view_properties_iresearch.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/put_api_view_rename.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/delete_api_view.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/JSA_get_api_view_properties.md"
},
"patch_api_view_props_consolidation_count": {
"description": "Use empty object for default values, i.e. {}\n\n",
"properties": {
"segmentThreshold": {
"description": "Apply consolidation policy IFF {segmentThreshold} >= #segments (default: 300, to disable use: 0)\n\n",
"format": "uint64",
"type": "integer"
},
"threshold": {
"description": "Consolidate IFF {threshold} > segment_docs{valid} / (all_segment_docs{valid} / #segments) (default: 0.85)\n\n",
"format": "uint64",
"type": "integer"
}
},
"type": "object",
"x-filename": "Views - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/put_api_view_properties_iresearch.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/JSA_get_api_view_name.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/get_api_views.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/post_api_view_iresearch.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/patch_api_view_properties_iresearch.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/put_api_view_rename.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/delete_api_view.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/JSA_get_api_view_properties.md"
},
"patch_api_view_props_consolidation_fill": {
"description": "Use empty object for default values, i.e. {}\n\n",
"properties": {
"segmentThreshold": {
"description": "Apply consolidation policy IFF {segmentThreshold} >= #segments (default: 300, to disable use: 0)\n\n",
"format": "uint64",
"type": "integer"
},
"threshold": {
"description": "Consolidate IFF {threshold} > #segment_docs{valid} / (#segment_docs{valid} + #segment_docs{removed}) (default: 0.85)\n\n",
"format": "uint64",
"type": "integer"
}
},
"type": "object",
"x-filename": "Views - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/put_api_view_properties_iresearch.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/JSA_get_api_view_name.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/get_api_views.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/post_api_view_iresearch.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/patch_api_view_properties_iresearch.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/put_api_view_rename.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/delete_api_view.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/JSA_get_api_view_properties.md"
},
"post_api_aqlfunction": {
"properties": {
"code": {
"description": "a string representation of the function body.\n\n",
"type": "string"
},
"isDeterministic": {
"description": "an optional boolean value to indicate whether the function\nresults are fully deterministic (function return value solely depends on\nthe input value and return value is the same for repeated calls with same\ninput). The *isDeterministic* attribute is currently not used but may be\nused later for optimisations.\n\n",
"format": "",
"type": "boolean"
},
"name": {
"description": "the fully qualified name of the user functions.\n\n",
"type": "string"
}
},
"required": [
"name",
"code"
],
"type": "object",
"x-filename": "AQL - /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/get_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/post_api_explain.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/post_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/delete_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md"
},
"post_api_aqlfunction_rc_200": {
"properties": {
"code": {
"description": "the HTTP status code\n\n",
"format": "int64",
"type": "integer"
},
"error": {
"description": "boolean flag to indicate whether an error occurred (*false* in this case)\n\n",
"format": "",
"type": "boolean"
}
},
"required": [
"error",
"code"
],
"type": "object",
"x-filename": "AQL - /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/get_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/post_api_explain.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/post_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/delete_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md"
},
"post_api_aqlfunction_rc_201": {
"properties": {
"code": {
"description": "the HTTP status code\n\n\n",
"format": "int64",
"type": "integer"
},
"error": {
"description": "boolean flag to indicate whether an error occurred (*false* in this case)\n\n",
"format": "",
"type": "boolean"
}
},
"required": [
"error",
"code"
],
"type": "object",
"x-filename": "AQL - /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/get_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/post_api_explain.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/post_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/delete_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md"
},
"post_api_aqlfunction_rc_400": {
"properties": {
"code": {
"description": "the HTTP status code\n\n",
"format": "int64",
"type": "integer"
},
"error": {
"description": "boolean flag to indicate whether an error occurred (*true* in this case)\n\n",
"format": "",
"type": "boolean"
},
"errorMessage": {
"description": "a descriptive error message\n\n",
"type": "string"
},
"errorNum": {
"description": "the server error number\n\n",
"format": "int64",
"type": "integer"
}
},
"required": [
"error",
"code",
"errorNum",
"errorMessage"
],
"type": "object",
"x-filename": "AQL - /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/get_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/post_api_explain.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/post_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/delete_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md"
},
"post_api_collection": {
"properties": {
"distributeShardsLike": {
"description": "(The default is *\"\"*): in an enterprise cluster, this attribute binds\nthe specifics of sharding for the newly created collection to follow that of a\nspecified existing collection. \n**Note**: Using this parameter has consequences for the prototype\ncollection. It can no longer be dropped, before sharding imitating\ncollections are dropped. Equally, backups and restores of imitating\ncollections alone will generate warnings, which can be overridden,\nabout missing sharding prototype. \n\n",
"type": "string"
},
"doCompact": {
"description": "whether or not the collection will be compacted (default is *true*)\nThis option is meaningful for the MMFiles storage engine only.\n\n",
"format": "",
"type": "boolean"
},
"indexBuckets": {
"description": "The number of buckets into which indexes using a hash\ntable are split. The default is 16 and this number has to be a\npower of 2 and less than or equal to 1024. \n\nFor very large collections one should increase this to avoid long pauses \nwhen the hash table has to be initially built or resized, since buckets \nare resized individually and can be initially built in parallel. For \nexample, 64 might be a sensible value for a collection with 100\n000 000 documents. Currently, only the edge index respects this\nvalue, but other index types might follow in future ArangoDB versions. \nChanges (see below) are applied when the collection is loaded the next \ntime.\nThis option is meaningful for the MMFiles storage engine only.\n\n",
"format": "int64",
"type": "integer"
},
"isSystem": {
"description": "If *true*, create a system collection. In this case *collection-name*\nshould start with an underscore. End users should normally create non-system\ncollections only. API implementors may be required to create system\ncollections in very special occasions, but normally a regular collection will do.\n(The default is *false*)\n\n",
"format": "",
"type": "boolean"
},
"isVolatile": {
"description": "If *true* then the collection data is kept in-memory only and not made persistent.\nUnloading the collection will cause the collection data to be discarded. Stopping\nor re-starting the server will also cause full loss of data in the\ncollection. Setting this option will make the resulting collection be\nslightly faster than regular collections because ArangoDB does not\nenforce any synchronization to disk and does not calculate any CRC\nchecksums for datafiles (as there are no datafiles). This option \nshould therefore be used for cache-type collections only, and not \nfor data that cannot be re-created otherwise.\n(The default is *false*)\nThis option is meaningful for the MMFiles storage engine only.\n\n",
"format": "",
"type": "boolean"
},
"journalSize": {
"description": "The maximal size of a journal or datafile in bytes. The value \nmust be at least `1048576` (1 MiB). (The default is a configuration parameter)\nThis option is meaningful for the MMFiles storage engine only.\n\n",
"format": "int64",
"type": "integer"
},
"keyOptions": {
"$ref": "#/definitions/post_api_collection_opts"
},
"name": {
"description": "The name of the collection.\n\n",
"type": "string"
},
"numberOfShards": {
"description": "(The default is *1*): in a cluster, this value determines the\nnumber of shards to create for the collection. In a single\nserver setup, this option is meaningless.\n\n",
"format": "int64",
"type": "integer"
},
"replicationFactor": {
"description": "(The default is *1*): in a cluster, this attribute determines how many copies \nof each shard are kept on different DBServers. The value 1 means that only one \ncopy (no synchronous replication) is kept. A value of k means that k-1 replicas \nare kept. Any two copies reside on different DBServers. Replication between them is \nsynchronous, that is, every write operation to the \"leader\" copy will be replicated \nto all \"follower\" replicas, before the write operation is reported successful.\n\nIf a server fails, this is detected automatically and one of the servers holding \ncopies take over, usually without an error being reported.\n\n",
"format": "int64",
"type": "integer"
},
"shardKeys": {
"description": "(The default is *[ \"_key\" ]*): in a cluster, this attribute determines\nwhich document attributes are used to determine the target shard for documents.\nDocuments are sent to shards based on the values of their shard key attributes.\nThe values of all shard key attributes in a document are hashed,\nand the hash value is used to determine the target shard.\n**Note**: Values of shard key attributes cannot be changed once set.\n This option is meaningless in a single server setup.\n\n",
"type": "string"
},
"type": {
"description": "(The default is *2*): the type of the collection to create.\nThe following values for *type* are valid:\n\n- *2*: document collection\n- *3*: edges collection\n\n",
"format": "int64",
"type": "integer"
},
"waitForSync": {
"description": "If *true* then the data is synchronized to disk before returning from a\ndocument create, update, replace or removal operation. (default: false)\n\n",
"format": "",
"type": "boolean"
}
},
"required": [
"name"
],
"type": "object",
"x-filename": "Collections - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_load.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_rename.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/delete_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/post_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_truncate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_unload.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_rotate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_load_indexes_in_memory.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/get_api_collections.md"
},
"post_api_collection_opts": {
"description": "additional options for key generation. If specified, then *keyOptions*\nshould be a JSON array containing the following attributes:\n\n",
"properties": {
"allowUserKeys": {
"description": "if set to *true*, then it is allowed to supply own key values in the\n*_key* attribute of a document. If set to *false*, then the key generator\nwill solely be responsible for generating keys and supplying own key values\nin the *_key* attribute of documents is considered an error.\n\n",
"type": "boolean"
},
"increment": {
"description": "increment value for *autoincrement* key generator. Not used for other key\ngenerator types.\n\n",
"format": "int64",
"type": "integer"
},
"offset": {
"description": "Initial offset value for *autoincrement* key generator.\nNot used for other key generator types.\n\n",
"format": "int64",
"type": "integer"
},
"type": {
"description": "specifies the type of the key generator. The currently available generators are\n*traditional* and *autoincrement*.\n\n",
"type": "string"
}
},
"type": "object",
"x-filename": "Collections - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_load.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_rename.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/delete_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/post_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_truncate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_unload.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_rotate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_load_indexes_in_memory.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/get_api_collections.md"
},
"post_api_cursor": {
"properties": {
"batchSize": {
"description": "maximum number of result documents to be transferred from\nthe server to the client in one roundtrip. If this attribute is\nnot set, a server-controlled default value will be used. A *batchSize* value of\n*0* is disallowed.\n\n",
"format": "int64",
"type": "integer"
},
"bindVars": {
"description": "key/value pairs representing the bind parameters.\n\n",
"items": {
"additionalProperties": {},
"type": "object"
},
"type": "array"
},
"cache": {
"description": "flag to determine whether the AQL query cache\nshall be used. If set to *false*, then any query cache lookup will be skipped\nfor the query. If set to *true*, it will lead to the query cache being checked\nfor the query if the query cache mode is either *on* or *demand*.\n\n",
"format": "",
"type": "boolean"
},
"count": {
"description": "indicates whether the number of documents in the result set should be returned in\nthe \"count\" attribute of the result.\nCalculating the \"count\" attribute might have a performance impact for some queries\nin the future so this option is turned off by default, and \"count\"\nis only returned when requested.\n\n",
"format": "",
"type": "boolean"
},
"memoryLimit": {
"description": "the maximum number of memory (measured in bytes) that the query is allowed to\nuse. If set, then the query will fail with error \"resource limit exceeded\" in\ncase it allocates too much memory. A value of *0* indicates that there is no\nmemory limit.\n\n",
"format": "int64",
"type": "integer"
},
"options": {
"$ref": "#/definitions/post_api_cursor_opts"
},
"query": {
"description": "contains the query string to be executed\n\n",
"type": "string"
},
"ttl": {
"description": "The time-to-live for the cursor (in seconds). The cursor will be\nremoved on the server automatically after the specified amount of time. This\nis useful to ensure garbage collection of cursors that are not fully fetched\nby clients. If not set, a server-defined value will be used.\n\n",
"format": "int64",
"type": "integer"
}
},
"required": [
"query"
],
"type": "object",
"x-filename": "Cursors - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cursors/post_api_cursor_delete.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cursors/post_api_cursor.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cursors/post_api_cursor_identifier.md"
},
"post_api_cursor_opts": {
"description": "key/value object with extra options for the query.\n\n",
"properties": {
"failOnWarning": {
"description": "When set to *true*, the query will throw an exception and abort instead of producing\na warning. This option should be used during development to catch potential issues\nearly. When the attribute is set to *false*, warnings will not be propagated to\nexceptions and will be returned with the query result.\nThere is also a server configuration option `--query.fail-on-warning` for setting the\ndefault value for *failOnWarning* so it does not need to be set on a per-query level.\n\n",
"type": "boolean"
},
"fullCount": {
"description": "if set to *true* and the query contains a *LIMIT* clause, then the\nresult will have an *extra* attribute with the sub-attributes *stats*\nand *fullCount*, `{ ... , \"extra\": { \"stats\": { \"fullCount\": 123 } } }`.\nThe *fullCount* attribute will contain the number of documents in the result before the\nlast LIMIT in the query was applied. It can be used to count the number of documents that\nmatch certain filter criteria, but only return a subset of them, in one go.\nIt is thus similar to MySQL's *SQL_CALC_FOUND_ROWS* hint. Note that setting the option\nwill disable a few LIMIT optimizations and may lead to more documents being processed,\nand thus make queries run longer. Note that the *fullCount* attribute will only\nbe present in the result if the query has a LIMIT clause and the LIMIT clause is\nactually used in the query.\n\n",
"type": "boolean"
},
"intermediateCommitCount": {
"description": "Maximum number of operations after which an intermediate commit is performed\nautomatically. Honored by the RocksDB storage engine only.\n\n",
"format": "int64",
"type": "integer"
},
"intermediateCommitSize": {
"description": "Maximum total size of operations after which an intermediate commit is performed\nautomatically. Honored by the RocksDB storage engine only.\n\n",
"format": "int64",
"type": "integer"
},
"maxPlans": {
"description": "Limits the maximum number of plans that are created by the AQL query optimizer.\n\n",
"format": "int64",
"type": "integer"
},
"maxTransactionSize": {
"description": "Transaction size limit in bytes. Honored by the RocksDB storage engine only.\n\n",
"format": "int64",
"type": "integer"
},
"maxWarningCount": {
"description": "Limits the maximum number of warnings a query will return. The number of warnings\na query will return is limited to 10 by default, but that number can be increased\nor decreased by setting this attribute.\n\n",
"format": "int64",
"type": "integer"
},
"optimizer.rules": {
"description": "A list of to-be-included or to-be-excluded optimizer rules\ncan be put into this attribute, telling the optimizer to include or exclude\nspecific rules. To disable a rule, prefix its name with a `-`, to enable a rule, prefix it\nwith a `+`. There is also a pseudo-rule `all`, which will match all optimizer rules.\n\n",
"format": "string",
"items": {
"type": "string"
},
"type": "array"
},
"profile": {
"description": "If set to *true*, then the additional query profiling information will be returned\nin the sub-attribute *profile* of the *extra* return attribute if the query result\nis not served from the query cache.\n\n",
"type": "boolean"
},
"satelliteSyncWait": {
"description": "This *enterprise* parameter allows to configure how long a DBServer will have time\nto bring the satellite collections involved in the query into sync.\nThe default value is *60.0* (seconds). When the max time has been reached the query\nwill be stopped.\n\n",
"type": "boolean"
},
"skipInaccessibleCollections": {
"description": "AQL queries (especially graph traversals) will treat collection to which a user has no access rights as if these collections were empty. Instead of returning a forbidden access error, your queries will execute normally. This is intended to help with certain use-cases: A graph contains several collections and different users execute AQL queries on that graph. You can now naturally limit the accessible results by changing the access rights of users on collections. This feature is only available in the Enterprise Edition.\n\n",
"type": "boolean"
}
},
"type": "object",
"x-filename": "Cursors - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cursors/post_api_cursor_delete.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cursors/post_api_cursor.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cursors/post_api_cursor_identifier.md"
},
"post_api_cursor_rc_201": {
"properties": {
"cached": {
"description": "a boolean flag indicating whether the query result was served\nfrom the query cache or not. If the query result is served from the query\ncache, the *extra* return attribute will not contain any *stats* sub-attribute\nand no *profile* sub-attribute.\n\n",
"format": "",
"type": "boolean"
},
"code": {
"description": "the HTTP status code\n\n",
"format": "integer",
"type": "integer"
},
"count": {
"description": "the total number of result documents available (only\navailable if the query was executed with the *count* attribute set)\n\n",
"format": "int64",
"type": "integer"
},
"error": {
"description": "A flag to indicate that an error occurred (*false* in this case)\n\n",
"format": "",
"type": "boolean"
},
"extra": {
"additionalProperties": {},
"description": "an optional JSON object with extra information about the query result\ncontained in its *stats* sub-attribute. For data-modification queries, the\n*extra.stats* sub-attribute will contain the number of modified documents and\nthe number of documents that could not be modified\ndue to an error (if *ignoreErrors* query option is specified)\n\n",
"type": "object"
},
"hasMore": {
"description": "A boolean indicator whether there are more results\navailable for the cursor on the server\n\n",
"format": "",
"type": "boolean"
},
"id": {
"description": "id of temporary cursor created on the server (optional, see above)\n\n",
"type": "string"
},
"result": {
"description": "an array of result documents (might be empty if query has no results)\n\n",
"items": {},
"type": "array"
}
},
"required": [
"error",
"code",
"hasMore",
"id",
"cached"
],
"type": "object",
"x-filename": "Cursors - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cursors/post_api_cursor_delete.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cursors/post_api_cursor.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cursors/post_api_cursor_identifier.md"
},
"post_api_cursor_rc_400": {
"properties": {
"code": {
"description": "the HTTP status code\n\n",
"format": "int64",
"type": "integer"
},
"error": {
"description": "boolean flag to indicate that an error occurred (*true* in this case)\n\n",
"format": "",
"type": "boolean"
},
"errorMessage": {
"description": "a descriptive error message\n\nIf the query specification is complete, the server will process the query. If an\nerror occurs during query processing, the server will respond with *HTTP 400*.\nAgain, the body of the response will contain details about the error.\n\nA [list of query errors can be found here](../../Manual/Appendix/ErrorCodes.html).\n\n\n",
"type": "string"
},
"errorNum": {
"description": "the server error number\n\n",
"format": "int64",
"type": "integer"
}
},
"required": [
"error",
"code",
"errorNum",
"errorMessage"
],
"type": "object",
"x-filename": "Cursors - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cursors/post_api_cursor_delete.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cursors/post_api_cursor.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cursors/post_api_cursor_identifier.md"
},
"post_api_explain": {
"properties": {
"bindVars": {
"description": "key/value pairs representing the bind parameters.\n\n",
"items": {
"additionalProperties": {},
"type": "object"
},
"type": "array"
},
"options": {
"$ref": "#/definitions/explain_options"
},
"query": {
"description": "the query which you want explained; If the query references any bind variables,\nthese must also be passed in the attribute *bindVars*. Additional\noptions for the query can be passed in the *options* attribute.\n\n",
"type": "string"
}
},
"required": [
"query"
],
"type": "object",
"x-filename": "AQL - /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/get_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/post_api_explain.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/post_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/delete_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md"
},
"post_api_export": {
"properties": {
"batchSize": {
"description": "maximum number of result documents to be transferred from\nthe server to the client in one roundtrip (optional). If this attribute is\nnot set, a server-controlled default value will be used.\n\n",
"format": "int64",
"type": "integer"
},
"count": {
"description": "boolean flag that indicates whether the number of documents\nin the result set should be returned in the \"count\" attribute of the result\n(optional).\nCalculating the \"count\" attribute might in the future have a performance\nimpact so this option is turned off by default, and \"count\" is only returned\nwhen requested.\n\n",
"format": "",
"type": "boolean"
},
"flush": {
"description": "if set to *true*, a WAL flush operation will be executed prior to the\nexport. The flush operation will start copying documents from the WAL to the\ncollection's datafiles. There will be an additional wait time of up\nto *flushWait* seconds after the flush to allow the WAL collector to change\nthe adjusted document meta-data to point into the datafiles, too.\nThe default value is *false* (i.e. no flush) so most recently inserted or\nupdated\ndocuments from the collection might be missing in the export.\n\n",
"format": "",
"type": "boolean"
},
"flushWait": {
"description": "maximum wait time in seconds after a flush operation. The default\nvalue is 10. This option only has an effect when *flush* is set to *true*.\n\n",
"format": "int64",
"type": "integer"
},
"limit": {
"description": "an optional limit value, determining the maximum number of documents to\nbe included in the cursor. Omitting the *limit* attribute or setting it to 0 will\nlead to no limit being used. If a limit is used, it is undefined which documents\nfrom the collection will be included in the export and which will be excluded. \nThis is because there is no natural order of documents in a collection.\n\n",
"format": "int64",
"type": "integer"
},
"restrict": {
"$ref": "#/definitions/post_api_export_restrictions"
},
"ttl": {
"description": "an optional time-to-live for the cursor (in seconds). The cursor will be\nremoved on the server automatically after the specified amount of time. This\nis useful to ensure garbage collection of cursors that are not fully fetched\nby clients. If not set, a server-defined value will be used.\n\n",
"format": "int64",
"type": "integer"
}
},
"required": [
"flush",
"flushWait",
"count",
"batchSize",
"limit",
"ttl"
],
"type": "object",
"x-filename": "Bulk - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Bulk/batch_processing.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Bulk/import_json.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Bulk/import_document.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Bulk/post_api_export.md"
},
"post_api_export_restrictions": {
"description": "an object containing an array of attribute names that will be \nincluded or excluded when returning result documents.\n\nNot specifying *restrict* will by default return all attributes of each document.\n\n",
"properties": {
"fields": {
"description": "Contains an array of attribute names to *include* or *exclude*. Matching of attribute names\nfor *inclusion* or *exclusion* will be done on the top level only.\nSpecifying names of nested attributes is not supported at the moment.\n\n\n",
"format": "string",
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"description": "has to be be set to either *include* or *exclude* depending on which you want to use\n\n",
"type": "string"
}
},
"type": "object",
"x-filename": "Bulk - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Bulk/batch_processing.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Bulk/import_json.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Bulk/import_document.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Bulk/post_api_export.md"
},
"post_api_gharial_create_opts": {
"description": "a JSON object which is only useful in Enterprise version and with isSmart set to true.\nIt can contain the following attributes:\n\n",
"properties": {
"numberOfShards": {
"description": "The number of shards that is used for every collection within this graph.\nCannot be modified later.\n\n",
"format": "",
"type": "integer"
},
"smartGraphAttribute": {
"description": "The attribute name that is used to smartly shard the vertices of a graph.\nEvery vertex in this Graph has to have this attribute.\nCannot be modified later.\n\n",
"type": "string"
}
},
"type": "object",
"x-filename": "Graph - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_list_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_definition_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_list_edge_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_replace_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_collection_add_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_replace_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_collection_remove_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_delete_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_definition_remove_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_delete_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_list_vertex_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_definition_add_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_drop_http_examples.md"
},
"post_api_index_fulltext": {
"properties": {
"fields": {
"description": "an array of attribute names. Currently, the array is limited\nto exactly one attribute.\n\n",
"items": {
"type": "string"
},
"type": "array"
},
"minLength": {
"description": "Minimum character length of words to index. Will default\nto a server-defined value if unspecified. It is thus recommended to set\nthis value explicitly when creating the index.\n\n",
"format": "int64",
"type": "integer"
},
"type": {
"description": "must be equal to *\"fulltext\"*.\n\n",
"type": "string"
}
},
"required": [
"type",
"fields",
"minLength"
],
"type": "object",
"x-filename": "Indexes - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/post_api_index_skiplist.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/post_api_index_hash.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/get_api_reads_index.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/post_api_index_persistent.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/post_api_index_delete.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/post_api_index_fulltext.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/post_api_index.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/get_api_index.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/post_api_index_geo.md"
},
"post_api_index_geo": {
"properties": {
"fields": {
"description": "An array with one or two attribute paths.\n\nIf it is an array with one attribute path *location*, then a geo-spatial\nindex on all documents is created using *location* as path to the\ncoordinates. The value of the attribute must be an array with at least two\ndouble values. The array must contain the latitude (first value) and the\nlongitude (second value). All documents, which do not have the attribute\npath or with value that are not suitable, are ignored.\n\nIf it is an array with two attribute paths *latitude* and *longitude*,\nthen a geo-spatial index on all documents is created using *latitude*\nand *longitude* as paths the latitude and the longitude. The value of\nthe attribute *latitude* and of the attribute *longitude* must a\ndouble. All documents, which do not have the attribute paths or which\nvalues are not suitable, are ignored.\n\n",
"items": {
"type": "string"
},
"type": "array"
},
"geoJson": {
"description": "If a geo-spatial index on a *location* is constructed\nand *geoJson* is *true*, then the order within the array is longitude\nfollowed by latitude. This corresponds to the format described in\nhttp://geojson.org/geojson-spec.html#positions\n\n",
"type": "string"
},
"type": {
"description": "must be equal to *\"geo\"*.\n\n",
"type": "string"
}
},
"required": [
"type",
"fields",
"geoJson"
],
"type": "object",
"x-filename": "Indexes - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/post_api_index_skiplist.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/post_api_index_hash.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/get_api_reads_index.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/post_api_index_persistent.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/post_api_index_delete.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/post_api_index_fulltext.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/post_api_index.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/get_api_index.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/post_api_index_geo.md"
},
"post_api_index_hash": {
"properties": {
"deduplicate": {
"description": "if *false*, the deduplication of array values is turned off.\n\n",
"format": "boolean",
"type": "boolean"
},
"fields": {
"description": "an array of attribute paths.\n\n",
"items": {
"type": "string"
},
"type": "array"
},
"sparse": {
"description": "if *true*, then create a sparse index.\n\n",
"format": "",
"type": "boolean"
},
"type": {
"description": "must be equal to *\"hash\"*.\n\n",
"type": "string"
},
"unique": {
"description": "if *true*, then create a unique index.\n\n",
"format": "",
"type": "boolean"
}
},
"required": [
"type",
"fields",
"unique",
"sparse"
],
"type": "object",
"x-filename": "Indexes - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/post_api_index_skiplist.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/post_api_index_hash.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/get_api_reads_index.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/post_api_index_persistent.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/post_api_index_delete.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/post_api_index_fulltext.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/post_api_index.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/get_api_index.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/post_api_index_geo.md"
},
"post_api_index_persistent": {
"properties": {
"fields": {
"description": "an array of attribute paths.\n\n",
"items": {
"type": "string"
},
"type": "array"
},
"sparse": {
"description": "if *true*, then create a sparse index.\n\n",
"format": "",
"type": "boolean"
},
"type": {
"description": "must be equal to *\"persistent\"*.\n\n",
"type": "string"
},
"unique": {
"description": "if *true*, then create a unique index.\n\n",
"format": "",
"type": "boolean"
}
},
"required": [
"type",
"fields",
"unique",
"sparse"
],
"type": "object",
"x-filename": "Indexes - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/post_api_index_skiplist.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/post_api_index_hash.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/get_api_reads_index.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/post_api_index_persistent.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/post_api_index_delete.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/post_api_index_fulltext.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/post_api_index.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/get_api_index.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/post_api_index_geo.md"
},
"post_api_index_skiplist": {
"properties": {
"deduplicate": {
"description": "if *false*, the deduplication of array values is turned off.\n\n",
"format": "boolean",
"type": "boolean"
},
"fields": {
"description": "an array of attribute paths.\n\n",
"items": {
"type": "string"
},
"type": "array"
},
"sparse": {
"description": "if *true*, then create a sparse index.\n\n",
"format": "",
"type": "boolean"
},
"type": {
"description": "must be equal to *\"skiplist\"*.\n\n",
"type": "string"
},
"unique": {
"description": "if *true*, then create a unique index.\n\n",
"format": "",
"type": "boolean"
}
},
"required": [
"type",
"fields",
"unique",
"sparse"
],
"type": "object",
"x-filename": "Indexes - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/post_api_index_skiplist.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/post_api_index_hash.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/get_api_reads_index.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/post_api_index_persistent.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/post_api_index_delete.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/post_api_index_fulltext.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/post_api_index.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/get_api_index.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/post_api_index_geo.md"
},
"post_api_new_tasks": {
"properties": {
"command": {
"description": "The JavaScript code to be executed\n\n",
"type": "string"
},
"name": {
"description": "The name of the task\n\n",
"type": "string"
},
"offset": {
"description": "Number of seconds initial delay \n\n",
"format": "int64",
"type": "integer"
},
"params": {
"description": "The parameters to be passed into command\n\n",
"type": "string"
},
"period": {
"description": "number of seconds between the executions\n\n",
"format": "int64",
"type": "integer"
}
},
"required": [
"name",
"command",
"params"
],
"type": "object",
"x-filename": "Administration - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_long_echo.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_statistics_description.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_time.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_tasks_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_server_role.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_database_version.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_statistics.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_modules_flush.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_server_id.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_cluster_endpoints.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_return.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_endpoint.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/post_admin_execute.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/post_admin_test.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/put_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_initiate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/post_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_engine.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/delete_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_echo.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_routing_reloads.md"
},
"post_api_transaction": {
"properties": {
"action": {
"description": "the actual transaction operations to be executed, in the\nform of stringified JavaScript code. The code will be executed on server\nside, with late binding. It is thus critical that the code specified in\n*action* properly sets up all the variables it needs.\nIf the code specified in *action* ends with a return statement, the\nvalue returned will also be returned by the REST API in the *result*\nattribute if the transaction committed successfully.\n\n",
"type": "string"
},
"collections": {
"description": "*collections* must be a JSON object that can have either or both sub-attributes\n*read* and *write*, each being an array of collection names or a single\ncollection name as string. Collections that will be written to in the\ntransaction must be declared with the *write* attribute or it will fail,\nwhereas non-declared collections from which is solely read will be added lazily.\nThe optional sub-attribute *allowImplicit* can be set to *false* to let\ntransactions fail in case of undeclared collections for reading. Collections\nfor reading should be fully declared if possible, to avoid deadlocks.\n\n",
"type": "string"
},
"intermediateCommitCount": {
"description": "Maximum number of operations after which an intermediate commit is performed \nautomatically. Honored by the RocksDB storage engine only.\n\n",
"format": "int64",
"type": "integer"
},
"intermediateCommitSize": {
"description": "Maximum total size of operations after which an intermediate commit is performed \nautomatically. Honored by the RocksDB storage engine only.\n\n",
"format": "int64",
"type": "integer"
},
"lockTimeout": {
"description": "an optional numeric value that can be used to set a\ntimeout for waiting on collection locks. If not specified, a default\nvalue will be used. Setting *lockTimeout* to *0* will make ArangoDB\nnot time out waiting for a lock.\n\n",
"format": "int64",
"type": "integer"
},
"maxTransactionSize": {
"description": "Transaction size limit in bytes. Honored by the RocksDB storage engine only.\n\n",
"format": "int64",
"type": "integer"
},
"params": {
"description": "optional arguments passed to *action*.\n\n",
"type": "string"
},
"waitForSync": {
"description": "an optional boolean flag that, if set, will force the\ntransaction to write all data to disk before returning.\n\n",
"format": "boolean",
"type": "boolean"
}
},
"required": [
"collections",
"action"
],
"type": "object",
"x-filename": "Transactions - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Transactions/post_api_transaction.md"
},
"post_api_view_iresearch": {
"properties": {
"name": {
"description": "The name of the view.\n\n",
"type": "string"
},
"properties": {
"$ref": "#/definitions/post_api_view_props"
},
"type": {
"description": "The type of the view. must be equal to *\"arangosearch\"*\n\n",
"type": "string"
}
},
"required": [
"name",
"type"
],
"type": "object",
"x-filename": "Views - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/put_api_view_properties_iresearch.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/JSA_get_api_view_name.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/get_api_views.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/post_api_view_iresearch.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/patch_api_view_properties_iresearch.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/put_api_view_rename.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/delete_api_view.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/JSA_get_api_view_properties.md"
},
"post_api_view_link_props": {
"description": "The link properties. If specified, then *properties*\nshould be a JSON object containing the following attributes:\n\n",
"properties": {
"[field-name]": {
"$ref": "#/definitions/post_api_view_link_props_field_props"
},
"analyzers": {
"description": "The list of analyzers to be used for indexing of string values (default: [\"identity\"]).\n\n",
"format": "string",
"items": {
"type": "string"
},
"type": "array"
},
"includeAllFields": {
"description": "The flag determines whether or not to index all fields on a particular level of depth (default: false).\n\n",
"type": "boolean"
},
"trackListPositions": {
"description": "The flag determines whether or not values in a lists should be treated separate (default: false).\n\n",
"type": "boolean"
}
},
"type": "object",
"x-filename": "Views - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/put_api_view_properties_iresearch.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/JSA_get_api_view_name.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/get_api_views.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/post_api_view_iresearch.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/patch_api_view_properties_iresearch.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/put_api_view_rename.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/delete_api_view.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/JSA_get_api_view_properties.md"
},
"post_api_view_link_props_field_props": {
"description": "The field properties. If specified, then *properties*\nshould be a JSON object containing the following attributes:\n\n",
"properties": {
"[field-name]": {
"description": "Specify properties for nested fields here\n\n",
"type": "string"
},
"analyzers": {
"description": "The list of analyzers to be used for indexing of string values (default: [\"identity\"]).\n\n",
"format": "string",
"items": {
"type": "string"
},
"type": "array"
},
"includeAllFields": {
"description": "The flag determines whether or not to index all fields on a particular level of depth (default: false).\n\n",
"type": "boolean"
},
"trackListPositions": {
"description": "The flag determines whether or not values in a lists should be treated separate (default: false).\n\n",
"type": "boolean"
}
},
"type": "object",
"x-filename": "Views - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/put_api_view_properties_iresearch.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/JSA_get_api_view_name.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/get_api_views.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/post_api_view_iresearch.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/patch_api_view_properties_iresearch.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/put_api_view_rename.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/delete_api_view.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/JSA_get_api_view_properties.md"
},
"post_api_view_links": {
"description": "The set of collection names associated with the properties.\n\n",
"properties": {
"[collection-name]": {
"$ref": "#/definitions/post_api_view_link_props"
}
},
"type": "object",
"x-filename": "Views - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/put_api_view_properties_iresearch.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/JSA_get_api_view_name.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/get_api_views.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/post_api_view_iresearch.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/patch_api_view_properties_iresearch.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/put_api_view_rename.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/delete_api_view.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/JSA_get_api_view_properties.md"
},
"post_api_view_props": {
"description": "The view properties. If specified, then *properties*\nshould be a JSON object containing the following attributes:\n\n",
"properties": {
"commit": {
"$ref": "#/definitions/post_api_view_props_commit"
},
"dataPath": {
"description": "The filesystem path where to store persisted view data (default: *\"<ArangoDB database path>/arangosearch-<view-id>\"*).\n\n",
"type": "string"
},
"locale": {
"description": "The default locale used for queries on analyzed string values (default: *C*).\n\n",
"type": "string"
},
"threadMaxIdle": {
"description": "Maximum idle number of threads for single-run tasks (default: 5).\nFor the case where there are a lot of short-lived asynchronous tasks, a lower value will cause a lot of thread creation/deletion calls.\nFor the case where there are no short-lived asynchronous tasks, a higher value will only waste memory.\n",
"format": "uint64",
"type": "integer"
},
"threadMaxTotal": {
"description": "Maximum total number of threads (>0) for single-run tasks (default: 5).\nFor the case where there are a lot of parallelizable tasks and an abundance of resources, a lower value would limit performance.\nFor the case where there are limited resources CPU/memory, a higher value will negatively impact performance.\n\n",
"format": "uint64",
"type": "integer"
}
},
"type": "object",
"x-filename": "Views - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/put_api_view_properties_iresearch.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/JSA_get_api_view_name.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/get_api_views.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/post_api_view_iresearch.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/patch_api_view_properties_iresearch.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/put_api_view_rename.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/delete_api_view.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/JSA_get_api_view_properties.md"
},
"post_api_view_props_commit": {
"description": "Commit options for regular operations.\n\nCommit options for regular operations.\n\n",
"properties": {
"cleanupIntervalStep": {
"description": "Wait at least this many commits between removing unused files in data directory (default: 10, \nto disable use: 0).\nFor the case where the consolidation policies merge segments often (i.e. a lot of commit+consolidate), a lower value will cause a\nlot of disk space to be wasted.\nFor the case where the consolidation policies rarely merge segments (i.e. few inserts/deletes), a higher value will impact\nperformance without any added benefits.\n\n",
"format": "uint64",
"type": "integer"
},
"commitIntervalMsec": {
"description": "Wait at least this many milliseconds between committing index data changes and\nmaking them visible to queries (default: 60000, to disable use: 0).\nFor the case where there are a lot of inserts/updates, a lower value, until commit, will cause the index not to account for them and\nmemory usage would continue to grow.\nFor the case where there are a few inserts/updates, a higher value will impact performance and waste disk space for each\ncommit call without any added benefits.\n\n",
"format": "uint64",
"type": "integer"
},
"consolidate": {
"$ref": "#/definitions/post_api_view_props_consolidation"
}
},
"type": "object",
"x-filename": "Views - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/put_api_view_properties_iresearch.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/JSA_get_api_view_name.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/get_api_views.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/post_api_view_iresearch.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/patch_api_view_properties_iresearch.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/put_api_view_rename.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/delete_api_view.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/JSA_get_api_view_properties.md"
},
"post_api_view_props_consolidation": {
"description": "\n\n",
"properties": {
"bytes": {
"$ref": "#/definitions/post_api_view_props_consolidation_bytes"
},
"bytes_accum": {
"$ref": "#/definitions/post_api_view_props_consolidation_bytes_accum"
},
"count": {
"$ref": "#/definitions/post_api_view_props_consolidation_count"
},
"fill": {
"$ref": "#/definitions/post_api_view_props_consolidation_fill"
}
},
"type": "object"
},
"post_api_view_props_consolidation_bytes": {
"description": "Use empty object for default values, i.e. {}\n\nUse empty object for default values, i.e. {}\n\n",
"properties": {
"segmentThreshold": {
"description": "Apply consolidation policy IFF {segmentThreshold} >= #segments (default: 300, to disable use: 0)\n\n",
"format": "uint64",
"type": "integer"
},
"threshold": {
"description": "Consolidate IFF {threshold} > segment_bytes / (all_segment_bytes / #segments) (default: 0.85)\n\n",
"format": "uint64",
"type": "integer"
}
},
"type": "object",
"x-filename": "Views - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/put_api_view_properties_iresearch.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/JSA_get_api_view_name.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/get_api_views.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/post_api_view_iresearch.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/patch_api_view_properties_iresearch.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/put_api_view_rename.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/delete_api_view.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/JSA_get_api_view_properties.md"
},
"post_api_view_props_consolidation_bytes_accum": {
"description": "Use empty object for default values, i.e. {}\n\nUse empty object for default values, i.e. {}\n\n",
"properties": {
"segmentThreshold": {
"description": "Apply consolidation policy IFF {segmentThreshold} >= #segments (default: 300, to disable use: 0)\n\n",
"format": "uint64",
"type": "integer"
},
"threshold": {
"description": "Consolidate IFF {threshold} > (segment_bytes + sum_of_merge_candidate_segment_bytes) / all_segment_bytes (default: 0.85)\n\n",
"format": "uint64",
"type": "integer"
}
},
"type": "object",
"x-filename": "Views - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/put_api_view_properties_iresearch.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/JSA_get_api_view_name.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/get_api_views.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/post_api_view_iresearch.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/patch_api_view_properties_iresearch.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/put_api_view_rename.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/delete_api_view.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/JSA_get_api_view_properties.md"
},
"post_api_view_props_consolidation_count": {
"description": "Use empty object for default values, i.e. {}\n\nUse empty object for default values, i.e. {}\n\n",
"properties": {
"segmentThreshold": {
"description": "Apply consolidation policy IFF {segmentThreshold} >= #segments (default: 300, to disable use: 0)\n\n",
"format": "uint64",
"type": "integer"
},
"threshold": {
"description": "Consolidate IFF {threshold} > segment_docs{valid} / (all_segment_docs{valid} / #segments) (default: 0.85)\n\n",
"format": "uint64",
"type": "integer"
}
},
"type": "object",
"x-filename": "Views - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/put_api_view_properties_iresearch.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/JSA_get_api_view_name.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/get_api_views.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/post_api_view_iresearch.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/patch_api_view_properties_iresearch.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/put_api_view_rename.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/delete_api_view.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/JSA_get_api_view_properties.md"
},
"post_api_view_props_consolidation_fill": {
"description": "Use empty object for default values, i.e. {}\n\nUse empty object for default values, i.e. {}\n\n",
"properties": {
"segmentThreshold": {
"description": "Apply consolidation policy IFF {segmentThreshold} >= #segments (default: 300, to disable use: 0)\n\n",
"format": "uint64",
"type": "integer"
},
"threshold": {
"description": "Consolidate IFF {threshold} > #segment_docs{valid} / (#segment_docs{valid} + #segment_docs{removed}) (default: 0.85)\n\n",
"format": "uint64",
"type": "integer"
}
},
"type": "object",
"x-filename": "Views - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/put_api_view_properties_iresearch.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/JSA_get_api_view_name.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/get_api_views.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/post_api_view_iresearch.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/patch_api_view_properties_iresearch.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/put_api_view_rename.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/delete_api_view.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/JSA_get_api_view_properties.md"
},
"post_batch_replication": {
"properties": {
"ttl": {
"description": "the time-to-live for the new batch (in seconds)\n\nA JSON object with the batch configuration.\n\n",
"format": "int64",
"type": "integer"
}
},
"required": [
"ttl"
],
"type": "object",
"x-filename": "Replication - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/put_api_replication_makeSlave.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/delete_batch_replication.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/get_api_replication_cluster_inventory.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/get_api_replication_logger_tick_ranges.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/get_api_replication_dump.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/put_api_replication_synchronize.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/put_api_replication_applier.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/get_api_replication_logger_returns.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/post_batch_replication.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/get_api_replication_applier_state.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/get_api_replication_logger_return_state.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/put_api_replication_applier_start.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/put_api_replication_applier_adjust.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/put_api_replication_serverID.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/put_api_replication_applier_stop.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/put_batch_replication.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/put_api_replication_inventory.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/get_api_replication_logger_first_tick.md"
},
"put_admin_loglevel": {
"properties": {
"agency": {
"description": "One of the possible loglevels.\n\n",
"type": "string"
},
"agencycomm": {
"description": "One of the possible loglevels.\n\n",
"type": "string"
},
"audit-authentication": {
"description": "One of the possible loglevels.\n\n",
"type": "string"
},
"audit-collection": {
"description": "One of the possible loglevels.\n\n",
"type": "string"
},
"audit-database": {
"description": "One of the possible loglevels.\n\n",
"type": "string"
},
"audit-documentation": {
"description": "One of the possible loglevels.\n\n",
"type": "string"
},
"audit-service": {
"description": "One of the possible loglevels.\n\n",
"type": "string"
},
"audit-view": {
"description": "One of the possible loglevels.\n\n",
"type": "string"
},
"authentication": {
"description": "One of the possible loglevels.\n\n",
"type": "string"
},
"authorization": {
"description": "One of the possible loglevels.\n\n",
"type": "string"
},
"cache": {
"description": "One of the possible loglevels.\n\n",
"type": "string"
},
"cluster": {
"description": "One of the possible loglevels.\n\n",
"type": "string"
},
"collector": {
"description": "One of the possible loglevels.\n\n",
"type": "string"
},
"communication": {
"description": "One of the possible loglevels.\n\n",
"type": "string"
},
"compactor": {
"description": "One of the possible loglevels.\n\n",
"type": "string"
},
"config": {
"description": "One of the possible loglevels.\n\n",
"type": "string"
},
"datafiles": {
"description": "One of the possible loglevels.\n\n",
"type": "string"
},
"development": {
"description": "One of the possible loglevels.\n\n",
"type": "string"
},
"engines": {
"description": "One of the possible loglevels.\n\n",
"type": "string"
},
"general": {
"description": "One of the possible loglevels.\n\n",
"type": "string"
},
"graphs": {
"description": "One of the possible loglevels.\n\n",
"type": "string"
},
"heartbeat": {
"description": "One of the possible loglevels.\n\n",
"type": "string"
},
"ldap": {
"description": "One of the possible loglevels.\n\n",
"type": "string"
},
"memory": {
"description": "One of the possible loglevels.\n\n",
"type": "string"
},
"mmap": {
"description": "One of the possible loglevels.\n\n",
"type": "string"
},
"performance": {
"description": "One of the possible loglevels.\n\n",
"type": "string"
},
"pregel": {
"description": "One of the possible loglevels.\n\n",
"type": "string"
},
"queries": {
"description": "One of the possible loglevels.\n\n",
"type": "string"
},
"replication": {
"description": "One of the possible loglevels.\n\n",
"type": "string"
},
"requests": {
"description": "One of the possible loglevels.\n\n",
"type": "string"
},
"rocksdb": {
"description": "One of the possible loglevels.\n\n",
"type": "string"
},
"ssl": {
"description": "One of the possible loglevels.\n\n",
"type": "string"
},
"startup": {
"description": "One of the possible loglevels.\n\n",
"type": "string"
},
"supervision": {
"description": "One of the possible loglevels.\n\n",
"type": "string"
},
"syscall": {
"description": "One of the possible loglevels.\n\n",
"type": "string"
},
"threads": {
"description": "One of the possible loglevels.\n\n",
"type": "string"
},
"trx": {
"description": "One of the possible loglevels.\n\n",
"type": "string"
},
"v8": {
"description": "One of the possible loglevels.\n\n",
"type": "string"
},
"views": {
"description": "One of the possible loglevels.\n\n",
"type": "string"
}
},
"type": "object",
"x-filename": "Administration - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_long_echo.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_statistics_description.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_time.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_tasks_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_server_role.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_database_version.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_statistics.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_modules_flush.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_server_id.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_cluster_endpoints.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_return.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_endpoint.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/post_admin_execute.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/post_admin_test.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/put_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_initiate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/post_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_engine.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/delete_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_echo.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_routing_reloads.md"
},
"put_api_new_tasks": {
"properties": {
"command": {
"description": "The JavaScript code to be executed\n\n",
"type": "string"
},
"name": {
"description": "The name of the task\n\n",
"type": "string"
},
"offset": {
"description": "Number of seconds initial delay \n\n",
"format": "int64",
"type": "integer"
},
"params": {
"description": "The parameters to be passed into command\n\n",
"type": "string"
},
"period": {
"description": "number of seconds between the executions\n\n",
"format": "int64",
"type": "integer"
}
},
"required": [
"name",
"command",
"params"
],
"type": "object",
"x-filename": "Administration - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_long_echo.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_statistics_description.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_time.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_tasks_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_server_role.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_database_version.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_statistics.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_modules_flush.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_server_id.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_cluster_endpoints.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_return.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_endpoint.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/post_admin_execute.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/post_admin_test.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/put_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_initiate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/post_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_engine.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/delete_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_echo.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_routing_reloads.md"
},
"put_api_replication_applier_adjust": {
"properties": {
"adaptivePolling": {
"description": "if set to *true*, the replication applier will fall\nto sleep for an increasingly long period in case the logger server at the\nendpoint does not have any more replication events to apply. Using\nadaptive polling is thus useful to reduce the amount of work for both the\napplier and the logger server for cases when there are only infrequent\nchanges. The downside is that when using adaptive polling, it might take\nlonger for the replication applier to detect that there are new replication\nevents on the logger server.\n\nSetting *adaptivePolling* to false will make the replication applier\ncontact the logger server in a constant interval, regardless of whether\nthe logger server provides updates frequently or seldom.\n\n",
"format": "",
"type": "boolean"
},
"autoResync": {
"description": "whether or not the slave should perform a full automatic resynchronization\nwith the master in case the master cannot serve log data requested by the\nslave,\nor when the replication is started and no tick value can be found.\n\n",
"format": "",
"type": "boolean"
},
"autoResyncRetries": {
"description": "number of resynchronization retries that will be performed in a row when\nautomatic resynchronization is enabled and kicks in. Setting this to *0*\nwill\neffectively disable *autoResync*. Setting it to some other value will limit\nthe number of retries that are performed. This helps preventing endless\nretries\nin case resynchronizations always fail.\n\n",
"format": "int64",
"type": "integer"
},
"autoStart": {
"description": "whether or not to auto-start the replication applier on\n(next and following) server starts\n\n",
"format": "",
"type": "boolean"
},
"chunkSize": {
"description": "the requested maximum size for log transfer packets that\nis used when the endpoint is contacted.\n\n",
"format": "int64",
"type": "integer"
},
"connectTimeout": {
"description": "the timeout (in seconds) when attempting to connect to the\nendpoint. This value is used for each connection attempt.\n\n",
"format": "int64",
"type": "integer"
},
"connectionRetryWaitTime": {
"description": "the time (in seconds) that the applier will intentionally idle before\nit retries connecting to the master in case of connection problems.\nThis value will be ignored if set to *0*.\n\n",
"format": "int64",
"type": "integer"
},
"database": {
"description": "the name of the database on the endpoint. If not specified, defaults to the current local database name.\n\n",
"type": "string"
},
"endpoint": {
"description": "the logger server to connect to (e.g. \"tcp://192.168.173.13:8529\"). The endpoint must be specified.\n\n",
"type": "string"
},
"idleMaxWaitTime": {
"description": "the maximum wait time (in seconds) that the applier will intentionally idle \nbefore fetching more log data from the master in case the master has \nalready sent all its log data and there have been previous log fetch attempts\nthat resulted in no more log data. This wait time can be used to control the\nmaximum frequency with which the replication applier sends HTTP log fetch\nrequests to the master in case there is no write activity on the master for\nlonger periods. This configuration value will only be used if the option\n*adaptivePolling* is set to *true*.\nThis value will be ignored if set to *0*.\n\n",
"format": "int64",
"type": "integer"
},
"idleMinWaitTime": {
"description": "the minimum wait time (in seconds) that the applier will intentionally idle\nbefore fetching more log data from the master in case the master has\nalready sent all its log data. This wait time can be used to control the\nfrequency with which the replication applier sends HTTP log fetch requests\nto the master in case there is no write activity on the master.\nThis value will be ignored if set to *0*.\n\n",
"format": "int64",
"type": "integer"
},
"includeSystem": {
"description": "whether or not system collection operations will be applied\n\n",
"format": "",
"type": "boolean"
},
"initialSyncMaxWaitTime": {
"description": "the maximum wait time (in seconds) that the initial synchronization will\nwait for a response from the master when fetching initial collection data.\nThis wait time can be used to control after what time the initial\nsynchronization\nwill give up waiting for a response and fail. This value is relevant even\nfor continuous replication when *autoResync* is set to *true* because this\nmay re-start the initial synchronization when the master cannot provide\nlog data the slave requires.\nThis value will be ignored if set to *0*.\n\n",
"format": "int64",
"type": "integer"
},
"maxConnectRetries": {
"description": "the maximum number of connection attempts the applier\nwill make in a row. If the applier cannot establish a connection to the\nendpoint in this number of attempts, it will stop itself.\n\n",
"format": "int64",
"type": "integer"
},
"password": {
"description": "the password to use when connecting to the endpoint.\n\n",
"type": "string"
},
"requestTimeout": {
"description": "the timeout (in seconds) for individual requests to the endpoint.\n\n",
"format": "int64",
"type": "integer"
},
"requireFromPresent": {
"description": "if set to *true*, then the replication applier will check\nat start whether the start tick from which it starts or resumes replication is\nstill present on the master. If not, then there would be data loss. If \n*requireFromPresent* is *true*, the replication applier will abort with an\nappropriate error message. If set to *false*, then the replication applier will\nstill start, and ignore the data loss.\n\n",
"format": "",
"type": "boolean"
},
"restrictCollections": {
"description": "the array of collections to include or exclude,\nbased on the setting of *restrictType*\n\n",
"items": {
"type": "string"
},
"type": "array"
},
"restrictType": {
"description": "the configuration for *restrictCollections*; Has to be either *include* or *exclude*\n\n",
"type": "string"
},
"username": {
"description": "an optional ArangoDB username to use when connecting to the endpoint.\n\n",
"type": "string"
},
"verbose": {
"description": "if set to *true*, then a log line will be emitted for all operations \nperformed by the replication applier. This should be used for debugging replication\nproblems only.\n\n",
"format": "",
"type": "boolean"
}
},
"required": [
"endpoint",
"database",
"password",
"maxConnectRetries",
"connectTimeout",
"requestTimeout",
"chunkSize",
"autoStart",
"adaptivePolling",
"includeSystem",
"requireFromPresent",
"verbose",
"restrictType"
],
"type": "object",
"x-filename": "Replication - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/put_api_replication_makeSlave.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/delete_batch_replication.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/get_api_replication_cluster_inventory.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/get_api_replication_logger_tick_ranges.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/get_api_replication_dump.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/put_api_replication_synchronize.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/put_api_replication_applier.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/get_api_replication_logger_returns.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/post_batch_replication.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/get_api_replication_applier_state.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/get_api_replication_logger_return_state.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/put_api_replication_applier_start.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/put_api_replication_applier_adjust.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/put_api_replication_serverID.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/put_api_replication_applier_stop.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/put_batch_replication.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/put_api_replication_inventory.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/get_api_replication_logger_first_tick.md"
},
"put_api_replication_makeSlave": {
"properties": {
"adaptivePolling": {
"description": "whether or not the replication applier will use adaptive polling.\n\n",
"format": "",
"type": "boolean"
},
"autoResync": {
"description": "whether or not the slave should perform an automatic resynchronization with\nthe master in case the master cannot serve log data requested by the slave,\nor when the replication is started and no tick value can be found.\n\n",
"format": "",
"type": "boolean"
},
"autoResyncRetries": {
"description": "number of resynchronization retries that will be performed in a row when\nautomatic resynchronization is enabled and kicks in. Setting this to *0* will\neffectively disable *autoResync*. Setting it to some other value will limit\nthe number of retries that are performed. This helps preventing endless retries\nin case resynchronizations always fail.\n\n",
"format": "int64",
"type": "integer"
},
"chunkSize": {
"description": "the requested maximum size for log transfer packets that\nis used when the endpoint is contacted.\n\n",
"format": "int64",
"type": "integer"
},
"connectTimeout": {
"description": "the timeout (in seconds) when attempting to connect to the\nendpoint. This value is used for each connection attempt.\n\n",
"format": "int64",
"type": "integer"
},
"connectionRetryWaitTime": {
"description": "the time (in seconds) that the applier will intentionally idle before\nit retries connecting to the master in case of connection problems.\nThis value will be ignored if set to *0*.\n\n",
"format": "int64",
"type": "integer"
},
"database": {
"description": "the database name on the master (if not specified, defaults to the\nname of the local current database).\n\n",
"type": "string"
},
"endpoint": {
"description": "the master endpoint to connect to (e.g. \"tcp://192.168.173.13:8529\").\n\n",
"type": "string"
},
"idleMaxWaitTime": {
"description": "the maximum wait time (in seconds) that the applier will intentionally idle\nbefore fetching more log data from the master in case the master has\nalready sent all its log data and there have been previous log fetch attempts\nthat resulted in no more log data. This wait time can be used to control the\nmaximum frequency with which the replication applier sends HTTP log fetch\nrequests to the master in case there is no write activity on the master for\nlonger periods. This configuration value will only be used if the option\n*adaptivePolling* is set to *true*.\nThis value will be ignored if set to *0*.\n\n",
"format": "int64",
"type": "integer"
},
"idleMinWaitTime": {
"description": "the minimum wait time (in seconds) that the applier will intentionally idle\nbefore fetching more log data from the master in case the master has\nalready sent all its log data. This wait time can be used to control the\nfrequency with which the replication applier sends HTTP log fetch requests\nto the master in case there is no write activity on the master.\nThis value will be ignored if set to *0*.\n\n",
"format": "int64",
"type": "integer"
},
"includeSystem": {
"description": "whether or not system collection operations will be applied\n\n",
"format": "",
"type": "boolean"
},
"initialSyncMaxWaitTime": {
"description": "the maximum wait time (in seconds) that the initial synchronization will\nwait for a response from the master when fetching initial collection data.\nThis wait time can be used to control after what time the initial synchronization\nwill give up waiting for a response and fail. This value is relevant even\nfor continuous replication when *autoResync* is set to *true* because this\nmay re-start the initial synchronization when the master cannot provide\nlog data the slave requires.\nThis value will be ignored if set to *0*.\n\n",
"format": "int64",
"type": "integer"
},
"maxConnectRetries": {
"description": "the maximum number of connection attempts the applier\nwill make in a row. If the applier cannot establish a connection to the\nendpoint in this number of attempts, it will stop itself.\n\n",
"format": "int64",
"type": "integer"
},
"password": {
"description": "the password to use when connecting to the master.\n\n",
"type": "string"
},
"requestTimeout": {
"description": "the timeout (in seconds) for individual requests to the endpoint.\n\n",
"format": "int64",
"type": "integer"
},
"requireFromPresent": {
"description": "if set to *true*, then the replication applier will check\nat start of its continuous replication if the start tick from the dump phase\nis still present on the master. If not, then there would be data loss. If\n*requireFromPresent* is *true*, the replication applier will abort with an\nappropriate error message. If set to *false*, then the replication applier will\nstill start, and ignore the data loss.\n\n",
"format": "",
"type": "boolean"
},
"restrictCollections": {
"description": "an optional array of collections for use with *restrictType*.\nIf *restrictType* is *include*, only the specified collections\nwill be sychronised. If *restrictType* is *exclude*, all but the specified\ncollections will be synchronized.\n\n",
"items": {
"type": "string"
},
"type": "array"
},
"restrictType": {
"description": "an optional string value for collection filtering. When\nspecified, the allowed values are *include* or *exclude*.\n\n",
"type": "string"
},
"username": {
"description": "an optional ArangoDB username to use when connecting to the master.\n\n",
"type": "string"
},
"verbose": {
"description": "if set to *true*, then a log line will be emitted for all operations\nperformed by the replication applier. This should be used for debugging\nreplication\nproblems only.\n\n",
"format": "",
"type": "boolean"
}
},
"required": [
"endpoint",
"database",
"password",
"includeSystem"
],
"type": "object",
"x-filename": "Replication - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/put_api_replication_makeSlave.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/delete_batch_replication.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/get_api_replication_cluster_inventory.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/get_api_replication_logger_tick_ranges.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/get_api_replication_dump.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/put_api_replication_synchronize.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/put_api_replication_applier.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/get_api_replication_logger_returns.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/post_batch_replication.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/get_api_replication_applier_state.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/get_api_replication_logger_return_state.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/put_api_replication_applier_start.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/put_api_replication_applier_adjust.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/put_api_replication_serverID.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/put_api_replication_applier_stop.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/put_batch_replication.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/put_api_replication_inventory.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/get_api_replication_logger_first_tick.md"
},
"put_api_replication_synchronize": {
"properties": {
"database": {
"description": "the database name on the master (if not specified, defaults to the\nname of the local current database).\n\n",
"type": "string"
},
"endpoint": {
"description": "the master endpoint to connect to (e.g. \"tcp://192.168.173.13:8529\").\n\n",
"type": "string"
},
"includeSystem": {
"description": "whether or not system collection operations will be applied\n\n",
"format": "",
"type": "boolean"
},
"incremental": {
"description": "if set to *true*, then an incremental synchronization method will be used\nfor synchronizing data in collections. This method is useful when\ncollections already exist locally, and only the remaining differences need\nto be transferred from the remote endpoint. In this case, the incremental\nsynchronization can be faster than a full synchronization.\nThe default value is *false*, meaning that the complete data from the remote\ncollection will be transferred.\n\n",
"format": "",
"type": "boolean"
},
"initialSyncMaxWaitTime": {
"description": "the maximum wait time (in seconds) that the initial synchronization will\nwait for a response from the master when fetching initial collection data.\nThis wait time can be used to control after what time the initial synchronization\nwill give up waiting for a response and fail.\nThis value will be ignored if set to *0*.\n\n",
"format": "int64",
"type": "integer"
},
"password": {
"description": "the password to use when connecting to the endpoint.\n\n",
"type": "string"
},
"restrictCollections": {
"description": "an optional array of collections for use with\n*restrictType*. If *restrictType* is *include*, only the specified collections\nwill be sychronised. If *restrictType* is *exclude*, all but the specified\ncollections will be synchronized.\n\n",
"items": {
"type": "string"
},
"type": "array"
},
"restrictType": {
"description": "an optional string value for collection filtering. When\nspecified, the allowed values are *include* or *exclude*.\n\n",
"type": "string"
},
"username": {
"description": "an optional ArangoDB username to use when connecting to the endpoint.\n\n",
"type": "string"
}
},
"required": [
"endpoint",
"password"
],
"type": "object",
"x-filename": "Replication - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/put_api_replication_makeSlave.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/delete_batch_replication.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/get_api_replication_cluster_inventory.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/get_api_replication_logger_tick_ranges.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/get_api_replication_dump.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/put_api_replication_synchronize.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/put_api_replication_applier.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/get_api_replication_logger_returns.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/post_batch_replication.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/get_api_replication_applier_state.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/get_api_replication_logger_return_state.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/put_api_replication_applier_start.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/put_api_replication_applier_adjust.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/put_api_replication_serverID.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/put_api_replication_applier_stop.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/put_batch_replication.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/put_api_replication_inventory.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/get_api_replication_logger_first_tick.md"
},
"put_api_simple_remove_by_example_opts": {
"description": "a json object which can contains following attributes:\n\n",
"properties": {
"limit": {
"description": "an optional value that determines how many documents to\ndelete at most. If *limit* is specified but is less than the number\nof documents in the collection, it is undefined which of the documents\nwill be deleted.\n\n",
"type": "string"
},
"waitForSync": {
"description": "if set to true, then all removal operations will\ninstantly be synchronized to disk. If this is not specified, then the\ncollection's default sync behavior will be applied.\n\n",
"type": "boolean"
}
},
"type": "object",
"x-filename": "Simple Queries - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md"
},
"put_api_simple_remove_by_keys_opts": {
"description": "a json object which can contains following attributes:\n\n",
"properties": {
"returnOld": {
"description": "if set to *true* and *silent* above is *false*, then the above\ninformation about the removed documents contains the complete\nremoved documents.\n\n",
"type": "boolean"
},
"silent": {
"description": "if set to *false*, then the result will contain an additional\nattribute *old* which contains an array with one entry for each\nremoved document. By default, these entries will have the *_id*,\n*_key* and *_rev* attributes.\n\n",
"type": "boolean"
},
"waitForSync": {
"description": "if set to true, then all removal operations will\ninstantly be synchronized to disk. If this is not specified, then the\ncollection's default sync behavior will be applied.\n\n",
"type": "boolean"
}
},
"type": "object",
"x-filename": "Simple Queries - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md"
},
"put_api_simple_replace_by_example_options": {
"description": "a json object which can contain following attributes\n\n",
"properties": {
"limit": {
"description": "an optional value that determines how many documents to\nreplace at most. If *limit* is specified but is less than the number\nof documents in the collection, it is undefined which of the documents\nwill be replaced.\n\n\n",
"type": "string"
},
"waitForSync": {
"description": "if set to true, then all removal operations will\n instantly be synchronized to disk. If this is not specified, then the\n collection's default sync behavior will be applied.\n\n",
"type": "boolean"
}
},
"type": "object",
"x-filename": "Simple Queries - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md"
},
"put_api_simple_update_by_example_options": {
"description": "a json object which can contains following attributes:\n\n",
"properties": {
"keepNull": {
"description": "This parameter can be used to modify the behavior when\nhandling *null* values. Normally, *null* values are stored in the\ndatabase. By setting the *keepNull* parameter to *false*, this\nbehavior can be changed so that all attributes in *data* with *null*\nvalues will be removed from the updated document.\n\n",
"type": "boolean"
},
"limit": {
"description": "an optional value that determines how many documents to\nupdate at most. If *limit* is specified but is less than the number\nof documents in the collection, it is undefined which of the documents\nwill be updated.\n\n",
"format": "int64",
"type": "integer"
},
"mergeObjects": {
"description": "Controls whether objects (not arrays) will be merged if present in both the\nexisting and the patch document. If set to false, the value in the\npatch document will overwrite the existing document's value. If set to\ntrue, objects will be merged. The default is true.\n\n",
"type": "boolean"
},
"waitForSync": {
"description": "if set to true, then all removal operations will\ninstantly be synchronized to disk. If this is not specified, then the\ncollection's default sync behavior will be applied.\n\n",
"type": "boolean"
}
},
"type": "object",
"x-filename": "Simple Queries - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md"
},
"put_api_view_properties_iresearch": {
"properties": {
"commit": {
"$ref": "#/definitions/post_api_view_props_commit"
},
"dataPath": {
"description": "The filesystem path where to store persisted view data (default: *\"<ArangoDB database path>/arangosearch-<view-id>\"*).\n\n",
"type": "string"
},
"links": {
"$ref": "#/definitions/post_api_view_links"
},
"locale": {
"description": "The default locale used for queries on analyzed string values (default: *C*).\n\n",
"type": "string"
},
"threadMaxIdle": {
"description": "Maximum idle number of threads for single-run tasks (default: 5).\nFor the case where there are a lot of short-lived asynchronous tasks, a lower value will cause a lot of thread creation/deletion calls.\nFor the case where there are no short-lived asynchronous tasks, a higher value will only waste memory.\n\n",
"format": "uint64",
"type": "integer"
},
"threadMaxTotal": {
"description": "Maximum total number of threads (>0) for single-run tasks (default: 5).\nFor the case where there are a lot of parallelizable tasks and an abundance of resources, a lower value would limit performance.\nFor the case where there are limited resources CPU/memory, a higher value will negatively impact performance.\n\n",
"format": "uint64",
"type": "integer"
}
},
"type": "object",
"x-filename": "Views - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/put_api_view_properties_iresearch.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/JSA_get_api_view_name.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/get_api_views.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/post_api_view_iresearch.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/patch_api_view_properties_iresearch.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/put_api_view_rename.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/delete_api_view.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Views/JSA_get_api_view_properties.md"
},
"put_batch_replication": {
"properties": {
"ttl": {
"description": "the time-to-live for the new batch (in seconds)\n\n",
"format": "int64",
"type": "integer"
}
},
"required": [
"ttl"
],
"type": "object",
"x-filename": "Replication - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/put_api_replication_makeSlave.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/delete_batch_replication.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/get_api_replication_cluster_inventory.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/get_api_replication_logger_tick_ranges.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/get_api_replication_dump.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/put_api_replication_synchronize.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/put_api_replication_applier.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/get_api_replication_logger_returns.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/post_batch_replication.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/get_api_replication_applier_state.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/get_api_replication_logger_return_state.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/put_api_replication_applier_start.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/put_api_replication_applier_adjust.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/put_api_replication_serverID.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/put_api_replication_applier_stop.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/put_batch_replication.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/put_api_replication_inventory.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/get_api_replication_logger_first_tick.md"
}
},
"info": {
"description": "ArangoDB REST API Interface",
"license": {
"name": "Apache License, Version 2.0"
},
"title": "ArangoDB",
"version": "1.0"
},
"paths": {
"/_admin/cluster-test": {
"delete": {
"description": "\n\nSee GET method.\n\n\n",
"parameters": [],
"summary": "Delete cluster roundtrip",
"tags": [
"Cluster"
],
"x-examples": [],
"x-filename": "Cluster - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/cluster_check_port_GET.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/cluster_test_GET.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/cluster_statistics_GET.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/cluster_test_PUT.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/cluster_test_HEAD.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/cluster_test_DELETE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/cluster_test_PATCH.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/cluster_test_POST.md"
},
"get": {
"description": "\n\n\nExecutes a cluster roundtrip from a coordinator to a DB server and\nback. This call only works in a coordinator node in a cluster.\nOne can and should append an arbitrary path to the URL and the\npart after */_admin/cluster-test* is used as the path of the HTTP\nrequest which is sent from the coordinator to a DB node. Likewise,\nany form data appended to the URL is forwarded in the request to the\nDB node. This handler takes care of all request types (see below)\nand uses the same request type in its request to the DB node.\n\nThe following HTTP headers are interpreted in a special way:\n\n - *X-Shard-ID*: This specifies the ID of the shard to which the\n cluster request is sent and thus tells the system to which DB server\n to send the cluster request. Note that the mapping from the\n shard ID to the responsible server has to be defined in the\n agency under *Current/ShardLocation/<shardID>*. One has to give\n this header, otherwise the system does not know where to send\n the request.\n - *X-Client-Transaction-ID*: the value of this header is taken\n as the client transaction ID for the request\n - *X-Timeout*: specifies a timeout in seconds for the cluster\n operation. If the answer does not arrive within the specified\n timeout, an corresponding error is returned and any subsequent\n real answer is ignored. The default if not given is 24 hours.\n - *X-Synchronous-Mode*: If set to *true* the test function uses\n synchronous mode, otherwise the default asynchronous operation\n mode is used. This is mainly for debugging purposes.\n - *Host*: This header is ignored and not forwarded to the DB server.\n - *User-Agent*: This header is ignored and not forwarded to the DB\n server.\n\nAll other HTTP headers and the body of the request (if present, see\nother HTTP methods below) are forwarded as given in the original request.\n\nIn asynchronous mode the DB server answers with an HTTP request of its\nown, in synchronous mode it sends a HTTP response. In both cases the\nheaders and the body are used to produce the HTTP response of this\nAPI call.\n\n",
"parameters": [],
"responses": {
"200": {
"description": "is returned when everything went well, or if a timeout occurred. In the\nlatter case a body of type application/json indicating the timeout\nis returned.\n\n"
},
"403": {
"description": "is returned if ArangoDB is not running in cluster mode.\n\n"
},
"404": {
"description": "is returned if ArangoDB was not compiled for cluster operation.\n\n\n"
}
},
"summary": "Execute cluster roundtrip",
"tags": [
"Cluster"
],
"x-examples": [],
"x-filename": "Cluster - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/cluster_check_port_GET.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/cluster_test_GET.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/cluster_statistics_GET.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/cluster_test_PUT.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/cluster_test_HEAD.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/cluster_test_DELETE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/cluster_test_PATCH.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/cluster_test_POST.md"
},
"head": {
"description": "\n\nSee GET method.\n\n\n",
"parameters": [],
"summary": "Execute cluster roundtrip",
"tags": [
"Cluster"
],
"x-examples": [],
"x-filename": "Cluster - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/cluster_check_port_GET.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/cluster_test_GET.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/cluster_statistics_GET.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/cluster_test_PUT.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/cluster_test_HEAD.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/cluster_test_DELETE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/cluster_test_PATCH.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/cluster_test_POST.md"
},
"patch": {
"description": "\n\nSee GET method. The body can be any type and is simply forwarded.\n\n\n",
"parameters": [
{
"description": "\n",
"in": "body",
"name": "Json Request Body",
"required": true,
"schema": {
"additionalProperties": {},
"type": "object"
},
"x-description-offset": 0
}
],
"summary": "Update cluster roundtrip",
"tags": [
"Cluster"
],
"x-examples": [],
"x-filename": "Cluster - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/cluster_check_port_GET.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/cluster_test_GET.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/cluster_statistics_GET.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/cluster_test_PUT.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/cluster_test_HEAD.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/cluster_test_DELETE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/cluster_test_PATCH.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/cluster_test_POST.md"
},
"post": {
"description": "\n\nSee GET method.\n\n\n",
"parameters": [
{
"description": "The body can be any type and is simply forwarded.\n\n",
"in": "body",
"name": "Json Request Body",
"required": true,
"schema": {
"additionalProperties": {},
"type": "object"
},
"x-description-offset": 0
}
],
"summary": "Execute cluster roundtrip",
"tags": [
"Cluster"
],
"x-examples": [],
"x-filename": "Cluster - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/cluster_check_port_GET.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/cluster_test_GET.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/cluster_statistics_GET.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/cluster_test_PUT.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/cluster_test_HEAD.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/cluster_test_DELETE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/cluster_test_PATCH.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/cluster_test_POST.md"
},
"put": {
"description": "\n\nSee GET method. The body can be any type and is simply forwarded.\n\n\n",
"parameters": [
{
"description": "\n",
"in": "body",
"name": "Json Request Body",
"required": true,
"schema": {
"additionalProperties": {},
"type": "object"
},
"x-description-offset": 0
}
],
"summary": "Execute cluster roundtrip",
"tags": [
"Cluster"
],
"x-examples": [],
"x-filename": "Cluster - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/cluster_check_port_GET.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/cluster_test_GET.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/cluster_statistics_GET.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/cluster_test_PUT.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/cluster_test_HEAD.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/cluster_test_DELETE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/cluster_test_PATCH.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/cluster_test_POST.md"
}
},
"/_admin/clusterCheckPort": {
"get": {
"description": "\n\n\n",
"parameters": [
{
"description": "\n",
"in": "query",
"name": "port",
"required": true,
"type": "integer"
}
],
"responses": {
"200": {
"description": "\n"
},
"400": {
"description": "\n\n"
}
},
"summary": "Check port",
"tags": [
"Cluster"
],
"x-examples": [],
"x-filename": "Cluster - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/cluster_check_port_GET.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/cluster_test_GET.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/cluster_statistics_GET.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/cluster_test_PUT.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/cluster_test_HEAD.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/cluster_test_DELETE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/cluster_test_PATCH.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/cluster_test_POST.md"
}
},
"/_admin/clusterStatistics": {
"get": {
"description": "\n\n\n",
"parameters": [
{
"description": "\n",
"in": "query",
"name": "DBserver",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "\n"
},
"400": {
"description": "ID of a DBserver\n\n"
},
"403": {
"description": "\n\n"
}
},
"summary": "Queries statistics of DBserver",
"tags": [
"Cluster"
],
"x-examples": [],
"x-filename": "Cluster - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/cluster_check_port_GET.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/cluster_test_GET.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/cluster_statistics_GET.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/cluster_test_PUT.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/cluster_test_HEAD.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/cluster_test_DELETE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/cluster_test_PATCH.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/cluster_test_POST.md"
}
},
"/_admin/database/target-version": {
"get": {
"description": "\n\n\nReturns the database-version that this server requires.\nThe version is returned in the *version* attribute of the result.\n\n",
"parameters": [],
"responses": {
"200": {
"description": "Is returned in all cases.\n\n\n"
}
},
"summary": "Return the required version of the database",
"tags": [
"Administration"
],
"x-examples": [],
"x-filename": "Administration - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_long_echo.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_statistics_description.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_time.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_tasks_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_server_role.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_database_version.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_statistics.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_modules_flush.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_server_id.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_cluster_endpoints.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_return.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_endpoint.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/post_admin_execute.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/post_admin_test.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/put_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_initiate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/post_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_engine.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/delete_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_echo.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_routing_reloads.md"
}
},
"/_admin/echo": {
"get": {
"description": "\n\n\nThe call returns an object with the following attributes:\n\n- *headers*: object with HTTP headers received\n\n- *requestType*: the HTTP request method (e.g. GET)\n\n- *parameters*: object with query parameters received\n\n",
"parameters": [],
"responses": {
"200": {
"description": "Echo was returned successfully.\n\n\n"
}
},
"summary": "Return current request",
"tags": [
"Administration"
],
"x-examples": [],
"x-filename": "Administration - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_long_echo.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_statistics_description.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_time.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_tasks_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_server_role.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_database_version.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_statistics.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_modules_flush.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_server_id.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_cluster_endpoints.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_return.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_endpoint.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/post_admin_execute.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/post_admin_test.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/put_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_initiate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/post_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_engine.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/delete_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_echo.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_routing_reloads.md"
}
},
"/_admin/execute": {
"post": {
"description": "\n\n\nExecutes the javascript code in the body on the server as the body\nof a function with no arguments. If you have a *return* statement\nthen the return value you produce will be returned as content type\n*application/json*. If the parameter *returnAsJSON* is set to\n*true*, the result will be a JSON object describing the return value\ndirectly, otherwise a string produced by JSON.stringify will be\nreturned.\n\nNote that this API endpoint will only be present if the server was\nstarted with the option `--javascript.allow-admin-execute true`.\n\nThe default value of this option is `false`, which disables the execution of \nuser-defined code and disables this API endpoint entirely. \nThis is also the recommended setting for production. \n\n\n\n",
"parameters": [
{
"description": "The body to be executed.\n\n",
"in": "body",
"name": "Json Request Body",
"required": true,
"schema": {
"additionalProperties": {},
"type": "object"
},
"x-description-offset": 0
}
],
"summary": "Execute program",
"tags": [
"Administration"
],
"x-examples": [],
"x-filename": "Administration - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_long_echo.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_statistics_description.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_time.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_tasks_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_server_role.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_database_version.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_statistics.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_modules_flush.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_server_id.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_cluster_endpoints.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_return.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_endpoint.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/post_admin_execute.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/post_admin_test.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/put_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_initiate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/post_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_engine.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/delete_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_echo.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_routing_reloads.md"
}
},
"/_admin/log": {
"get": {
"description": "\n\nReturns fatal, error, warning or info log messages from the server's global log.\nThe result is a JSON object with the following attributes:\n\n**A json document with these Properties is returned:**\n\n#### HTTP 200\n- **lid** (string): a list of log entry identifiers. Each log message is uniquely\nidentified by its @LIT{lid} and the identifiers are in ascending\norder.\n- **level**: A list of the loglevels for all log entries.\n- **timestamp** (string): a list of the timestamps as seconds since 1970-01-01 for all log\nentries.\n- **topic**: a list of the topics of all log entries\n- **text**: a list of the texts of all log entries\n- **totalAmount**: the total amount of log entries before pagination.\n\n",
"parameters": [
{
"description": "Returns all log entries up to log level *upto*. Note that *upto* must be:\n- *fatal* or *0*\n- *error* or *1*\n- *warning* or *2*\n- *info* or *3*\n- *debug* or *4*\nThe default value is *info*.\n\n",
"in": "query",
"name": "upto",
"required": false,
"type": "string"
},
{
"description": "Returns all log entries of log level *level*. Note that the query parameters\n*upto* and *level* are mutually exclusive.\n\n",
"in": "query",
"name": "level",
"required": false,
"type": "string"
},
{
"description": "Returns all log entries such that their log entry identifier (*lid* value)\nis greater or equal to *start*.\n\n",
"in": "query",
"name": "start",
"required": false,
"type": "number"
},
{
"description": "Restricts the result to at most *size* log entries.\n\n",
"in": "query",
"name": "size",
"required": false,
"type": "number"
},
{
"description": "Starts to return log entries skipping the first *offset* log entries. *offset*\nand *size* can be used for pagination.\n\n",
"in": "query",
"name": "offset",
"required": false,
"type": "number"
},
{
"description": "Only return the log entries containing the text specified in *search*.\n\n",
"in": "query",
"name": "search",
"required": false,
"type": "string"
},
{
"description": "Sort the log entries either ascending (if *sort* is *asc*) or descending\n(if *sort* is *desc*) according to their *lid* values. Note that the *lid*\nimposes a chronological order. The default value is *asc*.\n\n",
"in": "query",
"name": "sort",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "\n",
"schema": {
"$ref": "#/definitions/get_admin_log_rc_200"
},
"x-description-offset": 198
},
"400": {
"description": "is returned if invalid values are specified for *upto* or *level*.\n\n"
},
"500": {
"description": "is returned if the server cannot generate the result due to an out-of-memory\nerror.\n\n\n\n"
}
},
"summary": "Read global logs from the server",
"tags": [
"Administration"
],
"x-examples": [],
"x-filename": "Administration - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_long_echo.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_statistics_description.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_time.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_tasks_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_server_role.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_database_version.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_statistics.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_modules_flush.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_server_id.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_cluster_endpoints.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_return.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_endpoint.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/post_admin_execute.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/post_admin_test.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/put_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_initiate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/post_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_engine.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/delete_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_echo.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_routing_reloads.md"
}
},
"/_admin/log/level": {
"get": {
"description": "\n\nReturns the server's current loglevel settings.\nThe result is a JSON object with the log topics being the object keys, and\nthe log levels being the object values.\n\n",
"parameters": [],
"responses": {
"200": {
"description": "is returned if the request is valid\n\n"
},
"500": {
"description": "is returned if the server cannot generate the result due to an out-of-memory\nerror.\n\n\n\n"
}
},
"summary": "Return the current server loglevel",
"tags": [
"Administration"
],
"x-examples": [],
"x-filename": "Administration - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_long_echo.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_statistics_description.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_time.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_tasks_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_server_role.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_database_version.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_statistics.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_modules_flush.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_server_id.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_cluster_endpoints.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_return.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_endpoint.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/post_admin_execute.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/post_admin_test.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/put_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_initiate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/post_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_engine.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/delete_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_echo.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_routing_reloads.md"
},
"put": {
"description": "\n\nModifies and returns the server's current loglevel settings.\nThe request body must be a JSON object with the log topics being the object keys\nand the log levels being the object values.\n\nThe result is a JSON object with the adjusted log topics being the object keys, and\nthe adjusted log levels being the object values.\n\nIt can set the loglevel of all facilities by only specifying the loglevel as string without json.\n\nPossible loglevels are:\n - FATAL - There will be no way out of this. ArangoDB will go down after this message.\n - ERROR - This is an error. you should investigate and fix it. It may harm your production.\n - WARNING - This may be serious application-wise, but we don't know.\n - INFO - Something has happened, take notice, but no drama attached.\n - DEBUG - output debug messages\n - TRACE - trace - prepare your log to be flooded - don't use in production.\n\n\n**A JSON object with these properties is required:**\n\n - **audit-service**: One of the possible loglevels.\n - **cache**: One of the possible loglevels.\n - **syscall**: One of the possible loglevels.\n - **communication**: One of the possible loglevels.\n - **audit-authentication**: One of the possible loglevels.\n - **agencycomm**: One of the possible loglevels.\n - **startup**: One of the possible loglevels.\n - **general**: One of the possible loglevels.\n - **cluster**: One of the possible loglevels.\n - **audit-view**: One of the possible loglevels.\n - **collector**: One of the possible loglevels.\n - **audit-documentation**: One of the possible loglevels.\n - **engines**: One of the possible loglevels.\n - **trx**: One of the possible loglevels.\n - **mmap**: One of the possible loglevels.\n - **agency**: One of the possible loglevels.\n - **authentication**: One of the possible loglevels.\n - **memory**: One of the possible loglevels.\n - **performance**: One of the possible loglevels.\n - **config**: One of the possible loglevels.\n - **authorization**: One of the possible loglevels.\n - **development**: One of the possible loglevels.\n - **datafiles**: One of the possible loglevels.\n - **views**: One of the possible loglevels.\n - **ldap**: One of the possible loglevels.\n - **replication**: One of the possible loglevels.\n - **threads**: One of the possible loglevels.\n - **audit-database**: One of the possible loglevels.\n - **v8**: One of the possible loglevels.\n - **ssl**: One of the possible loglevels.\n - **pregel**: One of the possible loglevels.\n - **audit-collection**: One of the possible loglevels.\n - **rocksdb**: One of the possible loglevels.\n - **supervision**: One of the possible loglevels.\n - **graphs**: One of the possible loglevels.\n - **compactor**: One of the possible loglevels.\n - **queries**: One of the possible loglevels.\n - **heartbeat**: One of the possible loglevels.\n - **requests**: One of the possible loglevels.\n\n\n",
"parameters": [
{
"in": "body",
"name": "Json Request Body",
"required": true,
"schema": {
"$ref": "#/definitions/put_admin_loglevel"
},
"x-description-offset": 931
}
],
"responses": {
"200": {
"description": "is returned if the request is valid\n\n"
},
"400": {
"description": "is returned when the request body contains invalid JSON.\n\n"
},
"405": {
"description": "is returned when an invalid HTTP method is used.\n\n"
},
"500": {
"description": "is returned if the server cannot generate the result due to an out-of-memory\nerror.\n\n\n"
}
},
"summary": "Modify and return the current server loglevel",
"tags": [
"Administration"
],
"x-examples": [],
"x-filename": "Administration - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_long_echo.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_statistics_description.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_time.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_tasks_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_server_role.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_database_version.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_statistics.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_modules_flush.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_server_id.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_cluster_endpoints.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_return.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_endpoint.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/post_admin_execute.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/post_admin_test.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/put_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_initiate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/post_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_engine.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/delete_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_echo.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_routing_reloads.md"
}
},
"/_admin/long_echo": {
"get": {
"description": "\n\n\nThe call returns an object with the following attributes:\n\n- *headers*: object with HTTP headers received\n\n- *requestType*: the HTTP request method (e.g. GET)\n\n- *parameters*: object with query parameters received\n\n",
"parameters": [],
"responses": {
"200": {
"description": "Echo was returned successfully.\n\n\n"
}
},
"summary": "Return current request and continues",
"tags": [
"Administration"
],
"x-examples": [],
"x-filename": "Administration - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_long_echo.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_statistics_description.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_time.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_tasks_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_server_role.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_database_version.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_statistics.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_modules_flush.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_server_id.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_cluster_endpoints.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_return.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_endpoint.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/post_admin_execute.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/post_admin_test.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/put_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_initiate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/post_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_engine.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/delete_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_echo.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_routing_reloads.md"
}
},
"/_admin/routing/reload": {
"post": {
"description": "\n\n\nReloads the routing information from the collection *routing*.\n\n",
"parameters": [],
"responses": {
"200": {
"description": "Routing information was reloaded successfully.\n\n\n"
}
},
"summary": "Reloads the routing information",
"tags": [
"Administration"
],
"x-examples": [],
"x-filename": "Administration - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_long_echo.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_statistics_description.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_time.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_tasks_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_server_role.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_database_version.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_statistics.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_modules_flush.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_server_id.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_cluster_endpoints.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_return.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_endpoint.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/post_admin_execute.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/post_admin_test.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/put_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_initiate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/post_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_engine.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/delete_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_echo.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_routing_reloads.md"
}
},
"/_admin/server/id": {
"get": {
"description": "\n\n\nReturns the id of a server in a cluster.\nThe id is empty if it is working in single server mode.\n\n",
"parameters": [],
"responses": {
"200": {
"description": "Is returned in all cases.\n\n\n"
}
},
"summary": "Return id of a server in a cluster",
"tags": [
"Administration"
],
"x-examples": [],
"x-filename": "Administration - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_long_echo.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_statistics_description.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_time.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_tasks_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_server_role.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_database_version.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_statistics.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_modules_flush.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_server_id.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_cluster_endpoints.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_return.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_endpoint.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/post_admin_execute.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/post_admin_test.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/put_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_initiate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/post_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_engine.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/delete_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_echo.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_routing_reloads.md"
}
},
"/_admin/server/role": {
"get": {
"description": "\n\n\nReturns the role of a server in a cluster.\nThe role is returned in the *role* attribute of the result.\nPossible return values for *role* are:\n- *SINGLE*: the server is a standalone server without clustering\n- *COORDINATOR*: the server is a coordinator in a cluster\n- *PRIMARY*: the server is a primary database server in a cluster\n- *SECONDARY*: the server is a secondary database server in a cluster\n- *AGENT*: the server is an agency node in a cluster\n- *UNDEFINED*: in a cluster, *UNDEFINED* is returned if the server role cannot be\n determined.\n\n",
"parameters": [],
"responses": {
"200": {
"description": "Is returned in all cases.\n\n\n"
}
},
"summary": "Return role of a server in a cluster",
"tags": [
"Administration"
],
"x-examples": [],
"x-filename": "Administration - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_long_echo.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_statistics_description.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_time.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_tasks_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_server_role.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_database_version.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_statistics.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_modules_flush.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_server_id.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_cluster_endpoints.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_return.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_endpoint.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/post_admin_execute.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/post_admin_test.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/put_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_initiate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/post_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_engine.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/delete_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_echo.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_routing_reloads.md"
}
},
"/_admin/shutdown": {
"delete": {
"description": "\n\nThis call initiates a clean shutdown sequence. Requires administrive privileges\n\n",
"parameters": [],
"responses": {
"200": {
"description": "is returned in all cases.\n\n\n"
}
},
"summary": "Initiate shutdown sequence",
"tags": [
"Administration"
],
"x-examples": [],
"x-filename": "Administration - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_long_echo.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_statistics_description.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_time.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_tasks_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_server_role.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_database_version.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_statistics.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_modules_flush.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_server_id.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_cluster_endpoints.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_return.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_endpoint.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/post_admin_execute.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/post_admin_test.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/put_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_initiate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/post_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_engine.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/delete_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_echo.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_routing_reloads.md"
}
},
"/_admin/statistics": {
"get": {
"description": "\n\n\nReturns the statistics information. The returned object contains the\nstatistics figures grouped together according to the description returned by\n*_admin/statistics-description*. For instance, to access a figure *userTime*\nfrom the group *system*, you first select the sub-object describing the\ngroup stored in *system* and in that sub-object the value for *userTime* is\nstored in the attribute of the same name.\n\nIn case of a distribution, the returned object contains the total count in\n*count* and the distribution list in *counts*. The sum (or total) of the\nindividual values is returned in *sum*.\n\n\n\n\n**Example:**\n \n\n<pre><code class=\"json\">shell> curl --dump - http://localhost:8529/_admin/statistics\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">200</span> OK\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\nx-content-type-options: nosniff\n\n{ \n <span class=\"hljs-string\">\"time\"</span> : <span class=\"hljs-number\">1513675488.7956874</span>, \n <span class=\"hljs-string\">\"enabled\"</span> : <span class=\"hljs-literal\">true</span>, \n <span class=\"hljs-string\">\"system\"</span> : { \n <span class=\"hljs-string\">\"minorPageFaults\"</span> : <span class=\"hljs-number\">75570</span>, \n <span class=\"hljs-string\">\"majorPageFaults\"</span> : <span class=\"hljs-number\">7</span>, \n <span class=\"hljs-string\">\"userTime\"</span> : <span class=\"hljs-number\">3.12</span>, \n <span class=\"hljs-string\">\"systemTime\"</span> : <span class=\"hljs-number\">1.01</span>, \n <span class=\"hljs-string\">\"numberOfThreads\"</span> : <span class=\"hljs-number\">47</span>, \n <span class=\"hljs-string\">\"residentSize\"</span> : <span class=\"hljs-number\">424198144</span>, \n <span class=\"hljs-string\">\"residentSizePercent\"</span> : <span class=\"hljs-number\">0.012601637541208355</span>, \n <span class=\"hljs-string\">\"virtualSize\"</span> : <span class=\"hljs-number\">3223433216</span> \n }, \n <span class=\"hljs-string\">\"client\"</span> : { \n <span class=\"hljs-string\">\"httpConnections\"</span> : <span class=\"hljs-number\">1</span>, \n <span class=\"hljs-string\">\"connectionTime\"</span> : { \n <span class=\"hljs-string\">\"sum\"</span> : <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-string\">\"count\"</span> : <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-string\">\"counts\"</span> : [ \n <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-number\">0</span> \n ] \n }, \n <span class=\"hljs-string\">\"totalTime\"</span> : { \n <span class=\"hljs-string\">\"sum\"</span> : <span class=\"hljs-number\">15.40323543548584</span>, \n <span class=\"hljs-string\">\"count\"</span> : <span class=\"hljs-number\">4032</span>, \n <span class=\"hljs-string\">\"counts\"</span> : [ \n <span class=\"hljs-number\">3781</span>, \n <span class=\"hljs-number\">155</span>, \n <span class=\"hljs-number\">69</span>, \n <span class=\"hljs-number\">20</span>, \n <span class=\"hljs-number\">7</span>, \n <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-number\">0</span> \n ] \n }, \n <span class=\"hljs-string\">\"requestTime\"</span> : { \n <span class=\"hljs-string\">\"sum\"</span> : <span class=\"hljs-number\">0.11271238327026367</span>, \n <span class=\"hljs-string\">\"count\"</span> : <span class=\"hljs-number\">4032</span>, \n <span class=\"hljs-string\">\"counts\"</span> : [ \n <span class=\"hljs-number\">4031</span>, \n <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-number\">1</span>, \n <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-number\">0</span> \n ] \n }, \n <span class=\"hljs-string\">\"queueTime\"</span> : { \n <span class=\"hljs-string\">\"sum\"</span> : <span class=\"hljs-number\">0.0005056858062744141</span>, \n <span class=\"hljs-string\">\"count\"</span> : <span class=\"hljs-number\">9</span>, \n <span class=\"hljs-string\">\"counts\"</span> : [ \n <span class=\"hljs-number\">9</span>, \n <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-number\">0</span> \n ] \n }, \n <span class=\"hljs-string\">\"ioTime\"</span> : { \n <span class=\"hljs-string\">\"sum\"</span> : <span class=\"hljs-number\">15.290017366409302</span>, \n <span class=\"hljs-string\">\"count\"</span> : <span class=\"hljs-number\">4032</span>, \n <span class=\"hljs-string\">\"counts\"</span> : [ \n <span class=\"hljs-number\">3782</span>, \n <span class=\"hljs-number\">155</span>, \n <span class=\"hljs-number\">69</span>, \n <span class=\"hljs-number\">19</span>, \n <span class=\"hljs-number\">7</span>, \n <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-number\">0</span> \n ] \n }, \n <span class=\"hljs-string\">\"bytesSent\"</span> : { \n <span class=\"hljs-string\">\"sum\"</span> : <span class=\"hljs-number\">1832358</span>, \n <span class=\"hljs-string\">\"count\"</span> : <span class=\"hljs-number\">4032</span>, \n <span class=\"hljs-string\">\"counts\"</span> : [ \n <span class=\"hljs-number\">302</span>, \n <span class=\"hljs-number\">3392</span>, \n <span class=\"hljs-number\">273</span>, \n <span class=\"hljs-number\">65</span>, \n <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-number\">0</span> \n ] \n }, \n <span class=\"hljs-string\">\"bytesReceived\"</span> : { \n <span class=\"hljs-string\">\"sum\"</span> : <span class=\"hljs-number\">870869</span>, \n <span class=\"hljs-string\">\"count\"</span> : <span class=\"hljs-number\">4032</span>, \n <span class=\"hljs-string\">\"counts\"</span> : [ \n <span class=\"hljs-number\">3725</span>, \n <span class=\"hljs-number\">307</span>, \n <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-number\">0</span> \n ] \n } \n }, \n <span class=\"hljs-string\">\"http\"</span> : { \n <span class=\"hljs-string\">\"requestsTotal\"</span> : <span class=\"hljs-number\">4032</span>, \n <span class=\"hljs-string\">\"requestsAsync\"</span> : <span class=\"hljs-number\">9</span>, \n <span class=\"hljs-string\">\"requestsGet\"</span> : <span class=\"hljs-number\">1017</span>, \n <span class=\"hljs-string\">\"requestsHead\"</span> : <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-string\">\"requestsPost\"</span> : <span class=\"hljs-number\">2794</span>, \n <span class=\"hljs-string\">\"requestsPut\"</span> : <span class=\"hljs-number\">70</span>, \n <span class=\"hljs-string\">\"requestsPatch\"</span> : <span class=\"hljs-number\">3</span>, \n <span class=\"hljs-string\">\"requestsDelete\"</span> : <span class=\"hljs-number\">148</span>, \n <span class=\"hljs-string\">\"requestsOptions\"</span> : <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-string\">\"requestsOther\"</span> : <span class=\"hljs-number\">0</span> \n }, \n <span class=\"hljs-string\">\"server\"</span> : { \n <span class=\"hljs-string\">\"uptime\"</span> : <span class=\"hljs-number\">20.24964141845703</span>, \n <span class=\"hljs-string\">\"physicalMemory\"</span> : <span class=\"hljs-number\">33662144512</span>, \n <span class=\"hljs-string\">\"v8Context\"</span> : { \n <span class=\"hljs-string\">\"available\"</span> : <span class=\"hljs-number\">4</span>, \n <span class=\"hljs-string\">\"busy\"</span> : <span class=\"hljs-number\">4</span>, \n <span class=\"hljs-string\">\"dirty\"</span> : <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-string\">\"free\"</span> : <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-string\">\"max\"</span> : <span class=\"hljs-number\">16</span> \n }, \n <span class=\"hljs-string\">\"threads\"</span> : { \n <span class=\"hljs-string\">\"running\"</span> : <span class=\"hljs-number\">5</span>, \n <span class=\"hljs-string\">\"working\"</span> : <span class=\"hljs-number\">4</span>, \n <span class=\"hljs-string\">\"blocked\"</span> : <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-string\">\"queued\"</span> : <span class=\"hljs-number\">1</span> \n } \n }, \n <span class=\"hljs-string\">\"error\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"code\"</span> : <span class=\"hljs-number\">200</span> \n}\n</code></pre>\n\n\n\n\n",
"parameters": [],
"responses": {
"200": {
"description": "Statistics were returned successfully.\n\n"
}
},
"summary": "Read the statistics",
"tags": [
"Administration"
],
"x-examples": [],
"x-filename": "Administration - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_long_echo.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_statistics_description.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_time.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_tasks_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_server_role.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_database_version.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_statistics.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_modules_flush.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_server_id.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_cluster_endpoints.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_return.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_endpoint.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/post_admin_execute.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/post_admin_test.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/put_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_initiate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/post_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_engine.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/delete_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_echo.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_routing_reloads.md"
}
},
"/_admin/statistics-description": {
"get": {
"description": "\n\n\nReturns a description of the statistics returned by */_admin/statistics*.\nThe returned objects contains an array of statistics groups in the attribute\n*groups* and an array of statistics figures in the attribute *figures*.\n\nA statistics group is described by\n\n- *group*: The identifier of the group.\n- *name*: The name of the group.\n- *description*: A description of the group.\n\nA statistics figure is described by\n\n- *group*: The identifier of the group to which this figure belongs.\n- *identifier*: The identifier of the figure. It is unique within the group.\n- *name*: The name of the figure.\n- *description*: A description of the figure.\n- *type*: Either *current*, *accumulated*, or *distribution*.\n- *cuts*: The distribution vector.\n- *units*: Units in which the figure is measured.\n\n\n\n\n**Example:**\n \n\n<pre><code class=\"json\">shell> curl --dump - http://localhost:8529/_admin/statistics-description\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">200</span> OK\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\nx-content-type-options: nosniff\n\n{ \n <span class=\"hljs-string\">\"groups\"</span> : [ \n { \n <span class=\"hljs-string\">\"group\"</span> : <span class=\"hljs-string\">\"system\"</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"Process Statistics\"</span>, \n <span class=\"hljs-string\">\"description\"</span> : <span class=\"hljs-string\">\"Statistics about the ArangoDB process\"</span> \n }, \n { \n <span class=\"hljs-string\">\"group\"</span> : <span class=\"hljs-string\">\"client\"</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"Client Connection Statistics\"</span>, \n <span class=\"hljs-string\">\"description\"</span> : <span class=\"hljs-string\">\"Statistics about the connections.\"</span> \n }, \n { \n <span class=\"hljs-string\">\"group\"</span> : <span class=\"hljs-string\">\"http\"</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"HTTP Request Statistics\"</span>, \n <span class=\"hljs-string\">\"description\"</span> : <span class=\"hljs-string\">\"Statistics about the HTTP requests.\"</span> \n }, \n { \n <span class=\"hljs-string\">\"group\"</span> : <span class=\"hljs-string\">\"server\"</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"Server Statistics\"</span>, \n <span class=\"hljs-string\">\"description\"</span> : <span class=\"hljs-string\">\"Statistics about the ArangoDB server\"</span> \n } \n ], \n <span class=\"hljs-string\">\"figures\"</span> : [ \n { \n <span class=\"hljs-string\">\"group\"</span> : <span class=\"hljs-string\">\"system\"</span>, \n <span class=\"hljs-string\">\"identifier\"</span> : <span class=\"hljs-string\">\"userTime\"</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"User Time\"</span>, \n <span class=\"hljs-string\">\"description\"</span> : <span class=\"hljs-string\">\"Amount of time that this process has been scheduled in user mode, measured in seconds.\"</span>, \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"accumulated\"</span>, \n <span class=\"hljs-string\">\"units\"</span> : <span class=\"hljs-string\">\"seconds\"</span> \n }, \n { \n <span class=\"hljs-string\">\"group\"</span> : <span class=\"hljs-string\">\"system\"</span>, \n <span class=\"hljs-string\">\"identifier\"</span> : <span class=\"hljs-string\">\"systemTime\"</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"System Time\"</span>, \n <span class=\"hljs-string\">\"description\"</span> : <span class=\"hljs-string\">\"Amount of time that this process has been scheduled in kernel mode, measured in seconds.\"</span>, \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"accumulated\"</span>, \n <span class=\"hljs-string\">\"units\"</span> : <span class=\"hljs-string\">\"seconds\"</span> \n }, \n { \n <span class=\"hljs-string\">\"group\"</span> : <span class=\"hljs-string\">\"system\"</span>, \n <span class=\"hljs-string\">\"identifier\"</span> : <span class=\"hljs-string\">\"numberOfThreads\"</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"Number of Threads\"</span>, \n <span class=\"hljs-string\">\"description\"</span> : <span class=\"hljs-string\">\"Number of threads in the arangod process.\"</span>, \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"current\"</span>, \n <span class=\"hljs-string\">\"units\"</span> : <span class=\"hljs-string\">\"number\"</span> \n }, \n { \n <span class=\"hljs-string\">\"group\"</span> : <span class=\"hljs-string\">\"system\"</span>, \n <span class=\"hljs-string\">\"identifier\"</span> : <span class=\"hljs-string\">\"residentSize\"</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"Resident Set Size\"</span>, \n <span class=\"hljs-string\">\"description\"</span> : <span class=\"hljs-string\">\"The total size of the number of pages the process has in real memory. This is just the pages which count toward text, data, or stack space. This does not include pages which have not been demand-loaded in, or which are swapped out. The resident set size is reported in bytes.\"</span>, \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"current\"</span>, \n <span class=\"hljs-string\">\"units\"</span> : <span class=\"hljs-string\">\"bytes\"</span> \n }, \n { \n <span class=\"hljs-string\">\"group\"</span> : <span class=\"hljs-string\">\"system\"</span>, \n <span class=\"hljs-string\">\"identifier\"</span> : <span class=\"hljs-string\">\"residentSizePercent\"</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"Resident Set Size\"</span>, \n <span class=\"hljs-string\">\"description\"</span> : <span class=\"hljs-string\">\"The percentage of physical memory used by the process as resident set size.\"</span>, \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"current\"</span>, \n <span class=\"hljs-string\">\"units\"</span> : <span class=\"hljs-string\">\"percent\"</span> \n }, \n { \n <span class=\"hljs-string\">\"group\"</span> : <span class=\"hljs-string\">\"system\"</span>, \n <span class=\"hljs-string\">\"identifier\"</span> : <span class=\"hljs-string\">\"virtualSize\"</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"Virtual Memory Size\"</span>, \n <span class=\"hljs-string\">\"description\"</span> : <span class=\"hljs-string\">\"On Windows, this figure contains the total amount of memory that the memory manager has committed for the arangod process. On other systems, this figure contains The size of the virtual memory the process is using.\"</span>, \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"current\"</span>, \n <span class=\"hljs-string\">\"units\"</span> : <span class=\"hljs-string\">\"bytes\"</span> \n }, \n { \n <span class=\"hljs-string\">\"group\"</span> : <span class=\"hljs-string\">\"system\"</span>, \n <span class=\"hljs-string\">\"identifier\"</span> : <span class=\"hljs-string\">\"minorPageFaults\"</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"Minor Page Faults\"</span>, \n <span class=\"hljs-string\">\"description\"</span> : <span class=\"hljs-string\">\"The number of minor faults the process has made which have not required loading a memory page from disk. This figure is not reported on Windows.\"</span>, \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"accumulated\"</span>, \n <span class=\"hljs-string\">\"units\"</span> : <span class=\"hljs-string\">\"number\"</span> \n }, \n { \n <span class=\"hljs-string\">\"group\"</span> : <span class=\"hljs-string\">\"system\"</span>, \n <span class=\"hljs-string\">\"identifier\"</span> : <span class=\"hljs-string\">\"majorPageFaults\"</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"Major Page Faults\"</span>, \n <span class=\"hljs-string\">\"description\"</span> : <span class=\"hljs-string\">\"On Windows, this figure contains the total number of page faults. On other system, this figure contains the number of major faults the process has made which have required loading a memory page from disk.\"</span>, \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"accumulated\"</span>, \n <span class=\"hljs-string\">\"units\"</span> : <span class=\"hljs-string\">\"number\"</span> \n }, \n { \n <span class=\"hljs-string\">\"group\"</span> : <span class=\"hljs-string\">\"client\"</span>, \n <span class=\"hljs-string\">\"identifier\"</span> : <span class=\"hljs-string\">\"httpConnections\"</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"Client Connections\"</span>, \n <span class=\"hljs-string\">\"description\"</span> : <span class=\"hljs-string\">\"The number of connections that are currently open.\"</span>, \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"current\"</span>, \n <span class=\"hljs-string\">\"units\"</span> : <span class=\"hljs-string\">\"number\"</span> \n }, \n { \n <span class=\"hljs-string\">\"group\"</span> : <span class=\"hljs-string\">\"client\"</span>, \n <span class=\"hljs-string\">\"identifier\"</span> : <span class=\"hljs-string\">\"totalTime\"</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"Total Time\"</span>, \n <span class=\"hljs-string\">\"description\"</span> : <span class=\"hljs-string\">\"Total time needed to answer a request.\"</span>, \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"distribution\"</span>, \n <span class=\"hljs-string\">\"cuts\"</span> : [ \n <span class=\"hljs-number\">0.01</span>, \n <span class=\"hljs-number\">0.05</span>, \n <span class=\"hljs-number\">0.1</span>, \n <span class=\"hljs-number\">0.2</span>, \n <span class=\"hljs-number\">0.5</span>, \n <span class=\"hljs-number\">1</span> \n ], \n <span class=\"hljs-string\">\"units\"</span> : <span class=\"hljs-string\">\"seconds\"</span> \n }, \n { \n <span class=\"hljs-string\">\"group\"</span> : <span class=\"hljs-string\">\"client\"</span>, \n <span class=\"hljs-string\">\"identifier\"</span> : <span class=\"hljs-string\">\"requestTime\"</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"Request Time\"</span>, \n <span class=\"hljs-string\">\"description\"</span> : <span class=\"hljs-string\">\"Request time needed to answer a request.\"</span>, \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"distribution\"</span>, \n <span class=\"hljs-string\">\"cuts\"</span> : [ \n <span class=\"hljs-number\">0.01</span>, \n <span class=\"hljs-number\">0.05</span>, \n <span class=\"hljs-number\">0.1</span>, \n <span class=\"hljs-number\">0.2</span>, \n <span class=\"hljs-number\">0.5</span>, \n <span class=\"hljs-number\">1</span> \n ], \n <span class=\"hljs-string\">\"units\"</span> : <span class=\"hljs-string\">\"seconds\"</span> \n }, \n { \n <span class=\"hljs-string\">\"group\"</span> : <span class=\"hljs-string\">\"client\"</span>, \n <span class=\"hljs-string\">\"identifier\"</span> : <span class=\"hljs-string\">\"queueTime\"</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"Queue Time\"</span>, \n <span class=\"hljs-string\">\"description\"</span> : <span class=\"hljs-string\">\"Queue time needed to answer a request.\"</span>, \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"distribution\"</span>, \n <span class=\"hljs-string\">\"cuts\"</span> : [ \n <span class=\"hljs-number\">0.01</span>, \n <span class=\"hljs-number\">0.05</span>, \n <span class=\"hljs-number\">0.1</span>, \n <span class=\"hljs-number\">0.2</span>, \n <span class=\"hljs-number\">0.5</span>, \n <span class=\"hljs-number\">1</span> \n ], \n <span class=\"hljs-string\">\"units\"</span> : <span class=\"hljs-string\">\"seconds\"</span> \n }, \n { \n <span class=\"hljs-string\">\"group\"</span> : <span class=\"hljs-string\">\"client\"</span>, \n <span class=\"hljs-string\">\"identifier\"</span> : <span class=\"hljs-string\">\"bytesSent\"</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"Bytes Sent\"</span>, \n <span class=\"hljs-string\">\"description\"</span> : <span class=\"hljs-string\">\"Bytes sents for a request.\"</span>, \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"distribution\"</span>, \n <span class=\"hljs-string\">\"cuts\"</span> : [ \n <span class=\"hljs-number\">250</span>, \n <span class=\"hljs-number\">1000</span>, \n <span class=\"hljs-number\">2000</span>, \n <span class=\"hljs-number\">5000</span>, \n <span class=\"hljs-number\">10000</span> \n ], \n <span class=\"hljs-string\">\"units\"</span> : <span class=\"hljs-string\">\"bytes\"</span> \n }, \n { \n <span class=\"hljs-string\">\"group\"</span> : <span class=\"hljs-string\">\"client\"</span>, \n <span class=\"hljs-string\">\"identifier\"</span> : <span class=\"hljs-string\">\"bytesReceived\"</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"Bytes Received\"</span>, \n <span class=\"hljs-string\">\"description\"</span> : <span class=\"hljs-string\">\"Bytes receiveds for a request.\"</span>, \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"distribution\"</span>, \n <span class=\"hljs-string\">\"cuts\"</span> : [ \n <span class=\"hljs-number\">250</span>, \n <span class=\"hljs-number\">1000</span>, \n <span class=\"hljs-number\">2000</span>, \n <span class=\"hljs-number\">5000</span>, \n <span class=\"hljs-number\">10000</span> \n ], \n <span class=\"hljs-string\">\"units\"</span> : <span class=\"hljs-string\">\"bytes\"</span> \n }, \n { \n <span class=\"hljs-string\">\"group\"</span> : <span class=\"hljs-string\">\"client\"</span>, \n <span class=\"hljs-string\">\"identifier\"</span> : <span class=\"hljs-string\">\"connectionTime\"</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"Connection Time\"</span>, \n <span class=\"hljs-string\">\"description\"</span> : <span class=\"hljs-string\">\"Total connection time of a client.\"</span>, \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"distribution\"</span>, \n <span class=\"hljs-string\">\"cuts\"</span> : [ \n <span class=\"hljs-number\">0.1</span>, \n <span class=\"hljs-number\">1</span>, \n <span class=\"hljs-number\">60</span> \n ], \n <span class=\"hljs-string\">\"units\"</span> : <span class=\"hljs-string\">\"seconds\"</span> \n }, \n { \n <span class=\"hljs-string\">\"group\"</span> : <span class=\"hljs-string\">\"http\"</span>, \n <span class=\"hljs-string\">\"identifier\"</span> : <span class=\"hljs-string\">\"requestsTotal\"</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"Total requests\"</span>, \n <span class=\"hljs-string\">\"description\"</span> : <span class=\"hljs-string\">\"Total number of HTTP requests.\"</span>, \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"accumulated\"</span>, \n <span class=\"hljs-string\">\"units\"</span> : <span class=\"hljs-string\">\"number\"</span> \n }, \n { \n <span class=\"hljs-string\">\"group\"</span> : <span class=\"hljs-string\">\"http\"</span>, \n <span class=\"hljs-string\">\"identifier\"</span> : <span class=\"hljs-string\">\"requestsAsync\"</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"Async requests\"</span>, \n <span class=\"hljs-string\">\"description\"</span> : <span class=\"hljs-string\">\"Number of asynchronously executed HTTP requests.\"</span>, \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"accumulated\"</span>, \n <span class=\"hljs-string\">\"units\"</span> : <span class=\"hljs-string\">\"number\"</span> \n }, \n { \n <span class=\"hljs-string\">\"group\"</span> : <span class=\"hljs-string\">\"http\"</span>, \n <span class=\"hljs-string\">\"identifier\"</span> : <span class=\"hljs-string\">\"requestsGet\"</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"HTTP GET requests\"</span>, \n <span class=\"hljs-string\">\"description\"</span> : <span class=\"hljs-string\">\"Number of HTTP GET requests.\"</span>, \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"accumulated\"</span>, \n <span class=\"hljs-string\">\"units\"</span> : <span class=\"hljs-string\">\"number\"</span> \n }, \n { \n <span class=\"hljs-string\">\"group\"</span> : <span class=\"hljs-string\">\"http\"</span>, \n <span class=\"hljs-string\">\"identifier\"</span> : <span class=\"hljs-string\">\"requestsHead\"</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"HTTP HEAD requests\"</span>, \n <span class=\"hljs-string\">\"description\"</span> : <span class=\"hljs-string\">\"Number of HTTP HEAD requests.\"</span>, \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"accumulated\"</span>, \n <span class=\"hljs-string\">\"units\"</span> : <span class=\"hljs-string\">\"number\"</span> \n }, \n { \n <span class=\"hljs-string\">\"group\"</span> : <span class=\"hljs-string\">\"http\"</span>, \n <span class=\"hljs-string\">\"identifier\"</span> : <span class=\"hljs-string\">\"requestsPost\"</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"HTTP POST requests\"</span>, \n <span class=\"hljs-string\">\"description\"</span> : <span class=\"hljs-string\">\"Number of HTTP POST requests.\"</span>, \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"accumulated\"</span>, \n <span class=\"hljs-string\">\"units\"</span> : <span class=\"hljs-string\">\"number\"</span> \n }, \n { \n <span class=\"hljs-string\">\"group\"</span> : <span class=\"hljs-string\">\"http\"</span>, \n <span class=\"hljs-string\">\"identifier\"</span> : <span class=\"hljs-string\">\"requestsPut\"</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"HTTP PUT requests\"</span>, \n <span class=\"hljs-string\">\"description\"</span> : <span class=\"hljs-string\">\"Number of HTTP PUT requests.\"</span>, \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"accumulated\"</span>, \n <span class=\"hljs-string\">\"units\"</span> : <span class=\"hljs-string\">\"number\"</span> \n }, \n { \n <span class=\"hljs-string\">\"group\"</span> : <span class=\"hljs-string\">\"http\"</span>, \n <span class=\"hljs-string\">\"identifier\"</span> : <span class=\"hljs-string\">\"requestsPatch\"</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"HTTP PATCH requests\"</span>, \n <span class=\"hljs-string\">\"description\"</span> : <span class=\"hljs-string\">\"Number of HTTP PATCH requests.\"</span>, \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"accumulated\"</span>, \n <span class=\"hljs-string\">\"units\"</span> : <span class=\"hljs-string\">\"number\"</span> \n }, \n { \n <span class=\"hljs-string\">\"group\"</span> : <span class=\"hljs-string\">\"http\"</span>, \n <span class=\"hljs-string\">\"identifier\"</span> : <span class=\"hljs-string\">\"requestsDelete\"</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"HTTP DELETE requests\"</span>, \n <span class=\"hljs-string\">\"description\"</span> : <span class=\"hljs-string\">\"Number of HTTP DELETE requests.\"</span>, \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"accumulated\"</span>, \n <span class=\"hljs-string\">\"units\"</span> : <span class=\"hljs-string\">\"number\"</span> \n }, \n { \n <span class=\"hljs-string\">\"group\"</span> : <span class=\"hljs-string\">\"http\"</span>, \n <span class=\"hljs-string\">\"identifier\"</span> : <span class=\"hljs-string\">\"requestsOptions\"</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"HTTP OPTIONS requests\"</span>, \n <span class=\"hljs-string\">\"description\"</span> : <span class=\"hljs-string\">\"Number of HTTP OPTIONS requests.\"</span>, \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"accumulated\"</span>, \n <span class=\"hljs-string\">\"units\"</span> : <span class=\"hljs-string\">\"number\"</span> \n }, \n { \n <span class=\"hljs-string\">\"group\"</span> : <span class=\"hljs-string\">\"http\"</span>, \n <span class=\"hljs-string\">\"identifier\"</span> : <span class=\"hljs-string\">\"requestsOther\"</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"other HTTP requests\"</span>, \n <span class=\"hljs-string\">\"description\"</span> : <span class=\"hljs-string\">\"Number of other HTTP requests.\"</span>, \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"accumulated\"</span>, \n <span class=\"hljs-string\">\"units\"</span> : <span class=\"hljs-string\">\"number\"</span> \n }, \n { \n <span class=\"hljs-string\">\"group\"</span> : <span class=\"hljs-string\">\"server\"</span>, \n <span class=\"hljs-string\">\"identifier\"</span> : <span class=\"hljs-string\">\"uptime\"</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"Server Uptime\"</span>, \n <span class=\"hljs-string\">\"description\"</span> : <span class=\"hljs-string\">\"Number of seconds elapsed since server start.\"</span>, \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"current\"</span>, \n <span class=\"hljs-string\">\"units\"</span> : <span class=\"hljs-string\">\"seconds\"</span> \n }, \n { \n <span class=\"hljs-string\">\"group\"</span> : <span class=\"hljs-string\">\"server\"</span>, \n <span class=\"hljs-string\">\"identifier\"</span> : <span class=\"hljs-string\">\"physicalMemory\"</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"Physical Memory\"</span>, \n <span class=\"hljs-string\">\"description\"</span> : <span class=\"hljs-string\">\"Physical memory in bytes.\"</span>, \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"current\"</span>, \n <span class=\"hljs-string\">\"units\"</span> : <span class=\"hljs-string\">\"bytes\"</span> \n } \n ], \n <span class=\"hljs-string\">\"error\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"code\"</span> : <span class=\"hljs-number\">200</span> \n}\n</code></pre>\n\n\n\n\n",
"parameters": [],
"responses": {
"200": {
"description": "Description was returned successfully.\n\n"
}
},
"summary": "Statistics description",
"tags": [
"Administration"
],
"x-examples": [],
"x-filename": "Administration - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_long_echo.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_statistics_description.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_time.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_tasks_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_server_role.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_database_version.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_statistics.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_modules_flush.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_server_id.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_cluster_endpoints.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_return.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_endpoint.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/post_admin_execute.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/post_admin_test.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/put_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_initiate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/post_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_engine.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/delete_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_echo.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_routing_reloads.md"
}
},
"/_admin/test": {
"post": {
"description": "\n\n\nExecutes the specified tests on the server and returns an object with the\ntest results. The object has an attribute \"error\" which states whether\nany error occurred. The object also has an attribute \"passed\" which\nindicates which tests passed and which did not.\n\n\n",
"parameters": [
{
"description": "A JSON object containing an attribute *tests* which lists the files\ncontaining the test suites.\n\n",
"in": "body",
"name": "Json Request Body",
"required": true,
"schema": {
"additionalProperties": {},
"type": "object"
},
"x-description-offset": 0
}
],
"summary": "Runs tests on server",
"tags": [
"Administration"
],
"x-examples": [],
"x-filename": "Administration - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_long_echo.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_statistics_description.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_time.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_tasks_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_server_role.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_database_version.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_statistics.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_modules_flush.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_server_id.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_cluster_endpoints.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_return.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_endpoint.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/post_admin_execute.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/post_admin_test.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/put_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_initiate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/post_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_engine.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/delete_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_echo.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_routing_reloads.md"
}
},
"/_admin/time": {
"get": {
"description": "\n\n\nThe call returns an object with the attribute *time*. This contains the\ncurrent system time as a Unix timestamp with microsecond precision.\n\n",
"parameters": [],
"responses": {
"200": {
"description": "Time was returned successfully.\n\n\n"
}
},
"summary": "Return system time",
"tags": [
"Administration"
],
"x-examples": [],
"x-filename": "Administration - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_long_echo.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_statistics_description.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_time.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_tasks_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_server_role.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_database_version.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_statistics.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_modules_flush.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_server_id.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_cluster_endpoints.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_return.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_endpoint.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/post_admin_execute.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/post_admin_test.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/put_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_initiate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/post_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_engine.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/delete_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_echo.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_routing_reloads.md"
}
},
"/_admin/wal/flush": {
"put": {
"description": "\n\n\nFlushes the write-ahead log. By flushing the currently active write-ahead\nlogfile, the data in it can be transferred to collection journals and\ndatafiles. This is useful to ensure that all data for a collection is\npresent in the collection journals and datafiles, for example, when dumping\nthe data of a collection.\n\n",
"parameters": [
{
"description": "Whether or not the operation should block until the not-yet synchronized\ndata in the write-ahead log was synchronized to disk.\n\n",
"in": "query",
"name": "waitForSync",
"required": false,
"type": "boolean"
},
{
"description": "Whether or not the operation should block until the data in the flushed\nlog has been collected by the write-ahead log garbage collector. Note that\nsetting this option to *true* might block for a long time if there are\nlong-running transactions and the write-ahead log garbage collector cannot\nfinish garbage collection.\n\n",
"in": "query",
"name": "waitForCollector",
"required": false,
"type": "boolean"
}
],
"responses": {
"200": {
"description": "Is returned if the operation succeeds.\n\n"
},
"405": {
"description": "is returned when an invalid HTTP method is used.\n\n\n"
}
},
"summary": "Flushes the write-ahead log",
"tags": [
"wal"
],
"x-examples": [],
"x-filename": "wal - /home/willi/src/devel/Documentation/DocuBlocks/Rest/wal/put_admin_wal_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/wal/get_admin_wal_transactions.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/wal/put_admin_wal_flush.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/wal/get_admin_wal_properties.md"
}
},
"/_admin/wal/properties": {
"get": {
"description": "\n\n\nRetrieves the configuration of the write-ahead log. The result is a JSON\nobject with the following attributes:\n- *allowOversizeEntries*: whether or not operations that are bigger than a\n single logfile can be executed and stored\n- *logfileSize*: the size of each write-ahead logfile\n- *historicLogfiles*: the maximum number of historic logfiles to keep\n- *reserveLogfiles*: the maximum number of reserve logfiles that ArangoDB\n allocates in the background\n- *syncInterval*: the interval for automatic synchronization of not-yet\n synchronized write-ahead log data (in milliseconds)\n- *throttleWait*: the maximum wait time that operations will wait before\n they get aborted if case of write-throttling (in milliseconds)\n- *throttleWhenPending*: the number of unprocessed garbage-collection\n operations that, when reached, will activate write-throttling. A value of\n *0* means that write-throttling will not be triggered.\n\n\n\n\n**Example:**\n \n\n<pre><code class=\"json\">shell> curl --dump - http://localhost:8529/_admin/wal/properties\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">200</span> OK\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\nx-content-type-options: nosniff\n\n{ \n <span class=\"hljs-string\">\"allowOversizeEntries\"</span> : <span class=\"hljs-literal\">true</span>, \n <span class=\"hljs-string\">\"logfileSize\"</span> : <span class=\"hljs-number\">33554432</span>, \n <span class=\"hljs-string\">\"historicLogfiles\"</span> : <span class=\"hljs-number\">10</span>, \n <span class=\"hljs-string\">\"reserveLogfiles\"</span> : <span class=\"hljs-number\">3</span>, \n <span class=\"hljs-string\">\"syncInterval\"</span> : <span class=\"hljs-number\">100</span>, \n <span class=\"hljs-string\">\"throttleWait\"</span> : <span class=\"hljs-number\">15000</span>, \n <span class=\"hljs-string\">\"throttleWhenPending\"</span> : <span class=\"hljs-number\">0</span> \n}\n</code></pre>\n\n\n\n\n",
"parameters": [],
"responses": {
"200": {
"description": "Is returned if the operation succeeds.\n\n"
},
"405": {
"description": "is returned when an invalid HTTP method is used.\n\n\n"
}
},
"summary": "Retrieves the configuration of the write-ahead log",
"tags": [
"wal"
],
"x-examples": [],
"x-filename": "wal - /home/willi/src/devel/Documentation/DocuBlocks/Rest/wal/put_admin_wal_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/wal/get_admin_wal_transactions.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/wal/put_admin_wal_flush.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/wal/get_admin_wal_properties.md"
},
"put": {
"description": "\n\n\nConfigures the behavior of the write-ahead log. The body of the request\nmust be a JSON object with the following attributes:\n- *allowOversizeEntries*: whether or not operations that are bigger than a\n single logfile can be executed and stored\n- *logfileSize*: the size of each write-ahead logfile\n- *historicLogfiles*: the maximum number of historic logfiles to keep\n- *reserveLogfiles*: the maximum number of reserve logfiles that ArangoDB\n allocates in the background\n- *throttleWait*: the maximum wait time that operations will wait before\n they get aborted if case of write-throttling (in milliseconds)\n- *throttleWhenPending*: the number of unprocessed garbage-collection\n operations that, when reached, will activate write-throttling. A value of\n *0* means that write-throttling will not be triggered.\n\nSpecifying any of the above attributes is optional. Not specified attributes\nwill be ignored and the configuration for them will not be modified.\n\n\n\n\n**Example:**\n \n\n<pre><code class=\"json\">shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_admin/wal/properties &lt;&lt;EOF\n{ \n <span class=\"hljs-string\">\"logfileSize\"</span> : <span class=\"hljs-number\">33554432</span>, \n <span class=\"hljs-string\">\"allowOversizeEntries\"</span> : <span class=\"hljs-literal\">true</span> \n}\nEOF\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">200</span> OK\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\nx-content-type-options: nosniff\n\n{ \n <span class=\"hljs-string\">\"allowOversizeEntries\"</span> : <span class=\"hljs-literal\">true</span>, \n <span class=\"hljs-string\">\"logfileSize\"</span> : <span class=\"hljs-number\">33554432</span>, \n <span class=\"hljs-string\">\"historicLogfiles\"</span> : <span class=\"hljs-number\">10</span>, \n <span class=\"hljs-string\">\"reserveLogfiles\"</span> : <span class=\"hljs-number\">3</span>, \n <span class=\"hljs-string\">\"syncInterval\"</span> : <span class=\"hljs-number\">100</span>, \n <span class=\"hljs-string\">\"throttleWait\"</span> : <span class=\"hljs-number\">15000</span>, \n <span class=\"hljs-string\">\"throttleWhenPending\"</span> : <span class=\"hljs-number\">0</span> \n}\n</code></pre>\n\n\n\n\n",
"parameters": [],
"responses": {
"200": {
"description": "Is returned if the operation succeeds.\n\n"
},
"405": {
"description": "is returned when an invalid HTTP method is used.\n\n\n"
}
},
"summary": "Configures the write-ahead log",
"tags": [
"wal"
],
"x-examples": [],
"x-filename": "wal - /home/willi/src/devel/Documentation/DocuBlocks/Rest/wal/put_admin_wal_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/wal/get_admin_wal_transactions.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/wal/put_admin_wal_flush.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/wal/get_admin_wal_properties.md"
}
},
"/_admin/wal/transactions": {
"get": {
"description": "\n\n\nReturns information about the currently running transactions. The result\nis a JSON object with the following attributes:\n- *runningTransactions*: number of currently running transactions\n- *minLastCollected*: minimum id of the last collected logfile (at the\n start of each running transaction). This is *null* if no transaction is\n running.\n- *minLastSealed*: minimum id of the last sealed logfile (at the\n start of each running transaction). This is *null* if no transaction is\n running.\n\n\n\n\n**Example:**\n \n\n<pre><code class=\"json\">shell> curl --dump - http://localhost:8529/_admin/wal/transactions\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">200</span> OK\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\nx-content-type-options: nosniff\n\n{ \n <span class=\"hljs-string\">\"runningTransactions\"</span> : <span class=\"hljs-number\">2</span>, \n <span class=\"hljs-string\">\"minLastCollected\"</span> : <span class=\"hljs-number\">41</span>, \n <span class=\"hljs-string\">\"minLastSealed\"</span> : <span class=\"hljs-literal\">null</span> \n}\n</code></pre>\n\n\n\n\n",
"parameters": [],
"responses": {
"200": {
"description": "Is returned if the operation succeeds.\n\n"
},
"405": {
"description": "is returned when an invalid HTTP method is used.\n\n\n"
}
},
"summary": "Returns information about the currently running transactions",
"tags": [
"wal"
],
"x-examples": [],
"x-filename": "wal - /home/willi/src/devel/Documentation/DocuBlocks/Rest/wal/put_admin_wal_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/wal/get_admin_wal_transactions.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/wal/put_admin_wal_flush.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/wal/get_admin_wal_properties.md"
}
},
"/_api/aqlfunction": {
"get": {
"description": "\n\nReturns all registered AQL user functions.\n\nThe call will return a JSON array with status codes and all user functions found under *result*.\n\n**A json document with these Properties is returned:**\n\n#### HTTP 200\non success *HTTP 200* is returned.\n\n- **code**: the HTTP status code\n- **result**: All functions, or the ones matching the *namespace* parameter \n - **isDeterministic**: an optional boolean value to indicate whether the function\n results are fully deterministic (function return value solely depends on\n the input value and return value is the same for repeated calls with same\n input). The *isDeterministic* attribute is currently not used but may be\n used later for optimisations.\n - **code**: A string representation of the function body\n - **name**: The fully qualified name of the user function\n- **error**: boolean flag to indicate whether an error occurred (*false* in this case)\n\n**A json document with these Properties is returned:**\n\n#### HTTP 400\nIf the user function name is malformed, the server will respond with *HTTP 400*.\n\n- **errorMessage**: a descriptive error message\n- **errorNum**: the server error number\n- **code**: the HTTP status code\n- **error**: boolean flag to indicate whether an error occurred (*true* in this case)\n\n\n\n\n**Example:**\n \n\n<pre><code class=\"json\">shell> curl --dump - http://localhost:8529/_api/aqlfunction/test\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">200</span> OK\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\nx-content-type-options: nosniff\n\n{ \n <span class=\"hljs-string\">\"error\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"code\"</span> : <span class=\"hljs-number\">200</span>, \n <span class=\"hljs-string\">\"result\"</span> : [ ] \n}\n</code></pre>\n\n\n\n\n",
"parameters": [
{
"description": "Returns all registered AQL user functions from namespace *namespace* under *result*.\n\n",
"in": "query",
"name": "namespace",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "on success *HTTP 200* is returned.\n\n",
"schema": {
"$ref": "#/definitions/get_api_aqlfunction_rc_200"
},
"x-description-offset": 199
},
"400": {
"description": "If the user function name is malformed, the server will respond with *HTTP 400*.\n\n",
"schema": {
"$ref": "#/definitions/get_api_aqlfunction_rc_400"
},
"x-description-offset": 254
}
},
"summary": "Return registered AQL user functions",
"tags": [
"AQL"
],
"x-examples": [],
"x-filename": "AQL - /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/get_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/post_api_explain.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/post_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/delete_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md"
},
"post": {
"description": "\n**A JSON object with these properties is required:**\n\n - **isDeterministic**: an optional boolean value to indicate whether the function\n results are fully deterministic (function return value solely depends on\n the input value and return value is the same for repeated calls with same\n input). The *isDeterministic* attribute is currently not used but may be\n used later for optimisations.\n - **code**: a string representation of the function body.\n - **name**: the fully qualified name of the user functions.\n\n\n\n\n\nIn case of success, HTTP 200 is returned.\nIf the function isn't valid etc. HTTP 400 including a detailed error message will be returned.\n\n**A json document with these Properties is returned:**\n\n#### HTTP 200\nIf the function already existed and was replaced by the\ncall, the server will respond with *HTTP 200*.\n\n- **code**: the HTTP status code\n- **error**: boolean flag to indicate whether an error occurred (*false* in this case)\n\n**A json document with these Properties is returned:**\n\n#### HTTP 201\nIf the function can be registered by the server, the server will respond with\n*HTTP 201*.\n\n- **code**: the HTTP status code\n- **error**: boolean flag to indicate whether an error occurred (*false* in this case)\n\n**A json document with these Properties is returned:**\n\n#### HTTP 400\nIf the JSON representation is malformed or mandatory data is missing from the\nrequest, the server will respond with *HTTP 400*.\n\n- **errorMessage**: a descriptive error message\n- **errorNum**: the server error number\n- **code**: the HTTP status code\n- **error**: boolean flag to indicate whether an error occurred (*true* in this case)\n\n\n\n\n**Example:**\n \n\n<pre><code class=\"json\">shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/aqlfunction &lt;&lt;EOF\n{ \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"myfunctions::temperature::celsiustofahrenheit\"</span>, \n <span class=\"hljs-string\">\"code\"</span> : <span class=\"hljs-string\">\"function (celsius) { return celsius * 1.8 + 32; }\"</span>, \n <span class=\"hljs-string\">\"isDeterministic\"</span> : <span class=\"hljs-literal\">true</span> \n}\nEOF\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">201</span> Created\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\nx-content-type-options: nosniff\n\n{ \n <span class=\"hljs-string\">\"error\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"code\"</span> : <span class=\"hljs-number\">201</span> \n}\n</code></pre>\n\n\n\n\n",
"parameters": [
{
"in": "body",
"name": "Json Request Body",
"required": true,
"schema": {
"$ref": "#/definitions/post_api_aqlfunction"
},
"x-description-offset": 54
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "If the function already existed and was replaced by the\ncall, the server will respond with *HTTP 200*.\n\n",
"schema": {
"$ref": "#/definitions/post_api_aqlfunction_rc_200"
},
"x-description-offset": 250
},
"201": {
"description": "If the function can be registered by the server, the server will respond with\n*HTTP 201*.\n\n",
"schema": {
"$ref": "#/definitions/post_api_aqlfunction_rc_201"
},
"x-description-offset": 305
},
"400": {
"description": "If the JSON representation is malformed or mandatory data is missing from the\nrequest, the server will respond with *HTTP 400*.\n\n",
"schema": {
"$ref": "#/definitions/post_api_aqlfunction_rc_400"
},
"x-description-offset": 360
}
},
"summary": "Create AQL user function",
"tags": [
"AQL"
],
"x-examples": [],
"x-filename": "AQL - /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/get_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/post_api_explain.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/post_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/delete_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md"
}
},
"/_api/aqlfunction/{name}": {
"delete": {
"description": "\n\n\nRemoves an existing AQL user function or function group, identified by *name*.\n\n**A json document with these Properties is returned:**\n\n#### HTTP 200\nIf the function can be removed by the server, the server will respond with\n*HTTP 200*.\n\n- **deletedCount**: The number of deleted user functions, always `1` when `group` is set to *false*. \nAny number `>= 0` when `group` is set to *true*\n- **code**: the HTTP status code\n- **error**: boolean flag to indicate whether an error occurred (*false* in this case)\n\n**A json document with these Properties is returned:**\n\n#### HTTP 400\nIf the user function name is malformed, the server will respond with *HTTP 400*.\n\n- **errorMessage**: a descriptive error message\n- **errorNum**: the server error number\n- **code**: the HTTP status code\n- **error**: boolean flag to indicate whether an error occurred (*true* in this case)\n\n**A json document with these Properties is returned:**\n\n#### HTTP 404\nIf the specified user user function does not exist, the server will respond with *HTTP 404*.\n\n- **errorMessage**: a descriptive error message\n- **errorNum**: the server error number\n- **code**: the HTTP status code\n- **error**: boolean flag to indicate whether an error occurred (*true* in this case)\n\n\n\n\n**Example:**\n deletes a function:\n\n<pre><code class=\"json\">shell> curl -X DELETE --dump - http://localhost:8529/_api/aqlfunction/square::x::y\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">200</span> OK\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\nx-content-type-options: nosniff\n\n{ \n <span class=\"hljs-string\">\"code\"</span> : <span class=\"hljs-number\">200</span>, \n <span class=\"hljs-string\">\"error\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"deletedCount\"</span> : <span class=\"hljs-number\">1</span> \n}\n</code></pre>\n\n\n\n\n**Example:**\n function not found:\n\n<pre><code class=\"json\">shell> curl -X DELETE --dump - http://localhost:8529/_api/aqlfunction/myfunction::x::y\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">404</span> Not Found\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\nx-content-type-options: nosniff\n\n{ \n <span class=\"hljs-string\">\"error\"</span> : <span class=\"hljs-literal\">true</span>, \n <span class=\"hljs-string\">\"errorMessage\"</span> : <span class=\"hljs-string\">\"no AQL user function with name 'myfunction::x::y' found\"</span>, \n <span class=\"hljs-string\">\"code\"</span> : <span class=\"hljs-number\">404</span>, \n <span class=\"hljs-string\">\"errorNum\"</span> : <span class=\"hljs-number\">1582</span> \n}\n</code></pre>\n\n\n\n\n",
"parameters": [
{
"description": "the name of the AQL user function.\n\n",
"format": "string",
"in": "path",
"name": "name",
"required": true,
"type": "string"
},
{
"description": "- *true*: The function name provided in *name* is treated as\n a namespace prefix, and all functions in the specified namespace will be deleted.\n The returned number of deleted functions may become 0 if none matches the string.\n- *false*: The function name provided in *name* must be fully\n qualified, including any namespaces. If none matches the *name*, HTTP 404 is returned. \n\n",
"in": "query",
"name": "group",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "If the function can be removed by the server, the server will respond with\n*HTTP 200*.\n\n",
"schema": {
"$ref": "#/definitions/delete_api_aqlfunction_rc_200"
},
"x-description-offset": 138
},
"400": {
"description": "If the user function name is malformed, the server will respond with *HTTP 400*.\n\n",
"schema": {
"$ref": "#/definitions/delete_api_aqlfunction_rc_400"
},
"x-description-offset": 193
},
"404": {
"description": "If the specified user user function does not exist, the server will respond with *HTTP 404*.\n\n",
"schema": {
"$ref": "#/definitions/delete_api_aqlfunction_rc_404"
},
"x-description-offset": 248
}
},
"summary": "Remove existing AQL user function",
"tags": [
"AQL"
],
"x-examples": [],
"x-filename": "AQL - /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/get_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/post_api_explain.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/post_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/delete_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md"
}
},
"/_api/batch": {
"post": {
"description": "\n\nExecutes a batch request. A batch request can contain any number of\nother requests that can be sent to ArangoDB in isolation. The benefit of\nusing batch requests is that batching requests requires less client/server\nroundtrips than when sending isolated requests.\n\nAll parts of a batch request are executed serially on the server. The\nserver will return the results of all parts in a single response when all\nparts are finished.\n\nTechnically, a batch request is a multipart HTTP request, with\ncontent-type `multipart/form-data`. A batch request consists of an\nenvelope and the individual batch part actions. Batch part actions\nare \"regular\" HTTP requests, including full header and an optional body.\nMultiple batch parts are separated by a boundary identifier. The\nboundary identifier is declared in the batch envelope. The MIME content-type\nfor each individual batch part must be `application/x-arango-batchpart`.\n\nPlease note that when constructing the individual batch parts, you must\nuse CRLF (`\\\\\\r\\\\\\n`) as the line terminator as in regular HTTP messages.\n\nThe response sent by the server will be an `HTTP 200` response, with an\noptional error summary header `x-arango-errors`. This header contains the\nnumber of batch part operations that failed with an HTTP error code of at\nleast 400. This header is only present in the response if the number of\nerrors is greater than zero.\n\nThe response sent by the server is a multipart response, too. It contains\nthe individual HTTP responses for all batch parts, including the full HTTP\nresult header (with status code and other potential headers) and an\noptional result body. The individual batch parts in the result are\nseperated using the same boundary value as specified in the request.\n\nThe order of batch parts in the response will be the same as in the\noriginal client request. Client can additionally use the `Content-Id`\nMIME header in a batch part to define an individual id for each batch part.\nThe server will return this id is the batch part responses, too.\n\n\n\n\n**Example:**\n Sending a batch request with five batch parts:\n\n- GET /_api/version\n\n- DELETE /_api/collection/products\n\n- POST /_api/collection/products\n\n- GET /_api/collection/products/figures\n\n- DELETE /_api/collection/products\n\nThe boundary (`SomeBoundaryValue`) is passed to the server in the HTTP\n`Content-Type` HTTP header.\n*Please note the reply is not displayed all accurate.*\n\n<pre><code class=\"json\">shell> curl -X POST --header 'Content-Type: multipart/form-data; boundary=SomeBoundaryValue' --data-binary @- --dump - http://localhost:8529/_api/batch &lt;&lt;EOF\n--SomeBoundaryValue\r\nContent-Type: application/x-arango-batchpart\r\nContent-Id: myId1\r\n\r\nGET /_api/version HTTP/1.1\r\n\r\n--SomeBoundaryValue\r\nContent-Type: application/x-arango-batchpart\r\nContent-Id: myId2\r\n\r\nDELETE /_api/collection/products HTTP/1.1\r\n\r\n--SomeBoundaryValue\r\nContent-Type: application/x-arango-batchpart\r\nContent-Id: someId\r\n\r\nPOST /_api/collection/products HTTP/1.1\r\n\r\n{\"name\": \"products\" }\r\n\r\n--SomeBoundaryValue\r\nContent-Type: application/x-arango-batchpart\r\nContent-Id: nextId\r\n\r\nGET /_api/collection/products/figures HTTP/1.1\r\n\r\n--SomeBoundaryValue\r\nContent-Type: application/x-arango-batchpart\r\nContent-Id: otherId\r\n\r\nDELETE /_api/collection/products HTTP/1.1\r\n--SomeBoundaryValue--\r\n\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: multipart/form-data; boundary=SomeBoundaryValue\nx-content-type-options: nosniff\nx-arango-errors: 1\n\n\"--SomeBoundaryValue\\r\\nContent-Type: application/x-arango-batchpart\\r\\nContent-Id: myId1\\r\\n\\r\\nHTTP/1.1 200 OK\\r\\nServer: \\r\\nConnection: \\r\\nContent-Type: application/json; charset=utf-8\\r\\nContent-Length: 63\\r\\n\\r\\n{\\\"server\\\":\\\"arango\\\",\\\"version\\\":\\\"3.3.devel\\\",\\\"license\\\":\\\"community\\\"}\\r\\n--SomeBoundaryValue\\r\\nContent-Type: application/x-arango-batchpart\\r\\nContent-Id: myId2\\r\\n\\r\\nHTTP/1.1 404 Not Found\\r\\nServer: \\r\\nConnection: \\r\\nContent-Type: application/json; charset=utf-8\\r\\nContent-Length: 79\\r\\n\\r\\n{\\\"error\\\":true,\\\"errorMessage\\\":\\\"collection not found\\\",\\\"code\\\":404,\\\"errorNum\\\":1203}\\r\\n--SomeBoundaryValue\\r\\nContent-Type: application/x-arango-batchpart\\r\\nContent-Id: someId\\r\\n\\r\\nHTTP/1.1 200 OK\\r\\nServer: \\r\\nConnection: \\r\\nContent-Type: application/json; charset=utf-8\\r\\nContent-Length: 326\\r\\n\\r\\n{\\\"code\\\":200,\\\"error\\\":false,\\\"waitForSync\\\":false,\\\"type\\\":2,\\\"statusString\\\":\\\"loaded\\\",\\\"indexBuckets\\\":8,\\\"globallyUniqueId\\\":\\\"h66D61C8E346D/10004\\\",\\\"doCompact\\\":true,\\\"isSystem\\\":false,\\\"journalSize\\\":33554432,\\\"id\\\":\\\"10004\\\",\\\"isVolatile\\\":false,\\\"keyOptions\\\":{\\\"type\\\":\\\"traditional\\\",\\\"allowUserKeys\\\":true,\\\"lastValue\\\":0},\\\"name\\\":\\\"products\\\",\\\"status\\\":3}\\r\\n--SomeBoundaryValue\\r\\nContent-Type: application/x-arango-batchpart\\r\\nContent-Id: nextId\\r\\n\\r\\nHTTP/1.1 200 OK\\r\\nServer: \\r\\nLocation: /_api/collection/products/figures\\r\\nConnection: \\r\\nContent-Type: application/json; charset=utf-8\\r\\nContent-Length: 833\\r\\n\\r\\n{\\\"code\\\":200,\\\"error\\\":false,\\\"waitForSync\\\":false,\\\"type\\\":2,\\\"statusString\\\":\\\"loaded\\\",\\\"status\\\":3,\\\"name\\\":\\\"products\\\",\\\"figures\\\":{\\\"indexes\\\":{\\\"count\\\":1,\\\"size\\\":32128},\\\"documentReferences\\\":0,\\\"waitingFor\\\":\\\"-\\\",\\\"alive\\\":{\\\"count\\\":0,\\\"size\\\":0},\\\"dead\\\":{\\\"count\\\":0,\\\"size\\\":0,\\\"deletion\\\":0},\\\"compactionStatus\\\":{\\\"message\\\":\\\"compaction not yet started\\\",\\\"time\\\":\\\"2017-12-19T09:24:48Z\\\",\\\"count\\\":0,\\\"filesCombined\\\":0,\\\"bytesRead\\\":0,\\\"bytesWritten\\\":0},\\\"datafiles\\\":{\\\"count\\\":0,\\\"fileSize\\\":0},\\\"journals\\\":{\\\"count\\\":0,\\\"fileSize\\\":0},\\\"compactors\\\":{\\\"count\\\":0,\\\"fileSize\\\":0},\\\"revisions\\\":{\\\"count\\\":0,\\\"size\\\":48192},\\\"lastTick\\\":0,\\\"uncollectedLogfileEntries\\\":0},\\\"doCompact\\\":true,\\\"globallyUniqueId\\\":\\\"h66D61C8E346D/10004\\\",\\\"count\\\":0,\\\"indexBuckets\\\":8,\\\"isSystem\\\":false,\\\"journalSize\\\":33554432,\\\"id\\\":\\\"10004\\\",\\\"isVolatile\\\":false,\\\"keyOptions\\\":{\\\"type\\\":\\\"traditional\\\",\\\"allowUserKeys\\\":true,\\\"lastValue\\\":0}}\\r\\n--SomeBoundaryValue\\r\\nContent-Type: application/x-arango-batchpart\\r\\nContent-Id: otherId\\r\\n\\r\\nHTTP/1.1 200 OK\\r\\nServer: \\r\\nConnection: \\r\\nContent-Type: application/json; charset=utf-8\\r\\nContent-Length: 39\\r\\n\\r\\n{\\\"code\\\":200,\\\"error\\\":false,\\\"id\\\":\\\"10004\\\"}\\r\\n--SomeBoundaryValue--\"\n</code></pre>\n\n\n\n\n**Example:**\n Sending a batch request, setting the boundary implicitly (the server will\nin this case try to find the boundary at the beginning of the request body).\n\n<pre><code class=\"json\">shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/batch &lt;&lt;EOF\n--SomeBoundaryValue\r\nContent-Type: application/x-arango-batchpart\r\n\r\nDELETE /_api/collection/notexisting1 HTTP/1.1\r\n\r\n--SomeBoundaryValue\r\nContent-Type: application/x-arango-batchpart\r\n\r\nDELETE _api/collection/notexisting2 HTTP/1.1\r\n--SomeBoundaryValue--\r\n\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: \nx-content-type-options: nosniff\nx-arango-errors: 2\n\n\"--SomeBoundaryValue\\r\\nContent-Type: application/x-arango-batchpart\\r\\n\\r\\nHTTP/1.1 404 Not Found\\r\\nServer: \\r\\nConnection: \\r\\nContent-Type: application/json; charset=utf-8\\r\\nContent-Length: 79\\r\\n\\r\\n{\\\"error\\\":true,\\\"errorMessage\\\":\\\"collection not found\\\",\\\"code\\\":404,\\\"errorNum\\\":1203}\\r\\n--SomeBoundaryValue\\r\\nContent-Type: application/x-arango-batchpart\\r\\n\\r\\nHTTP/1.1 404 Not Found\\r\\nServer: \\r\\nConnection: \\r\\nContent-Type: application/json; charset=utf-8\\r\\nContent-Length: 101\\r\\n\\r\\n{\\\"error\\\":true,\\\"code\\\":404,\\\"errorNum\\\":404,\\\"errorMessage\\\":\\\"unknown path '_api/collection/notexisting2'\\\"}\\r\\n--SomeBoundaryValue--\"\n</code></pre>\n\n\n\n\n",
"parameters": [
{
"description": "The multipart batch request, consisting of the envelope and the individual\nbatch parts.\n\n",
"in": "body",
"name": "Json Request Body",
"required": true,
"schema": {
"additionalProperties": {},
"type": "object"
},
"x-description-offset": 0
}
],
"responses": {
"200": {
"description": "is returned if the batch was received successfully. HTTP 200 is returned\neven if one or multiple batch part actions failed.\n\n"
},
"400": {
"description": "is returned if the batch envelope is malformed or incorrectly formatted.\nThis code will also be returned if the content-type of the overall batch\nrequest or the individual MIME parts is not as expected.\n\n"
},
"405": {
"description": "is returned when an invalid HTTP method is used.\n\n"
}
},
"summary": "executes a batch request",
"tags": [
"Bulk"
],
"x-examples": [],
"x-filename": "Bulk - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Bulk/batch_processing.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Bulk/import_json.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Bulk/import_document.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Bulk/post_api_export.md"
}
},
"/_api/cluster/endpoints": {
"get": {
"description": "\n\n\nReturns an object with an attribute `endpoints`, which contains an\narray of objects, which each have the attribute `endpoint`, whose value\nis a string with the endpoint description. There is an entry for each\ncoordinator in the cluster. This method only works on coordinators in\ncluster mode. In case of an error the `error` attribute is set to\n`true`.\n\n",
"parameters": [],
"responses": {
"200": {
"description": "\n"
},
"403": {
"description": "\n\n"
}
},
"summary": "Get information about all coordinator endpoints",
"tags": [
"Administration"
],
"x-examples": [],
"x-filename": "Administration - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_long_echo.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_statistics_description.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_time.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_tasks_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_server_role.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_database_version.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_statistics.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_modules_flush.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_server_id.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_cluster_endpoints.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_return.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_endpoint.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/post_admin_execute.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/post_admin_test.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/put_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_initiate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/post_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_engine.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/delete_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_echo.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_routing_reloads.md"
}
},
"/_api/collection": {
"get": {
"description": "\n\nReturns an object with an attribute *collections* containing an\narray of all collection descriptions. The same information is also\navailable in the *names* as an object with the collection names\nas keys.\n\nBy providing the optional query parameter *excludeSystem* with a value of\n*true*, all system collections will be excluded from the response.\n\n\n\n\n**Example:**\n Return information about all collections:\n\n<pre><code class=\"json\">shell> curl --dump - http://localhost:8529/_api/collection\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">200</span> OK\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\nx-content-type-options: nosniff\n\n{ \n <span class=\"hljs-string\">\"error\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"code\"</span> : <span class=\"hljs-number\">200</span>, \n <span class=\"hljs-string\">\"result\"</span> : [ \n { \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-string\">\"34\"</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"_jobs\"</span>, \n <span class=\"hljs-string\">\"status\"</span> : <span class=\"hljs-number\">3</span>, \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-number\">2</span>, \n <span class=\"hljs-string\">\"isSystem\"</span> : <span class=\"hljs-literal\">true</span>, \n <span class=\"hljs-string\">\"globallyUniqueId\"</span> : <span class=\"hljs-string\">\"_jobs\"</span> \n }, \n { \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-string\">\"103\"</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"demo\"</span>, \n <span class=\"hljs-string\">\"status\"</span> : <span class=\"hljs-number\">3</span>, \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-number\">2</span>, \n <span class=\"hljs-string\">\"isSystem\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"globallyUniqueId\"</span> : <span class=\"hljs-string\">\"h66D61C8E346D/103\"</span> \n }, \n { \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-string\">\"43\"</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"_apps\"</span>, \n <span class=\"hljs-string\">\"status\"</span> : <span class=\"hljs-number\">3</span>, \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-number\">2</span>, \n <span class=\"hljs-string\">\"isSystem\"</span> : <span class=\"hljs-literal\">true</span>, \n <span class=\"hljs-string\">\"globallyUniqueId\"</span> : <span class=\"hljs-string\">\"_apps\"</span> \n }, \n { \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-string\">\"89\"</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"_statistics15\"</span>, \n <span class=\"hljs-string\">\"status\"</span> : <span class=\"hljs-number\">3</span>, \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-number\">2</span>, \n <span class=\"hljs-string\">\"isSystem\"</span> : <span class=\"hljs-literal\">true</span>, \n <span class=\"hljs-string\">\"globallyUniqueId\"</span> : <span class=\"hljs-string\">\"_statistics15\"</span> \n }, \n { \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-string\">\"32\"</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"_queues\"</span>, \n <span class=\"hljs-string\">\"status\"</span> : <span class=\"hljs-number\">3</span>, \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-number\">2</span>, \n <span class=\"hljs-string\">\"isSystem\"</span> : <span class=\"hljs-literal\">true</span>, \n <span class=\"hljs-string\">\"globallyUniqueId\"</span> : <span class=\"hljs-string\">\"_queues\"</span> \n }, \n { \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-string\">\"78\"</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"_statisticsRaw\"</span>, \n <span class=\"hljs-string\">\"status\"</span> : <span class=\"hljs-number\">3</span>, \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-number\">2</span>, \n <span class=\"hljs-string\">\"isSystem\"</span> : <span class=\"hljs-literal\">true</span>, \n <span class=\"hljs-string\">\"globallyUniqueId\"</span> : <span class=\"hljs-string\">\"_statisticsRaw\"</span> \n }, \n { \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-string\">\"28\"</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"_aqlfunctions\"</span>, \n <span class=\"hljs-string\">\"status\"</span> : <span class=\"hljs-number\">3</span>, \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-number\">2</span>, \n <span class=\"hljs-string\">\"isSystem\"</span> : <span class=\"hljs-literal\">true</span>, \n <span class=\"hljs-string\">\"globallyUniqueId\"</span> : <span class=\"hljs-string\">\"_aqlfunctions\"</span> \n }, \n { \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-string\">\"30\"</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"_frontend\"</span>, \n <span class=\"hljs-string\">\"status\"</span> : <span class=\"hljs-number\">3</span>, \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-number\">2</span>, \n <span class=\"hljs-string\">\"isSystem\"</span> : <span class=\"hljs-literal\">true</span>, \n <span class=\"hljs-string\">\"globallyUniqueId\"</span> : <span class=\"hljs-string\">\"_frontend\"</span> \n }, \n { \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-string\">\"8\"</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"_users\"</span>, \n <span class=\"hljs-string\">\"status\"</span> : <span class=\"hljs-number\">3</span>, \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-number\">2</span>, \n <span class=\"hljs-string\">\"isSystem\"</span> : <span class=\"hljs-literal\">true</span>, \n <span class=\"hljs-string\">\"globallyUniqueId\"</span> : <span class=\"hljs-string\">\"_users\"</span> \n }, \n { \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-string\">\"2\"</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"_iresearch_analyzers\"</span>, \n <span class=\"hljs-string\">\"status\"</span> : <span class=\"hljs-number\">3</span>, \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-string\">\"isSystem\"</span> : <span class=\"hljs-literal\">true</span>, \n <span class=\"hljs-string\">\"globallyUniqueId\"</span> : <span class=\"hljs-string\">\"_iresearch_analyzers\"</span> \n }, \n { \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-string\">\"48\"</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"_appbundles\"</span>, \n <span class=\"hljs-string\">\"status\"</span> : <span class=\"hljs-number\">3</span>, \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-number\">2</span>, \n <span class=\"hljs-string\">\"isSystem\"</span> : <span class=\"hljs-literal\">true</span>, \n <span class=\"hljs-string\">\"globallyUniqueId\"</span> : <span class=\"hljs-string\">\"_appbundles\"</span> \n }, \n { \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-string\">\"83\"</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"_statistics\"</span>, \n <span class=\"hljs-string\">\"status\"</span> : <span class=\"hljs-number\">3</span>, \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-number\">2</span>, \n <span class=\"hljs-string\">\"isSystem\"</span> : <span class=\"hljs-literal\">true</span>, \n <span class=\"hljs-string\">\"globallyUniqueId\"</span> : <span class=\"hljs-string\">\"_statistics\"</span> \n }, \n { \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-string\">\"6\"</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"_graphs\"</span>, \n <span class=\"hljs-string\">\"status\"</span> : <span class=\"hljs-number\">3</span>, \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-number\">2</span>, \n <span class=\"hljs-string\">\"isSystem\"</span> : <span class=\"hljs-literal\">true</span>, \n <span class=\"hljs-string\">\"globallyUniqueId\"</span> : <span class=\"hljs-string\">\"_graphs\"</span> \n }, \n { \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-string\">\"13\"</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"_modules\"</span>, \n <span class=\"hljs-string\">\"status\"</span> : <span class=\"hljs-number\">3</span>, \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-number\">2</span>, \n <span class=\"hljs-string\">\"isSystem\"</span> : <span class=\"hljs-literal\">true</span>, \n <span class=\"hljs-string\">\"globallyUniqueId\"</span> : <span class=\"hljs-string\">\"_modules\"</span> \n }, \n { \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-string\">\"15\"</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"_routing\"</span>, \n <span class=\"hljs-string\">\"status\"</span> : <span class=\"hljs-number\">3</span>, \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-number\">2</span>, \n <span class=\"hljs-string\">\"isSystem\"</span> : <span class=\"hljs-literal\">true</span>, \n <span class=\"hljs-string\">\"globallyUniqueId\"</span> : <span class=\"hljs-string\">\"_routing\"</span> \n }, \n { \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-string\">\"109\"</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"animals\"</span>, \n <span class=\"hljs-string\">\"status\"</span> : <span class=\"hljs-number\">3</span>, \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-number\">2</span>, \n <span class=\"hljs-string\">\"isSystem\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"globallyUniqueId\"</span> : <span class=\"hljs-string\">\"h66D61C8E346D/109\"</span> \n } \n ] \n}\n</code></pre>\n\n\n\n\n",
"parameters": [
{
"description": "Whether or not system collections should be excluded from the result.\n\n",
"in": "query",
"name": "excludeSystem",
"required": false,
"type": "boolean"
}
],
"responses": {
"200": {
"description": "The list of collections\n\n"
}
},
"summary": "reads all collections",
"tags": [
"Collections"
],
"x-examples": [],
"x-filename": "Collections - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_load.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_rename.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/delete_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/post_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_truncate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_unload.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_rotate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_load_indexes_in_memory.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/get_api_collections.md"
},
"post": {
"description": "\n**A JSON object with these properties is required:**\n\n - **journalSize**: The maximal size of a journal or datafile in bytes. The value \n must be at least `1048576` (1 MiB). (The default is a configuration parameter)\n This option is meaningful for the MMFiles storage engine only.\n - **replicationFactor**: (The default is *1*): in a cluster, this attribute determines how many copies \n of each shard are kept on different DBServers. The value 1 means that only one \n copy (no synchronous replication) is kept. A value of k means that k-1 replicas \n are kept. Any two copies reside on different DBServers. Replication between them is \n synchronous, that is, every write operation to the \"leader\" copy will be replicated \n to all \"follower\" replicas, before the write operation is reported successful.\n If a server fails, this is detected automatically and one of the servers holding \n copies take over, usually without an error being reported.\n - **keyOptions**:\n - **allowUserKeys**: if set to *true*, then it is allowed to supply own key values in the\n *_key* attribute of a document. If set to *false*, then the key generator\n will solely be responsible for generating keys and supplying own key values\n in the *_key* attribute of documents is considered an error.\n - **type**: specifies the type of the key generator. The currently available generators are\n *traditional* and *autoincrement*.\n - **increment**: increment value for *autoincrement* key generator. Not used for other key\n generator types.\n - **offset**: Initial offset value for *autoincrement* key generator.\n Not used for other key generator types.\n - **name**: The name of the collection.\n - **waitForSync**: If *true* then the data is synchronized to disk before returning from a\n document create, update, replace or removal operation. (default: false)\n - **doCompact**: whether or not the collection will be compacted (default is *true*)\n This option is meaningful for the MMFiles storage engine only.\n - **isVolatile**: If *true* then the collection data is kept in-memory only and not made persistent.\n Unloading the collection will cause the collection data to be discarded. Stopping\n or re-starting the server will also cause full loss of data in the\n collection. Setting this option will make the resulting collection be\n slightly faster than regular collections because ArangoDB does not\n enforce any synchronization to disk and does not calculate any CRC\n checksums for datafiles (as there are no datafiles). This option \n should therefore be used for cache-type collections only, and not \n for data that cannot be re-created otherwise.\n (The default is *false*)\n This option is meaningful for the MMFiles storage engine only.\n - **shardKeys**: (The default is *[ \"_key\" ]*): in a cluster, this attribute determines\n which document attributes are used to determine the target shard for documents.\n Documents are sent to shards based on the values of their shard key attributes.\n The values of all shard key attributes in a document are hashed,\n and the hash value is used to determine the target shard.\n **Note**: Values of shard key attributes cannot be changed once set.\n This option is meaningless in a single server setup.\n - **numberOfShards**: (The default is *1*): in a cluster, this value determines the\n number of shards to create for the collection. In a single\n server setup, this option is meaningless.\n - **isSystem**: If *true*, create a system collection. In this case *collection-name*\n should start with an underscore. End users should normally create non-system\n collections only. API implementors may be required to create system\n collections in very special occasions, but normally a regular collection will do.\n (The default is *false*)\n - **type**: (The default is *2*): the type of the collection to create.\n The following values for *type* are valid:\n - *2*: document collection\n - *3*: edges collection\n - **indexBuckets**: The number of buckets into which indexes using a hash\n table are split. The default is 16 and this number has to be a\n power of 2 and less than or equal to 1024. \n For very large collections one should increase this to avoid long pauses \n when the hash table has to be initially built or resized, since buckets \n are resized individually and can be initially built in parallel. For \n example, 64 might be a sensible value for a collection with 100\n 000 000 documents. Currently, only the edge index respects this\n value, but other index types might follow in future ArangoDB versions. \n Changes (see below) are applied when the collection is loaded the next \n time.\n This option is meaningful for the MMFiles storage engine only.\n - **distributeShardsLike**: (The default is *\"\"*): in an enterprise cluster, this attribute binds\n the specifics of sharding for the newly created collection to follow that of a\n specified existing collection. \n **Note**: Using this parameter has consequences for the prototype\n collection. It can no longer be dropped, before sharding imitating\n collections are dropped. Equally, backups and restores of imitating\n collections alone will generate warnings, which can be overridden,\n about missing sharding prototype. \n\n\n\n\nCreates a new collection with a given name. The request must contain an\nobject with the following attributes.\n\n\n\n\n\n**Example:**\n \n\n<pre><code class=\"json\">shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/collection &lt;&lt;EOF\n{ \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"testCollectionBasics\"</span> \n}\nEOF\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">200</span> OK\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\nx-content-type-options: nosniff\n\n{ \n <span class=\"hljs-string\">\"code\"</span> : <span class=\"hljs-number\">200</span>, \n <span class=\"hljs-string\">\"error\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"waitForSync\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-number\">2</span>, \n <span class=\"hljs-string\">\"statusString\"</span> : <span class=\"hljs-string\">\"loaded\"</span>, \n <span class=\"hljs-string\">\"indexBuckets\"</span> : <span class=\"hljs-number\">8</span>, \n <span class=\"hljs-string\">\"globallyUniqueId\"</span> : <span class=\"hljs-string\">\"h66D61C8E346D/10013\"</span>, \n <span class=\"hljs-string\">\"doCompact\"</span> : <span class=\"hljs-literal\">true</span>, \n <span class=\"hljs-string\">\"isSystem\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"journalSize\"</span> : <span class=\"hljs-number\">33554432</span>, \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-string\">\"10013\"</span>, \n <span class=\"hljs-string\">\"isVolatile\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"keyOptions\"</span> : { \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"traditional\"</span>, \n <span class=\"hljs-string\">\"allowUserKeys\"</span> : <span class=\"hljs-literal\">true</span>, \n <span class=\"hljs-string\">\"lastValue\"</span> : <span class=\"hljs-number\">0</span> \n }, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"testCollectionBasics\"</span>, \n <span class=\"hljs-string\">\"status\"</span> : <span class=\"hljs-number\">3</span> \n}\nshell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/collection &lt;&lt;EOF\n{ \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"testCollectionEdges\"</span>, \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-number\">3</span> \n}\nEOF\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">200</span> OK\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\nx-content-type-options: nosniff\n\n{ \n <span class=\"hljs-string\">\"code\"</span> : <span class=\"hljs-number\">200</span>, \n <span class=\"hljs-string\">\"error\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"waitForSync\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-number\">3</span>, \n <span class=\"hljs-string\">\"statusString\"</span> : <span class=\"hljs-string\">\"loaded\"</span>, \n <span class=\"hljs-string\">\"indexBuckets\"</span> : <span class=\"hljs-number\">8</span>, \n <span class=\"hljs-string\">\"globallyUniqueId\"</span> : <span class=\"hljs-string\">\"h66D61C8E346D/10016\"</span>, \n <span class=\"hljs-string\">\"doCompact\"</span> : <span class=\"hljs-literal\">true</span>, \n <span class=\"hljs-string\">\"isSystem\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"journalSize\"</span> : <span class=\"hljs-number\">33554432</span>, \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-string\">\"10016\"</span>, \n <span class=\"hljs-string\">\"isVolatile\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"keyOptions\"</span> : { \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"traditional\"</span>, \n <span class=\"hljs-string\">\"allowUserKeys\"</span> : <span class=\"hljs-literal\">true</span>, \n <span class=\"hljs-string\">\"lastValue\"</span> : <span class=\"hljs-number\">0</span> \n }, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"testCollectionEdges\"</span>, \n <span class=\"hljs-string\">\"status\"</span> : <span class=\"hljs-number\">3</span> \n}\n</code></pre>\n\n\n\n\n**Example:**\n \n\n<pre><code class=\"json\">shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/collection &lt;&lt;EOF\n{ \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"testCollectionUsers\"</span>, \n <span class=\"hljs-string\">\"keyOptions\"</span> : { \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"autoincrement\"</span>, \n <span class=\"hljs-string\">\"increment\"</span> : <span class=\"hljs-number\">5</span>, \n <span class=\"hljs-string\">\"allowUserKeys\"</span> : <span class=\"hljs-literal\">true</span> \n } \n}\nEOF\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">200</span> OK\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\nx-content-type-options: nosniff\n\n{ \n <span class=\"hljs-string\">\"code\"</span> : <span class=\"hljs-number\">200</span>, \n <span class=\"hljs-string\">\"error\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"waitForSync\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-number\">2</span>, \n <span class=\"hljs-string\">\"statusString\"</span> : <span class=\"hljs-string\">\"loaded\"</span>, \n <span class=\"hljs-string\">\"indexBuckets\"</span> : <span class=\"hljs-number\">8</span>, \n <span class=\"hljs-string\">\"globallyUniqueId\"</span> : <span class=\"hljs-string\">\"h66D61C8E346D/10027\"</span>, \n <span class=\"hljs-string\">\"doCompact\"</span> : <span class=\"hljs-literal\">true</span>, \n <span class=\"hljs-string\">\"isSystem\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"journalSize\"</span> : <span class=\"hljs-number\">33554432</span>, \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-string\">\"10027\"</span>, \n <span class=\"hljs-string\">\"isVolatile\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"keyOptions\"</span> : { \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"autoincrement\"</span>, \n <span class=\"hljs-string\">\"allowUserKeys\"</span> : <span class=\"hljs-literal\">true</span>, \n <span class=\"hljs-string\">\"offset\"</span> : <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-string\">\"increment\"</span> : <span class=\"hljs-number\">5</span>, \n <span class=\"hljs-string\">\"lastValue\"</span> : <span class=\"hljs-number\">0</span> \n }, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"testCollectionUsers\"</span>, \n <span class=\"hljs-string\">\"status\"</span> : <span class=\"hljs-number\">3</span> \n}\n</code></pre>\n\n\n\n\n",
"parameters": [
{
"in": "body",
"name": "Json Request Body",
"required": true,
"schema": {
"$ref": "#/definitions/post_api_collection"
},
"x-description-offset": 54
},
{
"description": "Default is *1* which means the server will only report success back to the client\nif all replicas have created the collection. Set to *0* if you want faster\nserver responses and don't care about full replication.\n\n",
"in": "query",
"name": "waitForSyncReplication",
"required": false,
"type": "integer"
},
{
"description": "Default is *1* which means the server will check if there are enough replicas\navailable at creation time and bail out otherwise. Set to *0* to disable this\nextra check.\n\n",
"in": "query",
"name": "enforceReplicationFactor",
"required": false,
"type": "integer"
}
],
"responses": {
"400": {
"description": "If the *collection-name* is missing, then a *HTTP 400* is\nreturned.\n\n"
},
"404": {
"description": "If the *collection-name* is unknown, then a *HTTP 404* is returned.\n\n\n"
}
},
"summary": "Create collection",
"tags": [
"Collections"
],
"x-examples": [],
"x-filename": "Collections - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_load.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_rename.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/delete_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/post_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_truncate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_unload.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_rotate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_load_indexes_in_memory.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/get_api_collections.md"
}
},
"/_api/collection/{collection-name}": {
"delete": {
"description": "\n\nDrops the collection identified by *collection-name*.\n\nIf the collection was successfully dropped, an object is returned with\nthe following attributes:\n\n- *error*: *false*\n\n- *id*: The identifier of the dropped collection.\n\n\n\n\n**Example:**\n Using an identifier:\n\n<pre><code class=\"json\">shell> curl -X DELETE --dump - http://localhost:8529/_api/collection/10034\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">200</span> OK\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\nx-content-type-options: nosniff\n\n{ \n <span class=\"hljs-string\">\"code\"</span> : <span class=\"hljs-number\">200</span>, \n <span class=\"hljs-string\">\"error\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-string\">\"10034\"</span> \n}\n</code></pre>\n\n\n\n\n**Example:**\n Using a name:\n\n<pre><code class=\"json\">shell> curl -X DELETE --dump - http://localhost:8529/_api/collection/products1\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">200</span> OK\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\nx-content-type-options: nosniff\n\n{ \n <span class=\"hljs-string\">\"code\"</span> : <span class=\"hljs-number\">200</span>, \n <span class=\"hljs-string\">\"error\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-string\">\"10041\"</span> \n}\n</code></pre>\n\n\n\n\n**Example:**\n Dropping a system collection\n\n<pre><code class=\"json\">shell> curl -X DELETE --dump - http://localhost:8529/_api/collection/_example?isSystem=true\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">200</span> OK\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\nx-content-type-options: nosniff\n\n{ \n <span class=\"hljs-string\">\"code\"</span> : <span class=\"hljs-number\">200</span>, \n <span class=\"hljs-string\">\"error\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-string\">\"10048\"</span> \n}\n</code></pre>\n\n\n\n\n\n",
"parameters": [
{
"description": "The name of the collection to drop.\n\n",
"format": "string",
"in": "path",
"name": "collection-name",
"required": true,
"type": "string"
},
{
"description": "Whether or not the collection to drop is a system collection. This parameter\nmust be set to *true* in order to drop a system collection.\n\n",
"in": "query",
"name": "isSystem",
"required": false,
"type": "bool"
}
],
"responses": {
"400": {
"description": "If the *collection-name* is missing, then a *HTTP 400* is\nreturned.\n\n"
},
"404": {
"description": "If the *collection-name* is unknown, then a *HTTP 404* is returned.\n\n"
}
},
"summary": "Drops a collection",
"tags": [
"Collections"
],
"x-examples": [],
"x-filename": "Collections - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_load.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_rename.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/delete_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/post_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_truncate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_unload.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_rotate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_load_indexes_in_memory.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/get_api_collections.md"
},
"get": {
"description": "\n\nThe result is an object describing the collection with the following\nattributes:\n\n- *id*: The identifier of the collection.\n\n- *name*: The name of the collection.\n\n- *status*: The status of the collection as number.\n - 1: new born collection\n - 2: unloaded\n - 3: loaded\n - 4: in the process of being unloaded\n - 5: deleted\n - 6: loading\n\nEvery other status indicates a corrupted collection.\n\n- *type*: The type of the collection as number.\n - 2: document collection (normal case)\n - 3: edges collection\n\n- *isSystem*: If *true* then the collection is a system collection.\n\n",
"parameters": [
{
"description": "The name of the collection.\n\n",
"format": "string",
"in": "path",
"name": "collection-name",
"required": true,
"type": "string"
}
],
"responses": {
"404": {
"description": "If the *collection-name* is unknown, then a *HTTP 404* is\nreturned.\n\n\n"
}
},
"summary": "Return information about a collection",
"tags": [
"Collections"
],
"x-examples": [],
"x-filename": "Collections - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_load.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_rename.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/delete_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/post_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_truncate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_unload.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_rotate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_load_indexes_in_memory.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/get_api_collections.md"
}
},
"/_api/collection/{collection-name}/checksum": {
"get": {
"description": "\n\nWill calculate a checksum of the meta-data (keys and optionally revision ids) and\noptionally the document data in the collection.\n\nThe checksum can be used to compare if two collections on different ArangoDB\ninstances contain the same contents. The current revision of the collection is\nreturned too so one can make sure the checksums are calculated for the same\nstate of data.\n\nBy default, the checksum will only be calculated on the *_key* system attribute\nof the documents contained in the collection. For edge collections, the system\nattributes *_from* and *_to* will also be included in the calculation.\n\nBy setting the optional query parameter *withRevisions* to *true*, then revision\nids (*_rev* system attributes) are included in the checksumming.\n\nBy providing the optional query parameter *withData* with a value of *true*,\nthe user-defined document attributes will be included in the calculation too.\n**Note**: Including user-defined attributes will make the checksumming slower.\n\nThe response is a JSON object with the following attributes:\n\n- *checksum*: The calculated checksum as a number.\n\n- *revision*: The collection revision id as a string.\n\n**Note**: this method is not available in a cluster.\n\n\n\n\n**Example:**\n Retrieving the checksum of a collection:\n\n<pre><code class=\"json\">shell> curl --dump - http://localhost:8529/_api/collection/products/checksum\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">200</span> OK\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\nx-content-type-options: nosniff\nlocation: <span class=\"hljs-regexp\">/_api/</span>collection/products/checksum\n\n{ \n <span class=\"hljs-string\">\"code\"</span> : <span class=\"hljs-number\">200</span>, \n <span class=\"hljs-string\">\"error\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"globallyUniqueId\"</span> : <span class=\"hljs-string\">\"h66D61C8E346D/10055\"</span>, \n <span class=\"hljs-string\">\"status\"</span> : <span class=\"hljs-number\">3</span>, \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-string\">\"10055\"</span>, \n <span class=\"hljs-string\">\"isSystem\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-number\">2</span>, \n <span class=\"hljs-string\">\"revision\"</span> : <span class=\"hljs-string\">\"_WE2V-XO--_\"</span>, \n <span class=\"hljs-string\">\"checksum\"</span> : <span class=\"hljs-string\">\"4972202737689673332\"</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"products\"</span> \n}\n</code></pre>\n\n\n\n\n**Example:**\n Retrieving the checksum of a collection including the collection data,\nbut not the revisions:\n\n<pre><code class=\"json\">shell> curl --dump - http://localhost:8529/_api/collection/products/checksum?withRevisions=false&withData=true\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">200</span> OK\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\nx-content-type-options: nosniff\nlocation: <span class=\"hljs-regexp\">/_api/</span>collection/products/checksum\n\n{ \n <span class=\"hljs-string\">\"code\"</span> : <span class=\"hljs-number\">200</span>, \n <span class=\"hljs-string\">\"error\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"globallyUniqueId\"</span> : <span class=\"hljs-string\">\"h66D61C8E346D/10067\"</span>, \n <span class=\"hljs-string\">\"status\"</span> : <span class=\"hljs-number\">3</span>, \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-string\">\"10067\"</span>, \n <span class=\"hljs-string\">\"isSystem\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-number\">2</span>, \n <span class=\"hljs-string\">\"revision\"</span> : <span class=\"hljs-string\">\"_WE2V-de--_\"</span>, \n <span class=\"hljs-string\">\"checksum\"</span> : <span class=\"hljs-string\">\"5234535310238245814\"</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"products\"</span> \n}\n</code></pre>\n\n\n\n\n",
"parameters": [
{
"description": "The name of the collection.\n\n",
"format": "string",
"in": "path",
"name": "collection-name",
"required": true,
"type": "string"
},
{
"description": "Whether or not to include document revision ids in the checksum calculation.\n\n",
"in": "query",
"name": "withRevisions",
"required": false,
"type": "boolean"
},
{
"description": "Whether or not to include document body data in the checksum calculation.\n\n",
"in": "query",
"name": "withData",
"required": false,
"type": "boolean"
}
],
"responses": {
"400": {
"description": "If the *collection-name* is missing, then a *HTTP 400* is\nreturned.\n\n"
},
"404": {
"description": "If the *collection-name* is unknown, then a *HTTP 404*\nis returned.\n\n"
}
},
"summary": "Return checksum for the collection",
"tags": [
"Collections"
],
"x-examples": [],
"x-filename": "Collections - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_load.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_rename.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/delete_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/post_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_truncate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_unload.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_rotate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_load_indexes_in_memory.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/get_api_collections.md"
}
},
"/_api/collection/{collection-name}/count": {
"get": {
"description": "\n\nIn addition to the above, the result also contains the number of documents.\n**Note** that this will always load the collection into memory.\n\n- *count*: The number of documents inside the collection.\n\n\n\n\n**Example:**\n Requesting the number of documents:\n\n<pre><code class=\"json\">shell> curl --dump - http://localhost:8529/_api/collection/products/count\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">200</span> OK\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\nx-content-type-options: nosniff\nlocation: <span class=\"hljs-regexp\">/_api/</span>collection/products/count\n\n{ \n <span class=\"hljs-string\">\"code\"</span> : <span class=\"hljs-number\">200</span>, \n <span class=\"hljs-string\">\"error\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"waitForSync\"</span> : <span class=\"hljs-literal\">true</span>, \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-number\">2</span>, \n <span class=\"hljs-string\">\"statusString\"</span> : <span class=\"hljs-string\">\"loaded\"</span>, \n <span class=\"hljs-string\">\"status\"</span> : <span class=\"hljs-number\">3</span>, \n <span class=\"hljs-string\">\"doCompact\"</span> : <span class=\"hljs-literal\">true</span>, \n <span class=\"hljs-string\">\"globallyUniqueId\"</span> : <span class=\"hljs-string\">\"h66D61C8E346D/10079\"</span>, \n <span class=\"hljs-string\">\"count\"</span> : <span class=\"hljs-number\">100</span>, \n <span class=\"hljs-string\">\"indexBuckets\"</span> : <span class=\"hljs-number\">8</span>, \n <span class=\"hljs-string\">\"isSystem\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"journalSize\"</span> : <span class=\"hljs-number\">33554432</span>, \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-string\">\"10079\"</span>, \n <span class=\"hljs-string\">\"isVolatile\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"keyOptions\"</span> : { \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"traditional\"</span>, \n <span class=\"hljs-string\">\"allowUserKeys\"</span> : <span class=\"hljs-literal\">true</span>, \n <span class=\"hljs-string\">\"lastValue\"</span> : <span class=\"hljs-number\">10391</span> \n }, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"products\"</span> \n}\n</code></pre>\n\n\n\n\n",
"parameters": [
{
"description": "The name of the collection.\n\n",
"format": "string",
"in": "path",
"name": "collection-name",
"required": true,
"type": "string"
}
],
"responses": {
"400": {
"description": "If the *collection-name* is missing, then a *HTTP 400* is\nreturned.\n\n"
},
"404": {
"description": "If the *collection-name* is unknown, then a *HTTP 404*\nis returned.\n\n"
}
},
"summary": "Return number of documents in a collection",
"tags": [
"Collections"
],
"x-examples": [],
"x-filename": "Collections - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_load.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_rename.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/delete_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/post_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_truncate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_unload.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_rotate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_load_indexes_in_memory.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/get_api_collections.md"
}
},
"/_api/collection/{collection-name}/figures": {
"get": {
"description": "\n\nIn addition to the above, the result also contains the number of documents\nand additional statistical information about the collection.\n**Note** : This will always load the collection into memory.\n\n**Note**: collection data that are stored in the write-ahead log only are\nnot reported in the results. When the write-ahead log is collected, documents\nmight be added to journals and datafiles of the collection, which may modify\nthe figures of the collection.\n\nAdditionally, the filesizes of collection and index parameter JSON files are\nnot reported. These files should normally have a size of a few bytes\neach. Please also note that the *fileSize* values are reported in bytes\nand reflect the logical file sizes. Some filesystems may use optimisations\n(e.g. sparse files) so that the actual physical file size is somewhat\ndifferent. Directories and sub-directories may also require space in the\nfile system, but this space is not reported in the *fileSize* results.\n\nThat means that the figures reported do not reflect the actual disk\nusage of the collection with 100% accuracy. The actual disk usage of\na collection is normally slightly higher than the sum of the reported\n*fileSize* values. Still the sum of the *fileSize* values can still be\nused as a lower bound approximation of the disk usage.\n\n**A json document with these Properties is returned:**\n\n#### HTTP 200\nReturns information about the collection:\n\n- **count**: The number of documents currently present in the collection.\n- **journalSize**: The maximal size of a journal or datafile in bytes.\n- **figures**:\n - **datafiles**:\n - **count**: The number of datafiles.\n - **fileSize**: The total filesize of datafiles (in bytes).\n - **uncollectedLogfileEntries**: The number of markers in the write-ahead\n log for this collection that have not been transferred to journals or datafiles.\n - **documentReferences**: The number of references to documents in datafiles that JavaScript code \n currently holds. This information can be used for debugging compaction and \n unload issues.\n - **compactionStatus**:\n - **message**: The action that was performed when the compaction was last run for the collection. \n This information can be used for debugging compaction issues.\n - **time**: The point in time the compaction for the collection was last executed. \n This information can be used for debugging compaction issues.\n - **compactors**:\n - **count**: The number of compactor files.\n - **fileSize**: The total filesize of all compactor files (in bytes).\n - **dead**:\n - **count**: The number of dead documents. This includes document\n versions that have been deleted or replaced by a newer version. Documents\n deleted or replaced that are contained the write-ahead log only are not reported\n in this figure.\n - **deletion**: The total number of deletion markers. Deletion markers\n only contained in the write-ahead log are not reporting in this figure.\n - **size**: The total size in bytes used by all dead documents.\n - **indexes**:\n - **count**: The total number of indexes defined for the collection, including the pre-defined\n indexes (e.g. primary index).\n - **size**: The total memory allocated for indexes in bytes.\n - **readcache**:\n - **count**: The number of revisions of this collection stored in the document revisions cache.\n - **size**: The memory used for storing the revisions of this collection in the document \n revisions cache (in bytes). This figure does not include the document data but \n only mappings from document revision ids to cache entry locations.\n - **waitingFor**: An optional string value that contains information about which object type is at the \n head of the collection's cleanup queue. This information can be used for debugging \n compaction and unload issues.\n - **alive**:\n - **count**: The number of currently active documents in all datafiles\n and journals of the collection. Documents that are contained in the\n write-ahead log only are not reported in this figure.\n - **size**: The total size in bytes used by all active documents of\n the collection. Documents that are contained in the write-ahead log only are\n not reported in this figure.\n - **lastTick**: The tick of the last marker that was stored in a journal\n of the collection. This might be 0 if the collection does not yet have\n a journal.\n - **journals**:\n - **count**: The number of journal files.\n - **fileSize**: The total filesize of all journal files (in bytes).\n - **revisions**:\n - **count**: The number of revisions of this collection managed by the storage engine.\n - **size**: The memory used for storing the revisions of this collection in the storage \n engine (in bytes). This figure does not include the document data but only mappings \n from document revision ids to storage engine datafile positions.\n\n\n\n\n**Example:**\n Using an identifier and requesting the figures of the collection:\n\n<pre><code class=\"json\">shell> curl --dump - http://localhost:8529/_api/collection/products/figures\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">200</span> OK\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\nx-content-type-options: nosniff\nlocation: <span class=\"hljs-regexp\">/_api/</span>collection/products/figures\n\n{ \n <span class=\"hljs-string\">\"code\"</span> : <span class=\"hljs-number\">200</span>, \n <span class=\"hljs-string\">\"error\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"waitForSync\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-number\">2</span>, \n <span class=\"hljs-string\">\"statusString\"</span> : <span class=\"hljs-string\">\"loaded\"</span>, \n <span class=\"hljs-string\">\"status\"</span> : <span class=\"hljs-number\">3</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"products\"</span>, \n <span class=\"hljs-string\">\"figures\"</span> : { \n <span class=\"hljs-string\">\"indexes\"</span> : { \n <span class=\"hljs-string\">\"count\"</span> : <span class=\"hljs-number\">1</span>, \n <span class=\"hljs-string\">\"size\"</span> : <span class=\"hljs-number\">32128</span> \n }, \n <span class=\"hljs-string\">\"documentReferences\"</span> : <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-string\">\"waitingFor\"</span> : <span class=\"hljs-string\">\"-\"</span>, \n <span class=\"hljs-string\">\"alive\"</span> : { \n <span class=\"hljs-string\">\"count\"</span> : <span class=\"hljs-number\">1</span>, \n <span class=\"hljs-string\">\"size\"</span> : <span class=\"hljs-number\">80</span> \n }, \n <span class=\"hljs-string\">\"dead\"</span> : { \n <span class=\"hljs-string\">\"count\"</span> : <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-string\">\"size\"</span> : <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-string\">\"deletion\"</span> : <span class=\"hljs-number\">0</span> \n }, \n <span class=\"hljs-string\">\"compactionStatus\"</span> : { \n <span class=\"hljs-string\">\"message\"</span> : <span class=\"hljs-string\">\"skipped compaction because collection has no datafiles\"</span>, \n <span class=\"hljs-string\">\"time\"</span> : <span class=\"hljs-string\">\"2017-12-19T09:24:51Z\"</span>, \n <span class=\"hljs-string\">\"count\"</span> : <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-string\">\"filesCombined\"</span> : <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-string\">\"bytesRead\"</span> : <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-string\">\"bytesWritten\"</span> : <span class=\"hljs-number\">0</span> \n }, \n <span class=\"hljs-string\">\"datafiles\"</span> : { \n <span class=\"hljs-string\">\"count\"</span> : <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-string\">\"fileSize\"</span> : <span class=\"hljs-number\">0</span> \n }, \n <span class=\"hljs-string\">\"journals\"</span> : { \n <span class=\"hljs-string\">\"count\"</span> : <span class=\"hljs-number\">1</span>, \n <span class=\"hljs-string\">\"fileSize\"</span> : <span class=\"hljs-number\">33554432</span> \n }, \n <span class=\"hljs-string\">\"compactors\"</span> : { \n <span class=\"hljs-string\">\"count\"</span> : <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-string\">\"fileSize\"</span> : <span class=\"hljs-number\">0</span> \n }, \n <span class=\"hljs-string\">\"revisions\"</span> : { \n <span class=\"hljs-string\">\"count\"</span> : <span class=\"hljs-number\">1</span>, \n <span class=\"hljs-string\">\"size\"</span> : <span class=\"hljs-number\">48192</span> \n }, \n <span class=\"hljs-string\">\"lastTick\"</span> : <span class=\"hljs-number\">10405</span>, \n <span class=\"hljs-string\">\"uncollectedLogfileEntries\"</span> : <span class=\"hljs-number\">0</span> \n }, \n <span class=\"hljs-string\">\"doCompact\"</span> : <span class=\"hljs-literal\">true</span>, \n <span class=\"hljs-string\">\"globallyUniqueId\"</span> : <span class=\"hljs-string\">\"h66D61C8E346D/10399\"</span>, \n <span class=\"hljs-string\">\"count\"</span> : <span class=\"hljs-number\">1</span>, \n <span class=\"hljs-string\">\"indexBuckets\"</span> : <span class=\"hljs-number\">8</span>, \n <span class=\"hljs-string\">\"isSystem\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"journalSize\"</span> : <span class=\"hljs-number\">33554432</span>, \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-string\">\"10399\"</span>, \n <span class=\"hljs-string\">\"isVolatile\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"keyOptions\"</span> : { \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"traditional\"</span>, \n <span class=\"hljs-string\">\"allowUserKeys\"</span> : <span class=\"hljs-literal\">true</span>, \n <span class=\"hljs-string\">\"lastValue\"</span> : <span class=\"hljs-number\">10403</span> \n } \n}\n</code></pre>\n\n\n\n\n",
"parameters": [
{
"description": "The name of the collection.\n\n",
"format": "string",
"in": "path",
"name": "collection-name",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Returns information about the collection:\n\n",
"schema": {
"$ref": "#/definitions/JSA_get_api_collection_figures_rc_200"
},
"x-description-offset": 1358
},
"400": {
"description": "If the *collection-name* is missing, then a *HTTP 400* is\nreturned.\n\n"
},
"404": {
"description": "If the *collection-name* is unknown, then a *HTTP 404*\nis returned.\n\n"
}
},
"summary": "Return statistics for a collection",
"tags": [
"Collections"
],
"x-examples": [],
"x-filename": "Collections - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_load.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_rename.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/delete_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/post_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_truncate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_unload.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_rotate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_load_indexes_in_memory.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/get_api_collections.md"
}
},
"/_api/collection/{collection-name}/load": {
"put": {
"description": "\n\nLoads a collection into memory. Returns the collection on success.\n\nThe request body object might optionally contain the following attribute:\n\n- *count*: If set, this controls whether the return value should include\n the number of documents in the collection. Setting *count* to\n *false* may speed up loading a collection. The default value for\n *count* is *true*.\n\nOn success an object with the following attributes is returned:\n\n- *id*: The identifier of the collection.\n\n- *name*: The name of the collection.\n\n- *count*: The number of documents inside the collection. This is only\n returned if the *count* input parameters is set to *true* or has\n not been specified.\n\n- *status*: The status of the collection as number.\n\n- *type*: The collection type. Valid types are:\n - 2: document collection\n - 3: edges collection\n\n- *isSystem*: If *true* then the collection is a system collection.\n\n\n\n\n**Example:**\n \n\n<pre><code class=\"json\">shell> curl -X PUT --dump - http://localhost:8529/_api/collection/products/load\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">200</span> OK\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\nx-content-type-options: nosniff\nlocation: <span class=\"hljs-regexp\">/_api/</span>collection/products/load\n\n{ \n <span class=\"hljs-string\">\"code\"</span> : <span class=\"hljs-number\">200</span>, \n <span class=\"hljs-string\">\"error\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"status\"</span> : <span class=\"hljs-number\">3</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"products\"</span>, \n <span class=\"hljs-string\">\"count\"</span> : <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-string\">\"globallyUniqueId\"</span> : <span class=\"hljs-string\">\"h66D61C8E346D/10451\"</span>, \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-string\">\"10451\"</span>, \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-number\">2</span>, \n <span class=\"hljs-string\">\"isSystem\"</span> : <span class=\"hljs-literal\">false</span> \n}\n</code></pre>\n\n\n\n\n",
"parameters": [
{
"description": "The name of the collection.\n\n",
"format": "string",
"in": "path",
"name": "collection-name",
"required": true,
"type": "string"
}
],
"responses": {
"400": {
"description": "If the *collection-name* is missing, then a *HTTP 400* is\nreturned.\n\n"
},
"404": {
"description": "If the *collection-name* is unknown, then a *HTTP 404*\nis returned.\n\n"
}
},
"summary": "Load collection",
"tags": [
"Collections"
],
"x-examples": [],
"x-filename": "Collections - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_load.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_rename.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/delete_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/post_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_truncate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_unload.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_rotate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_load_indexes_in_memory.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/get_api_collections.md"
}
},
"/_api/collection/{collection-name}/loadIndexesIntoMemory": {
"put": {
"description": "\n\nThis route tries to cache all index entries\nof this collection into the main memory.\nTherefore it iterates over all indexes of the collection\nand stores the indexed values, not the entire document data,\nin memory.\nAll lookups that could be found in the cache are much faster\nthan lookups not stored in the cache so you get a nice performance boost.\nIt is also guaranteed that the cache is consistent with the stored data.\n\nFor the time being this function is only useful on RocksDB storage engine,\nas in MMFiles engine all indexes are in memory anyways.\n\nOn RocksDB this function honors all memory limits, if the indexes you want\nto load are smaller than your memory limit this function guarantees that most\nindex values are cached.\nIf the index is larger than your memory limit this function will fill up values\nup to this limit and for the time being there is no way to control which indexes\nof the collection should have priority over others.\n\nOn sucess this function returns an object with attribute `result` set to `true`\n\n\n\n\n**Example:**\n \n\n<pre><code class=\"json\">shell> curl -X PUT --dump - http://localhost:8529/_api/collection/products/loadIndexesIntoMemory\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">200</span> OK\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\nx-content-type-options: nosniff\nlocation: <span class=\"hljs-regexp\">/_api/</span>collection/products/loadIndexesIntoMemory\n\n{ \n <span class=\"hljs-string\">\"code\"</span> : <span class=\"hljs-number\">200</span>, \n <span class=\"hljs-string\">\"error\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"result\"</span> : <span class=\"hljs-literal\">true</span> \n}\n</code></pre>\n\n\n\n\n\n",
"parameters": [
{
"description": "\n",
"format": "string",
"in": "path",
"name": "collection-name",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "If the indexes have all been loaded\n\n"
},
"400": {
"description": "If the *collection-name* is missing, then a *HTTP 400* is\nreturned.\n\n"
},
"404": {
"description": "If the *collection-name* is unknown, then a *HTTP 404* is returned.\n\n"
}
},
"summary": "Load Indexes into Memory",
"tags": [
"Collections"
],
"x-examples": [],
"x-filename": "Collections - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_load.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_rename.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/delete_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/post_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_truncate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_unload.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_rotate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_load_indexes_in_memory.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/get_api_collections.md"
}
},
"/_api/collection/{collection-name}/properties": {
"get": {
"description": "\n\nIn addition to the above, the result will always contain the\n*waitForSync* attribute, and the *doCompact*, *journalSize*, \nand *isVolatile* attributes for the MMFiles storage engine.\nThis is achieved by forcing a load of the underlying collection.\n\n- *waitForSync*: If *true* then creating, changing or removing\n documents will wait until the data has been synchronized to disk.\n\n- *doCompact*: Whether or not the collection will be compacted.\n This option is only present for the MMFiles storage engine.\n\n- *journalSize*: The maximal size setting for journals / datafiles\n in bytes.\n This option is only present for the MMFiles storage engine.\n\n- *keyOptions*: JSON object which contains key generation options:\n - *type*: specifies the type of the key generator. The currently\n available generators are *traditional* and *autoincrement*.\n - *allowUserKeys*: if set to *true*, then it is allowed to supply\n own key values in the *_key* attribute of a document. If set to\n *false*, then the key generator is solely responsible for\n generating keys and supplying own key values in the *_key* attribute\n of documents is considered an error.\n\n- *isVolatile*: If *true* then the collection data will be\n kept in memory only and ArangoDB will not write or sync the data\n to disk.\n This option is only present for the MMFiles storage engine.\n\nIn a cluster setup, the result will also contain the following attributes:\n- *numberOfShards*: the number of shards of the collection.\n\n- *shardKeys*: contains the names of document attributes that are used to\n determine the target shard for documents.\n\n- *replicationFactor*: contains how many copies of each shard are kept on different DBServers.\n\n\n\n\n**Example:**\n Using an identifier:\n\n<pre><code class=\"json\">shell> curl --dump - http://localhost:8529/_api/collection/10426/properties\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">200</span> OK\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\nx-content-type-options: nosniff\nlocation: <span class=\"hljs-regexp\">/_api/</span>collection/<span class=\"hljs-number\">10426</span>/properties\n\n{ \n <span class=\"hljs-string\">\"code\"</span> : <span class=\"hljs-number\">200</span>, \n <span class=\"hljs-string\">\"error\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"waitForSync\"</span> : <span class=\"hljs-literal\">true</span>, \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-number\">2</span>, \n <span class=\"hljs-string\">\"statusString\"</span> : <span class=\"hljs-string\">\"loaded\"</span>, \n <span class=\"hljs-string\">\"indexBuckets\"</span> : <span class=\"hljs-number\">8</span>, \n <span class=\"hljs-string\">\"globallyUniqueId\"</span> : <span class=\"hljs-string\">\"h66D61C8E346D/10426\"</span>, \n <span class=\"hljs-string\">\"doCompact\"</span> : <span class=\"hljs-literal\">true</span>, \n <span class=\"hljs-string\">\"isSystem\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"journalSize\"</span> : <span class=\"hljs-number\">33554432</span>, \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-string\">\"10426\"</span>, \n <span class=\"hljs-string\">\"isVolatile\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"keyOptions\"</span> : { \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"traditional\"</span>, \n <span class=\"hljs-string\">\"allowUserKeys\"</span> : <span class=\"hljs-literal\">true</span>, \n <span class=\"hljs-string\">\"lastValue\"</span> : <span class=\"hljs-number\">0</span> \n }, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"products\"</span>, \n <span class=\"hljs-string\">\"status\"</span> : <span class=\"hljs-number\">3</span> \n}\n</code></pre>\n\n\n\n\n**Example:**\n Using a name:\n\n<pre><code class=\"json\">shell> curl --dump - http://localhost:8529/_api/collection/products/properties\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">200</span> OK\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\nx-content-type-options: nosniff\nlocation: <span class=\"hljs-regexp\">/_api/</span>collection/products/properties\n\n{ \n <span class=\"hljs-string\">\"code\"</span> : <span class=\"hljs-number\">200</span>, \n <span class=\"hljs-string\">\"error\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"waitForSync\"</span> : <span class=\"hljs-literal\">true</span>, \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-number\">2</span>, \n <span class=\"hljs-string\">\"statusString\"</span> : <span class=\"hljs-string\">\"loaded\"</span>, \n <span class=\"hljs-string\">\"indexBuckets\"</span> : <span class=\"hljs-number\">8</span>, \n <span class=\"hljs-string\">\"globallyUniqueId\"</span> : <span class=\"hljs-string\">\"h66D61C8E346D/10434\"</span>, \n <span class=\"hljs-string\">\"doCompact\"</span> : <span class=\"hljs-literal\">true</span>, \n <span class=\"hljs-string\">\"isSystem\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"journalSize\"</span> : <span class=\"hljs-number\">33554432</span>, \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-string\">\"10434\"</span>, \n <span class=\"hljs-string\">\"isVolatile\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"keyOptions\"</span> : { \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"traditional\"</span>, \n <span class=\"hljs-string\">\"allowUserKeys\"</span> : <span class=\"hljs-literal\">true</span>, \n <span class=\"hljs-string\">\"lastValue\"</span> : <span class=\"hljs-number\">0</span> \n }, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"products\"</span>, \n <span class=\"hljs-string\">\"status\"</span> : <span class=\"hljs-number\">3</span> \n}\n</code></pre>\n\n\n\n\n",
"parameters": [
{
"description": "The name of the collection.\n\n",
"format": "string",
"in": "path",
"name": "collection-name",
"required": true,
"type": "string"
}
],
"responses": {
"400": {
"description": "If the *collection-name* is missing, then a *HTTP 400* is\nreturned.\n\n"
},
"404": {
"description": "If the *collection-name* is unknown, then a *HTTP 404*\nis returned.\n\n"
}
},
"summary": "Read properties of a collection",
"tags": [
"Collections"
],
"x-examples": [],
"x-filename": "Collections - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_load.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_rename.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/delete_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/post_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_truncate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_unload.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_rotate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_load_indexes_in_memory.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/get_api_collections.md"
},
"put": {
"description": "\n\nChanges the properties of a collection. Expects an object with the\nattribute(s)\n\n- *waitForSync*: If *true* then creating or changing a\n document will wait until the data has been synchronized to disk.\n\n- *journalSize*: The maximal size of a journal or datafile in bytes. \n The value must be at least `1048576` (1 MB). Note that when\n changing the journalSize value, it will only have an effect for\n additional journals or datafiles that are created. Already\n existing journals or datafiles will not be affected.\n\nOn success an object with the following attributes is returned:\n\n- *id*: The identifier of the collection.\n\n- *name*: The name of the collection.\n\n- *waitForSync*: The new value.\n\n- *journalSize*: The new value.\n\n- *status*: The status of the collection as number.\n\n- *type*: The collection type. Valid types are:\n - 2: document collection\n - 3: edges collection\n\n- *isSystem*: If *true* then the collection is a system collection.\n\n- *isVolatile*: If *true* then the collection data will be\n kept in memory only and ArangoDB will not write or sync the data\n to disk.\n\n- *doCompact*: Whether or not the collection will be compacted.\n\n- *keyOptions*: JSON object which contains key generation options:\n - *type*: specifies the type of the key generator. The currently\n available generators are *traditional* and *autoincrement*.\n - *allowUserKeys*: if set to *true*, then it is allowed to supply\n own key values in the *_key* attribute of a document. If set to\n *false*, then the key generator is solely responsible for\n generating keys and supplying own key values in the *_key* attribute\n of documents is considered an error.\n\n**Note**: except for *waitForSync*, *journalSize* and *name*, collection\nproperties **cannot be changed** once a collection is created. To rename\na collection, the rename endpoint must be used.\n\n\n\n\n**Example:**\n \n\n<pre><code class=\"json\">shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/collection/products/properties &lt;&lt;EOF\n{ \n <span class=\"hljs-string\">\"waitForSync\"</span> : <span class=\"hljs-literal\">true</span> \n}\nEOF\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">200</span> OK\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\nx-content-type-options: nosniff\nlocation: <span class=\"hljs-regexp\">/_api/</span>collection/products/properties\n\n{ \n <span class=\"hljs-string\">\"code\"</span> : <span class=\"hljs-number\">200</span>, \n <span class=\"hljs-string\">\"error\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"waitForSync\"</span> : <span class=\"hljs-literal\">true</span>, \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-number\">2</span>, \n <span class=\"hljs-string\">\"statusString\"</span> : <span class=\"hljs-string\">\"loaded\"</span>, \n <span class=\"hljs-string\">\"indexBuckets\"</span> : <span class=\"hljs-number\">8</span>, \n <span class=\"hljs-string\">\"globallyUniqueId\"</span> : <span class=\"hljs-string\">\"h66D61C8E346D/10468\"</span>, \n <span class=\"hljs-string\">\"doCompact\"</span> : <span class=\"hljs-literal\">true</span>, \n <span class=\"hljs-string\">\"isSystem\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"journalSize\"</span> : <span class=\"hljs-number\">33554432</span>, \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-string\">\"10468\"</span>, \n <span class=\"hljs-string\">\"isVolatile\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"keyOptions\"</span> : { \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"traditional\"</span>, \n <span class=\"hljs-string\">\"allowUserKeys\"</span> : <span class=\"hljs-literal\">true</span>, \n <span class=\"hljs-string\">\"lastValue\"</span> : <span class=\"hljs-number\">0</span> \n }, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"products\"</span>, \n <span class=\"hljs-string\">\"status\"</span> : <span class=\"hljs-number\">3</span> \n}\n</code></pre>\n\n\n\n\n",
"parameters": [
{
"description": "The name of the collection.\n\n",
"format": "string",
"in": "path",
"name": "collection-name",
"required": true,
"type": "string"
}
],
"responses": {
"400": {
"description": "If the *collection-name* is missing, then a *HTTP 400* is\nreturned.\n\n"
},
"404": {
"description": "If the *collection-name* is unknown, then a *HTTP 404*\nis returned.\n\n"
}
},
"summary": "Change properties of a collection",
"tags": [
"Collections"
],
"x-examples": [],
"x-filename": "Collections - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_load.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_rename.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/delete_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/post_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_truncate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_unload.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_rotate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_load_indexes_in_memory.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/get_api_collections.md"
}
},
"/_api/collection/{collection-name}/rename": {
"put": {
"description": "\n\nRenames a collection. Expects an object with the attribute(s)\n\n- *name*: The new name.\n\nIt returns an object with the attributes\n\n- *id*: The identifier of the collection.\n\n- *name*: The new name of the collection.\n\n- *status*: The status of the collection as number.\n\n- *type*: The collection type. Valid types are:\n - 2: document collection\n - 3: edges collection\n\n- *isSystem*: If *true* then the collection is a system collection.\n\nIf renaming the collection succeeds, then the collection is also renamed in \nall graph definitions inside the `_graphs` collection in the current database.\n\n**Note**: this method is not available in a cluster.\n\n\n\n\n**Example:**\n \n\n<pre><code class=\"json\">shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/collection/products1/rename &lt;&lt;EOF\n{ \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"newname\"</span> \n}\nEOF\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">200</span> OK\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\nx-content-type-options: nosniff\nlocation: <span class=\"hljs-regexp\">/_api/</span>collection/products1/rename\n\n{ \n <span class=\"hljs-string\">\"code\"</span> : <span class=\"hljs-number\">200</span>, \n <span class=\"hljs-string\">\"error\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"status\"</span> : <span class=\"hljs-number\">3</span>, \n <span class=\"hljs-string\">\"globallyUniqueId\"</span> : <span class=\"hljs-string\">\"h66D61C8E346D/10478\"</span>, \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-string\">\"10478\"</span>, \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-number\">2</span>, \n <span class=\"hljs-string\">\"isSystem\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"newname\"</span> \n}\n</code></pre>\n\n\n\n\n",
"parameters": [
{
"description": "The name of the collection to rename.\n\n",
"format": "string",
"in": "path",
"name": "collection-name",
"required": true,
"type": "string"
}
],
"responses": {
"400": {
"description": "If the *collection-name* is missing, then a *HTTP 400* is\nreturned.\n\n"
},
"404": {
"description": "If the *collection-name* is unknown, then a *HTTP 404*\nis returned.\n"
}
},
"summary": "Rename collection",
"tags": [
"Collections"
],
"x-examples": [],
"x-filename": "Collections - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_load.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_rename.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/delete_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/post_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_truncate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_unload.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_rotate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_load_indexes_in_memory.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/get_api_collections.md"
}
},
"/_api/collection/{collection-name}/revision": {
"get": {
"description": "\n\nIn addition to the above, the result will also contain the\ncollection's revision id. The revision id is a server-generated\nstring that clients can use to check whether data in a collection\nhas changed since the last revision check.\n\n- *revision*: The collection revision id as a string.\n\n\n\n\n**Example:**\n Retrieving the revision of a collection\n\n<pre><code class=\"json\">shell> curl --dump - http://localhost:8529/_api/collection/products/revision\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">200</span> OK\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\nx-content-type-options: nosniff\nlocation: <span class=\"hljs-regexp\">/_api/</span>collection/products/revision\n\n{ \n <span class=\"hljs-string\">\"code\"</span> : <span class=\"hljs-number\">200</span>, \n <span class=\"hljs-string\">\"error\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"statusString\"</span> : <span class=\"hljs-string\">\"loaded\"</span>, \n <span class=\"hljs-string\">\"journalSize\"</span> : <span class=\"hljs-number\">33554432</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"products\"</span>, \n <span class=\"hljs-string\">\"status\"</span> : <span class=\"hljs-number\">3</span>, \n <span class=\"hljs-string\">\"waitForSync\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"revision\"</span> : <span class=\"hljs-string\">\"0\"</span>, \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-number\">2</span>, \n <span class=\"hljs-string\">\"isSystem\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"doCompact\"</span> : <span class=\"hljs-literal\">true</span>, \n <span class=\"hljs-string\">\"globallyUniqueId\"</span> : <span class=\"hljs-string\">\"h66D61C8E346D/10442\"</span>, \n <span class=\"hljs-string\">\"indexBuckets\"</span> : <span class=\"hljs-number\">8</span>, \n <span class=\"hljs-string\">\"keyOptions\"</span> : { \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"traditional\"</span>, \n <span class=\"hljs-string\">\"allowUserKeys\"</span> : <span class=\"hljs-literal\">true</span>, \n <span class=\"hljs-string\">\"lastValue\"</span> : <span class=\"hljs-number\">0</span> \n }, \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-string\">\"10442\"</span>, \n <span class=\"hljs-string\">\"isVolatile\"</span> : <span class=\"hljs-literal\">false</span> \n}\n</code></pre>\n\n\n\n\n",
"parameters": [
{
"description": "The name of the collection.\n\n",
"format": "string",
"in": "path",
"name": "collection-name",
"required": true,
"type": "string"
}
],
"responses": {
"400": {
"description": "If the *collection-name* is missing, then a *HTTP 400* is\nreturned.\n\n"
},
"404": {
"description": "If the *collection-name* is unknown, then a *HTTP 404*\nis returned.\n\n"
}
},
"summary": "Return collection revision id",
"tags": [
"Collections"
],
"x-examples": [],
"x-filename": "Collections - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_load.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_rename.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/delete_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/post_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_truncate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_unload.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_rotate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_load_indexes_in_memory.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/get_api_collections.md"
}
},
"/_api/collection/{collection-name}/rotate": {
"put": {
"description": "\n\nRotates the journal of a collection. The current journal of the collection will be closed\nand made a read-only datafile. The purpose of the rotate method is to make the data in\nthe file available for compaction (compaction is only performed for read-only datafiles, and\nnot for journals).\n\nSaving new data in the collection subsequently will create a new journal file\nautomatically if there is no current journal.\n\nIt returns an object with the attributes\n\n- *result*: will be *true* if rotation succeeded\n\n**Note**: this method is specific for the MMFiles storage engine, and there\nit is not available in a cluster.\n\n\n\n\n**Example:**\n Rotating the journal:\n\n<pre><code class=\"json\">shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/collection/products/rotate &lt;&lt;EOF\n{ \n}\nEOF\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">200</span> OK\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\nx-content-type-options: nosniff\nlocation: <span class=\"hljs-regexp\">/_api/</span>collection/products/rotate\n\n{ \n <span class=\"hljs-string\">\"code\"</span> : <span class=\"hljs-number\">200</span>, \n <span class=\"hljs-string\">\"error\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"result\"</span> : <span class=\"hljs-literal\">true</span> \n}\n</code></pre>\n\n\n\n\n**Example:**\n Rotating if no journal exists:\n\n<pre><code class=\"json\">shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/collection/products/rotate &lt;&lt;EOF\n{ \n}\nEOF\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">400</span> Bad Request\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\nx-content-type-options: nosniff\n\n{ \n <span class=\"hljs-string\">\"error\"</span> : <span class=\"hljs-literal\">true</span>, \n <span class=\"hljs-string\">\"errorMessage\"</span> : <span class=\"hljs-string\">\"no journal\"</span>, \n <span class=\"hljs-string\">\"code\"</span> : <span class=\"hljs-number\">400</span>, \n <span class=\"hljs-string\">\"errorNum\"</span> : <span class=\"hljs-number\">1105</span> \n}\n</code></pre>\n\n\n\n\n",
"parameters": [
{
"description": "The name of the collection.\n\n",
"format": "string",
"in": "path",
"name": "collection-name",
"required": true,
"type": "string"
}
],
"responses": {
"400": {
"description": "If the collection currently has no journal, *HTTP 400* is returned.\n\n"
},
"404": {
"description": "If the *collection-name* is unknown, then a *HTTP 404* is returned.\n\n"
}
},
"summary": "Rotate journal of a collection",
"tags": [
"Collections"
],
"x-examples": [],
"x-filename": "Collections - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_load.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_rename.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/delete_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/post_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_truncate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_unload.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_rotate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_load_indexes_in_memory.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/get_api_collections.md"
}
},
"/_api/collection/{collection-name}/truncate": {
"put": {
"description": "\n\nRemoves all documents from the collection, but leaves the indexes intact.\n\n\n\n\n**Example:**\n \n\n<pre><code class=\"json\">shell> curl -X PUT --dump - http://localhost:8529/_api/collection/products/truncate\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">200</span> OK\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\nx-content-type-options: nosniff\nlocation: <span class=\"hljs-regexp\">/_api/</span>collection/products/truncate\n\n{ \n <span class=\"hljs-string\">\"code\"</span> : <span class=\"hljs-number\">200</span>, \n <span class=\"hljs-string\">\"error\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"status\"</span> : <span class=\"hljs-number\">3</span>, \n <span class=\"hljs-string\">\"globallyUniqueId\"</span> : <span class=\"hljs-string\">\"h66D61C8E346D/10487\"</span>, \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-string\">\"10487\"</span>, \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-number\">2</span>, \n <span class=\"hljs-string\">\"isSystem\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"products\"</span> \n}\n</code></pre>\n\n\n\n\n",
"parameters": [
{
"description": "The name of the collection.\n\n",
"format": "string",
"in": "path",
"name": "collection-name",
"required": true,
"type": "string"
}
],
"responses": {
"400": {
"description": "If the *collection-name* is missing, then a *HTTP 400* is\nreturned.\n\n"
},
"404": {
"description": "If the *collection-name* is unknown, then a *HTTP 404*\nis returned.\n\n"
}
},
"summary": "Truncate collection",
"tags": [
"Collections"
],
"x-examples": [],
"x-filename": "Collections - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_load.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_rename.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/delete_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/post_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_truncate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_unload.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_rotate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_load_indexes_in_memory.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/get_api_collections.md"
}
},
"/_api/collection/{collection-name}/unload": {
"put": {
"description": "\n\nRemoves a collection from memory. This call does not delete any documents.\nYou can use the collection afterwards; in which case it will be loaded into\nmemory, again. On success an object with the following attributes is\nreturned:\n\n- *id*: The identifier of the collection.\n\n- *name*: The name of the collection.\n\n- *status*: The status of the collection as number.\n\n- *type*: The collection type. Valid types are:\n - 2: document collection\n - 3: edges collection\n\n- *isSystem*: If *true* then the collection is a system collection.\n\n\n\n\n**Example:**\n \n\n<pre><code class=\"json\">shell> curl -X PUT --dump - http://localhost:8529/_api/collection/products/unload\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">200</span> OK\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\nx-content-type-options: nosniff\nlocation: <span class=\"hljs-regexp\">/_api/</span>collection/products/unload\n\n{ \n <span class=\"hljs-string\">\"code\"</span> : <span class=\"hljs-number\">200</span>, \n <span class=\"hljs-string\">\"error\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"status\"</span> : <span class=\"hljs-number\">4</span>, \n <span class=\"hljs-string\">\"globallyUniqueId\"</span> : <span class=\"hljs-string\">\"h66D61C8E346D/10495\"</span>, \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-string\">\"10495\"</span>, \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-number\">2</span>, \n <span class=\"hljs-string\">\"isSystem\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"products\"</span> \n}\n</code></pre>\n\n\n\n\n",
"parameters": [
{
"description": "\n",
"format": "string",
"in": "path",
"name": "collection-name",
"required": true,
"type": "string"
}
],
"responses": {
"400": {
"description": "If the *collection-name* is missing, then a *HTTP 400* is\nreturned.\n\n"
},
"404": {
"description": "If the *collection-name* is unknown, then a *HTTP 404* is returned.\n\n"
}
},
"summary": "Unload collection",
"tags": [
"Collections"
],
"x-examples": [],
"x-filename": "Collections - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_load.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_rename.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/delete_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/post_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_truncate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_unload.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_rotate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/put_api_collection_load_indexes_in_memory.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/get_api_collections.md"
}
},
"/_api/cursor": {
"post": {
"description": "\n**A JSON object with these properties is required:**\n\n - **count**: indicates whether the number of documents in the result set should be returned in\n the \"count\" attribute of the result.\n Calculating the \"count\" attribute might have a performance impact for some queries\n in the future so this option is turned off by default, and \"count\"\n is only returned when requested.\n - **batchSize**: maximum number of result documents to be transferred from\n the server to the client in one roundtrip. If this attribute is\n not set, a server-controlled default value will be used. A *batchSize* value of\n *0* is disallowed.\n - **cache**: flag to determine whether the AQL query cache\n shall be used. If set to *false*, then any query cache lookup will be skipped\n for the query. If set to *true*, it will lead to the query cache being checked\n for the query if the query cache mode is either *on* or *demand*.\n - **memoryLimit**: the maximum number of memory (measured in bytes) that the query is allowed to\n use. If set, then the query will fail with error \"resource limit exceeded\" in\n case it allocates too much memory. A value of *0* indicates that there is no\n memory limit.\n - **ttl**: The time-to-live for the cursor (in seconds). The cursor will be\n removed on the server automatically after the specified amount of time. This\n is useful to ensure garbage collection of cursors that are not fully fetched\n by clients. If not set, a server-defined value will be used.\n - **query**: contains the query string to be executed\n - **bindVars** (object): key/value pairs representing the bind parameters.\n - **options**:\n - **failOnWarning**: When set to *true*, the query will throw an exception and abort instead of producing\n a warning. This option should be used during development to catch potential issues\n early. When the attribute is set to *false*, warnings will not be propagated to\n exceptions and will be returned with the query result.\n There is also a server configuration option `--query.fail-on-warning` for setting the\n default value for *failOnWarning* so it does not need to be set on a per-query level.\n - **profile**: If set to *true*, then the additional query profiling information will be returned\n in the sub-attribute *profile* of the *extra* return attribute if the query result\n is not served from the query cache.\n - **maxTransactionSize**: Transaction size limit in bytes. Honored by the RocksDB storage engine only.\n - **skipInaccessibleCollections**: AQL queries (especially graph traversals) will treat collection to which a user has no access rights as if these collections were empty. Instead of returning a forbidden access error, your queries will execute normally. This is intended to help with certain use-cases: A graph contains several collections and different users execute AQL queries on that graph. You can now naturally limit the accessible results by changing the access rights of users on collections. This feature is only available in the Enterprise Edition.\n - **maxWarningCount**: Limits the maximum number of warnings a query will return. The number of warnings\n a query will return is limited to 10 by default, but that number can be increased\n or decreased by setting this attribute.\n - **intermediateCommitCount**: Maximum number of operations after which an intermediate commit is performed\n automatically. Honored by the RocksDB storage engine only.\n - **satelliteSyncWait**: This *enterprise* parameter allows to configure how long a DBServer will have time\n to bring the satellite collections involved in the query into sync.\n The default value is *60.0* (seconds). When the max time has been reached the query\n will be stopped.\n - **fullCount**: if set to *true* and the query contains a *LIMIT* clause, then the\n result will have an *extra* attribute with the sub-attributes *stats*\n and *fullCount*, `{ ... , \"extra\": { \"stats\": { \"fullCount\": 123 } } }`.\n The *fullCount* attribute will contain the number of documents in the result before the\n last LIMIT in the query was applied. It can be used to count the number of documents that\n match certain filter criteria, but only return a subset of them, in one go.\n It is thus similar to MySQL's *SQL_CALC_FOUND_ROWS* hint. Note that setting the option\n will disable a few LIMIT optimizations and may lead to more documents being processed,\n and thus make queries run longer. Note that the *fullCount* attribute will only\n be present in the result if the query has a LIMIT clause and the LIMIT clause is\n actually used in the query.\n - **intermediateCommitSize**: Maximum total size of operations after which an intermediate commit is performed\n automatically. Honored by the RocksDB storage engine only.\n - **optimizer.rules** (string): A list of to-be-included or to-be-excluded optimizer rules\n can be put into this attribute, telling the optimizer to include or exclude\n specific rules. To disable a rule, prefix its name with a `-`, to enable a rule, prefix it\n with a `+`. There is also a pseudo-rule `all`, which will match all optimizer rules.\n - **maxPlans**: Limits the maximum number of plans that are created by the AQL query optimizer.\n\n\n\n\nThe query details include the query string plus optional query options and\nbind parameters. These values need to be passed in a JSON representation in\nthe body of the POST request.\n\n**A json document with these Properties is returned:**\n\n#### HTTP 201\nis returned if the result set can be created by the server.\n\n- **count**: the total number of result documents available (only\navailable if the query was executed with the *count* attribute set)\n- **code**: the HTTP status code\n- **extra**: an optional JSON object with extra information about the query result\ncontained in its *stats* sub-attribute. For data-modification queries, the\n*extra.stats* sub-attribute will contain the number of modified documents and\nthe number of documents that could not be modified\ndue to an error (if *ignoreErrors* query option is specified)\n- **cached**: a boolean flag indicating whether the query result was served\nfrom the query cache or not. If the query result is served from the query\ncache, the *extra* return attribute will not contain any *stats* sub-attribute\nand no *profile* sub-attribute.\n- **hasMore**: A boolean indicator whether there are more results\navailable for the cursor on the server\n- **result** (anonymous json object): an array of result documents (might be empty if query has no results)\n- **error**: A flag to indicate that an error occurred (*false* in this case)\n- **id**: id of temporary cursor created on the server (optional, see above)\n\n**A json document with these Properties is returned:**\n\n#### HTTP 400\nis returned if the JSON representation is malformed or the query specification is\nmissing from the request.\nIf the JSON representation is malformed or the query specification is\nmissing from the request, the server will respond with *HTTP 400*.\nThe body of the response will contain a JSON object with additional error\ndetails. The object has the following attributes:\n\n- **errorMessage**: a descriptive error message\nIf the query specification is complete, the server will process the query. If an\nerror occurs during query processing, the server will respond with *HTTP 400*.\nAgain, the body of the response will contain details about the error.\nA [list of query errors can be found here](../../Manual/Appendix/ErrorCodes.html).\n- **errorNum**: the server error number\n- **code**: the HTTP status code\n- **error**: boolean flag to indicate that an error occurred (*true* in this case)\n\n\n\n\n**Example:**\n Execute a query and extract the result in a single go\n\n<pre><code class=\"json\">shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/cursor &lt;&lt;EOF\n{ \n <span class=\"hljs-string\">\"query\"</span> : <span class=\"hljs-string\">\"FOR p IN products LIMIT 2 RETURN p\"</span>, \n <span class=\"hljs-string\">\"count\"</span> : <span class=\"hljs-literal\">true</span>, \n <span class=\"hljs-string\">\"batchSize\"</span> : <span class=\"hljs-number\">2</span> \n}\nEOF\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">201</span> Created\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\nx-content-type-options: nosniff\n\n{ \n <span class=\"hljs-string\">\"result\"</span> : [ \n { \n <span class=\"hljs-string\">\"_key\"</span> : <span class=\"hljs-string\">\"10567\"</span>, \n <span class=\"hljs-string\">\"_id\"</span> : <span class=\"hljs-string\">\"products/10567\"</span>, \n <span class=\"hljs-string\">\"_rev\"</span> : <span class=\"hljs-string\">\"_WE2VDei--_\"</span>, \n <span class=\"hljs-string\">\"hello2\"</span> : <span class=\"hljs-string\">\"world1\"</span> \n }, \n { \n <span class=\"hljs-string\">\"_key\"</span> : <span class=\"hljs-string\">\"10563\"</span>, \n <span class=\"hljs-string\">\"_id\"</span> : <span class=\"hljs-string\">\"products/10563\"</span>, \n <span class=\"hljs-string\">\"_rev\"</span> : <span class=\"hljs-string\">\"_WE2VDee--_\"</span>, \n <span class=\"hljs-string\">\"hello1\"</span> : <span class=\"hljs-string\">\"world1\"</span> \n } \n ], \n <span class=\"hljs-string\">\"hasMore\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"count\"</span> : <span class=\"hljs-number\">2</span>, \n <span class=\"hljs-string\">\"cached\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"extra\"</span> : { \n <span class=\"hljs-string\">\"stats\"</span> : { \n <span class=\"hljs-string\">\"writesExecuted\"</span> : <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-string\">\"writesIgnored\"</span> : <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-string\">\"scannedFull\"</span> : <span class=\"hljs-number\">2</span>, \n <span class=\"hljs-string\">\"scannedIndex\"</span> : <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-string\">\"filtered\"</span> : <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-string\">\"httpRequests\"</span> : <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-string\">\"executionTime\"</span> : <span class=\"hljs-number\">0.00022745132446289062</span> \n }, \n <span class=\"hljs-string\">\"warnings\"</span> : [ ] \n }, \n <span class=\"hljs-string\">\"error\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"code\"</span> : <span class=\"hljs-number\">201</span> \n}\n</code></pre>\n\n\n\n\n**Example:**\n Execute a query and extract a part of the result\n\n<pre><code class=\"json\">shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/cursor &lt;&lt;EOF\n{ \n <span class=\"hljs-string\">\"query\"</span> : <span class=\"hljs-string\">\"FOR p IN products LIMIT 5 RETURN p\"</span>, \n <span class=\"hljs-string\">\"count\"</span> : <span class=\"hljs-literal\">true</span>, \n <span class=\"hljs-string\">\"batchSize\"</span> : <span class=\"hljs-number\">2</span> \n}\nEOF\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">201</span> Created\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\nx-content-type-options: nosniff\n\n{ \n <span class=\"hljs-string\">\"error\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"code\"</span> : <span class=\"hljs-number\">201</span>, \n <span class=\"hljs-string\">\"result\"</span> : [ \n { \n <span class=\"hljs-string\">\"_key\"</span> : <span class=\"hljs-string\">\"10551\"</span>, \n <span class=\"hljs-string\">\"_id\"</span> : <span class=\"hljs-string\">\"products/10551\"</span>, \n <span class=\"hljs-string\">\"_rev\"</span> : <span class=\"hljs-string\">\"_WE2VDX2--_\"</span>, \n <span class=\"hljs-string\">\"hello5\"</span> : <span class=\"hljs-string\">\"world1\"</span> \n }, \n { \n <span class=\"hljs-string\">\"_key\"</span> : <span class=\"hljs-string\">\"10548\"</span>, \n <span class=\"hljs-string\">\"_id\"</span> : <span class=\"hljs-string\">\"products/10548\"</span>, \n <span class=\"hljs-string\">\"_rev\"</span> : <span class=\"hljs-string\">\"_WE2VDXy--B\"</span>, \n <span class=\"hljs-string\">\"hello4\"</span> : <span class=\"hljs-string\">\"world1\"</span> \n } \n ], \n <span class=\"hljs-string\">\"hasMore\"</span> : <span class=\"hljs-literal\">true</span>, \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-string\">\"10554\"</span>, \n <span class=\"hljs-string\">\"count\"</span> : <span class=\"hljs-number\">5</span>, \n <span class=\"hljs-string\">\"extra\"</span> : { \n <span class=\"hljs-string\">\"stats\"</span> : { \n <span class=\"hljs-string\">\"writesExecuted\"</span> : <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-string\">\"writesIgnored\"</span> : <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-string\">\"scannedFull\"</span> : <span class=\"hljs-number\">5</span>, \n <span class=\"hljs-string\">\"scannedIndex\"</span> : <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-string\">\"filtered\"</span> : <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-string\">\"httpRequests\"</span> : <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-string\">\"executionTime\"</span> : <span class=\"hljs-number\">0.0002815723419189453</span> \n }, \n <span class=\"hljs-string\">\"warnings\"</span> : [ ] \n }, \n <span class=\"hljs-string\">\"cached\"</span> : <span class=\"hljs-literal\">false</span> \n}\n</code></pre>\n\n\n\n\n**Example:**\n Using the query option \"fullCount\"\n\n<pre><code class=\"json\">shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/cursor &lt;&lt;EOF\n{ \n <span class=\"hljs-string\">\"query\"</span> : <span class=\"hljs-string\">\"FOR i IN 1..1000 FILTER i &gt; 500 LIMIT 10 RETURN i\"</span>, \n <span class=\"hljs-string\">\"count\"</span> : <span class=\"hljs-literal\">true</span>, \n <span class=\"hljs-string\">\"options\"</span> : { \n <span class=\"hljs-string\">\"fullCount\"</span> : <span class=\"hljs-literal\">true</span> \n } \n}\nEOF\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">201</span> Created\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\nx-content-type-options: nosniff\n\n{ \n <span class=\"hljs-string\">\"result\"</span> : [ \n <span class=\"hljs-number\">501</span>, \n <span class=\"hljs-number\">502</span>, \n <span class=\"hljs-number\">503</span>, \n <span class=\"hljs-number\">504</span>, \n <span class=\"hljs-number\">505</span>, \n <span class=\"hljs-number\">506</span>, \n <span class=\"hljs-number\">507</span>, \n <span class=\"hljs-number\">508</span>, \n <span class=\"hljs-number\">509</span>, \n <span class=\"hljs-number\">510</span> \n ], \n <span class=\"hljs-string\">\"hasMore\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"count\"</span> : <span class=\"hljs-number\">10</span>, \n <span class=\"hljs-string\">\"cached\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"extra\"</span> : { \n <span class=\"hljs-string\">\"stats\"</span> : { \n <span class=\"hljs-string\">\"writesExecuted\"</span> : <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-string\">\"writesIgnored\"</span> : <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-string\">\"scannedFull\"</span> : <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-string\">\"scannedIndex\"</span> : <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-string\">\"filtered\"</span> : <span class=\"hljs-number\">500</span>, \n <span class=\"hljs-string\">\"httpRequests\"</span> : <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-string\">\"fullCount\"</span> : <span class=\"hljs-number\">500</span>, \n <span class=\"hljs-string\">\"executionTime\"</span> : <span class=\"hljs-number\">0.0006248950958251953</span> \n }, \n <span class=\"hljs-string\">\"warnings\"</span> : [ ] \n }, \n <span class=\"hljs-string\">\"error\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"code\"</span> : <span class=\"hljs-number\">201</span> \n}\n</code></pre>\n\n\n\n\n**Example:**\n Enabling and disabling optimizer rules\n\n<pre><code class=\"json\">shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/cursor &lt;&lt;EOF\n{ \n <span class=\"hljs-string\">\"query\"</span> : <span class=\"hljs-string\">\"FOR i IN 1..10 LET a = 1 LET b = 2 FILTER a + b == 3 RETURN i\"</span>, \n <span class=\"hljs-string\">\"count\"</span> : <span class=\"hljs-literal\">true</span>, \n <span class=\"hljs-string\">\"options\"</span> : { \n <span class=\"hljs-string\">\"maxPlans\"</span> : <span class=\"hljs-number\">1</span>, \n <span class=\"hljs-string\">\"optimizer\"</span> : { \n <span class=\"hljs-string\">\"rules\"</span> : [ \n <span class=\"hljs-string\">\"-all\"</span>, \n <span class=\"hljs-string\">\"+remove-unnecessary-filters\"</span> \n ] \n } \n } \n}\nEOF\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">201</span> Created\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\nx-content-type-options: nosniff\n\n{ \n <span class=\"hljs-string\">\"result\"</span> : [ \n <span class=\"hljs-number\">1</span>, \n <span class=\"hljs-number\">2</span>, \n <span class=\"hljs-number\">3</span>, \n <span class=\"hljs-number\">4</span>, \n <span class=\"hljs-number\">5</span>, \n <span class=\"hljs-number\">6</span>, \n <span class=\"hljs-number\">7</span>, \n <span class=\"hljs-number\">8</span>, \n <span class=\"hljs-number\">9</span>, \n <span class=\"hljs-number\">10</span> \n ], \n <span class=\"hljs-string\">\"hasMore\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"count\"</span> : <span class=\"hljs-number\">10</span>, \n <span class=\"hljs-string\">\"cached\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"extra\"</span> : { \n <span class=\"hljs-string\">\"stats\"</span> : { \n <span class=\"hljs-string\">\"writesExecuted\"</span> : <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-string\">\"writesIgnored\"</span> : <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-string\">\"scannedFull\"</span> : <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-string\">\"scannedIndex\"</span> : <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-string\">\"filtered\"</span> : <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-string\">\"httpRequests\"</span> : <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-string\">\"executionTime\"</span> : <span class=\"hljs-number\">0.0003383159637451172</span> \n }, \n <span class=\"hljs-string\">\"warnings\"</span> : [ ] \n }, \n <span class=\"hljs-string\">\"error\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"code\"</span> : <span class=\"hljs-number\">201</span> \n}\n</code></pre>\n\n\n\n\n**Example:**\n Execute a data-modification query and retrieve the number of\nmodified documents\n\n<pre><code class=\"json\">shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/cursor &lt;&lt;EOF\n{ \n <span class=\"hljs-string\">\"query\"</span> : <span class=\"hljs-string\">\"FOR p IN products REMOVE p IN products\"</span> \n}\nEOF\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">201</span> Created\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\nx-content-type-options: nosniff\n\n{ \n <span class=\"hljs-string\">\"result\"</span> : [ ], \n <span class=\"hljs-string\">\"hasMore\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"cached\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"extra\"</span> : { \n <span class=\"hljs-string\">\"stats\"</span> : { \n <span class=\"hljs-string\">\"writesExecuted\"</span> : <span class=\"hljs-number\">2</span>, \n <span class=\"hljs-string\">\"writesIgnored\"</span> : <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-string\">\"scannedFull\"</span> : <span class=\"hljs-number\">2</span>, \n <span class=\"hljs-string\">\"scannedIndex\"</span> : <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-string\">\"filtered\"</span> : <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-string\">\"httpRequests\"</span> : <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-string\">\"executionTime\"</span> : <span class=\"hljs-number\">0.0003459453582763672</span> \n }, \n <span class=\"hljs-string\">\"warnings\"</span> : [ ] \n }, \n <span class=\"hljs-string\">\"error\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"code\"</span> : <span class=\"hljs-number\">201</span> \n}\n</code></pre>\n\n\n\n\n**Example:**\n Execute a data-modification query with option *ignoreErrors*\n\n<pre><code class=\"json\">shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/cursor &lt;&lt;EOF\n{ \n <span class=\"hljs-string\">\"query\"</span> : <span class=\"hljs-string\">\"REMOVE 'bar' IN products OPTIONS { ignoreErrors: true }\"</span> \n}\nEOF\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">201</span> Created\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\nx-content-type-options: nosniff\n\n{ \n <span class=\"hljs-string\">\"result\"</span> : [ ], \n <span class=\"hljs-string\">\"hasMore\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"cached\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"extra\"</span> : { \n <span class=\"hljs-string\">\"stats\"</span> : { \n <span class=\"hljs-string\">\"writesExecuted\"</span> : <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-string\">\"writesIgnored\"</span> : <span class=\"hljs-number\">1</span>, \n <span class=\"hljs-string\">\"scannedFull\"</span> : <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-string\">\"scannedIndex\"</span> : <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-string\">\"filtered\"</span> : <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-string\">\"httpRequests\"</span> : <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-string\">\"executionTime\"</span> : <span class=\"hljs-number\">0.0002167224884033203</span> \n }, \n <span class=\"hljs-string\">\"warnings\"</span> : [ ] \n }, \n <span class=\"hljs-string\">\"error\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"code\"</span> : <span class=\"hljs-number\">201</span> \n}\n</code></pre>\n\n\n\n\n**Example:**\n Bad query - Missing body\n\n<pre><code class=\"json\">shell> curl -X POST --dump - http://localhost:8529/_api/cursor\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">400</span> Bad Request\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\nx-content-type-options: nosniff\n\n{ \n <span class=\"hljs-string\">\"error\"</span> : <span class=\"hljs-literal\">true</span>, \n <span class=\"hljs-string\">\"errorMessage\"</span> : <span class=\"hljs-string\">\"query is empty\"</span>, \n <span class=\"hljs-string\">\"code\"</span> : <span class=\"hljs-number\">400</span>, \n <span class=\"hljs-string\">\"errorNum\"</span> : <span class=\"hljs-number\">1502</span> \n}\n</code></pre>\n\n\n\n\n**Example:**\n Bad query - Unknown collection\n\n<pre><code class=\"json\">shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/cursor &lt;&lt;EOF\n{ \n <span class=\"hljs-string\">\"query\"</span> : <span class=\"hljs-string\">\"FOR u IN unknowncoll LIMIT 2 RETURN u\"</span>, \n <span class=\"hljs-string\">\"count\"</span> : <span class=\"hljs-literal\">true</span>, \n <span class=\"hljs-string\">\"batchSize\"</span> : <span class=\"hljs-number\">2</span> \n}\nEOF\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">404</span> Not Found\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\nx-content-type-options: nosniff\n\n{ \n <span class=\"hljs-string\">\"error\"</span> : <span class=\"hljs-literal\">true</span>, \n <span class=\"hljs-string\">\"errorMessage\"</span> : <span class=\"hljs-string\">\"AQL: collection not found: unknowncoll (while parsing)\"</span>, \n <span class=\"hljs-string\">\"code\"</span> : <span class=\"hljs-number\">404</span>, \n <span class=\"hljs-string\">\"errorNum\"</span> : <span class=\"hljs-number\">1203</span> \n}\n</code></pre>\n\n\n\n\n**Example:**\n Bad query - Execute a data-modification query that attempts to remove a non-existing\ndocument\n\n<pre><code class=\"json\">shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/cursor &lt;&lt;EOF\n{ \n <span class=\"hljs-string\">\"query\"</span> : <span class=\"hljs-string\">\"REMOVE 'foo' IN products\"</span> \n}\nEOF\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">404</span> Not Found\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\nx-content-type-options: nosniff\n\n{ \n <span class=\"hljs-string\">\"error\"</span> : <span class=\"hljs-literal\">true</span>, \n <span class=\"hljs-string\">\"errorMessage\"</span> : <span class=\"hljs-string\">\"AQL: document not found (while executing)\"</span>, \n <span class=\"hljs-string\">\"code\"</span> : <span class=\"hljs-number\">404</span>, \n <span class=\"hljs-string\">\"errorNum\"</span> : <span class=\"hljs-number\">1202</span> \n}\n</code></pre>\n\n\n\n\n\n",
"parameters": [
{
"in": "body",
"name": "Json Request Body",
"required": true,
"schema": {
"$ref": "#/definitions/post_api_cursor"
},
"x-description-offset": 54
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "is returned if the result set can be created by the server.\n\n",
"schema": {
"$ref": "#/definitions/post_api_cursor_rc_201"
},
"x-description-offset": 293
},
"400": {
"description": "is returned if the JSON representation is malformed or the query specification is\nmissing from the request.\n\nIf the JSON representation is malformed or the query specification is\nmissing from the request, the server will respond with *HTTP 400*.\n\nThe body of the response will contain a JSON object with additional error\ndetails. The object has the following attributes:\n\n",
"schema": {
"$ref": "#/definitions/post_api_cursor_rc_400"
},
"x-description-offset": 348
},
"404": {
"description": "The server will respond with *HTTP 404* in case a non-existing collection is\naccessed in the query.\n\n"
},
"405": {
"description": "The server will respond with *HTTP 405* if an unsupported HTTP method is used.\n\n"
}
},
"summary": "Create cursor",
"tags": [
"Cursors"
],
"x-examples": [],
"x-filename": "Cursors - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cursors/post_api_cursor_delete.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cursors/post_api_cursor.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cursors/post_api_cursor_identifier.md"
}
},
"/_api/cursor/{cursor-identifier}": {
"delete": {
"description": "\n\nDeletes the cursor and frees the resources associated with it.\n\nThe cursor will automatically be destroyed on the server when the client has\nretrieved all documents from it. The client can also explicitly destroy the\ncursor at any earlier time using an HTTP DELETE request. The cursor id must\nbe included as part of the URL.\n\nNote: the server will also destroy abandoned cursors automatically after a\ncertain server-controlled timeout to avoid resource leakage.\n\n\n\n\n**Example:**\n \n\n<pre><code class=\"json\">shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/cursor &lt;&lt;EOF\n{ \n <span class=\"hljs-string\">\"query\"</span> : <span class=\"hljs-string\">\"FOR p IN products LIMIT 5 RETURN p\"</span>, \n <span class=\"hljs-string\">\"count\"</span> : <span class=\"hljs-literal\">true</span>, \n <span class=\"hljs-string\">\"batchSize\"</span> : <span class=\"hljs-number\">2</span> \n}\nEOF\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">201</span> Created\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\nx-content-type-options: nosniff\n\n{ \n <span class=\"hljs-string\">\"error\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"code\"</span> : <span class=\"hljs-number\">201</span>, \n <span class=\"hljs-string\">\"result\"</span> : [ \n { \n <span class=\"hljs-string\">\"_key\"</span> : <span class=\"hljs-string\">\"10592\"</span>, \n <span class=\"hljs-string\">\"_id\"</span> : <span class=\"hljs-string\">\"products/10592\"</span>, \n <span class=\"hljs-string\">\"_rev\"</span> : <span class=\"hljs-string\">\"_WE2VDqG--B\"</span>, \n <span class=\"hljs-string\">\"hello5\"</span> : <span class=\"hljs-string\">\"world1\"</span> \n }, \n { \n <span class=\"hljs-string\">\"_key\"</span> : <span class=\"hljs-string\">\"10589\"</span>, \n <span class=\"hljs-string\">\"_id\"</span> : <span class=\"hljs-string\">\"products/10589\"</span>, \n <span class=\"hljs-string\">\"_rev\"</span> : <span class=\"hljs-string\">\"_WE2VDqG--_\"</span>, \n <span class=\"hljs-string\">\"hello4\"</span> : <span class=\"hljs-string\">\"world1\"</span> \n } \n ], \n <span class=\"hljs-string\">\"hasMore\"</span> : <span class=\"hljs-literal\">true</span>, \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-string\">\"10595\"</span>, \n <span class=\"hljs-string\">\"count\"</span> : <span class=\"hljs-number\">5</span>, \n <span class=\"hljs-string\">\"extra\"</span> : { \n <span class=\"hljs-string\">\"stats\"</span> : { \n <span class=\"hljs-string\">\"writesExecuted\"</span> : <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-string\">\"writesIgnored\"</span> : <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-string\">\"scannedFull\"</span> : <span class=\"hljs-number\">5</span>, \n <span class=\"hljs-string\">\"scannedIndex\"</span> : <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-string\">\"filtered\"</span> : <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-string\">\"httpRequests\"</span> : <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-string\">\"executionTime\"</span> : <span class=\"hljs-number\">0.00023794174194335938</span> \n }, \n <span class=\"hljs-string\">\"warnings\"</span> : [ ] \n }, \n <span class=\"hljs-string\">\"cached\"</span> : <span class=\"hljs-literal\">false</span> \n}\nshell> curl -X DELETE --dump - http://localhost:8529/_api/cursor/10595\n\n</code></pre>\n\n\n\n\n",
"parameters": [
{
"description": "The id of the cursor\n\n",
"format": "string",
"in": "path",
"name": "cursor-identifier",
"required": true,
"type": "string"
}
],
"responses": {
"202": {
"description": "is returned if the server is aware of the cursor.\n\n"
},
"404": {
"description": "is returned if the server is not aware of the cursor. It is also\nreturned if a cursor is used after it has been destroyed.\n\n"
}
},
"summary": "Delete cursor",
"tags": [
"Cursors"
],
"x-examples": [],
"x-filename": "Cursors - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cursors/post_api_cursor_delete.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cursors/post_api_cursor.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cursors/post_api_cursor_identifier.md"
},
"put": {
"description": "\n\n\nIf the cursor is still alive, returns an object with the following\nattributes:\n\n- *id*: the *cursor-identifier*\n- *result*: a list of documents for the current batch\n- *hasMore*: *false* if this was the last batch\n- *count*: if present the total number of elements\n\nNote that even if *hasMore* returns *true*, the next call might\nstill return no documents. If, however, *hasMore* is *false*, then\nthe cursor is exhausted. Once the *hasMore* attribute has a value of\n*false*, the client can stop.\n\n\n\n\n**Example:**\n Valid request for next batch\n\n<pre><code class=\"json\">shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/cursor &lt;&lt;EOF\n{ \n <span class=\"hljs-string\">\"query\"</span> : <span class=\"hljs-string\">\"FOR p IN products LIMIT 5 RETURN p\"</span>, \n <span class=\"hljs-string\">\"count\"</span> : <span class=\"hljs-literal\">true</span>, \n <span class=\"hljs-string\">\"batchSize\"</span> : <span class=\"hljs-number\">2</span> \n}\nEOF\n\nshell> curl -X PUT --dump - http://localhost:8529/_api/cursor/10662\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">200</span> OK\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\nx-content-type-options: nosniff\n\n{ \n <span class=\"hljs-string\">\"error\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"code\"</span> : <span class=\"hljs-number\">200</span>, \n <span class=\"hljs-string\">\"result\"</span> : [ \n { \n <span class=\"hljs-string\">\"_key\"</span> : <span class=\"hljs-string\">\"10650\"</span>, \n <span class=\"hljs-string\">\"_id\"</span> : <span class=\"hljs-string\">\"products/10650\"</span>, \n <span class=\"hljs-string\">\"_rev\"</span> : <span class=\"hljs-string\">\"_WE2VEEO--_\"</span>, \n <span class=\"hljs-string\">\"hello2\"</span> : <span class=\"hljs-string\">\"world1\"</span> \n }, \n { \n <span class=\"hljs-string\">\"_key\"</span> : <span class=\"hljs-string\">\"10656\"</span>, \n <span class=\"hljs-string\">\"_id\"</span> : <span class=\"hljs-string\">\"products/10656\"</span>, \n <span class=\"hljs-string\">\"_rev\"</span> : <span class=\"hljs-string\">\"_WE2VEES--_\"</span>, \n <span class=\"hljs-string\">\"hello4\"</span> : <span class=\"hljs-string\">\"world1\"</span> \n } \n ], \n <span class=\"hljs-string\">\"hasMore\"</span> : <span class=\"hljs-literal\">true</span>, \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-string\">\"10662\"</span>, \n <span class=\"hljs-string\">\"count\"</span> : <span class=\"hljs-number\">5</span>, \n <span class=\"hljs-string\">\"extra\"</span> : { \n <span class=\"hljs-string\">\"stats\"</span> : { \n <span class=\"hljs-string\">\"writesExecuted\"</span> : <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-string\">\"writesIgnored\"</span> : <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-string\">\"scannedFull\"</span> : <span class=\"hljs-number\">5</span>, \n <span class=\"hljs-string\">\"scannedIndex\"</span> : <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-string\">\"filtered\"</span> : <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-string\">\"httpRequests\"</span> : <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-string\">\"executionTime\"</span> : <span class=\"hljs-number\">0.0002200603485107422</span> \n }, \n <span class=\"hljs-string\">\"warnings\"</span> : [ ] \n }, \n <span class=\"hljs-string\">\"cached\"</span> : <span class=\"hljs-literal\">false</span> \n}\n</code></pre>\n\n\n\n\n**Example:**\n Missing identifier\n\n<pre><code class=\"json\">shell> curl -X PUT --dump - http://localhost:8529/_api/cursor\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">400</span> Bad Request\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\nx-content-type-options: nosniff\n\n{ \n <span class=\"hljs-string\">\"error\"</span> : <span class=\"hljs-literal\">true</span>, \n <span class=\"hljs-string\">\"errorMessage\"</span> : <span class=\"hljs-string\">\"expecting PUT /_api/cursor/&lt;cursor-id&gt;\"</span>, \n <span class=\"hljs-string\">\"code\"</span> : <span class=\"hljs-number\">400</span>, \n <span class=\"hljs-string\">\"errorNum\"</span> : <span class=\"hljs-number\">400</span> \n}\n</code></pre>\n\n\n\n\n**Example:**\n Unknown identifier\n\n<pre><code class=\"json\">shell> curl -X PUT --dump - http://localhost:8529/_api/cursor/123123\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">404</span> Not Found\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\nx-content-type-options: nosniff\n\n{ \n <span class=\"hljs-string\">\"error\"</span> : <span class=\"hljs-literal\">true</span>, \n <span class=\"hljs-string\">\"errorMessage\"</span> : <span class=\"hljs-string\">\"cursor not found\"</span>, \n <span class=\"hljs-string\">\"code\"</span> : <span class=\"hljs-number\">404</span>, \n <span class=\"hljs-string\">\"errorNum\"</span> : <span class=\"hljs-number\">1600</span> \n}\n</code></pre>\n\n\n\n\n",
"parameters": [
{
"description": "The name of the cursor\n\n",
"format": "string",
"in": "path",
"name": "cursor-identifier",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "The server will respond with *HTTP 200* in case of success.\n\n"
},
"400": {
"description": "If the cursor identifier is omitted, the server will respond with *HTTP 404*.\n\n"
},
"404": {
"description": "If no cursor with the specified identifier can be found, the server will respond\nwith *HTTP 404*.\n\n"
}
},
"summary": "Read next batch from cursor",
"tags": [
"Cursors"
],
"x-examples": [],
"x-filename": "Cursors - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cursors/post_api_cursor_delete.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cursors/post_api_cursor.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cursors/post_api_cursor_identifier.md"
}
},
"/_api/database": {
"get": {
"description": "\n\nRetrieves the list of all existing databases\n\n**Note**: retrieving the list of databases is only possible from within the *_system* database.\n\n**Note**: You should use the [*GET user API*](../UserManagement/README.md#list-the-accessible-databases-for-a-user) to fetch the list of the available databases now.\n\n\n\n\n**Example:**\n \n\n<pre><code class=\"json\">shell> curl --dump - http://localhost:8529/_api/database\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">200</span> OK\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\nx-content-type-options: nosniff\n\n{ \n <span class=\"hljs-string\">\"error\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"code\"</span> : <span class=\"hljs-number\">200</span>, \n <span class=\"hljs-string\">\"result\"</span> : [ \n <span class=\"hljs-string\">\"_system\"</span> \n ] \n}\n</code></pre>\n\n\n\n\n",
"parameters": [],
"responses": {
"200": {
"description": "is returned if the list of database was compiled successfully.\n\n"
},
"400": {
"description": "is returned if the request is invalid.\n\n"
},
"403": {
"description": "is returned if the request was not executed in the *_system* database.\n\n"
}
},
"summary": "List of databases",
"tags": [
"Database"
],
"x-examples": [],
"x-filename": "Database - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Database/get_api_database_new.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Database/get_api_database_user.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Database/get_api_database_delete.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Database/get_api_database_current.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Database/get_api_database_list.md"
},
"post": {
"description": "\n**A JSON object with these properties is required:**\n\n - **name**: Has to contain a valid database name.\n - **users**: Has to be an array of user objects to initially create for the new database.\n User information will not be changed for users that already exist.\n If *users* is not specified or does not contain any users, a default user\n *root* will be created with an empty string password. This ensures that the\n new database will be accessible after it is created.\n Each user object can contain the following attributes:\n - **username**: Loginname of the user to be created\n - **passwd**: The user password as a string. If not specified, it will default to an empty string.\n - **active**: A flag indicating whether the user account should be activated or not.\n The default value is *true*. If set to *false*, the user won't be able to\n log into the database.\n - **extra**: A JSON object with extra user information. The data contained in *extra*\n will be stored for the user but not be interpreted further by ArangoDB.\n\n\n\n\nCreates a new database\n\nThe response is a JSON object with the attribute *result* set to *true*.\n\n**Note**: creating a new database is only possible from within the *_system* database.\n\n\n\n\n**Example:**\n Creating a database named *example*.\n\n<pre><code class=\"json\">shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/database &lt;&lt;EOF\n{ \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"example\"</span> \n}\nEOF\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">201</span> Created\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\nx-content-type-options: nosniff\n\n{ \n <span class=\"hljs-string\">\"error\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"code\"</span> : <span class=\"hljs-number\">201</span>, \n <span class=\"hljs-string\">\"result\"</span> : <span class=\"hljs-literal\">true</span> \n}\n</code></pre>\n\n\n\n\n**Example:**\n Creating a database named *mydb* with two users.\n\n<pre><code class=\"json\">shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/database &lt;&lt;EOF\n{ \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"mydb\"</span>, \n <span class=\"hljs-string\">\"users\"</span> : [ \n { \n <span class=\"hljs-string\">\"username\"</span> : <span class=\"hljs-string\">\"admin\"</span>, \n <span class=\"hljs-string\">\"passwd\"</span> : <span class=\"hljs-string\">\"secret\"</span>, \n <span class=\"hljs-string\">\"active\"</span> : <span class=\"hljs-literal\">true</span> \n }, \n { \n <span class=\"hljs-string\">\"username\"</span> : <span class=\"hljs-string\">\"tester\"</span>, \n <span class=\"hljs-string\">\"passwd\"</span> : <span class=\"hljs-string\">\"test001\"</span>, \n <span class=\"hljs-string\">\"active\"</span> : <span class=\"hljs-literal\">false</span> \n } \n ] \n}\nEOF\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">201</span> Created\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\nx-content-type-options: nosniff\n\n{ \n <span class=\"hljs-string\">\"error\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"code\"</span> : <span class=\"hljs-number\">201</span>, \n <span class=\"hljs-string\">\"result\"</span> : <span class=\"hljs-literal\">true</span> \n}\n</code></pre>\n\n\n\n\n",
"parameters": [
{
"in": "body",
"name": "Json Request Body",
"required": true,
"schema": {
"$ref": "#/definitions/get_api_database_new"
},
"x-description-offset": 54
}
],
"responses": {
"201": {
"description": "is returned if the database was created successfully.\n\n"
},
"400": {
"description": "is returned if the request parameters are invalid or if a database with the\nspecified name already exists.\n\n"
},
"403": {
"description": "is returned if the request was not executed in the *_system* database.\n\n"
},
"409": {
"description": "is returned if a database with the specified name already exists.\n\n"
}
},
"summary": "Create database",
"tags": [
"Database"
],
"x-examples": [],
"x-filename": "Database - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Database/get_api_database_new.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Database/get_api_database_user.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Database/get_api_database_delete.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Database/get_api_database_current.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Database/get_api_database_list.md"
}
},
"/_api/database/current": {
"get": {
"description": "\n\nRetrieves information about the current database\n\nThe response is a JSON object with the following attributes:\n\n- *name*: the name of the current database\n\n- *id*: the id of the current database\n\n- *path*: the filesystem path of the current database\n\n- *isSystem*: whether or not the current database is the *_system* database\n\n\n\n\n**Example:**\n \n\n<pre><code class=\"json\">shell> curl --dump - http://localhost:8529/_api/database/current\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">200</span> OK\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\nx-content-type-options: nosniff\n\n{ \n <span class=\"hljs-string\">\"error\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"code\"</span> : <span class=\"hljs-number\">200</span>, \n <span class=\"hljs-string\">\"result\"</span> : { \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"_system\"</span>, \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-string\">\"1\"</span>, \n <span class=\"hljs-string\">\"path\"</span> : <span class=\"hljs-string\">\"/tmp/arangosh_2rcC3W/tmp-15388-2138382542/data/databases/database-1\"</span>, \n <span class=\"hljs-string\">\"isSystem\"</span> : <span class=\"hljs-literal\">true</span> \n } \n}\n</code></pre>\n\n\n\n\n",
"parameters": [],
"responses": {
"200": {
"description": "is returned if the information was retrieved successfully.\n\n"
},
"400": {
"description": "is returned if the request is invalid.\n\n"
},
"404": {
"description": "is returned if the database could not be found.\n\n"
}
},
"summary": "Information of the database",
"tags": [
"Database"
],
"x-examples": [],
"x-filename": "Database - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Database/get_api_database_new.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Database/get_api_database_user.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Database/get_api_database_delete.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Database/get_api_database_current.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Database/get_api_database_list.md"
}
},
"/_api/database/user": {
"get": {
"description": "\n\nRetrieves the list of all databases the current user can access without\nspecifying a different username or password.\n\n\n\n\n**Example:**\n \n\n<pre><code class=\"json\">shell> curl --dump - http://localhost:8529/_api/database/user\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">200</span> OK\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\nx-content-type-options: nosniff\n\n{ \n <span class=\"hljs-string\">\"error\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"code\"</span> : <span class=\"hljs-number\">200</span>, \n <span class=\"hljs-string\">\"result\"</span> : [ \n <span class=\"hljs-string\">\"_system\"</span> \n ] \n}\n</code></pre>\n\n\n\n\n",
"parameters": [],
"responses": {
"200": {
"description": "is returned if the list of database was compiled successfully.\n\n"
},
"400": {
"description": "is returned if the request is invalid.\n\n"
}
},
"summary": "List of accessible databases",
"tags": [
"Database"
],
"x-examples": [],
"x-filename": "Database - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Database/get_api_database_new.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Database/get_api_database_user.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Database/get_api_database_delete.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Database/get_api_database_current.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Database/get_api_database_list.md"
}
},
"/_api/database/{database-name}": {
"delete": {
"description": "\n\nDrops the database along with all data stored in it.\n\n**Note**: dropping a database is only possible from within the *_system* database.\nThe *_system* database itself cannot be dropped.\n\n\n\n\n**Example:**\n \n\n<pre><code class=\"json\">shell> curl -X DELETE --dump - http://localhost:8529/_api/database/example\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">200</span> OK\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\nx-content-type-options: nosniff\n\n{ \n <span class=\"hljs-string\">\"error\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"code\"</span> : <span class=\"hljs-number\">200</span>, \n <span class=\"hljs-string\">\"result\"</span> : <span class=\"hljs-literal\">true</span> \n}\n</code></pre>\n\n\n\n\n",
"parameters": [
{
"description": "The name of the database\n\n",
"format": "string",
"in": "path",
"name": "database-name",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "is returned if the database was dropped successfully.\n\n"
},
"400": {
"description": "is returned if the request is malformed.\n\n"
},
"403": {
"description": "is returned if the request was not executed in the *_system* database.\n\n"
},
"404": {
"description": "is returned if the database could not be found.\n\n"
}
},
"summary": "Drop database",
"tags": [
"Database"
],
"x-examples": [],
"x-filename": "Database - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Database/get_api_database_new.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Database/get_api_database_user.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Database/get_api_database_delete.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Database/get_api_database_current.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Database/get_api_database_list.md"
}
},
"/_api/document/{collection}": {
"delete": {
"description": "\n\nThe body of the request is an array consisting of selectors for\ndocuments. A selector can either be a string with a key or a string\nwith a document handle or an object with a *_key* attribute. This\nAPI call removes all specified documents from *collection*. If the\nselector is an object and has a *_rev* attribute, it is a\nprecondition that the actual revision of the removed document in the\ncollection is the specified one.\n\nThe body of the response is an array of the same length as the input\narray. For each input selector, the output contains a JSON object\nwith the information about the outcome of the operation. If no error\noccurred, an object is built in which the attribute *_id* contains\nthe known *document-handle* of the removed document, *_key* contains\nthe key which uniquely identifies a document in a given collection,\nand the attribute *_rev* contains the document revision. In case of\nan error, an object with the attribute *error* set to *true* and\n*errorCode* set to the error code is built.\n\nIf the *waitForSync* parameter is not specified or set to *false*,\nthen the collection's default *waitForSync* behavior is applied.\nThe *waitForSync* query parameter cannot be used to disable\nsynchronization for collections that have a default *waitForSync*\nvalue of *true*.\n\nIf the query parameter *returnOld* is *true*, then\nthe complete previous revision of the document\nis returned under the *old* attribute in the result.\n\nNote that if any precondition is violated or an error occurred with\nsome of the documents, the return code is still 200 or 202, but\nthe additional HTTP header *X-Arango-Error-Codes* is set, which\ncontains a map of the error codes that occurred together with their\nmultiplicities, as in: *1200:17,1205:10* which means that in 17\ncases the error 1200 \"revision conflict\" and in 10 cases the error\n1205 \"illegal document handle\" has happened.\n\n\n\n\n**Example:**\n Using document handle:\n\n<pre><code class=\"json\">shell> curl -X DELETE --dump - http://localhost:8529/_api/document/products/10897\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">200</span> OK\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\netag: <span class=\"hljs-string\">\"_WE2VG2K--_\"</span>\nx-content-type-options: nosniff\nlocation: <span class=\"hljs-regexp\">/_db/</span>_system/_api/<span class=\"hljs-built_in\">document</span>/products/<span class=\"hljs-number\">10897</span>\n\n{ \n <span class=\"hljs-string\">\"_id\"</span> : <span class=\"hljs-string\">\"products/10897\"</span>, \n <span class=\"hljs-string\">\"_key\"</span> : <span class=\"hljs-string\">\"10897\"</span>, \n <span class=\"hljs-string\">\"_rev\"</span> : <span class=\"hljs-string\">\"_WE2VG2K--_\"</span> \n}\n</code></pre>\n\n\n\n\n**Example:**\n Unknown document handle:\n\n<pre><code class=\"json\">shell> curl -X DELETE --dump - http://localhost:8529/_api/document/products/10932\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">404</span> Not Found\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\nx-content-type-options: nosniff\n\n{ \n <span class=\"hljs-string\">\"error\"</span> : <span class=\"hljs-literal\">true</span>, \n <span class=\"hljs-string\">\"errorMessage\"</span> : <span class=\"hljs-string\">\"document not found\"</span>, \n <span class=\"hljs-string\">\"code\"</span> : <span class=\"hljs-number\">404</span>, \n <span class=\"hljs-string\">\"errorNum\"</span> : <span class=\"hljs-number\">1202</span> \n}\n</code></pre>\n\n\n\n\n**Example:**\n Revision conflict:\n\n<pre><code class=\"json\">shell> curl -X DELETE --header 'If-Match: \"_WE2VGve--B\"' --dump - http://localhost:8529/_api/document/products/10878\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">412</span> Precondition Failed\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\netag: <span class=\"hljs-string\">\"_WE2VGve--_\"</span>\nx-content-type-options: nosniff\n\n{ \n <span class=\"hljs-string\">\"error\"</span> : <span class=\"hljs-literal\">true</span>, \n <span class=\"hljs-string\">\"code\"</span> : <span class=\"hljs-number\">412</span>, \n <span class=\"hljs-string\">\"errorNum\"</span> : <span class=\"hljs-number\">1200</span>, \n <span class=\"hljs-string\">\"errorMessage\"</span> : <span class=\"hljs-string\">\"precondition failed\"</span>, \n <span class=\"hljs-string\">\"_id\"</span> : <span class=\"hljs-string\">\"products/10878\"</span>, \n <span class=\"hljs-string\">\"_key\"</span> : <span class=\"hljs-string\">\"10878\"</span>, \n <span class=\"hljs-string\">\"_rev\"</span> : <span class=\"hljs-string\">\"_WE2VGve--_\"</span> \n}\n</code></pre>\n\n\n\n",
"parameters": [
{
"description": "A JSON array of strings or documents.\n\n",
"in": "body",
"name": "Json Request Body",
"required": true,
"schema": {
"additionalProperties": {},
"type": "object"
},
"x-description-offset": 0
},
{
"description": "Collection from which documents are removed.\n\n",
"format": "string",
"in": "path",
"name": "collection",
"required": true,
"type": "string"
},
{
"description": "Wait until deletion operation has been synced to disk.\n\n",
"in": "query",
"name": "waitForSync",
"required": false,
"type": "boolean"
},
{
"description": "Return additionally the complete previous revision of the changed \ndocument under the attribute *old* in the result.\n\n",
"in": "query",
"name": "returnOld",
"required": false,
"type": "boolean"
},
{
"description": "If set to *true*, ignore any *_rev* attribute in the selectors. No\nrevision check is performed.\n\n",
"in": "query",
"name": "ignoreRevs",
"required": false,
"type": "boolean"
}
],
"responses": {
"200": {
"description": "is returned if *waitForSync* was *true*.\n\n"
},
"202": {
"description": "is returned if *waitForSync* was *false*.\n\n"
},
"404": {
"description": "is returned if the collection was not found.\nThe response body contains an error document in this case.\n\n"
}
},
"summary": "Removes multiple documents",
"tags": [
"Documents"
],
"x-examples": [],
"x-filename": "Documents - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_HEAD.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_CREATE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE_MULTI.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_ALL.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE_MULTI.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE_MULTI.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ.md"
},
"patch": {
"description": "\n\nPartially updates documents, the documents to update are specified\nby the *_key* attributes in the body objects. The body of the\nrequest must contain a JSON array of document updates with the\nattributes to patch (the patch documents). All attributes from the\npatch documents will be added to the existing documents if they do\nnot yet exist, and overwritten in the existing documents if they do\nexist there.\n\nSetting an attribute value to *null* in the patch documents will cause a\nvalue of *null* to be saved for the attribute by default.\n\nIf *ignoreRevs* is *false* and there is a *_rev* attribute in a\ndocument in the body and its value does not match the revision of\nthe corresponding document in the database, the precondition is\nviolated.\n\nIf the document exists and can be updated, then an *HTTP 201* or\nan *HTTP 202* is returned (depending on *waitForSync*, see below).\n\nOptionally, the query parameter *waitForSync* can be used to force\nsynchronization of the document replacement operation to disk even in case\nthat the *waitForSync* flag had been disabled for the entire collection.\nThus, the *waitForSync* query parameter can be used to force synchronization\nof just specific operations. To use this, set the *waitForSync* parameter\nto *true*. If the *waitForSync* parameter is not specified or set to\n*false*, then the collection's default *waitForSync* behavior is\napplied. The *waitForSync* query parameter cannot be used to disable\nsynchronization for collections that have a default *waitForSync* value\nof *true*.\n\nThe body of the response contains a JSON array of the same length\nas the input array with the information about the handle and the\nrevision of the updated documents. In each entry, the attribute\n*_id* contains the known *document-handle* of each updated document,\n*_key* contains the key which uniquely identifies a document in a\ngiven collection, and the attribute *_rev* contains the new document\nrevision. In case of an error or violated precondition, an error\nobject with the attribute *error* set to *true* and the attribute\n*errorCode* set to the error code is built.\n\nIf the query parameter *returnOld* is *true*, then, for each\ngenerated document, the complete previous revision of the document\nis returned under the *old* attribute in the result.\n\nIf the query parameter *returnNew* is *true*, then, for each\ngenerated document, the complete new document is returned under\nthe *new* attribute in the result.\n\nNote that if any precondition is violated or an error occurred with\nsome of the documents, the return code is still 201 or 202, but\nthe additional HTTP header *X-Arango-Error-Codes* is set, which\ncontains a map of the error codes that occurred together with their\nmultiplicities, as in: *1200:17,1205:10* which means that in 17\ncases the error 1200 \"revision conflict\" and in 10 cases the error\n1205 \"illegal document handle\" has happened.\n\n",
"parameters": [
{
"description": "A JSON representation of an array of document updates as objects.\n\n",
"in": "body",
"name": "Json Request Body",
"required": true,
"schema": {
"additionalProperties": {},
"type": "object"
},
"x-description-offset": 0
},
{
"description": "This URL parameter is the name of the collection in which the\ndocuments are updated.\n\n",
"format": "string",
"in": "path",
"name": "collection",
"required": true,
"type": "string"
},
{
"description": "If the intention is to delete existing attributes with the patch\ncommand, the URL query parameter *keepNull* can be used with a value\nof *false*. This will modify the behavior of the patch command to\nremove any attributes from the existing document that are contained\nin the patch document with an attribute value of *null*.\n\n",
"in": "query",
"name": "keepNull",
"required": false,
"type": "boolean"
},
{
"description": "Controls whether objects (not arrays) will be merged if present in\nboth the existing and the patch document. If set to *false*, the\nvalue in the patch document will overwrite the existing document's\nvalue. If set to *true*, objects will be merged. The default is\n*true*.\n\n",
"in": "query",
"name": "mergeObjects",
"required": false,
"type": "boolean"
},
{
"description": "Wait until the new documents have been synced to disk.\n\n",
"in": "query",
"name": "waitForSync",
"required": false,
"type": "boolean"
},
{
"description": "By default, or if this is set to *true*, the *_rev* attributes in \nthe given documents are ignored. If this is set to *false*, then\nany *_rev* attribute given in a body document is taken as a\nprecondition. The document is only updated if the current revision\nis the one specified.\n\n",
"in": "query",
"name": "ignoreRevs",
"required": false,
"type": "boolean"
},
{
"description": "Return additionally the complete previous revision of the changed \ndocuments under the attribute *old* in the result.\n\n",
"in": "query",
"name": "returnOld",
"required": false,
"type": "boolean"
},
{
"description": "Return additionally the complete new documents under the attribute *new*\nin the result.\n\n",
"in": "query",
"name": "returnNew",
"required": false,
"type": "boolean"
}
],
"responses": {
"201": {
"description": "is returned if the documents were updated successfully and\n*waitForSync* was *true*.\n\n"
},
"202": {
"description": "is returned if the documents were updated successfully and\n*waitForSync* was *false*.\n\n"
},
"400": {
"description": "is returned if the body does not contain a valid JSON representation\nof an array of documents. The response body contains\nan error document in this case.\n\n"
},
"404": {
"description": "is returned if the collection was not found.\n\n\n\n"
}
},
"summary": "Update documents",
"tags": [
"Documents"
],
"x-examples": [],
"x-filename": "Documents - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_HEAD.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_CREATE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE_MULTI.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_ALL.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE_MULTI.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE_MULTI.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ.md"
},
"post": {
"description": "\n\nCreates a new document from the document given in the body, unless there\nis already a document with the *_key* given. If no *_key* is given, a new\nunique *_key* is generated automatically.\n\nThe body can be an array of documents, in which case all\ndocuments in the array are inserted with the same semantics as for a\nsingle document. The result body will contain a JSON array of the\nsame length as the input array, and each entry contains the result\nof the operation for the corresponding input. In case of an error\nthe entry is a document with attributes *error* set to *true* and\nerrorCode set to the error code that has happened.\n\nPossibly given *_id* and *_rev* attributes in the body are always ignored,\nthe URL part or the query parameter collection respectively counts.\n\nIf the document was created successfully, then the *Location* header\ncontains the path to the newly created document. The *Etag* header field\ncontains the revision of the document. Both are only set in the single\ndocument case.\n\nIf *silent* is not set to *true*, the body of the response contains a \nJSON object (single document case) with the following attributes:\n\n - *_id* contains the document handle of the newly created document\n - *_key* contains the document key\n - *_rev* contains the document revision\n\nIn the multi case the body is an array of such objects.\n\nIf the collection parameter *waitForSync* is *false*, then the call\nreturns as soon as the document has been accepted. It will not wait\nuntil the documents have been synced to disk.\n\nOptionally, the query parameter *waitForSync* can be used to force\nsynchronization of the document creation operation to disk even in\ncase that the *waitForSync* flag had been disabled for the entire\ncollection. Thus, the *waitForSync* query parameter can be used to\nforce synchronization of just this specific operations. To use this,\nset the *waitForSync* parameter to *true*. If the *waitForSync*\nparameter is not specified or set to *false*, then the collection's\ndefault *waitForSync* behavior is applied. The *waitForSync* query\nparameter cannot be used to disable synchronization for collections\nthat have a default *waitForSync* value of *true*.\n\nIf the query parameter *returnNew* is *true*, then, for each\ngenerated document, the complete new document is returned under\nthe *new* attribute in the result.\n\n\n\n\n**Example:**\n Create a document in a collection named *products*. Note that the\nrevision identifier might or might not by equal to the auto-generated\nkey.\n\n<pre><code class=\"json\">shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/document/products &lt;&lt;EOF\n{ \"Hello\": \"World\" }\nEOF\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">201</span> Created\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\netag: <span class=\"hljs-string\">\"_WE2VHtq--_\"</span>\nx-content-type-options: nosniff\nlocation: <span class=\"hljs-regexp\">/_db/</span>_system/_api/<span class=\"hljs-built_in\">document</span>/products/<span class=\"hljs-number\">11021</span>\n\n{ \n <span class=\"hljs-string\">\"_id\"</span> : <span class=\"hljs-string\">\"products/11021\"</span>, \n <span class=\"hljs-string\">\"_key\"</span> : <span class=\"hljs-string\">\"11021\"</span>, \n <span class=\"hljs-string\">\"_rev\"</span> : <span class=\"hljs-string\">\"_WE2VHtq--_\"</span> \n}\n</code></pre>\n\n\n\n\n**Example:**\n Create a document in a collection named *products* with a collection-level\n*waitForSync* value of *false*.\n\n<pre><code class=\"json\">shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/document/products &lt;&lt;EOF\n{ \"Hello\": \"World\" }\nEOF\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">202</span> Accepted\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\netag: <span class=\"hljs-string\">\"_WE2VHgi--_\"</span>\nx-content-type-options: nosniff\nlocation: <span class=\"hljs-regexp\">/_db/</span>_system/_api/<span class=\"hljs-built_in\">document</span>/products/<span class=\"hljs-number\">10995</span>\n\n{ \n <span class=\"hljs-string\">\"_id\"</span> : <span class=\"hljs-string\">\"products/10995\"</span>, \n <span class=\"hljs-string\">\"_key\"</span> : <span class=\"hljs-string\">\"10995\"</span>, \n <span class=\"hljs-string\">\"_rev\"</span> : <span class=\"hljs-string\">\"_WE2VHgi--_\"</span> \n}\n</code></pre>\n\n\n\n\n**Example:**\n Create a document in a collection with a collection-level *waitForSync*\nvalue of *false*, but using the *waitForSync* query parameter.\n\n<pre><code class=\"json\">shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/document/products?waitForSync=true &lt;&lt;EOF\n{ \"Hello\": \"World\" }\nEOF\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">201</span> Created\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\netag: <span class=\"hljs-string\">\"_WE2VIDm--_\"</span>\nx-content-type-options: nosniff\nlocation: <span class=\"hljs-regexp\">/_db/</span>_system/_api/<span class=\"hljs-built_in\">document</span>/products/<span class=\"hljs-number\">11072</span>\n\n{ \n <span class=\"hljs-string\">\"_id\"</span> : <span class=\"hljs-string\">\"products/11072\"</span>, \n <span class=\"hljs-string\">\"_key\"</span> : <span class=\"hljs-string\">\"11072\"</span>, \n <span class=\"hljs-string\">\"_rev\"</span> : <span class=\"hljs-string\">\"_WE2VIDm--_\"</span> \n}\n</code></pre>\n\n\n\n\n**Example:**\n Unknown collection name\n\n<pre><code class=\"json\">shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/document/products &lt;&lt;EOF\n{ \"Hello\": \"World\" }\nEOF\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">404</span> Not Found\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\nx-content-type-options: nosniff\n\n{ \n <span class=\"hljs-string\">\"error\"</span> : <span class=\"hljs-literal\">true</span>, \n <span class=\"hljs-string\">\"errorMessage\"</span> : <span class=\"hljs-string\">\"collection not found: products\"</span>, \n <span class=\"hljs-string\">\"code\"</span> : <span class=\"hljs-number\">404</span>, \n <span class=\"hljs-string\">\"errorNum\"</span> : <span class=\"hljs-number\">1203</span> \n}\n</code></pre>\n\n\n\n\n**Example:**\n Illegal document\n\n<pre><code class=\"json\">shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/document/products &lt;&lt;EOF\n{ 1: \"World\" }\nEOF\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">400</span> Bad Request\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\nx-content-type-options: nosniff\n\n{ \n <span class=\"hljs-string\">\"error\"</span> : <span class=\"hljs-literal\">true</span>, \n <span class=\"hljs-string\">\"errorMessage\"</span> : <span class=\"hljs-string\">\"VPackError error: Expecting '\\\"' or '}'\"</span>, \n <span class=\"hljs-string\">\"code\"</span> : <span class=\"hljs-number\">400</span>, \n <span class=\"hljs-string\">\"errorNum\"</span> : <span class=\"hljs-number\">600</span> \n}\n</code></pre>\n\n\n\n\n**Example:**\n Insert multiple documents:\n\n<pre><code class=\"json\">shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/document/products &lt;&lt;EOF\n[{\"Hello\":\"Earth\"}, {\"Hello\":\"Venus\"}, {\"Hello\":\"Mars\"}]\nEOF\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">202</span> Accepted\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\nx-content-type-options: nosniff\n\n[ \n { \n <span class=\"hljs-string\">\"_id\"</span> : <span class=\"hljs-string\">\"products/11036\"</span>, \n <span class=\"hljs-string\">\"_key\"</span> : <span class=\"hljs-string\">\"11036\"</span>, \n <span class=\"hljs-string\">\"_rev\"</span> : <span class=\"hljs-string\">\"_WE2VH2---_\"</span> \n }, \n { \n <span class=\"hljs-string\">\"_id\"</span> : <span class=\"hljs-string\">\"products/11040\"</span>, \n <span class=\"hljs-string\">\"_key\"</span> : <span class=\"hljs-string\">\"11040\"</span>, \n <span class=\"hljs-string\">\"_rev\"</span> : <span class=\"hljs-string\">\"_WE2VH2---B\"</span> \n }, \n { \n <span class=\"hljs-string\">\"_id\"</span> : <span class=\"hljs-string\">\"products/11042\"</span>, \n <span class=\"hljs-string\">\"_key\"</span> : <span class=\"hljs-string\">\"11042\"</span>, \n <span class=\"hljs-string\">\"_rev\"</span> : <span class=\"hljs-string\">\"_WE2VH2---D\"</span> \n } \n]\n</code></pre>\n\n\n\n\n**Example:**\n Use of returnNew:\n\n<pre><code class=\"json\">shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/document/products?returnNew=true &lt;&lt;EOF\n{\"Hello\":\"World\"}\nEOF\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">202</span> Accepted\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\netag: <span class=\"hljs-string\">\"_WE2VH8y--_\"</span>\nx-content-type-options: nosniff\nlocation: <span class=\"hljs-regexp\">/_db/</span>_system/_api/<span class=\"hljs-built_in\">document</span>/products/<span class=\"hljs-number\">11057</span>\n\n{ \n <span class=\"hljs-string\">\"_id\"</span> : <span class=\"hljs-string\">\"products/11057\"</span>, \n <span class=\"hljs-string\">\"_key\"</span> : <span class=\"hljs-string\">\"11057\"</span>, \n <span class=\"hljs-string\">\"_rev\"</span> : <span class=\"hljs-string\">\"_WE2VH8y--_\"</span>, \n <span class=\"hljs-string\">\"new\"</span> : { \n <span class=\"hljs-string\">\"_key\"</span> : <span class=\"hljs-string\">\"11057\"</span>, \n <span class=\"hljs-string\">\"_id\"</span> : <span class=\"hljs-string\">\"products/11057\"</span>, \n <span class=\"hljs-string\">\"_rev\"</span> : <span class=\"hljs-string\">\"_WE2VH8y--_\"</span>, \n <span class=\"hljs-string\">\"Hello\"</span> : <span class=\"hljs-string\">\"World\"</span> \n } \n}\n</code></pre>\n\n\n\n\n",
"parameters": [
{
"description": "The *collection* in which the collection is to be created.\n\n",
"format": "string",
"in": "path",
"name": "collection",
"required": true,
"type": "string"
},
{
"description": "A JSON representation of a single document or of an array of documents.\n\n",
"in": "body",
"name": "Json Request Body",
"required": true,
"schema": {
"additionalProperties": {},
"type": "object"
},
"x-description-offset": 0
},
{
"description": "The name of the collection. This is only for backward compatibility.\nIn ArangoDB versions < 3.0, the URL path was */_api/document* and\nthis query parameter was required. This combination still works, but\nthe recommended way is to specify the collection in the URL path.\n\n",
"in": "query",
"name": "collection",
"required": false,
"type": "string"
},
{
"description": "Wait until document has been synced to disk.\n\n",
"in": "query",
"name": "waitForSync",
"required": false,
"type": "boolean"
},
{
"description": "Additionally return the complete new document under the attribute *new*\nin the result.\n\n",
"in": "query",
"name": "returnNew",
"required": false,
"type": "boolean"
},
{
"description": "If set to *true*, an empty object will be returned as response. No meta-data \nwill be returned for the created document. This option can be used to\nsave some network traffic.\n\n",
"in": "query",
"name": "silent",
"required": false,
"type": "boolean"
}
],
"responses": {
"201": {
"description": "is returned if the documents were created successfully and\n*waitForSync* was *true*.\n\n"
},
"202": {
"description": "is returned if the documents were created successfully and\n*waitForSync* was *false*.\n\n"
},
"400": {
"description": "is returned if the body does not contain a valid JSON representation\nof one document or an array of documents. The response body contains\nan error document in this case.\n\n"
},
"404": {
"description": "is returned if the collection specified by *collection* is unknown.\nThe response body contains an error document in this case.\n\n"
},
"409": {
"description": "is returned in the single document case if a document with the\nsame qualifiers in an indexed attribute conflicts with an already\nexisting document and thus violates that unique constraint. The\nresponse body contains an error document in this case. In the array\ncase only 201 or 202 is returned, but if an error occurred, the\nadditional HTTP header *X-Arango-Error-Codes* is set, which\ncontains a map of the error codes that occurred together with their\nmultiplicities, as in: *1205:10,1210:17* which means that in 10\ncases the error 1205 \"illegal document handle\" and in 17 cases the\nerror 1210 \"unique constraint violated\" has happened.\n\n"
}
},
"summary": "Create document",
"tags": [
"Documents"
],
"x-examples": [],
"x-filename": "Documents - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_HEAD.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_CREATE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE_MULTI.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_ALL.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE_MULTI.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE_MULTI.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ.md"
},
"put": {
"description": "\n\nReplaces multiple documents in the specified collection with the\nones in the body, the replaced documents are specified by the *_key*\nattributes in the body documents.\n\nIf *ignoreRevs* is *false* and there is a *_rev* attribute in a\ndocument in the body and its value does not match the revision of\nthe corresponding document in the database, the precondition is\nviolated.\n\nIf the document exists and can be updated, then an *HTTP 201* or\nan *HTTP 202* is returned (depending on *waitForSync*, see below).\n\nOptionally, the query parameter *waitForSync* can be used to force\nsynchronization of the document replacement operation to disk even in case\nthat the *waitForSync* flag had been disabled for the entire collection.\nThus, the *waitForSync* query parameter can be used to force synchronization\nof just specific operations. To use this, set the *waitForSync* parameter\nto *true*. If the *waitForSync* parameter is not specified or set to\n*false*, then the collection's default *waitForSync* behavior is\napplied. The *waitForSync* query parameter cannot be used to disable\nsynchronization for collections that have a default *waitForSync* value\nof *true*.\n\nThe body of the response contains a JSON array of the same length\nas the input array with the information about the handle and the\nrevision of the replaced documents. In each entry, the attribute\n*_id* contains the known *document-handle* of each updated document,\n*_key* contains the key which uniquely identifies a document in a\ngiven collection, and the attribute *_rev* contains the new document\nrevision. In case of an error or violated precondition, an error\nobject with the attribute *error* set to *true* and the attribute\n*errorCode* set to the error code is built.\n\nIf the query parameter *returnOld* is *true*, then, for each\ngenerated document, the complete previous revision of the document\nis returned under the *old* attribute in the result.\n\nIf the query parameter *returnNew* is *true*, then, for each\ngenerated document, the complete new document is returned under\nthe *new* attribute in the result.\n\nNote that if any precondition is violated or an error occurred with\nsome of the documents, the return code is still 201 or 202, but\nthe additional HTTP header *X-Arango-Error-Codes* is set, which\ncontains a map of the error codes that occurred together with their\nmultiplicities, as in: *1200:17,1205:10* which means that in 17\ncases the error 1200 \"revision conflict\" and in 10 cases the error\n1205 \"illegal document handle\" has happened.\n\n",
"parameters": [
{
"description": "A JSON representation of an array of documents.\n\n",
"in": "body",
"name": "Json Request Body",
"required": true,
"schema": {
"additionalProperties": {},
"type": "object"
},
"x-description-offset": 0
},
{
"description": "This URL parameter is the name of the collection in which the\ndocuments are replaced.\n\n",
"format": "string",
"in": "path",
"name": "collection",
"required": true,
"type": "string"
},
{
"description": "Wait until the new documents have been synced to disk.\n\n",
"in": "query",
"name": "waitForSync",
"required": false,
"type": "boolean"
},
{
"description": "By default, or if this is set to *true*, the *_rev* attributes in \nthe given documents are ignored. If this is set to *false*, then\nany *_rev* attribute given in a body document is taken as a\nprecondition. The document is only replaced if the current revision\nis the one specified.\n\n",
"in": "query",
"name": "ignoreRevs",
"required": false,
"type": "boolean"
},
{
"description": "Return additionally the complete previous revision of the changed \ndocuments under the attribute *old* in the result.\n\n",
"in": "query",
"name": "returnOld",
"required": false,
"type": "boolean"
},
{
"description": "Return additionally the complete new documents under the attribute *new*\nin the result.\n\n",
"in": "query",
"name": "returnNew",
"required": false,
"type": "boolean"
}
],
"responses": {
"201": {
"description": "is returned if the documents were replaced successfully and\n*waitForSync* was *true*.\n\n"
},
"202": {
"description": "is returned if the documents were replaced successfully and\n*waitForSync* was *false*.\n\n"
},
"400": {
"description": "is returned if the body does not contain a valid JSON representation\nof an array of documents. The response body contains\nan error document in this case.\n\n"
},
"404": {
"description": "is returned if the collection was not found.\n\n\n\n"
}
},
"summary": "Replace documents",
"tags": [
"Documents"
],
"x-examples": [],
"x-filename": "Documents - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_HEAD.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_CREATE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE_MULTI.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_ALL.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE_MULTI.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE_MULTI.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ.md"
}
},
"/_api/document/{document-handle}": {
"delete": {
"description": "\n\nIf *silent* is not set to *true*, the body of the response contains a JSON \nobject with the information about the handle and the revision. The attribute \n*_id* contains the known *document-handle* of the removed document, *_key* \ncontains the key which uniquely identifies a document in a given collection, \nand the attribute *_rev* contains the document revision.\n\nIf the *waitForSync* parameter is not specified or set to *false*,\nthen the collection's default *waitForSync* behavior is applied.\nThe *waitForSync* query parameter cannot be used to disable\nsynchronization for collections that have a default *waitForSync*\nvalue of *true*.\n\nIf the query parameter *returnOld* is *true*, then\nthe complete previous revision of the document\nis returned under the *old* attribute in the result.\n\n\n\n\n**Example:**\n Using document handle:\n\n<pre><code class=\"json\">shell> curl -X DELETE --dump - http://localhost:8529/_api/document/products/10842\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">200</span> OK\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\netag: <span class=\"hljs-string\">\"_WE2VGfS--_\"</span>\nx-content-type-options: nosniff\nlocation: <span class=\"hljs-regexp\">/_db/</span>_system/_api/<span class=\"hljs-built_in\">document</span>/products/<span class=\"hljs-number\">10842</span>\n\n{ \n <span class=\"hljs-string\">\"_id\"</span> : <span class=\"hljs-string\">\"products/10842\"</span>, \n <span class=\"hljs-string\">\"_key\"</span> : <span class=\"hljs-string\">\"10842\"</span>, \n <span class=\"hljs-string\">\"_rev\"</span> : <span class=\"hljs-string\">\"_WE2VGfS--_\"</span> \n}\n</code></pre>\n\n\n\n\n**Example:**\n Unknown document handle:\n\n<pre><code class=\"json\">shell> curl -X DELETE --dump - http://localhost:8529/_api/document/products/10914\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">404</span> Not Found\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\nx-content-type-options: nosniff\n\n{ \n <span class=\"hljs-string\">\"error\"</span> : <span class=\"hljs-literal\">true</span>, \n <span class=\"hljs-string\">\"errorMessage\"</span> : <span class=\"hljs-string\">\"document not found\"</span>, \n <span class=\"hljs-string\">\"code\"</span> : <span class=\"hljs-number\">404</span>, \n <span class=\"hljs-string\">\"errorNum\"</span> : <span class=\"hljs-number\">1202</span> \n}\n</code></pre>\n\n\n\n\n**Example:**\n Revision conflict:\n\n<pre><code class=\"json\">shell> curl -X DELETE --header 'If-Match: \"_WE2VGpq--A\"' --dump - http://localhost:8529/_api/document/products/10859\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">412</span> Precondition Failed\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\netag: <span class=\"hljs-string\">\"_WE2VGpq---\"</span>\nx-content-type-options: nosniff\n\n{ \n <span class=\"hljs-string\">\"error\"</span> : <span class=\"hljs-literal\">true</span>, \n <span class=\"hljs-string\">\"code\"</span> : <span class=\"hljs-number\">412</span>, \n <span class=\"hljs-string\">\"errorNum\"</span> : <span class=\"hljs-number\">1200</span>, \n <span class=\"hljs-string\">\"errorMessage\"</span> : <span class=\"hljs-string\">\"precondition failed\"</span>, \n <span class=\"hljs-string\">\"_id\"</span> : <span class=\"hljs-string\">\"products/10859\"</span>, \n <span class=\"hljs-string\">\"_key\"</span> : <span class=\"hljs-string\">\"10859\"</span>, \n <span class=\"hljs-string\">\"_rev\"</span> : <span class=\"hljs-string\">\"_WE2VGpq---\"</span> \n}\n</code></pre>\n\n\n\n",
"parameters": [
{
"description": "Removes the document identified by *document-handle*.\n\n",
"format": "string",
"in": "path",
"name": "document-handle",
"required": true,
"type": "string"
},
{
"description": "Wait until deletion operation has been synced to disk.\n\n",
"in": "query",
"name": "waitForSync",
"required": false,
"type": "boolean"
},
{
"description": "Return additionally the complete previous revision of the changed \ndocument under the attribute *old* in the result.\n\n",
"in": "query",
"name": "returnOld",
"required": false,
"type": "boolean"
},
{
"description": "If set to *true*, an empty object will be returned as response. No meta-data \nwill be returned for the removed document. This option can be used to\nsave some network traffic.\n\n",
"in": "query",
"name": "silent",
"required": false,
"type": "boolean"
},
{
"description": "You can conditionally remove a document based on a target revision id by\nusing the *if-match* HTTP header.\n\n",
"in": "header",
"name": "If-Match",
"type": "string"
}
],
"responses": {
"200": {
"description": "is returned if the document was removed successfully and\n*waitForSync* was *true*.\n\n"
},
"202": {
"description": "is returned if the document was removed successfully and\n*waitForSync* was *false*.\n\n"
},
"404": {
"description": "is returned if the collection or the document was not found.\nThe response body contains an error document in this case.\n\n"
},
"412": {
"description": "is returned if a \"If-Match\" header or *rev* is given and the found\ndocument has a different version. The response will also contain the found\ndocument's current revision in the *_rev* attribute. Additionally, the\nattributes *_id* and *_key* will be returned.\n\n"
}
},
"summary": "Removes a document",
"tags": [
"Documents"
],
"x-examples": [],
"x-filename": "Documents - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_HEAD.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_CREATE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE_MULTI.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_ALL.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE_MULTI.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE_MULTI.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ.md"
},
"get": {
"description": "\n\nReturns the document identified by *document-handle*. The returned\ndocument contains three special attributes: *_id* containing the document\nhandle, *_key* containing key which uniquely identifies a document\nin a given collection and *_rev* containing the revision.\n\n\n\n\n**Example:**\n Use a document handle:\n\n<pre><code class=\"json\">shell> curl --dump - http://localhost:8529/_api/document/products/11087\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">200</span> OK\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\netag: <span class=\"hljs-string\">\"_WE2VIK6--_\"</span>\nx-content-type-options: nosniff\n\n{ \n <span class=\"hljs-string\">\"_key\"</span> : <span class=\"hljs-string\">\"11087\"</span>, \n <span class=\"hljs-string\">\"_id\"</span> : <span class=\"hljs-string\">\"products/11087\"</span>, \n <span class=\"hljs-string\">\"_rev\"</span> : <span class=\"hljs-string\">\"_WE2VIK6--_\"</span>, \n <span class=\"hljs-string\">\"hello\"</span> : <span class=\"hljs-string\">\"world\"</span> \n}\n</code></pre>\n\n\n\n\n**Example:**\n Use a document handle and an Etag:\n\n<pre><code class=\"json\">shell> curl --header 'If-None-Match: \"_WE2VIou--_\"' --dump - http://localhost:8529/_api/document/products/11163\n\n</code></pre>\n\n\n\n\n**Example:**\n Unknown document handle:\n\n<pre><code class=\"json\">shell> curl --dump - http://localhost:8529/_api/document/products/unknownhandle\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">404</span> Not Found\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\nx-content-type-options: nosniff\n\n{ \n <span class=\"hljs-string\">\"error\"</span> : <span class=\"hljs-literal\">true</span>, \n <span class=\"hljs-string\">\"errorMessage\"</span> : <span class=\"hljs-string\">\"collection not found: products\"</span>, \n <span class=\"hljs-string\">\"code\"</span> : <span class=\"hljs-number\">404</span>, \n <span class=\"hljs-string\">\"errorNum\"</span> : <span class=\"hljs-number\">1203</span> \n}\n</code></pre>\n\n\n\n\n",
"parameters": [
{
"description": "The handle of the document.\n\n",
"format": "string",
"in": "path",
"name": "document-handle",
"required": true,
"type": "string"
},
{
"description": "If the \"If-None-Match\" header is given, then it must contain exactly one\nEtag. The document is returned, if it has a different revision than the\ngiven Etag. Otherwise an *HTTP 304* is returned.\n\n",
"in": "header",
"name": "If-None-Match",
"type": "string"
},
{
"description": "If the \"If-Match\" header is given, then it must contain exactly one\nEtag. The document is returned, if it has the same revision as the\ngiven Etag. Otherwise a *HTTP 412* is returned.\n\n",
"in": "header",
"name": "If-Match",
"type": "string"
}
],
"responses": {
"200": {
"description": "is returned if the document was found\n\n"
},
"304": {
"description": "is returned if the \"If-None-Match\" header is given and the document has\nthe same version\n\n"
},
"404": {
"description": "is returned if the document or collection was not found\n\n"
},
"412": {
"description": "is returned if an \"If-Match\" header is given and the found\ndocument has a different version. The response will also contain the found\ndocument's current revision in the *_rev* attribute. Additionally, the\nattributes *_id* and *_key* will be returned.\n\n"
}
},
"summary": "Read document",
"tags": [
"Documents"
],
"x-examples": [],
"x-filename": "Documents - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_HEAD.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_CREATE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE_MULTI.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_ALL.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE_MULTI.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE_MULTI.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ.md"
},
"head": {
"description": "\n\nLike *GET*, but only returns the header fields and not the body. You\ncan use this call to get the current revision of a document or check if\nthe document was deleted.\n\n\n\n\n**Example:**\n \n\n<pre><code class=\"json\">shell> curl -X HEAD --dump - http://localhost:8529/_api/document/products/11147\n\n</code></pre>\n\n\n\n\n\n",
"parameters": [
{
"description": "The handle of the document.\n\n",
"format": "string",
"in": "path",
"name": "document-handle",
"required": true,
"type": "string"
},
{
"description": "If the \"If-None-Match\" header is given, then it must contain exactly one\nEtag. If the current document revision is not equal to the specified Etag,\nan *HTTP 200* response is returned. If the current document revision is\nidentical to the specified Etag, then an *HTTP 304* is returned.\n\n",
"in": "header",
"name": "If-None-Match",
"type": "string"
},
{
"description": "If the \"If-Match\" header is given, then it must contain exactly one\nEtag. The document is returned, if it has the same revision as the\ngiven Etag. Otherwise a *HTTP 412* is returned.\n\n",
"in": "header",
"name": "If-Match",
"type": "string"
}
],
"responses": {
"200": {
"description": "is returned if the document was found\n\n"
},
"304": {
"description": "is returned if the \"If-None-Match\" header is given and the document has\nthe same version\n\n"
},
"404": {
"description": "is returned if the document or collection was not found\n\n"
},
"412": {
"description": "is returned if an \"If-Match\" header is given and the found\ndocument has a different version. The response will also contain the found\ndocument's current revision in the *Etag* header.\n\n"
}
},
"summary": "Read document header",
"tags": [
"Documents"
],
"x-examples": [],
"x-filename": "Documents - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_HEAD.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_CREATE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE_MULTI.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_ALL.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE_MULTI.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE_MULTI.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ.md"
},
"patch": {
"description": "\n\nPartially updates the document identified by *document-handle*.\nThe body of the request must contain a JSON document with the\nattributes to patch (the patch document). All attributes from the\npatch document will be added to the existing document if they do not\nyet exist, and overwritten in the existing document if they do exist\nthere.\n\nSetting an attribute value to *null* in the patch document will cause a\nvalue of *null* to be saved for the attribute by default.\n\nIf the *If-Match* header is specified and the revision of the\ndocument in the database is unequal to the given revision, the\nprecondition is violated.\n\nIf *If-Match* is not given and *ignoreRevs* is *false* and there\nis a *_rev* attribute in the body and its value does not match\nthe revision of the document in the database, the precondition is\nviolated.\n\nIf a precondition is violated, an *HTTP 412* is returned.\n\nIf the document exists and can be updated, then an *HTTP 201* or\nan *HTTP 202* is returned (depending on *waitForSync*, see below),\nthe *Etag* header field contains the new revision of the document\n(in double quotes) and the *Location* header contains a complete URL\nunder which the document can be queried.\n\nOptionally, the query parameter *waitForSync* can be used to force\nsynchronization of the updated document operation to disk even in case\nthat the *waitForSync* flag had been disabled for the entire collection.\nThus, the *waitForSync* query parameter can be used to force synchronization\nof just specific operations. To use this, set the *waitForSync* parameter\nto *true*. If the *waitForSync* parameter is not specified or set to\n*false*, then the collection's default *waitForSync* behavior is\napplied. The *waitForSync* query parameter cannot be used to disable\nsynchronization for collections that have a default *waitForSync* value\nof *true*.\n\nIf *silent* is not set to *true*, the body of the response contains a JSON \nobject with the information about the handle and the revision. The attribute \n*_id* contains the known *document-handle* of the updated document, *_key* \ncontains the key which uniquely identifies a document in a given collection, \nand the attribute *_rev* contains the new document revision.\n\nIf the query parameter *returnOld* is *true*, then\nthe complete previous revision of the document\nis returned under the *old* attribute in the result.\n\nIf the query parameter *returnNew* is *true*, then\nthe complete new document is returned under\nthe *new* attribute in the result.\n\nIf the document does not exist, then a *HTTP 404* is returned and the\nbody of the response contains an error document.\n\n\n\n\n**Example:**\n Patches an existing document with new content.\n\n<pre><code class=\"json\">shell> curl -X PATCH --data-binary @- --dump - http://localhost:8529/_api/document/products/10950 &lt;&lt;EOF\n{ \n <span class=\"hljs-string\">\"hello\"</span> : <span class=\"hljs-string\">\"world\"</span> \n}\nEOF\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">202</span> Accepted\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\netag: <span class=\"hljs-string\">\"_WE2VHRa--_\"</span>\nx-content-type-options: nosniff\nlocation: <span class=\"hljs-regexp\">/_db/</span>_system/_api/<span class=\"hljs-built_in\">document</span>/products/<span class=\"hljs-number\">10950</span>\n\n{ \n <span class=\"hljs-string\">\"_id\"</span> : <span class=\"hljs-string\">\"products/10950\"</span>, \n <span class=\"hljs-string\">\"_key\"</span> : <span class=\"hljs-string\">\"10950\"</span>, \n <span class=\"hljs-string\">\"_rev\"</span> : <span class=\"hljs-string\">\"_WE2VHRa--_\"</span>, \n <span class=\"hljs-string\">\"_oldRev\"</span> : <span class=\"hljs-string\">\"_WE2VHRW--_\"</span> \n}\nshell> curl -X PATCH --data-binary @- --dump - http://localhost:8529/_api/document/products/10950 &lt;&lt;EOF\n{ \n <span class=\"hljs-string\">\"numbers\"</span> : { \n <span class=\"hljs-string\">\"one\"</span> : <span class=\"hljs-number\">1</span>, \n <span class=\"hljs-string\">\"two\"</span> : <span class=\"hljs-number\">2</span>, \n <span class=\"hljs-string\">\"three\"</span> : <span class=\"hljs-number\">3</span>, \n <span class=\"hljs-string\">\"empty\"</span> : <span class=\"hljs-literal\">null</span> \n } \n}\nEOF\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">202</span> Accepted\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\netag: <span class=\"hljs-string\">\"_WE2VHRm--_\"</span>\nx-content-type-options: nosniff\nlocation: <span class=\"hljs-regexp\">/_db/</span>_system/_api/<span class=\"hljs-built_in\">document</span>/products/<span class=\"hljs-number\">10950</span>\n\n{ \n <span class=\"hljs-string\">\"_id\"</span> : <span class=\"hljs-string\">\"products/10950\"</span>, \n <span class=\"hljs-string\">\"_key\"</span> : <span class=\"hljs-string\">\"10950\"</span>, \n <span class=\"hljs-string\">\"_rev\"</span> : <span class=\"hljs-string\">\"_WE2VHRm--_\"</span>, \n <span class=\"hljs-string\">\"_oldRev\"</span> : <span class=\"hljs-string\">\"_WE2VHRa--_\"</span> \n}\nshell> curl --dump - http://localhost:8529/_api/document/products/10950\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">200</span> OK\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\netag: <span class=\"hljs-string\">\"_WE2VHRm--_\"</span>\nx-content-type-options: nosniff\n\n{ \n <span class=\"hljs-string\">\"_key\"</span> : <span class=\"hljs-string\">\"10950\"</span>, \n <span class=\"hljs-string\">\"_id\"</span> : <span class=\"hljs-string\">\"products/10950\"</span>, \n <span class=\"hljs-string\">\"_rev\"</span> : <span class=\"hljs-string\">\"_WE2VHRm--_\"</span>, \n <span class=\"hljs-string\">\"one\"</span> : <span class=\"hljs-string\">\"world\"</span>, \n <span class=\"hljs-string\">\"hello\"</span> : <span class=\"hljs-string\">\"world\"</span>, \n <span class=\"hljs-string\">\"numbers\"</span> : { \n <span class=\"hljs-string\">\"one\"</span> : <span class=\"hljs-number\">1</span>, \n <span class=\"hljs-string\">\"two\"</span> : <span class=\"hljs-number\">2</span>, \n <span class=\"hljs-string\">\"three\"</span> : <span class=\"hljs-number\">3</span>, \n <span class=\"hljs-string\">\"empty\"</span> : <span class=\"hljs-literal\">null</span> \n } \n}\nshell> curl -X PATCH --data-binary @- --dump - http://localhost:8529/_api/document/products/10950?keepNull=false &lt;&lt;EOF\n{ \n <span class=\"hljs-string\">\"hello\"</span> : <span class=\"hljs-literal\">null</span>, \n <span class=\"hljs-string\">\"numbers\"</span> : { \n <span class=\"hljs-string\">\"four\"</span> : <span class=\"hljs-number\">4</span> \n } \n}\nEOF\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">202</span> Accepted\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\netag: <span class=\"hljs-string\">\"_WE2VHS---_\"</span>\nx-content-type-options: nosniff\nlocation: <span class=\"hljs-regexp\">/_db/</span>_system/_api/<span class=\"hljs-built_in\">document</span>/products/<span class=\"hljs-number\">10950</span>\n\n{ \n <span class=\"hljs-string\">\"_id\"</span> : <span class=\"hljs-string\">\"products/10950\"</span>, \n <span class=\"hljs-string\">\"_key\"</span> : <span class=\"hljs-string\">\"10950\"</span>, \n <span class=\"hljs-string\">\"_rev\"</span> : <span class=\"hljs-string\">\"_WE2VHS---_\"</span>, \n <span class=\"hljs-string\">\"_oldRev\"</span> : <span class=\"hljs-string\">\"_WE2VHRm--_\"</span> \n}\nshell> curl --dump - http://localhost:8529/_api/document/products/10950\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">200</span> OK\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\netag: <span class=\"hljs-string\">\"_WE2VHS---_\"</span>\nx-content-type-options: nosniff\n\n{ \n <span class=\"hljs-string\">\"_key\"</span> : <span class=\"hljs-string\">\"10950\"</span>, \n <span class=\"hljs-string\">\"_id\"</span> : <span class=\"hljs-string\">\"products/10950\"</span>, \n <span class=\"hljs-string\">\"_rev\"</span> : <span class=\"hljs-string\">\"_WE2VHS---_\"</span>, \n <span class=\"hljs-string\">\"one\"</span> : <span class=\"hljs-string\">\"world\"</span>, \n <span class=\"hljs-string\">\"numbers\"</span> : { \n <span class=\"hljs-string\">\"empty\"</span> : <span class=\"hljs-literal\">null</span>, \n <span class=\"hljs-string\">\"one\"</span> : <span class=\"hljs-number\">1</span>, \n <span class=\"hljs-string\">\"three\"</span> : <span class=\"hljs-number\">3</span>, \n <span class=\"hljs-string\">\"two\"</span> : <span class=\"hljs-number\">2</span>, \n <span class=\"hljs-string\">\"four\"</span> : <span class=\"hljs-number\">4</span> \n } \n}\n</code></pre>\n\n\n\n\n**Example:**\n Merging attributes of an object using `mergeObjects`:\n\n<pre><code class=\"json\">shell> curl --dump - http://localhost:8529/_api/document/products/10973\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">200</span> OK\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\netag: <span class=\"hljs-string\">\"_WE2VHXq--_\"</span>\nx-content-type-options: nosniff\n\n{ \n <span class=\"hljs-string\">\"_key\"</span> : <span class=\"hljs-string\">\"10973\"</span>, \n <span class=\"hljs-string\">\"_id\"</span> : <span class=\"hljs-string\">\"products/10973\"</span>, \n <span class=\"hljs-string\">\"_rev\"</span> : <span class=\"hljs-string\">\"_WE2VHXq--_\"</span>, \n <span class=\"hljs-string\">\"inhabitants\"</span> : { \n <span class=\"hljs-string\">\"china\"</span> : <span class=\"hljs-number\">1366980000</span>, \n <span class=\"hljs-string\">\"india\"</span> : <span class=\"hljs-number\">1263590000</span>, \n <span class=\"hljs-string\">\"usa\"</span> : <span class=\"hljs-number\">319220000</span> \n } \n}\nshell> curl -X PATCH --data-binary @- --dump - http://localhost:8529/_api/document/products/10973?mergeObjects=true &lt;&lt;EOF\n{ \n <span class=\"hljs-string\">\"inhabitants\"</span> : { \n <span class=\"hljs-string\">\"indonesia\"</span> : <span class=\"hljs-number\">252164800</span>, \n <span class=\"hljs-string\">\"brazil\"</span> : <span class=\"hljs-number\">203553000</span> \n } \n}\nEOF\n\nshell> curl --dump - http://localhost:8529/_api/document/products/10973\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">200</span> OK\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\netag: <span class=\"hljs-string\">\"_WE2VHX2--_\"</span>\nx-content-type-options: nosniff\n\n{ \n <span class=\"hljs-string\">\"_key\"</span> : <span class=\"hljs-string\">\"10973\"</span>, \n <span class=\"hljs-string\">\"_id\"</span> : <span class=\"hljs-string\">\"products/10973\"</span>, \n <span class=\"hljs-string\">\"_rev\"</span> : <span class=\"hljs-string\">\"_WE2VHX2--_\"</span>, \n <span class=\"hljs-string\">\"inhabitants\"</span> : { \n <span class=\"hljs-string\">\"china\"</span> : <span class=\"hljs-number\">1366980000</span>, \n <span class=\"hljs-string\">\"india\"</span> : <span class=\"hljs-number\">1263590000</span>, \n <span class=\"hljs-string\">\"usa\"</span> : <span class=\"hljs-number\">319220000</span>, \n <span class=\"hljs-string\">\"indonesia\"</span> : <span class=\"hljs-number\">252164800</span>, \n <span class=\"hljs-string\">\"brazil\"</span> : <span class=\"hljs-number\">203553000</span> \n } \n}\nshell> curl -X PATCH --data-binary @- --dump - http://localhost:8529/_api/document/products/10973?mergeObjects=false &lt;&lt;EOF\n{ \n <span class=\"hljs-string\">\"inhabitants\"</span> : { \n <span class=\"hljs-string\">\"pakistan\"</span> : <span class=\"hljs-number\">188346000</span> \n } \n}\nEOF\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">202</span> Accepted\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\netag: <span class=\"hljs-string\">\"_WE2VHYa---\"</span>\nx-content-type-options: nosniff\nlocation: <span class=\"hljs-regexp\">/_db/</span>_system/_api/<span class=\"hljs-built_in\">document</span>/products/<span class=\"hljs-number\">10973</span>\n\n{ \n <span class=\"hljs-string\">\"_id\"</span> : <span class=\"hljs-string\">\"products/10973\"</span>, \n <span class=\"hljs-string\">\"_key\"</span> : <span class=\"hljs-string\">\"10973\"</span>, \n <span class=\"hljs-string\">\"_rev\"</span> : <span class=\"hljs-string\">\"_WE2VHYa---\"</span>, \n <span class=\"hljs-string\">\"_oldRev\"</span> : <span class=\"hljs-string\">\"_WE2VHX2--_\"</span> \n}\nshell> curl --dump - http://localhost:8529/_api/document/products/10973\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">200</span> OK\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\netag: <span class=\"hljs-string\">\"_WE2VHYa---\"</span>\nx-content-type-options: nosniff\n\n{ \n <span class=\"hljs-string\">\"_key\"</span> : <span class=\"hljs-string\">\"10973\"</span>, \n <span class=\"hljs-string\">\"_id\"</span> : <span class=\"hljs-string\">\"products/10973\"</span>, \n <span class=\"hljs-string\">\"_rev\"</span> : <span class=\"hljs-string\">\"_WE2VHYa---\"</span>, \n <span class=\"hljs-string\">\"inhabitants\"</span> : { \n <span class=\"hljs-string\">\"pakistan\"</span> : <span class=\"hljs-number\">188346000</span> \n } \n}\n</code></pre>\n\n\n\n\n",
"parameters": [
{
"description": "A JSON representation of a document update as an object.\n\n",
"in": "body",
"name": "Json Request Body",
"required": true,
"schema": {
"additionalProperties": {},
"type": "object"
},
"x-description-offset": 0
},
{
"description": "This URL parameter must be a document handle.\n\n",
"format": "string",
"in": "path",
"name": "document-handle",
"required": true,
"type": "string"
},
{
"description": "If the intention is to delete existing attributes with the patch\ncommand, the URL query parameter *keepNull* can be used with a value\nof *false*. This will modify the behavior of the patch command to\nremove any attributes from the existing document that are contained\nin the patch document with an attribute value of *null*.\n\n",
"in": "query",
"name": "keepNull",
"required": false,
"type": "boolean"
},
{
"description": "Controls whether objects (not arrays) will be merged if present in\nboth the existing and the patch document. If set to *false*, the\nvalue in the patch document will overwrite the existing document's\nvalue. If set to *true*, objects will be merged. The default is\n*true*.\n\n",
"in": "query",
"name": "mergeObjects",
"required": false,
"type": "boolean"
},
{
"description": "Wait until document has been synced to disk.\n\n",
"in": "query",
"name": "waitForSync",
"required": false,
"type": "boolean"
},
{
"description": "By default, or if this is set to *true*, the *_rev* attributes in \nthe given document is ignored. If this is set to *false*, then\nthe *_rev* attribute given in the body document is taken as a\nprecondition. The document is only updated if the current revision\nis the one specified.\n\n",
"in": "query",
"name": "ignoreRevs",
"required": false,
"type": "boolean"
},
{
"description": "Return additionally the complete previous revision of the changed \ndocument under the attribute *old* in the result.\n\n",
"in": "query",
"name": "returnOld",
"required": false,
"type": "boolean"
},
{
"description": "Return additionally the complete new document under the attribute *new*\nin the result.\n\n",
"in": "query",
"name": "returnNew",
"required": false,
"type": "boolean"
},
{
"description": "If set to *true*, an empty object will be returned as response. No meta-data \nwill be returned for the updated document. This option can be used to\nsave some network traffic.\n\n",
"in": "query",
"name": "silent",
"required": false,
"type": "boolean"
},
{
"description": "You can conditionally update a document based on a target revision id by\nusing the *if-match* HTTP header.\n\n",
"in": "header",
"name": "If-Match",
"type": "string"
}
],
"responses": {
"201": {
"description": "is returned if the document was updated successfully and\n*waitForSync* was *true*.\n\n"
},
"202": {
"description": "is returned if the document was updated successfully and\n*waitForSync* was *false*.\n\n"
},
"400": {
"description": "is returned if the body does not contain a valid JSON representation\nof a document. The response body contains\nan error document in this case.\n\n"
},
"404": {
"description": "is returned if the collection or the document was not found.\n\n"
},
"412": {
"description": "is returned if the precondition was violated. The response will\nalso contain the found documents' current revisions in the *_rev*\nattributes. Additionally, the attributes *_id* and *_key* will be\nreturned.\n\n"
}
},
"summary": "Update document",
"tags": [
"Documents"
],
"x-examples": [],
"x-filename": "Documents - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_HEAD.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_CREATE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE_MULTI.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_ALL.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE_MULTI.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE_MULTI.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ.md"
},
"put": {
"description": "\n\nReplaces the document with handle <document-handle> with the one in\nthe body, provided there is such a document and no precondition is\nviolated.\n\nIf the *If-Match* header is specified and the revision of the\ndocument in the database is unequal to the given revision, the\nprecondition is violated.\n\nIf *If-Match* is not given and *ignoreRevs* is *false* and there\nis a *_rev* attribute in the body and its value does not match\nthe revision of the document in the database, the precondition is\nviolated.\n\nIf a precondition is violated, an *HTTP 412* is returned.\n\nIf the document exists and can be updated, then an *HTTP 201* or\nan *HTTP 202* is returned (depending on *waitForSync*, see below),\nthe *Etag* header field contains the new revision of the document\nand the *Location* header contains a complete URL under which the\ndocument can be queried.\n\nOptionally, the query parameter *waitForSync* can be used to force\nsynchronization of the document replacement operation to disk even in case\nthat the *waitForSync* flag had been disabled for the entire collection.\nThus, the *waitForSync* query parameter can be used to force synchronization\nof just specific operations. To use this, set the *waitForSync* parameter\nto *true*. If the *waitForSync* parameter is not specified or set to\n*false*, then the collection's default *waitForSync* behavior is\napplied. The *waitForSync* query parameter cannot be used to disable\nsynchronization for collections that have a default *waitForSync* value\nof *true*.\n\nIf *silent* is not set to *true*, the body of the response contains a JSON \nobject with the information about the handle and the revision. The attribute \n*_id* contains the known *document-handle* of the updated document, *_key* \ncontains the key which uniquely identifies a document in a given collection, \nand the attribute *_rev* contains the new document revision.\n\nIf the query parameter *returnOld* is *true*, then\nthe complete previous revision of the document\nis returned under the *old* attribute in the result.\n\nIf the query parameter *returnNew* is *true*, then\nthe complete new document is returned under\nthe *new* attribute in the result.\n\nIf the document does not exist, then a *HTTP 404* is returned and the\nbody of the response contains an error document.\n\n\n\n\n**Example:**\n Using a document handle\n\n<pre><code class=\"json\">shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/document/products/11179 &lt;&lt;EOF\n{\"Hello\": \"you\"}\nEOF\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">202</span> Accepted\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\netag: <span class=\"hljs-string\">\"_WE2VIvi--B\"</span>\nx-content-type-options: nosniff\nlocation: <span class=\"hljs-regexp\">/_db/</span>_system/_api/<span class=\"hljs-built_in\">document</span>/products/<span class=\"hljs-number\">11179</span>\n\n{ \n <span class=\"hljs-string\">\"_id\"</span> : <span class=\"hljs-string\">\"products/11179\"</span>, \n <span class=\"hljs-string\">\"_key\"</span> : <span class=\"hljs-string\">\"11179\"</span>, \n <span class=\"hljs-string\">\"_rev\"</span> : <span class=\"hljs-string\">\"_WE2VIvi--B\"</span>, \n <span class=\"hljs-string\">\"_oldRev\"</span> : <span class=\"hljs-string\">\"_WE2VIvi--_\"</span> \n}\n</code></pre>\n\n\n\n\n**Example:**\n Unknown document handle\n\n<pre><code class=\"json\">shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/document/products/11215 &lt;&lt;EOF\n{}\nEOF\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">404</span> Not Found\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\nx-content-type-options: nosniff\n\n{ \n <span class=\"hljs-string\">\"error\"</span> : <span class=\"hljs-literal\">true</span>, \n <span class=\"hljs-string\">\"errorMessage\"</span> : <span class=\"hljs-string\">\"document not found\"</span>, \n <span class=\"hljs-string\">\"code\"</span> : <span class=\"hljs-number\">404</span>, \n <span class=\"hljs-string\">\"errorNum\"</span> : <span class=\"hljs-number\">1202</span> \n}\n</code></pre>\n\n\n\n\n**Example:**\n Produce a revision conflict\n\n<pre><code class=\"json\">shell> curl -X PUT --header 'If-Match: \"_WE2VI7C--B\"' --data-binary @- --dump - http://localhost:8529/_api/document/products/11196 &lt;&lt;EOF\n{\"other\":\"content\"}\nEOF\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">412</span> Precondition Failed\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\netag: <span class=\"hljs-string\">\"_WE2VI7C--_\"</span>\nx-content-type-options: nosniff\n\n{ \n <span class=\"hljs-string\">\"error\"</span> : <span class=\"hljs-literal\">true</span>, \n <span class=\"hljs-string\">\"code\"</span> : <span class=\"hljs-number\">412</span>, \n <span class=\"hljs-string\">\"errorNum\"</span> : <span class=\"hljs-number\">1200</span>, \n <span class=\"hljs-string\">\"errorMessage\"</span> : <span class=\"hljs-string\">\"precondition failed\"</span>, \n <span class=\"hljs-string\">\"_id\"</span> : <span class=\"hljs-string\">\"products/11196\"</span>, \n <span class=\"hljs-string\">\"_key\"</span> : <span class=\"hljs-string\">\"11196\"</span>, \n <span class=\"hljs-string\">\"_rev\"</span> : <span class=\"hljs-string\">\"_WE2VI7C--_\"</span> \n}\n</code></pre>\n\n\n\n\n",
"parameters": [
{
"description": "A JSON representation of a single document.\n\n",
"in": "body",
"name": "Json Request Body",
"required": true,
"schema": {
"additionalProperties": {},
"type": "object"
},
"x-description-offset": 0
},
{
"description": "This URL parameter must be a document handle.\n\n",
"format": "string",
"in": "path",
"name": "document-handle",
"required": true,
"type": "string"
},
{
"description": "Wait until document has been synced to disk.\n\n",
"in": "query",
"name": "waitForSync",
"required": false,
"type": "boolean"
},
{
"description": "By default, or if this is set to *true*, the *_rev* attributes in \nthe given document is ignored. If this is set to *false*, then\nthe *_rev* attribute given in the body document is taken as a\nprecondition. The document is only replaced if the current revision\nis the one specified.\n\n",
"in": "query",
"name": "ignoreRevs",
"required": false,
"type": "boolean"
},
{
"description": "Return additionally the complete previous revision of the changed \ndocument under the attribute *old* in the result.\n\n",
"in": "query",
"name": "returnOld",
"required": false,
"type": "boolean"
},
{
"description": "Return additionally the complete new document under the attribute *new*\nin the result.\n\n",
"in": "query",
"name": "returnNew",
"required": false,
"type": "boolean"
},
{
"description": "If set to *true*, an empty object will be returned as response. No meta-data \nwill be returned for the replaced document. This option can be used to\nsave some network traffic.\n\n",
"in": "query",
"name": "silent",
"required": false,
"type": "boolean"
},
{
"description": "You can conditionally replace a document based on a target revision id by\nusing the *if-match* HTTP header.\n\n",
"in": "header",
"name": "If-Match",
"type": "string"
}
],
"responses": {
"201": {
"description": "is returned if the document was replaced successfully and\n*waitForSync* was *true*.\n\n"
},
"202": {
"description": "is returned if the document was replaced successfully and\n*waitForSync* was *false*.\n\n"
},
"400": {
"description": "is returned if the body does not contain a valid JSON representation\nof a document. The response body contains\nan error document in this case.\n\n"
},
"404": {
"description": "is returned if the collection or the document was not found.\n\n"
},
"412": {
"description": "is returned if the precondition was violated. The response will\nalso contain the found documents' current revisions in the *_rev*\nattributes. Additionally, the attributes *_id* and *_key* will be\nreturned.\n\n"
}
},
"summary": "Replace document",
"tags": [
"Documents"
],
"x-examples": [],
"x-filename": "Documents - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_HEAD.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_CREATE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE_MULTI.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_ALL.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE_MULTI.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE_MULTI.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ.md"
}
},
"/_api/edges/{collection-id}": {
"get": {
"description": "\n\nReturns an array of edges starting or ending in the vertex identified by\n*vertex-handle*.\n\n\n\n\n**Example:**\n Any direction\n\n<pre><code class=\"json\">shell> curl --dump - http://localhost:8529/_api/edges/edges?vertex=vertices/1\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">200</span> OK\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\nx-content-type-options: nosniff\n\n{ \n <span class=\"hljs-string\">\"edges\"</span> : [ \n { \n <span class=\"hljs-string\">\"_key\"</span> : <span class=\"hljs-string\">\"6\"</span>, \n <span class=\"hljs-string\">\"_id\"</span> : <span class=\"hljs-string\">\"edges/6\"</span>, \n <span class=\"hljs-string\">\"_from\"</span> : <span class=\"hljs-string\">\"vertices/2\"</span>, \n <span class=\"hljs-string\">\"_to\"</span> : <span class=\"hljs-string\">\"vertices/1\"</span>, \n <span class=\"hljs-string\">\"_rev\"</span> : <span class=\"hljs-string\">\"_WE2VJK2--B\"</span>, \n <span class=\"hljs-string\">\"$label\"</span> : <span class=\"hljs-string\">\"v2 -&gt; v1\"</span> \n }, \n { \n <span class=\"hljs-string\">\"_key\"</span> : <span class=\"hljs-string\">\"7\"</span>, \n <span class=\"hljs-string\">\"_id\"</span> : <span class=\"hljs-string\">\"edges/7\"</span>, \n <span class=\"hljs-string\">\"_from\"</span> : <span class=\"hljs-string\">\"vertices/4\"</span>, \n <span class=\"hljs-string\">\"_to\"</span> : <span class=\"hljs-string\">\"vertices/1\"</span>, \n <span class=\"hljs-string\">\"_rev\"</span> : <span class=\"hljs-string\">\"_WE2VJK6--_\"</span>, \n <span class=\"hljs-string\">\"$label\"</span> : <span class=\"hljs-string\">\"v4 -&gt; v1\"</span> \n }, \n { \n <span class=\"hljs-string\">\"_key\"</span> : <span class=\"hljs-string\">\"5\"</span>, \n <span class=\"hljs-string\">\"_id\"</span> : <span class=\"hljs-string\">\"edges/5\"</span>, \n <span class=\"hljs-string\">\"_from\"</span> : <span class=\"hljs-string\">\"vertices/1\"</span>, \n <span class=\"hljs-string\">\"_to\"</span> : <span class=\"hljs-string\">\"vertices/3\"</span>, \n <span class=\"hljs-string\">\"_rev\"</span> : <span class=\"hljs-string\">\"_WE2VJK2--_\"</span>, \n <span class=\"hljs-string\">\"$label\"</span> : <span class=\"hljs-string\">\"v1 -&gt; v3\"</span> \n } \n ], \n <span class=\"hljs-string\">\"error\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"code\"</span> : <span class=\"hljs-number\">200</span>, \n <span class=\"hljs-string\">\"stats\"</span> : { \n <span class=\"hljs-string\">\"scannedIndex\"</span> : <span class=\"hljs-number\">3</span>, \n <span class=\"hljs-string\">\"filtered\"</span> : <span class=\"hljs-number\">0</span> \n } \n}\n</code></pre>\n\n\n\n\n**Example:**\n In edges\n\n<pre><code class=\"json\">shell> curl --dump - http://localhost:8529/_api/edges/edges?vertex=vertices/1&direction=in\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">200</span> OK\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\nx-content-type-options: nosniff\n\n{ \n <span class=\"hljs-string\">\"edges\"</span> : [ \n { \n <span class=\"hljs-string\">\"_key\"</span> : <span class=\"hljs-string\">\"6\"</span>, \n <span class=\"hljs-string\">\"_id\"</span> : <span class=\"hljs-string\">\"edges/6\"</span>, \n <span class=\"hljs-string\">\"_from\"</span> : <span class=\"hljs-string\">\"vertices/2\"</span>, \n <span class=\"hljs-string\">\"_to\"</span> : <span class=\"hljs-string\">\"vertices/1\"</span>, \n <span class=\"hljs-string\">\"_rev\"</span> : <span class=\"hljs-string\">\"_WE2VJY---_\"</span>, \n <span class=\"hljs-string\">\"$label\"</span> : <span class=\"hljs-string\">\"v2 -&gt; v1\"</span> \n }, \n { \n <span class=\"hljs-string\">\"_key\"</span> : <span class=\"hljs-string\">\"7\"</span>, \n <span class=\"hljs-string\">\"_id\"</span> : <span class=\"hljs-string\">\"edges/7\"</span>, \n <span class=\"hljs-string\">\"_from\"</span> : <span class=\"hljs-string\">\"vertices/4\"</span>, \n <span class=\"hljs-string\">\"_to\"</span> : <span class=\"hljs-string\">\"vertices/1\"</span>, \n <span class=\"hljs-string\">\"_rev\"</span> : <span class=\"hljs-string\">\"_WE2VJY---B\"</span>, \n <span class=\"hljs-string\">\"$label\"</span> : <span class=\"hljs-string\">\"v4 -&gt; v1\"</span> \n } \n ], \n <span class=\"hljs-string\">\"error\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"code\"</span> : <span class=\"hljs-number\">200</span>, \n <span class=\"hljs-string\">\"stats\"</span> : { \n <span class=\"hljs-string\">\"scannedIndex\"</span> : <span class=\"hljs-number\">2</span>, \n <span class=\"hljs-string\">\"filtered\"</span> : <span class=\"hljs-number\">0</span> \n } \n}\n</code></pre>\n\n\n\n\n**Example:**\n Out edges\n\n<pre><code class=\"json\">shell> curl --dump - http://localhost:8529/_api/edges/edges?vertex=vertices/1&direction=out\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">200</span> OK\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\nx-content-type-options: nosniff\n\n{ \n <span class=\"hljs-string\">\"edges\"</span> : [ \n { \n <span class=\"hljs-string\">\"_key\"</span> : <span class=\"hljs-string\">\"5\"</span>, \n <span class=\"hljs-string\">\"_id\"</span> : <span class=\"hljs-string\">\"edges/5\"</span>, \n <span class=\"hljs-string\">\"_from\"</span> : <span class=\"hljs-string\">\"vertices/1\"</span>, \n <span class=\"hljs-string\">\"_to\"</span> : <span class=\"hljs-string\">\"vertices/3\"</span>, \n <span class=\"hljs-string\">\"_rev\"</span> : <span class=\"hljs-string\">\"_WE2VJmC--_\"</span>, \n <span class=\"hljs-string\">\"$label\"</span> : <span class=\"hljs-string\">\"v1 -&gt; v3\"</span> \n } \n ], \n <span class=\"hljs-string\">\"error\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"code\"</span> : <span class=\"hljs-number\">200</span>, \n <span class=\"hljs-string\">\"stats\"</span> : { \n <span class=\"hljs-string\">\"scannedIndex\"</span> : <span class=\"hljs-number\">1</span>, \n <span class=\"hljs-string\">\"filtered\"</span> : <span class=\"hljs-number\">0</span> \n } \n}\n</code></pre>\n\n\n\n\n",
"parameters": [
{
"description": "The id of the collection.\n\n",
"format": "string",
"in": "path",
"name": "collection-id",
"required": true,
"type": "string"
},
{
"description": "The id of the start vertex.\n\n",
"in": "query",
"name": "vertex",
"required": true,
"type": "string"
},
{
"description": "Selects *in* or *out* direction for edges. If not set, any edges are\nreturned.\n\n",
"in": "query",
"name": "direction",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "is returned if the edge collection was found and edges were retrieved.\n\n"
},
"400": {
"description": "is returned if the request contains invalid parameters.\n\n"
},
"404": {
"description": "is returned if the edge collection was not found.\n\n"
}
},
"summary": "Read in- or outbound edges",
"tags": [
"Graph Edges"
],
"x-examples": [],
"x-filename": "Graph Edges - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph Edges/API_EDGE_READINOUTBOUND.md"
}
},
"/_api/endpoint": {
"get": {
"description": "\n\n*THIS API IS DEPRECATED*\n\nReturns an array of all configured endpoints the server is listening on.\n\nThe result is a JSON array of JSON objects, each with `\"entrypoint\"' as\nthe only attribute, and with the value being a string describing the\nendpoint.\n\n**Note**: retrieving the array of all endpoints is allowed in the system database\nonly. Calling this action in any other database will make the server return\nan error.\n\n\n\n\n**Example:**\n \n\n<pre><code class=\"json\">shell> curl --dump - http://localhost:8529/_api/endpoint\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">200</span> OK\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\nx-content-type-options: nosniff\n\n[ \n { \n <span class=\"hljs-string\">\"endpoint\"</span> : <span class=\"hljs-string\">\"http://127.0.0.1:24507\"</span> \n } \n]\n</code></pre>\n\n\n\n\n",
"parameters": [],
"responses": {
"200": {
"description": "is returned when the array of endpoints can be determined successfully.\n\n"
},
"400": {
"description": "is returned if the action is not carried out in the system database.\n\n"
},
"405": {
"description": "The server will respond with *HTTP 405* if an unsupported HTTP method is used.\n\n"
}
},
"summary": "Return list of all endpoints",
"tags": [
"Administration"
],
"x-examples": [],
"x-filename": "Administration - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_long_echo.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_statistics_description.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_time.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_tasks_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_server_role.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_database_version.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_statistics.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_modules_flush.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_server_id.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_cluster_endpoints.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_return.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_endpoint.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/post_admin_execute.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/post_admin_test.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/put_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_initiate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/post_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_engine.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/delete_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_echo.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_routing_reloads.md"
}
},
"/_api/engine": {
"get": {
"description": "\n\nReturns the storage engine the server is configured to use.\nThe response is a JSON object with the following attributes:\n\n**A json document with these Properties is returned:**\n\n#### HTTP 200\nis returned in all cases.\n\n- **name**: will be *mmfiles* or *rocksdb*\n\n\n\n\n**Example:**\n Return the active storage engine\n\n<pre><code class=\"json\">shell> curl --dump - http://localhost:8529/_api/engine\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">200</span> OK\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\nx-content-type-options: nosniff\n\n{ \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"mmfiles\"</span>, \n <span class=\"hljs-string\">\"supports\"</span> : { \n <span class=\"hljs-string\">\"dfdb\"</span> : <span class=\"hljs-literal\">true</span>, \n <span class=\"hljs-string\">\"indexes\"</span> : [ \n <span class=\"hljs-string\">\"primary\"</span>, \n <span class=\"hljs-string\">\"edge\"</span>, \n <span class=\"hljs-string\">\"hash\"</span>, \n <span class=\"hljs-string\">\"skiplist\"</span>, \n <span class=\"hljs-string\">\"persistent\"</span>, \n <span class=\"hljs-string\">\"geo\"</span>, \n <span class=\"hljs-string\">\"fulltext\"</span> \n ] \n } \n}\n</code></pre>\n\n\n\n\n",
"parameters": [],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "is returned in all cases.\n\n",
"schema": {
"$ref": "#/definitions/get_engine_rc_200"
},
"x-description-offset": 179
}
},
"summary": "Return server database engine type",
"tags": [
"Administration"
],
"x-examples": [],
"x-filename": "Administration - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_long_echo.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_statistics_description.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_time.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_tasks_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_server_role.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_database_version.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_statistics.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_modules_flush.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_server_id.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_cluster_endpoints.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_return.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_endpoint.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/post_admin_execute.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/post_admin_test.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/put_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_initiate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/post_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_engine.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/delete_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_echo.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/get_admin_routing_reloads.md"
}
},
"/_api/explain": {
"post": {
"description": "\n**A JSON object with these properties is required:**\n\n - **query**: the query which you want explained; If the query references any bind variables,\n these must also be passed in the attribute *bindVars*. Additional\n options for the query can be passed in the *options* attribute.\n - **options**:\n - **optimizer.rules** (string): an array of to-be-included or to-be-excluded optimizer rules\n can be put into this attribute, telling the optimizer to include or exclude\n specific rules. To disable a rule, prefix its name with a `-`, to enable a rule, prefix it\n with a `+`. There is also a pseudo-rule `all`, which will match all optimizer rules.\n - **maxNumberOfPlans**: an optional maximum number of plans that the optimizer is \n allowed to generate. Setting this attribute to a low value allows to put a\n cap on the amount of work the optimizer does.\n - **allPlans**: if set to *true*, all possible execution plans will be returned.\n The default is *false*, meaning only the optimal plan will be returned.\n - **bindVars** (object): key/value pairs representing the bind parameters.\n\n\n\n\n\nTo explain how an AQL query would be executed on the server, the query string\ncan be sent to the server via an HTTP POST request. The server will then validate\nthe query and create an execution plan for it. The execution plan will be\nreturned, but the query will not be executed.\n\nThe execution plan that is returned by the server can be used to estimate the\nprobable performance of the query. Though the actual performance will depend\non many different factors, the execution plan normally can provide some rough\nestimates on the amount of work the server needs to do in order to actually run \nthe query.\n\nBy default, the explain operation will return the optimal plan as chosen by\nthe query optimizer The optimal plan is the plan with the lowest total estimated\ncost. The plan will be returned in the attribute *plan* of the response object.\nIf the option *allPlans* is specified in the request, the result will contain \nall plans created by the optimizer. The plans will then be returned in the \nattribute *plans*.\n\nThe result will also contain an attribute *warnings*, which is an array of \nwarnings that occurred during optimization or execution plan creation. Additionally,\na *stats* attribute is contained in the result with some optimizer statistics.\nIf *allPlans* is set to *false*, the result will contain an attribute *cacheable* \nthat states whether the query results can be cached on the server if the query\nresult cache were used. The *cacheable* attribute is not present when *allPlans*\nis set to *true*.\n\nEach plan in the result is a JSON object with the following attributes:\n- *nodes*: the array of execution nodes of the plan. The array of available node types\n can be found [here](../../AQL/ExecutionAndPerformance/Optimizer.html)\n\n- *estimatedCost*: the total estimated cost for the plan. If there are multiple\n plans, the optimizer will choose the plan with the lowest total cost.\n\n- *collections*: an array of collections used in the query\n\n- *rules*: an array of rules the optimizer applied. An overview of the\n available rules can be found [here](../../AQL/ExecutionAndPerformance/Optimizer.html)\n\n- *variables*: array of variables used in the query (note: this may contain\n internal variables created by the optimizer)\n\n\n\n\n**Example:**\n Valid query\n\n<pre><code class=\"json\">shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/explain &lt;&lt;EOF\n{ \n <span class=\"hljs-string\">\"query\"</span> : <span class=\"hljs-string\">\"FOR p IN products RETURN p\"</span> \n}\nEOF\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">200</span> OK\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\nx-content-type-options: nosniff\n\n{ \n <span class=\"hljs-string\">\"plan\"</span> : { \n <span class=\"hljs-string\">\"nodes\"</span> : [ \n { \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"SingletonNode\"</span>, \n <span class=\"hljs-string\">\"dependencies\"</span> : [ ], \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-number\">1</span>, \n <span class=\"hljs-string\">\"estimatedCost\"</span> : <span class=\"hljs-number\">1</span>, \n <span class=\"hljs-string\">\"estimatedNrItems\"</span> : <span class=\"hljs-number\">1</span> \n }, \n { \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"EnumerateCollectionNode\"</span>, \n <span class=\"hljs-string\">\"dependencies\"</span> : [ \n <span class=\"hljs-number\">1</span> \n ], \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-number\">2</span>, \n <span class=\"hljs-string\">\"estimatedCost\"</span> : <span class=\"hljs-number\">12</span>, \n <span class=\"hljs-string\">\"estimatedNrItems\"</span> : <span class=\"hljs-number\">10</span>, \n <span class=\"hljs-string\">\"database\"</span> : <span class=\"hljs-string\">\"_system\"</span>, \n <span class=\"hljs-string\">\"collection\"</span> : <span class=\"hljs-string\">\"products\"</span>, \n <span class=\"hljs-string\">\"random\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"satellite\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"outVariable\"</span> : { \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"p\"</span> \n } \n }, \n { \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"ReturnNode\"</span>, \n <span class=\"hljs-string\">\"dependencies\"</span> : [ \n <span class=\"hljs-number\">2</span> \n ], \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-number\">3</span>, \n <span class=\"hljs-string\">\"estimatedCost\"</span> : <span class=\"hljs-number\">22</span>, \n <span class=\"hljs-string\">\"estimatedNrItems\"</span> : <span class=\"hljs-number\">10</span>, \n <span class=\"hljs-string\">\"inVariable\"</span> : { \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"p\"</span> \n } \n } \n ], \n <span class=\"hljs-string\">\"rules\"</span> : [ ], \n <span class=\"hljs-string\">\"collections\"</span> : [ \n { \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"products\"</span>, \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"read\"</span> \n } \n ], \n <span class=\"hljs-string\">\"variables\"</span> : [ \n { \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"p\"</span> \n } \n ], \n <span class=\"hljs-string\">\"estimatedCost\"</span> : <span class=\"hljs-number\">22</span>, \n <span class=\"hljs-string\">\"estimatedNrItems\"</span> : <span class=\"hljs-number\">10</span>, \n <span class=\"hljs-string\">\"initialize\"</span> : <span class=\"hljs-literal\">true</span> \n }, \n <span class=\"hljs-string\">\"cacheable\"</span> : <span class=\"hljs-literal\">true</span>, \n <span class=\"hljs-string\">\"warnings\"</span> : [ ], \n <span class=\"hljs-string\">\"stats\"</span> : { \n <span class=\"hljs-string\">\"rulesExecuted\"</span> : <span class=\"hljs-number\">31</span>, \n <span class=\"hljs-string\">\"rulesSkipped\"</span> : <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-string\">\"plansCreated\"</span> : <span class=\"hljs-number\">1</span> \n }, \n <span class=\"hljs-string\">\"error\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"code\"</span> : <span class=\"hljs-number\">200</span> \n}\n</code></pre>\n\n\n\n\n**Example:**\n A plan with some optimizer rules applied\n\n<pre><code class=\"json\">shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/explain &lt;&lt;EOF\n{ \n <span class=\"hljs-string\">\"query\"</span> : <span class=\"hljs-string\">\"FOR p IN products LET a = p.id FILTER a == 4 LET name = p.name SORT p.id LIMIT 1 RETURN name\"</span> \n}\nEOF\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">200</span> OK\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\nx-content-type-options: nosniff\n\n{ \n <span class=\"hljs-string\">\"plan\"</span> : { \n <span class=\"hljs-string\">\"nodes\"</span> : [ \n { \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"SingletonNode\"</span>, \n <span class=\"hljs-string\">\"dependencies\"</span> : [ ], \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-number\">1</span>, \n <span class=\"hljs-string\">\"estimatedCost\"</span> : <span class=\"hljs-number\">1</span>, \n <span class=\"hljs-string\">\"estimatedNrItems\"</span> : <span class=\"hljs-number\">1</span> \n }, \n { \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"IndexNode\"</span>, \n <span class=\"hljs-string\">\"dependencies\"</span> : [ \n <span class=\"hljs-number\">1</span> \n ], \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-number\">11</span>, \n <span class=\"hljs-string\">\"estimatedCost\"</span> : <span class=\"hljs-number\">4.321928094887362</span>, \n <span class=\"hljs-string\">\"estimatedNrItems\"</span> : <span class=\"hljs-number\">1</span>, \n <span class=\"hljs-string\">\"database\"</span> : <span class=\"hljs-string\">\"_system\"</span>, \n <span class=\"hljs-string\">\"collection\"</span> : <span class=\"hljs-string\">\"products\"</span>, \n <span class=\"hljs-string\">\"satellite\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"outVariable\"</span> : { \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"p\"</span> \n }, \n <span class=\"hljs-string\">\"indexes\"</span> : [ \n { \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-string\">\"11397\"</span>, \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"skiplist\"</span>, \n <span class=\"hljs-string\">\"fields\"</span> : [ \n <span class=\"hljs-string\">\"id\"</span> \n ], \n <span class=\"hljs-string\">\"unique\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"sparse\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"deduplicate\"</span> : <span class=\"hljs-literal\">true</span> \n } \n ], \n <span class=\"hljs-string\">\"condition\"</span> : { \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"n-ary or\"</span>, \n <span class=\"hljs-string\">\"subNodes\"</span> : [ \n { \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"n-ary and\"</span>, \n <span class=\"hljs-string\">\"subNodes\"</span> : [ \n { \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"compare ==\"</span>, \n <span class=\"hljs-string\">\"subNodes\"</span> : [ \n { \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"attribute access\"</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"id\"</span>, \n <span class=\"hljs-string\">\"subNodes\"</span> : [ \n { \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"reference\"</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"p\"</span>, \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-number\">0</span> \n } \n ] \n }, \n { \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"value\"</span>, \n <span class=\"hljs-string\">\"value\"</span> : <span class=\"hljs-number\">4</span> \n } \n ] \n } \n ] \n } \n ] \n }, \n <span class=\"hljs-string\">\"reverse\"</span> : <span class=\"hljs-literal\">false</span> \n }, \n { \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"CalculationNode\"</span>, \n <span class=\"hljs-string\">\"dependencies\"</span> : [ \n <span class=\"hljs-number\">11</span> \n ], \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-number\">4</span>, \n <span class=\"hljs-string\">\"estimatedCost\"</span> : <span class=\"hljs-number\">5.321928094887362</span>, \n <span class=\"hljs-string\">\"estimatedNrItems\"</span> : <span class=\"hljs-number\">1</span>, \n <span class=\"hljs-string\">\"expression\"</span> : { \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"compare ==\"</span>, \n <span class=\"hljs-string\">\"subNodes\"</span> : [ \n { \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"attribute access\"</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"id\"</span>, \n <span class=\"hljs-string\">\"subNodes\"</span> : [ \n { \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"reference\"</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"p\"</span>, \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-number\">0</span> \n } \n ] \n }, \n { \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"value\"</span>, \n <span class=\"hljs-string\">\"value\"</span> : <span class=\"hljs-number\">4</span> \n } \n ] \n }, \n <span class=\"hljs-string\">\"outVariable\"</span> : { \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-number\">4</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"3\"</span> \n }, \n <span class=\"hljs-string\">\"canThrow\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"expressionType\"</span> : <span class=\"hljs-string\">\"simple\"</span> \n }, \n { \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"FilterNode\"</span>, \n <span class=\"hljs-string\">\"dependencies\"</span> : [ \n <span class=\"hljs-number\">4</span> \n ], \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-number\">5</span>, \n <span class=\"hljs-string\">\"estimatedCost\"</span> : <span class=\"hljs-number\">6.321928094887362</span>, \n <span class=\"hljs-string\">\"estimatedNrItems\"</span> : <span class=\"hljs-number\">1</span>, \n <span class=\"hljs-string\">\"inVariable\"</span> : { \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-number\">4</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"3\"</span> \n } \n }, \n { \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"LimitNode\"</span>, \n <span class=\"hljs-string\">\"dependencies\"</span> : [ \n <span class=\"hljs-number\">5</span> \n ], \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-number\">9</span>, \n <span class=\"hljs-string\">\"estimatedCost\"</span> : <span class=\"hljs-number\">7.321928094887362</span>, \n <span class=\"hljs-string\">\"estimatedNrItems\"</span> : <span class=\"hljs-number\">1</span>, \n <span class=\"hljs-string\">\"offset\"</span> : <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-string\">\"limit\"</span> : <span class=\"hljs-number\">1</span>, \n <span class=\"hljs-string\">\"fullCount\"</span> : <span class=\"hljs-literal\">false</span> \n }, \n { \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"CalculationNode\"</span>, \n <span class=\"hljs-string\">\"dependencies\"</span> : [ \n <span class=\"hljs-number\">9</span> \n ], \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-number\">6</span>, \n <span class=\"hljs-string\">\"estimatedCost\"</span> : <span class=\"hljs-number\">8.321928094887362</span>, \n <span class=\"hljs-string\">\"estimatedNrItems\"</span> : <span class=\"hljs-number\">1</span>, \n <span class=\"hljs-string\">\"expression\"</span> : { \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"attribute access\"</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"name\"</span>, \n <span class=\"hljs-string\">\"subNodes\"</span> : [ \n { \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"reference\"</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"p\"</span>, \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-number\">0</span> \n } \n ] \n }, \n <span class=\"hljs-string\">\"outVariable\"</span> : { \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-number\">2</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"name\"</span> \n }, \n <span class=\"hljs-string\">\"canThrow\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"expressionType\"</span> : <span class=\"hljs-string\">\"attribute\"</span> \n }, \n { \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"ReturnNode\"</span>, \n <span class=\"hljs-string\">\"dependencies\"</span> : [ \n <span class=\"hljs-number\">6</span> \n ], \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-number\">10</span>, \n <span class=\"hljs-string\">\"estimatedCost\"</span> : <span class=\"hljs-number\">9.321928094887362</span>, \n <span class=\"hljs-string\">\"estimatedNrItems\"</span> : <span class=\"hljs-number\">1</span>, \n <span class=\"hljs-string\">\"inVariable\"</span> : { \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-number\">2</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"name\"</span> \n } \n } \n ], \n <span class=\"hljs-string\">\"rules\"</span> : [ \n <span class=\"hljs-string\">\"move-calculations-up\"</span>, \n <span class=\"hljs-string\">\"remove-redundant-calculations\"</span>, \n <span class=\"hljs-string\">\"remove-unnecessary-calculations\"</span>, \n <span class=\"hljs-string\">\"move-calculations-up-2\"</span>, \n <span class=\"hljs-string\">\"use-indexes\"</span>, \n <span class=\"hljs-string\">\"use-index-for-sort\"</span>, \n <span class=\"hljs-string\">\"remove-unnecessary-calculations-2\"</span>, \n <span class=\"hljs-string\">\"move-calculations-down\"</span> \n ], \n <span class=\"hljs-string\">\"collections\"</span> : [ \n { \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"products\"</span>, \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"read\"</span> \n } \n ], \n <span class=\"hljs-string\">\"variables\"</span> : [ \n { \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-number\">6</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"5\"</span> \n }, \n { \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-number\">4</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"3\"</span> \n }, \n { \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-number\">2</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"name\"</span> \n }, \n { \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-number\">1</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"a\"</span> \n }, \n { \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"p\"</span> \n } \n ], \n <span class=\"hljs-string\">\"estimatedCost\"</span> : <span class=\"hljs-number\">9.321928094887362</span>, \n <span class=\"hljs-string\">\"estimatedNrItems\"</span> : <span class=\"hljs-number\">1</span>, \n <span class=\"hljs-string\">\"initialize\"</span> : <span class=\"hljs-literal\">true</span> \n }, \n <span class=\"hljs-string\">\"cacheable\"</span> : <span class=\"hljs-literal\">true</span>, \n <span class=\"hljs-string\">\"warnings\"</span> : [ ], \n <span class=\"hljs-string\">\"stats\"</span> : { \n <span class=\"hljs-string\">\"rulesExecuted\"</span> : <span class=\"hljs-number\">31</span>, \n <span class=\"hljs-string\">\"rulesSkipped\"</span> : <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-string\">\"plansCreated\"</span> : <span class=\"hljs-number\">1</span> \n }, \n <span class=\"hljs-string\">\"error\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"code\"</span> : <span class=\"hljs-number\">200</span> \n}\n</code></pre>\n\n\n\n\n**Example:**\n Using some options\n\n<pre><code class=\"json\">shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/explain &lt;&lt;EOF\n{ \n <span class=\"hljs-string\">\"query\"</span> : <span class=\"hljs-string\">\"FOR p IN products LET a = p.id FILTER a == 4 LET name = p.name SORT p.id LIMIT 1 RETURN name\"</span>, \n <span class=\"hljs-string\">\"options\"</span> : { \n <span class=\"hljs-string\">\"maxNumberOfPlans\"</span> : <span class=\"hljs-number\">2</span>, \n <span class=\"hljs-string\">\"allPlans\"</span> : <span class=\"hljs-literal\">true</span>, \n <span class=\"hljs-string\">\"optimizer\"</span> : { \n <span class=\"hljs-string\">\"rules\"</span> : [ \n <span class=\"hljs-string\">\"-all\"</span>, \n <span class=\"hljs-string\">\"+use-index-for-sort\"</span>, \n <span class=\"hljs-string\">\"+use-index-range\"</span> \n ] \n } \n } \n}\nEOF\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">200</span> OK\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\nx-content-type-options: nosniff\n\n{ \n <span class=\"hljs-string\">\"plans\"</span> : [ \n { \n <span class=\"hljs-string\">\"nodes\"</span> : [ \n { \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"SingletonNode\"</span>, \n <span class=\"hljs-string\">\"dependencies\"</span> : [ ], \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-number\">1</span>, \n <span class=\"hljs-string\">\"estimatedCost\"</span> : <span class=\"hljs-number\">1</span>, \n <span class=\"hljs-string\">\"estimatedNrItems\"</span> : <span class=\"hljs-number\">1</span> \n }, \n { \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"IndexNode\"</span>, \n <span class=\"hljs-string\">\"dependencies\"</span> : [ \n <span class=\"hljs-number\">1</span> \n ], \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-number\">11</span>, \n <span class=\"hljs-string\">\"estimatedCost\"</span> : <span class=\"hljs-number\">11</span>, \n <span class=\"hljs-string\">\"estimatedNrItems\"</span> : <span class=\"hljs-number\">10</span>, \n <span class=\"hljs-string\">\"database\"</span> : <span class=\"hljs-string\">\"_system\"</span>, \n <span class=\"hljs-string\">\"collection\"</span> : <span class=\"hljs-string\">\"products\"</span>, \n <span class=\"hljs-string\">\"satellite\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"outVariable\"</span> : { \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"p\"</span> \n }, \n <span class=\"hljs-string\">\"indexes\"</span> : [ \n { \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-string\">\"11444\"</span>, \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"skiplist\"</span>, \n <span class=\"hljs-string\">\"fields\"</span> : [ \n <span class=\"hljs-string\">\"id\"</span> \n ], \n <span class=\"hljs-string\">\"unique\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"sparse\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"deduplicate\"</span> : <span class=\"hljs-literal\">true</span> \n } \n ], \n <span class=\"hljs-string\">\"condition\"</span> : { \n }, \n <span class=\"hljs-string\">\"reverse\"</span> : <span class=\"hljs-literal\">false</span> \n }, \n { \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"CalculationNode\"</span>, \n <span class=\"hljs-string\">\"dependencies\"</span> : [ \n <span class=\"hljs-number\">11</span> \n ], \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-number\">3</span>, \n <span class=\"hljs-string\">\"estimatedCost\"</span> : <span class=\"hljs-number\">21</span>, \n <span class=\"hljs-string\">\"estimatedNrItems\"</span> : <span class=\"hljs-number\">10</span>, \n <span class=\"hljs-string\">\"expression\"</span> : { \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"attribute access\"</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"id\"</span>, \n <span class=\"hljs-string\">\"subNodes\"</span> : [ \n { \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"reference\"</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"p\"</span>, \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-number\">0</span> \n } \n ] \n }, \n <span class=\"hljs-string\">\"outVariable\"</span> : { \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-number\">1</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"a\"</span> \n }, \n <span class=\"hljs-string\">\"canThrow\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"expressionType\"</span> : <span class=\"hljs-string\">\"attribute\"</span> \n }, \n { \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"CalculationNode\"</span>, \n <span class=\"hljs-string\">\"dependencies\"</span> : [ \n <span class=\"hljs-number\">3</span> \n ], \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-number\">4</span>, \n <span class=\"hljs-string\">\"estimatedCost\"</span> : <span class=\"hljs-number\">31</span>, \n <span class=\"hljs-string\">\"estimatedNrItems\"</span> : <span class=\"hljs-number\">10</span>, \n <span class=\"hljs-string\">\"expression\"</span> : { \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"compare ==\"</span>, \n <span class=\"hljs-string\">\"subNodes\"</span> : [ \n { \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"reference\"</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"a\"</span>, \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-number\">1</span> \n }, \n { \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"value\"</span>, \n <span class=\"hljs-string\">\"value\"</span> : <span class=\"hljs-number\">4</span> \n } \n ] \n }, \n <span class=\"hljs-string\">\"outVariable\"</span> : { \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-number\">4</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"3\"</span> \n }, \n <span class=\"hljs-string\">\"canThrow\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"expressionType\"</span> : <span class=\"hljs-string\">\"simple\"</span> \n }, \n { \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"FilterNode\"</span>, \n <span class=\"hljs-string\">\"dependencies\"</span> : [ \n <span class=\"hljs-number\">4</span> \n ], \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-number\">5</span>, \n <span class=\"hljs-string\">\"estimatedCost\"</span> : <span class=\"hljs-number\">41</span>, \n <span class=\"hljs-string\">\"estimatedNrItems\"</span> : <span class=\"hljs-number\">10</span>, \n <span class=\"hljs-string\">\"inVariable\"</span> : { \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-number\">4</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"3\"</span> \n } \n }, \n { \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"CalculationNode\"</span>, \n <span class=\"hljs-string\">\"dependencies\"</span> : [ \n <span class=\"hljs-number\">5</span> \n ], \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-number\">6</span>, \n <span class=\"hljs-string\">\"estimatedCost\"</span> : <span class=\"hljs-number\">51</span>, \n <span class=\"hljs-string\">\"estimatedNrItems\"</span> : <span class=\"hljs-number\">10</span>, \n <span class=\"hljs-string\">\"expression\"</span> : { \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"attribute access\"</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"name\"</span>, \n <span class=\"hljs-string\">\"subNodes\"</span> : [ \n { \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"reference\"</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"p\"</span>, \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-number\">0</span> \n } \n ] \n }, \n <span class=\"hljs-string\">\"outVariable\"</span> : { \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-number\">2</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"name\"</span> \n }, \n <span class=\"hljs-string\">\"canThrow\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"expressionType\"</span> : <span class=\"hljs-string\">\"attribute\"</span> \n }, \n { \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"CalculationNode\"</span>, \n <span class=\"hljs-string\">\"dependencies\"</span> : [ \n <span class=\"hljs-number\">6</span> \n ], \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-number\">7</span>, \n <span class=\"hljs-string\">\"estimatedCost\"</span> : <span class=\"hljs-number\">61</span>, \n <span class=\"hljs-string\">\"estimatedNrItems\"</span> : <span class=\"hljs-number\">10</span>, \n <span class=\"hljs-string\">\"expression\"</span> : { \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"attribute access\"</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"id\"</span>, \n <span class=\"hljs-string\">\"subNodes\"</span> : [ \n { \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"reference\"</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"p\"</span>, \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-number\">0</span> \n } \n ] \n }, \n <span class=\"hljs-string\">\"outVariable\"</span> : { \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-number\">6</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"5\"</span> \n }, \n <span class=\"hljs-string\">\"canThrow\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"expressionType\"</span> : <span class=\"hljs-string\">\"attribute\"</span> \n }, \n { \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"LimitNode\"</span>, \n <span class=\"hljs-string\">\"dependencies\"</span> : [ \n <span class=\"hljs-number\">7</span> \n ], \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-number\">9</span>, \n <span class=\"hljs-string\">\"estimatedCost\"</span> : <span class=\"hljs-number\">62</span>, \n <span class=\"hljs-string\">\"estimatedNrItems\"</span> : <span class=\"hljs-number\">1</span>, \n <span class=\"hljs-string\">\"offset\"</span> : <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-string\">\"limit\"</span> : <span class=\"hljs-number\">1</span>, \n <span class=\"hljs-string\">\"fullCount\"</span> : <span class=\"hljs-literal\">false</span> \n }, \n { \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"ReturnNode\"</span>, \n <span class=\"hljs-string\">\"dependencies\"</span> : [ \n <span class=\"hljs-number\">9</span> \n ], \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-number\">10</span>, \n <span class=\"hljs-string\">\"estimatedCost\"</span> : <span class=\"hljs-number\">63</span>, \n <span class=\"hljs-string\">\"estimatedNrItems\"</span> : <span class=\"hljs-number\">1</span>, \n <span class=\"hljs-string\">\"inVariable\"</span> : { \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-number\">2</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"name\"</span> \n } \n } \n ], \n <span class=\"hljs-string\">\"rules\"</span> : [ \n <span class=\"hljs-string\">\"use-index-for-sort\"</span> \n ], \n <span class=\"hljs-string\">\"collections\"</span> : [ \n { \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"products\"</span>, \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"read\"</span> \n } \n ], \n <span class=\"hljs-string\">\"variables\"</span> : [ \n { \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-number\">6</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"5\"</span> \n }, \n { \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-number\">4</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"3\"</span> \n }, \n { \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-number\">2</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"name\"</span> \n }, \n { \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-number\">1</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"a\"</span> \n }, \n { \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"p\"</span> \n } \n ], \n <span class=\"hljs-string\">\"estimatedCost\"</span> : <span class=\"hljs-number\">63</span>, \n <span class=\"hljs-string\">\"estimatedNrItems\"</span> : <span class=\"hljs-number\">1</span>, \n <span class=\"hljs-string\">\"initialize\"</span> : <span class=\"hljs-literal\">true</span> \n } \n ], \n <span class=\"hljs-string\">\"warnings\"</span> : [ ], \n <span class=\"hljs-string\">\"stats\"</span> : { \n <span class=\"hljs-string\">\"rulesExecuted\"</span> : <span class=\"hljs-number\">2</span>, \n <span class=\"hljs-string\">\"rulesSkipped\"</span> : <span class=\"hljs-number\">29</span>, \n <span class=\"hljs-string\">\"plansCreated\"</span> : <span class=\"hljs-number\">1</span> \n }, \n <span class=\"hljs-string\">\"error\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"code\"</span> : <span class=\"hljs-number\">200</span> \n}\n</code></pre>\n\n\n\n\n**Example:**\n Returning all plans\n\n<pre><code class=\"json\">shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/explain &lt;&lt;EOF\n{ \n <span class=\"hljs-string\">\"query\"</span> : <span class=\"hljs-string\">\"FOR p IN products FILTER p.id == 25 RETURN p\"</span>, \n <span class=\"hljs-string\">\"options\"</span> : { \n <span class=\"hljs-string\">\"allPlans\"</span> : <span class=\"hljs-literal\">true</span> \n } \n}\nEOF\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">200</span> OK\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\nx-content-type-options: nosniff\n\n{ \n <span class=\"hljs-string\">\"plans\"</span> : [ \n { \n <span class=\"hljs-string\">\"nodes\"</span> : [ \n { \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"SingletonNode\"</span>, \n <span class=\"hljs-string\">\"dependencies\"</span> : [ ], \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-number\">1</span>, \n <span class=\"hljs-string\">\"estimatedCost\"</span> : <span class=\"hljs-number\">1</span>, \n <span class=\"hljs-string\">\"estimatedNrItems\"</span> : <span class=\"hljs-number\">1</span> \n }, \n { \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"IndexNode\"</span>, \n <span class=\"hljs-string\">\"dependencies\"</span> : [ \n <span class=\"hljs-number\">1</span> \n ], \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-number\">6</span>, \n <span class=\"hljs-string\">\"estimatedCost\"</span> : <span class=\"hljs-number\">1.99</span>, \n <span class=\"hljs-string\">\"estimatedNrItems\"</span> : <span class=\"hljs-number\">1</span>, \n <span class=\"hljs-string\">\"database\"</span> : <span class=\"hljs-string\">\"_system\"</span>, \n <span class=\"hljs-string\">\"collection\"</span> : <span class=\"hljs-string\">\"products\"</span>, \n <span class=\"hljs-string\">\"satellite\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"outVariable\"</span> : { \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"p\"</span> \n }, \n <span class=\"hljs-string\">\"indexes\"</span> : [ \n { \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-string\">\"11359\"</span>, \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"hash\"</span>, \n <span class=\"hljs-string\">\"fields\"</span> : [ \n <span class=\"hljs-string\">\"id\"</span> \n ], \n <span class=\"hljs-string\">\"selectivityEstimate\"</span> : <span class=\"hljs-number\">1</span>, \n <span class=\"hljs-string\">\"unique\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"sparse\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"deduplicate\"</span> : <span class=\"hljs-literal\">true</span> \n } \n ], \n <span class=\"hljs-string\">\"condition\"</span> : { \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"n-ary or\"</span>, \n <span class=\"hljs-string\">\"subNodes\"</span> : [ \n { \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"n-ary and\"</span>, \n <span class=\"hljs-string\">\"subNodes\"</span> : [ \n { \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"compare ==\"</span>, \n <span class=\"hljs-string\">\"subNodes\"</span> : [ \n { \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"attribute access\"</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"id\"</span>, \n <span class=\"hljs-string\">\"subNodes\"</span> : [ \n { \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"reference\"</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"p\"</span>, \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-number\">0</span> \n } \n ] \n }, \n { \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"value\"</span>, \n <span class=\"hljs-string\">\"value\"</span> : <span class=\"hljs-number\">25</span> \n } \n ] \n } \n ] \n } \n ] \n }, \n <span class=\"hljs-string\">\"reverse\"</span> : <span class=\"hljs-literal\">false</span> \n }, \n { \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"ReturnNode\"</span>, \n <span class=\"hljs-string\">\"dependencies\"</span> : [ \n <span class=\"hljs-number\">6</span> \n ], \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-number\">5</span>, \n <span class=\"hljs-string\">\"estimatedCost\"</span> : <span class=\"hljs-number\">2.99</span>, \n <span class=\"hljs-string\">\"estimatedNrItems\"</span> : <span class=\"hljs-number\">1</span>, \n <span class=\"hljs-string\">\"inVariable\"</span> : { \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"p\"</span> \n } \n } \n ], \n <span class=\"hljs-string\">\"rules\"</span> : [ \n <span class=\"hljs-string\">\"use-indexes\"</span>, \n <span class=\"hljs-string\">\"remove-filter-covered-by-index\"</span>, \n <span class=\"hljs-string\">\"remove-unnecessary-calculations-2\"</span> \n ], \n <span class=\"hljs-string\">\"collections\"</span> : [ \n { \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"products\"</span>, \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"read\"</span> \n } \n ], \n <span class=\"hljs-string\">\"variables\"</span> : [ \n { \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-number\">2</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"1\"</span> \n }, \n { \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"p\"</span> \n } \n ], \n <span class=\"hljs-string\">\"estimatedCost\"</span> : <span class=\"hljs-number\">2.99</span>, \n <span class=\"hljs-string\">\"estimatedNrItems\"</span> : <span class=\"hljs-number\">1</span>, \n <span class=\"hljs-string\">\"initialize\"</span> : <span class=\"hljs-literal\">true</span> \n } \n ], \n <span class=\"hljs-string\">\"warnings\"</span> : [ ], \n <span class=\"hljs-string\">\"stats\"</span> : { \n <span class=\"hljs-string\">\"rulesExecuted\"</span> : <span class=\"hljs-number\">31</span>, \n <span class=\"hljs-string\">\"rulesSkipped\"</span> : <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-string\">\"plansCreated\"</span> : <span class=\"hljs-number\">1</span> \n }, \n <span class=\"hljs-string\">\"error\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"code\"</span> : <span class=\"hljs-number\">200</span> \n}\n</code></pre>\n\n\n\n\n**Example:**\n A query that produces a warning\n\n<pre><code class=\"json\">shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/explain &lt;&lt;EOF\n{ \n <span class=\"hljs-string\">\"query\"</span> : <span class=\"hljs-string\">\"FOR i IN 1..10 RETURN 1 / 0\"</span> \n}\nEOF\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">200</span> OK\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\nx-content-type-options: nosniff\n\n{ \n <span class=\"hljs-string\">\"plan\"</span> : { \n <span class=\"hljs-string\">\"nodes\"</span> : [ \n { \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"SingletonNode\"</span>, \n <span class=\"hljs-string\">\"dependencies\"</span> : [ ], \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-number\">1</span>, \n <span class=\"hljs-string\">\"estimatedCost\"</span> : <span class=\"hljs-number\">1</span>, \n <span class=\"hljs-string\">\"estimatedNrItems\"</span> : <span class=\"hljs-number\">1</span> \n }, \n { \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"CalculationNode\"</span>, \n <span class=\"hljs-string\">\"dependencies\"</span> : [ \n <span class=\"hljs-number\">1</span> \n ], \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-number\">2</span>, \n <span class=\"hljs-string\">\"estimatedCost\"</span> : <span class=\"hljs-number\">2</span>, \n <span class=\"hljs-string\">\"estimatedNrItems\"</span> : <span class=\"hljs-number\">1</span>, \n <span class=\"hljs-string\">\"expression\"</span> : { \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"range\"</span>, \n <span class=\"hljs-string\">\"subNodes\"</span> : [ \n { \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"value\"</span>, \n <span class=\"hljs-string\">\"value\"</span> : <span class=\"hljs-number\">1</span> \n }, \n { \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"value\"</span>, \n <span class=\"hljs-string\">\"value\"</span> : <span class=\"hljs-number\">10</span> \n } \n ] \n }, \n <span class=\"hljs-string\">\"outVariable\"</span> : { \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-number\">2</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"1\"</span> \n }, \n <span class=\"hljs-string\">\"canThrow\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"expressionType\"</span> : <span class=\"hljs-string\">\"simple\"</span> \n }, \n { \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"CalculationNode\"</span>, \n <span class=\"hljs-string\">\"dependencies\"</span> : [ \n <span class=\"hljs-number\">2</span> \n ], \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-number\">4</span>, \n <span class=\"hljs-string\">\"estimatedCost\"</span> : <span class=\"hljs-number\">3</span>, \n <span class=\"hljs-string\">\"estimatedNrItems\"</span> : <span class=\"hljs-number\">1</span>, \n <span class=\"hljs-string\">\"expression\"</span> : { \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"value\"</span>, \n <span class=\"hljs-string\">\"value\"</span> : <span class=\"hljs-literal\">null</span> \n }, \n <span class=\"hljs-string\">\"outVariable\"</span> : { \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-number\">4</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"3\"</span> \n }, \n <span class=\"hljs-string\">\"canThrow\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"expressionType\"</span> : <span class=\"hljs-string\">\"json\"</span> \n }, \n { \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"EnumerateListNode\"</span>, \n <span class=\"hljs-string\">\"dependencies\"</span> : [ \n <span class=\"hljs-number\">4</span> \n ], \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-number\">3</span>, \n <span class=\"hljs-string\">\"estimatedCost\"</span> : <span class=\"hljs-number\">13</span>, \n <span class=\"hljs-string\">\"estimatedNrItems\"</span> : <span class=\"hljs-number\">10</span>, \n <span class=\"hljs-string\">\"inVariable\"</span> : { \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-number\">2</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"1\"</span> \n }, \n <span class=\"hljs-string\">\"outVariable\"</span> : { \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"i\"</span> \n } \n }, \n { \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"ReturnNode\"</span>, \n <span class=\"hljs-string\">\"dependencies\"</span> : [ \n <span class=\"hljs-number\">3</span> \n ], \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-number\">5</span>, \n <span class=\"hljs-string\">\"estimatedCost\"</span> : <span class=\"hljs-number\">23</span>, \n <span class=\"hljs-string\">\"estimatedNrItems\"</span> : <span class=\"hljs-number\">10</span>, \n <span class=\"hljs-string\">\"inVariable\"</span> : { \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-number\">4</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"3\"</span> \n } \n } \n ], \n <span class=\"hljs-string\">\"rules\"</span> : [ \n <span class=\"hljs-string\">\"move-calculations-up\"</span>, \n <span class=\"hljs-string\">\"move-calculations-up-2\"</span> \n ], \n <span class=\"hljs-string\">\"collections\"</span> : [ ], \n <span class=\"hljs-string\">\"variables\"</span> : [ \n { \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-number\">4</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"3\"</span> \n }, \n { \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-number\">2</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"1\"</span> \n }, \n { \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"i\"</span> \n } \n ], \n <span class=\"hljs-string\">\"estimatedCost\"</span> : <span class=\"hljs-number\">23</span>, \n <span class=\"hljs-string\">\"estimatedNrItems\"</span> : <span class=\"hljs-number\">10</span>, \n <span class=\"hljs-string\">\"initialize\"</span> : <span class=\"hljs-literal\">true</span> \n }, \n <span class=\"hljs-string\">\"cacheable\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"warnings\"</span> : [ \n { \n <span class=\"hljs-string\">\"code\"</span> : <span class=\"hljs-number\">1562</span>, \n <span class=\"hljs-string\">\"message\"</span> : <span class=\"hljs-string\">\"division by zero\"</span> \n } \n ], \n <span class=\"hljs-string\">\"stats\"</span> : { \n <span class=\"hljs-string\">\"rulesExecuted\"</span> : <span class=\"hljs-number\">31</span>, \n <span class=\"hljs-string\">\"rulesSkipped\"</span> : <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-string\">\"plansCreated\"</span> : <span class=\"hljs-number\">1</span> \n }, \n <span class=\"hljs-string\">\"error\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"code\"</span> : <span class=\"hljs-number\">200</span> \n}\n</code></pre>\n\n\n\n\n**Example:**\n Invalid query (missing bind parameter)\n\n<pre><code class=\"json\">shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/explain &lt;&lt;EOF\n{ \n <span class=\"hljs-string\">\"query\"</span> : <span class=\"hljs-string\">\"FOR p IN products FILTER p.id == @id LIMIT 2 RETURN p.n\"</span> \n}\nEOF\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">400</span> Bad Request\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\nx-content-type-options: nosniff\n\n{ \n <span class=\"hljs-string\">\"error\"</span> : <span class=\"hljs-literal\">true</span>, \n <span class=\"hljs-string\">\"errorMessage\"</span> : <span class=\"hljs-string\">\"no value specified for declared bind parameter 'id' (while parsing)\"</span>, \n <span class=\"hljs-string\">\"code\"</span> : <span class=\"hljs-number\">400</span>, \n <span class=\"hljs-string\">\"errorNum\"</span> : <span class=\"hljs-number\">1551</span> \n}\n</code></pre>\n\n\n\n\n**Example:**\n The data returned in the **plan** attribute of the result contains one element per AQL top-level statement\n(i.e. `FOR`, `RETURN`, `FILTER` etc.). If the query optimizer removed some unnecessary statements,\nthe result might also contain less elements than there were top-level statements in the AQL query.\n\nThe following example shows a query with a non-sensible filter condition that\nthe optimizer has removed so that there are less top-level statements.\n\n<pre><code class=\"json\">shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/explain &lt;&lt;EOF\n{ \"query\" : \"FOR i IN [ 1, 2, 3 ] FILTER 1 == 2 RETURN i\" }\nEOF\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">200</span> OK\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\nx-content-type-options: nosniff\n\n{ \n <span class=\"hljs-string\">\"plan\"</span> : { \n <span class=\"hljs-string\">\"nodes\"</span> : [ \n { \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"SingletonNode\"</span>, \n <span class=\"hljs-string\">\"dependencies\"</span> : [ ], \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-number\">1</span>, \n <span class=\"hljs-string\">\"estimatedCost\"</span> : <span class=\"hljs-number\">1</span>, \n <span class=\"hljs-string\">\"estimatedNrItems\"</span> : <span class=\"hljs-number\">1</span> \n }, \n { \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"CalculationNode\"</span>, \n <span class=\"hljs-string\">\"dependencies\"</span> : [ \n <span class=\"hljs-number\">1</span> \n ], \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-number\">2</span>, \n <span class=\"hljs-string\">\"estimatedCost\"</span> : <span class=\"hljs-number\">2</span>, \n <span class=\"hljs-string\">\"estimatedNrItems\"</span> : <span class=\"hljs-number\">1</span>, \n <span class=\"hljs-string\">\"expression\"</span> : { \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"array\"</span>, \n <span class=\"hljs-string\">\"subNodes\"</span> : [ \n { \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"value\"</span>, \n <span class=\"hljs-string\">\"value\"</span> : <span class=\"hljs-number\">1</span> \n }, \n { \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"value\"</span>, \n <span class=\"hljs-string\">\"value\"</span> : <span class=\"hljs-number\">2</span> \n }, \n { \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"value\"</span>, \n <span class=\"hljs-string\">\"value\"</span> : <span class=\"hljs-number\">3</span> \n } \n ] \n }, \n <span class=\"hljs-string\">\"outVariable\"</span> : { \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-number\">2</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"1\"</span> \n }, \n <span class=\"hljs-string\">\"canThrow\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"expressionType\"</span> : <span class=\"hljs-string\">\"json\"</span> \n }, \n { \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"NoResultsNode\"</span>, \n <span class=\"hljs-string\">\"dependencies\"</span> : [ \n <span class=\"hljs-number\">2</span> \n ], \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-number\">7</span>, \n <span class=\"hljs-string\">\"estimatedCost\"</span> : <span class=\"hljs-number\">0.5</span>, \n <span class=\"hljs-string\">\"estimatedNrItems\"</span> : <span class=\"hljs-number\">0</span> \n }, \n { \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"EnumerateListNode\"</span>, \n <span class=\"hljs-string\">\"dependencies\"</span> : [ \n <span class=\"hljs-number\">7</span> \n ], \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-number\">3</span>, \n <span class=\"hljs-string\">\"estimatedCost\"</span> : <span class=\"hljs-number\">0.5</span>, \n <span class=\"hljs-string\">\"estimatedNrItems\"</span> : <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-string\">\"inVariable\"</span> : { \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-number\">2</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"1\"</span> \n }, \n <span class=\"hljs-string\">\"outVariable\"</span> : { \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"i\"</span> \n } \n }, \n { \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"ReturnNode\"</span>, \n <span class=\"hljs-string\">\"dependencies\"</span> : [ \n <span class=\"hljs-number\">3</span> \n ], \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-number\">6</span>, \n <span class=\"hljs-string\">\"estimatedCost\"</span> : <span class=\"hljs-number\">0.5</span>, \n <span class=\"hljs-string\">\"estimatedNrItems\"</span> : <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-string\">\"inVariable\"</span> : { \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"i\"</span> \n } \n } \n ], \n <span class=\"hljs-string\">\"rules\"</span> : [ \n <span class=\"hljs-string\">\"move-calculations-up\"</span>, \n <span class=\"hljs-string\">\"move-filters-up\"</span>, \n <span class=\"hljs-string\">\"remove-unnecessary-filters\"</span>, \n <span class=\"hljs-string\">\"remove-unnecessary-calculations\"</span> \n ], \n <span class=\"hljs-string\">\"collections\"</span> : [ ], \n <span class=\"hljs-string\">\"variables\"</span> : [ \n { \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-number\">4</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"3\"</span> \n }, \n { \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-number\">2</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"1\"</span> \n }, \n { \n <span class=\"hljs-string\">\"id\"</span> : <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"i\"</span> \n } \n ], \n <span class=\"hljs-string\">\"estimatedCost\"</span> : <span class=\"hljs-number\">0.5</span>, \n <span class=\"hljs-string\">\"estimatedNrItems\"</span> : <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-string\">\"initialize\"</span> : <span class=\"hljs-literal\">true</span> \n }, \n <span class=\"hljs-string\">\"cacheable\"</span> : <span class=\"hljs-literal\">true</span>, \n <span class=\"hljs-string\">\"warnings\"</span> : [ ], \n <span class=\"hljs-string\">\"stats\"</span> : { \n <span class=\"hljs-string\">\"rulesExecuted\"</span> : <span class=\"hljs-number\">31</span>, \n <span class=\"hljs-string\">\"rulesSkipped\"</span> : <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-string\">\"plansCreated\"</span> : <span class=\"hljs-number\">1</span> \n }, \n <span class=\"hljs-string\">\"error\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"code\"</span> : <span class=\"hljs-number\">200</span> \n}\n</code></pre>\n\n\n\n\n",
"parameters": [
{
"in": "body",
"name": "Json Request Body",
"required": true,
"schema": {
"$ref": "#/definitions/post_api_explain"
},
"x-description-offset": 54
}
],
"responses": {
"200": {
"description": "If the query is valid, the server will respond with *HTTP 200* and\nreturn the optimal execution plan in the *plan* attribute of the response.\nIf option *allPlans* was set in the request, an array of plans will be returned\nin the *allPlans* attribute instead.\n\n"
},
"400": {
"description": "The server will respond with *HTTP 400* in case of a malformed request,\nor if the query contains a parse error. The body of the response will\ncontain the error details embedded in a JSON object.\nOmitting bind variables if the query references any will also result\nin an *HTTP 400* error.\n\n"
},
"404": {
"description": "The server will respond with *HTTP 404* in case a non-existing collection is\naccessed in the query.\n\n"
}
},
"summary": "Explain an AQL query",
"tags": [
"AQL"
],
"x-examples": [],
"x-filename": "AQL - /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/get_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/post_api_explain.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/post_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/delete_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md"
}
},
"/_api/export": {
"post": {
"description": "\n**A JSON object with these properties is required:**\n\n - **count**: boolean flag that indicates whether the number of documents\n in the result set should be returned in the \"count\" attribute of the result\n (optional).\n Calculating the \"count\" attribute might in the future have a performance\n impact so this option is turned off by default, and \"count\" is only returned\n when requested.\n - **restrict**:\n - **fields** (string): Contains an array of attribute names to *include* or *exclude*. Matching of attribute names\n for *inclusion* or *exclusion* will be done on the top level only.\n Specifying names of nested attributes is not supported at the moment.\n - **type**: has to be be set to either *include* or *exclude* depending on which you want to use\n - **batchSize**: maximum number of result documents to be transferred from\n the server to the client in one roundtrip (optional). If this attribute is\n not set, a server-controlled default value will be used.\n - **flush**: if set to *true*, a WAL flush operation will be executed prior to the\n export. The flush operation will start copying documents from the WAL to the\n collection's datafiles. There will be an additional wait time of up\n to *flushWait* seconds after the flush to allow the WAL collector to change\n the adjusted document meta-data to point into the datafiles, too.\n The default value is *false* (i.e. no flush) so most recently inserted or\n updated\n documents from the collection might be missing in the export.\n - **flushWait**: maximum wait time in seconds after a flush operation. The default\n value is 10. This option only has an effect when *flush* is set to *true*.\n - **limit**: an optional limit value, determining the maximum number of documents to\n be included in the cursor. Omitting the *limit* attribute or setting it to 0 will\n lead to no limit being used. If a limit is used, it is undefined which documents\n from the collection will be included in the export and which will be excluded. \n This is because there is no natural order of documents in a collection.\n - **ttl**: an optional time-to-live for the cursor (in seconds). The cursor will be\n removed on the server automatically after the specified amount of time. This\n is useful to ensure garbage collection of cursors that are not fully fetched\n by clients. If not set, a server-defined value will be used.\n\n\n\n\nA call to this method creates a cursor containing all documents in the \nspecified collection. In contrast to other data-producing APIs, the internal\ndata structures produced by the export API are more lightweight, so it is\nthe preferred way to retrieve all documents from a collection.\n\nDocuments are returned in a similar manner as in the `/_api/cursor` REST API. \nIf all documents of the collection fit into the first batch, then no cursor\nwill be created, and the result object's *hasMore* attribute will be set to\n*false*. If not all documents fit into the first batch, then the result \nobject's *hasMore* attribute will be set to *true*, and the *id* attribute\nof the result will contain a cursor id.\n\nThe order in which the documents are returned is not specified.\n\nBy default, only those documents from the collection will be returned that are\nstored in the collection's datafiles. Documents that are present in the write-ahead\nlog (WAL) at the time the export is run will not be exported.\n\nTo export these documents as well, the caller can issue a WAL flush request\nbefore calling the export API or set the *flush* attribute. Setting the *flush*\noption will trigger a WAL flush before the export so documents get copied from \nthe WAL to the collection datafiles.\n\nIf the result set can be created by the server, the server will respond with\n*HTTP 201*. The body of the response will contain a JSON object with the\nresult set.\n\nThe returned JSON object has the following properties:\n\n- *error*: boolean flag to indicate that an error occurred (*false*\n in this case)\n\n- *code*: the HTTP status code\n\n- *result*: an array of result documents (might be empty if the collection was empty)\n\n- *hasMore*: a boolean indicator whether there are more results\n available for the cursor on the server\n\n- *count*: the total number of result documents available (only\n available if the query was executed with the *count* attribute set)\n\n- *id*: id of temporary cursor created on the server (optional, see above)\n\nIf the JSON representation is malformed or the query specification is\nmissing from the request, the server will respond with *HTTP 400*.\n\nThe body of the response will contain a JSON object with additional error\ndetails. The object has the following attributes:\n\n- *error*: boolean flag to indicate that an error occurred (*true* in this case)\n\n- *code*: the HTTP status code\n\n- *errorNum*: the server error number\n\n- *errorMessage*: a descriptive error message\n\nClients should always delete an export cursor result as early as possible because a\nlingering export cursor will prevent the underlying collection from being\ncompacted or unloaded. By default, unused cursors will be deleted automatically \nafter a server-defined idle time, and clients can adjust this idle time by setting\nthe *ttl* value.\n\nNote: this API is currently not supported on cluster coordinators.\n\n",
"parameters": [
{
"in": "body",
"name": "Json Request Body",
"required": true,
"schema": {
"$ref": "#/definitions/post_api_export"
},
"x-description-offset": 54
},
{
"description": "The name of the collection to export.\n\n",
"in": "query",
"name": "collection",
"required": true,
"type": "string"
}
],
"responses": {
"201": {
"description": "is returned if the result set can be created by the server.\n\n"
},
"400": {
"description": "is returned if the JSON representation is malformed or the query specification is\nmissing from the request.\n\n"
},
"404": {
"description": "The server will respond with *HTTP 404* in case a non-existing collection is\naccessed in the query.\n\n"
},
"405": {
"description": "The server will respond with *HTTP 405* if an unsupported HTTP method is used.\n\n"
},
"501": {
"description": "The server will respond with *HTTP 501* if this API is called on a cluster\ncoordinator.\n\n\n\n"
}
},
"summary": "Create export cursor",
"tags": [
"Bulk"
],
"x-examples": [],
"x-filename": "Bulk - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Bulk/batch_processing.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Bulk/import_json.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Bulk/import_document.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Bulk/post_api_export.md"
}
},
"/_api/foxx": {
"get": {
"description": "\n\nFetches a list of services installed in the current database.\n\nReturns a list of objects with the following attributes:\n\n- *mount*: the mount path of the service\n- *development*: *true* if the service is running in development mode\n- *legacy*: *true* if the service is running in 2.8 legacy compatibility mode\n- *provides*: the service manifest's *provides* value or an empty object\n\nAdditionally the object may contain the following attributes if they have been set on the manifest:\n\n- *name*: a string identifying the service type\n- *version*: a semver-compatible version string\n\n",
"parameters": [
{
"description": "Whether or not system services should be excluded from the result.\n\n",
"in": "query",
"name": "excludeSystem",
"required": false,
"type": "boolean"
}
],
"responses": {
"200": {
"description": "Returned if the request was successful.\n\n\n"
}
},
"summary": "List installed services",
"tags": [
"Foxx"
],
"x-examples": [],
"x-filename": "Foxx - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_upgrade.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_tests_run.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_update.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_details.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_replace.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_list.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_run.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_replace.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_disable.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_readme.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_swagger.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_get.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_get.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_commit.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_uninstall.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_enable.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_list.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_update.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_bundle.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_install.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_replace.md"
},
"post": {
"description": "\n\nInstalls the given new service at the given mount path.\n\nThe request body can be any of the following formats:\n\n- `application/zip`: a raw zip bundle containing a service\n- `application/javascript`: a standalone JavaScript file\n- `application/json`: a service definition as JSON\n- `multipart/form-data`: a service definition as a multipart form\n\nA service definition is an object or form with the following properties or fields:\n\n- *configuration*: a JSON object describing configuration values\n- *dependencies*: a JSON object describing dependency settings\n- *source*: a fully qualified URL or an absolute path on the server's file system\n\nWhen using multipart data, the *source* field can also alternatively be a file field\ncontaining either a zip bundle or a standalone JavaScript file.\n\nWhen using a standalone JavaScript file the given file will be executed\nto define our service's HTTP endpoints. It is the same which would be defined\nin the field `main` of the service manifest.\n\nIf *source* is a URL, the URL must be reachable from the server.\nIf *source* is a file system path, the path will be resolved on the server.\nIn either case the path or URL is expected to resolve to a zip bundle,\nJavaScript file or (in case of a file system path) directory.\n\nNote that when using file system paths in a cluster with multiple coordinators\nthe file system path must resolve to equivalent files on every coordinator.\n\n",
"parameters": [
{
"description": "Mount path the service should be installed at.\n\n",
"in": "query",
"name": "mount",
"required": true,
"type": "string"
},
{
"description": "Set to `true` to enable development mode.\n\n",
"in": "query",
"name": "development",
"required": false,
"type": "boolean"
},
{
"description": "Set to `false` to not run the service's setup script.\n\n",
"in": "query",
"name": "setup",
"required": false,
"type": "boolean"
},
{
"description": "Set to `true` to install the service in 2.8 legacy compatibility mode.\n\n",
"in": "query",
"name": "legacy",
"required": false,
"type": "boolean"
}
],
"responses": {
"201": {
"description": "Returned if the request was successful.\n\n\n"
}
},
"summary": "Install new service",
"tags": [
"Foxx"
],
"x-examples": [],
"x-filename": "Foxx - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_upgrade.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_tests_run.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_update.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_details.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_replace.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_list.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_run.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_replace.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_disable.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_readme.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_swagger.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_get.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_get.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_commit.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_uninstall.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_enable.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_list.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_update.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_bundle.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_install.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_replace.md"
}
},
"/_api/foxx/commit": {
"post": {
"description": "\n\nCommits the local service state of the coordinator to the database.\n\nThis can be used to resolve service conflicts between coordinators that can not be fixed automatically due to missing data.\n\n",
"parameters": [
{
"description": "Overwrite existing service files in database even if they already exist.\n\n",
"in": "query",
"name": "replace",
"required": false,
"type": "boolean"
}
],
"responses": {
"204": {
"description": "Returned if the request was sucessful.\n\n\n"
}
},
"summary": "Commit local service state",
"tags": [
"Foxx"
],
"x-examples": [],
"x-filename": "Foxx - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_upgrade.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_tests_run.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_update.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_details.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_replace.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_list.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_run.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_replace.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_disable.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_readme.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_swagger.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_get.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_get.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_commit.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_uninstall.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_enable.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_list.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_update.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_bundle.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_install.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_replace.md"
}
},
"/_api/foxx/configuration": {
"get": {
"description": "\n\nFetches the current configuration for the service at the given mount path.\n\nReturns an object mapping the configuration option names to their definitions\nincluding a human-friendly *title* and the *current* value (if any).\n\n",
"parameters": [
{
"description": "Mount path of the installed service.\n\n",
"in": "query",
"name": "mount",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Returned if the request was sucessful.\n\n\n"
}
},
"summary": "Get configuration options",
"tags": [
"Foxx"
],
"x-examples": [],
"x-filename": "Foxx - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_upgrade.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_tests_run.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_update.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_details.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_replace.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_list.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_run.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_replace.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_disable.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_readme.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_swagger.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_get.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_get.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_commit.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_uninstall.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_enable.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_list.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_update.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_bundle.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_install.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_replace.md"
},
"patch": {
"description": "\n\nReplaces the given service's configuration.\n\nReturns an object mapping all configuration option names to their new values.\n\n",
"parameters": [
{
"description": "A JSON object mapping configuration option names to their new values.\nAny omitted options will be ignored.\n\n",
"in": "body",
"name": "Json Request Body",
"required": true,
"schema": {
"additionalProperties": {},
"type": "object"
},
"x-description-offset": 126
},
{
"description": "Mount path of the installed service.\n\n",
"in": "query",
"name": "mount",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Returned if the request was sucessful.\n\n\n"
}
},
"summary": "Update configuration options",
"tags": [
"Foxx"
],
"x-examples": [],
"x-filename": "Foxx - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_upgrade.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_tests_run.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_update.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_details.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_replace.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_list.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_run.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_replace.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_disable.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_readme.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_swagger.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_get.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_get.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_commit.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_uninstall.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_enable.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_list.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_update.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_bundle.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_install.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_replace.md"
},
"put": {
"description": "\n\nReplaces the given service's configuration completely.\n\nReturns an object mapping all configuration option names to their new values.\n\n",
"parameters": [
{
"description": "A JSON object mapping configuration option names to their new values.\nAny omitted options will be reset to their default values or marked as unconfigured.\n\n",
"in": "body",
"name": "Json Request Body",
"required": true,
"schema": {
"additionalProperties": {},
"type": "object"
},
"x-description-offset": 137
},
{
"description": "Mount path of the installed service.\n\n",
"in": "query",
"name": "mount",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Returned if the request was sucessful.\n\n\n"
}
},
"summary": "Replace configuration options",
"tags": [
"Foxx"
],
"x-examples": [],
"x-filename": "Foxx - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_upgrade.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_tests_run.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_update.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_details.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_replace.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_list.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_run.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_replace.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_disable.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_readme.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_swagger.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_get.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_get.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_commit.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_uninstall.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_enable.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_list.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_update.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_bundle.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_install.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_replace.md"
}
},
"/_api/foxx/dependencies": {
"get": {
"description": "\n\nFetches the current dependencies for service at the given mount path.\n\nReturns an object mapping the dependency names to their definitions\nincluding a human-friendly *title* and the *current* mount path (if any).\n\n",
"parameters": [
{
"description": "Mount path of the installed service.\n\n",
"in": "query",
"name": "mount",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Returned if the request was sucessful.\n\n\n"
}
},
"summary": "Get dependency options",
"tags": [
"Foxx"
],
"x-examples": [],
"x-filename": "Foxx - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_upgrade.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_tests_run.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_update.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_details.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_replace.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_list.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_run.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_replace.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_disable.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_readme.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_swagger.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_get.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_get.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_commit.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_uninstall.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_enable.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_list.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_update.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_bundle.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_install.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_replace.md"
},
"patch": {
"description": "\n\nReplaces the given service's dependencies.\n\nReturns an object mapping all dependency names to their new mount paths.\n\n",
"parameters": [
{
"description": "A JSON object mapping dependency names to their new mount paths.\nAny omitted dependencies will be ignored.\n\n",
"in": "body",
"name": "Json Request Body",
"required": true,
"schema": {
"additionalProperties": {},
"type": "object"
},
"x-description-offset": 120
},
{
"description": "Mount path of the installed service.\n\n",
"in": "query",
"name": "mount",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Returned if the request was sucessful.\n\n\n"
}
},
"summary": "Update dependencies options",
"tags": [
"Foxx"
],
"x-examples": [],
"x-filename": "Foxx - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_upgrade.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_tests_run.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_update.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_details.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_replace.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_list.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_run.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_replace.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_disable.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_readme.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_swagger.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_get.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_get.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_commit.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_uninstall.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_enable.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_list.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_update.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_bundle.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_install.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_replace.md"
},
"put": {
"description": "\n\nReplaces the given service's dependencies completely.\n\nReturns an object mapping all dependency names to their new mount paths.\n\n",
"parameters": [
{
"description": "A JSON object mapping dependency names to their new mount paths.\nAny omitted dependencies will be disabled.\n\n",
"in": "body",
"name": "Json Request Body",
"required": true,
"schema": {
"additionalProperties": {},
"type": "object"
},
"x-description-offset": 131
},
{
"description": "Mount path of the installed service.\n\n",
"in": "query",
"name": "mount",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Returned if the request was sucessful.\n\n\n"
}
},
"summary": "Replace dependencies options",
"tags": [
"Foxx"
],
"x-examples": [],
"x-filename": "Foxx - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_upgrade.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_tests_run.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_update.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_details.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_replace.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_list.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_run.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_replace.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_disable.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_readme.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_swagger.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_get.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_get.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_commit.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_uninstall.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_enable.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_list.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_update.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_bundle.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_install.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_replace.md"
}
},
"/_api/foxx/development": {
"delete": {
"description": "\n\nPuts the service at the given mount path into production mode.\n\nWhen running ArangoDB in a cluster with multiple coordinators this will\nreplace the service on all other coordinators with the version on this\ncoordinator.\n\n",
"parameters": [
{
"description": "Mount path of the installed service.\n\n",
"in": "query",
"name": "mount",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Returned if the request was sucessful.\n\n\n"
}
},
"summary": "Disable development mode",
"tags": [
"Foxx"
],
"x-examples": [],
"x-filename": "Foxx - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_upgrade.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_tests_run.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_update.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_details.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_replace.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_list.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_run.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_replace.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_disable.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_readme.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_swagger.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_get.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_get.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_commit.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_uninstall.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_enable.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_list.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_update.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_bundle.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_install.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_replace.md"
},
"post": {
"description": "\n\nPuts the service into development mode.\n\nWhile the service is running in development mode the service will be reloaded\nfrom the filesystem and its setup script (if any) will be re-executed every\ntime the service handles a request.\n\nWhen running ArangoDB in a cluster with multiple coordinators note that changes\nto the filesystem on one coordinator will not be reflected across the other\ncoordinators. This means you should treat your coordinators as inconsistent\nas long as any service is running in development mode.\n\n",
"parameters": [
{
"description": "Mount path of the installed service.\n\n",
"in": "query",
"name": "mount",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Returned if the request was sucessful.\n\n\n"
}
},
"summary": "Enable development mode",
"tags": [
"Foxx"
],
"x-examples": [],
"x-filename": "Foxx - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_upgrade.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_tests_run.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_update.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_details.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_replace.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_list.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_run.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_replace.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_disable.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_readme.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_swagger.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_get.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_get.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_commit.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_uninstall.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_enable.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_list.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_update.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_bundle.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_install.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_replace.md"
}
},
"/_api/foxx/download": {
"post": {
"description": "\n\nDownloads a zip bundle of the service directory.\n\nWhen development mode is enabled, this always creates a new bundle.\n\nOtherwise the bundle will represent the version of a service that\nis installed on that ArangoDB instance.\n\n",
"parameters": [
{
"description": "Mount path of the installed service.\n\n",
"in": "query",
"name": "mount",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Returned if the request was sucessful.\n\n"
},
"400": {
"description": "Returned if the mount path is unknown.\n\n\n"
}
},
"summary": "Download service bundle",
"tags": [
"Foxx"
],
"x-examples": [],
"x-filename": "Foxx - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_upgrade.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_tests_run.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_update.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_details.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_replace.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_list.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_run.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_replace.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_disable.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_readme.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_swagger.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_get.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_get.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_commit.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_uninstall.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_enable.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_list.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_update.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_bundle.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_install.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_replace.md"
}
},
"/_api/foxx/readme": {
"get": {
"description": "\n\nFetches the service's README or README.md file's contents if any.\n\n",
"parameters": [
{
"description": "Mount path of the installed service.\n\n",
"in": "query",
"name": "mount",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Returned if the request was sucessful.\n\n"
},
"204": {
"description": "Returned if no README file was found.\n\n\n"
}
},
"summary": "Service README",
"tags": [
"Foxx"
],
"x-examples": [],
"x-filename": "Foxx - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_upgrade.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_tests_run.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_update.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_details.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_replace.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_list.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_run.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_replace.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_disable.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_readme.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_swagger.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_get.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_get.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_commit.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_uninstall.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_enable.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_list.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_update.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_bundle.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_install.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_replace.md"
}
},
"/_api/foxx/scripts": {
"get": {
"description": "\n\nFetches a list of the scripts defined by the service.\n\nReturns an object mapping the raw script names to human-friendly names.\n\n",
"parameters": [
{
"description": "Mount path of the installed service.\n\n",
"in": "query",
"name": "mount",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Returned if the request was sucessful.\n\n\n"
}
},
"summary": "List service scripts",
"tags": [
"Foxx"
],
"x-examples": [],
"x-filename": "Foxx - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_upgrade.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_tests_run.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_update.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_details.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_replace.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_list.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_run.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_replace.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_disable.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_readme.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_swagger.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_get.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_get.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_commit.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_uninstall.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_enable.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_list.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_update.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_bundle.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_install.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_replace.md"
}
},
"/_api/foxx/scripts/{name}": {
"post": {
"description": "\n\nRuns the given script for the service at the given mount path.\n\nReturns the exports of the script, if any.\n\n",
"parameters": [
{
"description": "An arbitrary JSON value that will be parsed and passed to the\nscript as its first argument.\n\n",
"in": "body",
"name": "Json Request Body",
"required": false,
"schema": {
"additionalProperties": {},
"type": "object"
},
"x-description-offset": 110
},
{
"description": "Name of the script to run.\n\n",
"in": "query",
"name": "name",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Returned if the request was sucessful.\n\n\n"
}
},
"summary": "Run service script",
"tags": [
"Foxx"
],
"x-examples": [],
"x-filename": "Foxx - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_upgrade.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_tests_run.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_update.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_details.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_replace.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_list.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_run.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_replace.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_disable.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_readme.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_swagger.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_get.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_get.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_commit.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_uninstall.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_enable.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_list.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_update.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_bundle.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_install.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_replace.md"
}
},
"/_api/foxx/service": {
"delete": {
"description": "\n\nRemoves the service at the given mount path from the database and file system.\n\nReturns an empty response on success.\n\n",
"parameters": [
{
"description": "Mount path of the installed service.\n\n",
"in": "query",
"name": "mount",
"required": true,
"type": "string"
},
{
"description": "Set to `false` to not run the service's teardown script.\n\n",
"in": "query",
"name": "teardown",
"required": false,
"type": "boolean"
}
],
"responses": {
"204": {
"description": "Returned if the request was successful.\n\n\n"
}
},
"summary": "Uninstall service",
"tags": [
"Foxx"
],
"x-examples": [],
"x-filename": "Foxx - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_upgrade.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_tests_run.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_update.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_details.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_replace.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_list.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_run.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_replace.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_disable.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_readme.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_swagger.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_get.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_get.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_commit.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_uninstall.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_enable.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_list.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_update.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_bundle.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_install.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_replace.md"
},
"get": {
"description": "\n\nFetches detailed information for the service at the given mount path.\n\nReturns an object with the following attributes:\n\n- *mount*: the mount path of the service\n- *path*: the local file system path of the service\n- *development*: *true* if the service is running in development mode\n- *legacy*: *true* if the service is running in 2.8 legacy compatibility mode\n- *manifest*: the normalized JSON manifest of the service\n\nAdditionally the object may contain the following attributes if they have been set on the manifest:\n\n- *name*: a string identifying the service type\n- *version*: a semver-compatible version string\n\n",
"parameters": [
{
"description": "Mount path of the installed service.\n\n",
"in": "query",
"name": "mount",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Returned if the request was successful.\n\n"
},
"400": {
"description": "Returned if the mount path is unknown.\n\n\n"
}
},
"summary": "Service description",
"tags": [
"Foxx"
],
"x-examples": [],
"x-filename": "Foxx - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_upgrade.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_tests_run.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_update.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_details.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_replace.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_list.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_run.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_replace.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_disable.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_readme.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_swagger.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_get.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_get.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_commit.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_uninstall.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_enable.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_list.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_update.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_bundle.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_install.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_replace.md"
},
"patch": {
"description": "\n\nInstalls the given new service on top of the service currently installed at the given mount path.\nThis is only recommended for switching between different versions of the same service.\n\nUnlike replacing a service, upgrading a service retains the old service's configuration\nand dependencies (if any) and should therefore only be used to migrate an existing service\nto a newer or equivalent service.\n\nThe request body can be any of the following formats:\n\n- `application/zip`: a raw zip bundle containing a service\n- `application/javascript`: a standalone JavaScript file\n- `application/json`: a service definition as JSON\n- `multipart/form-data`: a service definition as a multipart form\n\nA service definition is an object or form with the following properties or fields:\n\n- *configuration*: a JSON object describing configuration values\n- *dependencies*: a JSON object describing dependency settings\n- *source*: a fully qualified URL or an absolute path on the server's file system\n\nWhen using multipart data, the *source* field can also alternatively be a file field\ncontaining either a zip bundle or a standalone JavaScript file.\n\nWhen using a standalone JavaScript file the given file will be executed\nto define our service's HTTP endpoints. It is the same which would be defined\nin the field `main` of the service manifest.\n\nIf *source* is a URL, the URL must be reachable from the server.\nIf *source* is a file system path, the path will be resolved on the server.\nIn either case the path or URL is expected to resolve to a zip bundle,\nJavaScript file or (in case of a file system path) directory.\n\nNote that when using file system paths in a cluster with multiple coordinators\nthe file system path must resolve to equivalent files on every coordinator.\n\n",
"parameters": [
{
"description": "Mount path of the installed service.\n\n",
"in": "query",
"name": "mount",
"required": true,
"type": "string"
},
{
"description": "Set to `true` to run the old service's teardown script.\n\n",
"in": "query",
"name": "teardown",
"required": false,
"type": "boolean"
},
{
"description": "Set to `false` to not run the new service's setup script.\n\n",
"in": "query",
"name": "setup",
"required": false,
"type": "boolean"
},
{
"description": "Set to `true` to install the new service in 2.8 legacy compatibility mode.\n\n",
"in": "query",
"name": "legacy",
"required": false,
"type": "boolean"
}
],
"responses": {
"200": {
"description": "Returned if the request was successful.\n\n\n"
}
},
"summary": "Upgrade service",
"tags": [
"Foxx"
],
"x-examples": [],
"x-filename": "Foxx - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_upgrade.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_tests_run.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_update.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_details.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_replace.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_list.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_run.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_replace.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_disable.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_readme.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_swagger.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_get.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_get.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_commit.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_uninstall.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_enable.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_list.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_update.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_bundle.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_install.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_replace.md"
},
"put": {
"description": "\n\nRemoves the service at the given mount path from the database and file system.\nThen installs the given new service at the same mount path.\n\nThis is a slightly safer equivalent to performing an uninstall of the old service\nfollowed by installing the new service. The new service's main and script files\n(if any) will be checked for basic syntax errors before the old service is removed.\n\nThe request body can be any of the following formats:\n\n- `application/zip`: a raw zip bundle containing a service\n- `application/javascript`: a standalone JavaScript file\n- `application/json`: a service definition as JSON\n- `multipart/form-data`: a service definition as a multipart form\n\nA service definition is an object or form with the following properties or fields:\n\n- *configuration*: a JSON object describing configuration values\n- *dependencies*: a JSON object describing dependency settings\n- *source*: a fully qualified URL or an absolute path on the server's file system\n\nWhen using multipart data, the *source* field can also alternatively be a file field\ncontaining either a zip bundle or a standalone JavaScript file.\n\nWhen using a standalone JavaScript file the given file will be executed\nto define our service's HTTP endpoints. It is the same which would be defined\nin the field `main` of the service manifest.\n\nIf *source* is a URL, the URL must be reachable from the server.\nIf *source* is a file system path, the path will be resolved on the server.\nIn either case the path or URL is expected to resolve to a zip bundle,\nJavaScript file or (in case of a file system path) directory.\n\nNote that when using file system paths in a cluster with multiple coordinators\nthe file system path must resolve to equivalent files on every coordinator.\n\n",
"parameters": [
{
"description": "Mount path of the installed service.\n\n",
"in": "query",
"name": "mount",
"required": true,
"type": "string"
},
{
"description": "Set to `false` to not run the old service's teardown script.\n\n",
"in": "query",
"name": "teardown",
"required": false,
"type": "boolean"
},
{
"description": "Set to `false` to not run the new service's setup script.\n\n",
"in": "query",
"name": "setup",
"required": false,
"type": "boolean"
},
{
"description": "Set to `true` to install the new service in 2.8 legacy compatibility mode.\n\n",
"in": "query",
"name": "legacy",
"required": false,
"type": "boolean"
}
],
"responses": {
"200": {
"description": "Returned if the request was successful.\n\n\n"
}
},
"summary": "Replace service",
"tags": [
"Foxx"
],
"x-examples": [],
"x-filename": "Foxx - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_upgrade.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_tests_run.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_update.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_details.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_replace.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_list.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_run.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_replace.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_disable.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_readme.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_swagger.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_get.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_get.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_commit.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_uninstall.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_enable.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_list.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_update.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_bundle.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_install.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_replace.md"
}
},
"/_api/foxx/swagger": {
"get": {
"description": "\n\nFetches the Swagger API description for the service at the given mount path.\n\nThe response body will be an OpenAPI 2.0 compatible JSON description of the service API.\n\n",
"parameters": [
{
"description": "Mount path of the installed service.\n\n",
"in": "query",
"name": "mount",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Returned if the request was sucessful.\n\n\n"
}
},
"summary": "Swagger description",
"tags": [
"Foxx"
],
"x-examples": [],
"x-filename": "Foxx - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_upgrade.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_tests_run.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_update.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_details.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_replace.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_list.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_run.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_replace.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_disable.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_readme.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_swagger.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_get.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_get.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_commit.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_uninstall.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_enable.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_list.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_update.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_bundle.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_install.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_replace.md"
}
},
"/_api/foxx/tests": {
"post": {
"description": "\n\nRuns the tests for the service at the given mount path and returns the results.\n\nSupported test reporters are:\n\n- *default*: a simple list of test cases\n- *suite*: an object of test cases nested in suites\n- *stream*: a raw stream of test results\n- *xunit*: an XUnit/JUnit compatible structure\n- *tap*: a raw TAP compatible stream\n\nThe *Accept* request header can be used to further control the response format:\n\nWhen using the *stream* reporter `application/x-ldjson` will result\nin the response body being formatted as a newline-delimited JSON stream.\n\nWhen using the *tap* reporter `text/plain` or `text/*` will result\nin the response body being formatted as a plain text TAP report.\n\nWhen using the *xunit* reporter `application/xml` or `text/xml` will result\nin the response body being formatted as XML instead of JSONML.\n\nOtherwise the response body will be formatted as non-prettyprinted JSON.\n\n",
"parameters": [
{
"description": "Mount path of the installed service.\n\n",
"in": "query",
"name": "mount",
"required": true,
"type": "string"
},
{
"description": "Test reporter to use.\n\n",
"in": "query",
"name": "reporter",
"required": false,
"type": "string"
},
{
"description": "Use the matching format for the reporter, regardless of the *Accept* header.\n\n",
"in": "query",
"name": "idiomatic",
"required": false,
"type": "boolean"
}
],
"responses": {
"200": {
"description": "Returned if the request was sucessful.\n\n\n"
}
},
"summary": "Run service tests",
"tags": [
"Foxx"
],
"x-examples": [],
"x-filename": "Foxx - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_upgrade.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_tests_run.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_update.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_details.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_replace.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_list.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_run.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_replace.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_disable.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_readme.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_swagger.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_get.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_get.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_commit.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_uninstall.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_enable.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_list.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_update.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_bundle.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_install.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_replace.md"
}
},
"/_api/gharial": {
"get": {
"description": "\n\nLists all graph names stored in this database.\n\n\n\n\n**Example:**\n \n\n<pre><code class=\"json\">shell> curl --dump - http://localhost:8529/_api/gharial\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">200</span> OK\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\nx-content-type-options: nosniff\n\n{ \n <span class=\"hljs-string\">\"error\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"graphs\"</span> : [ \n { \n <span class=\"hljs-string\">\"_key\"</span> : <span class=\"hljs-string\">\"routeplanner\"</span>, \n <span class=\"hljs-string\">\"_id\"</span> : <span class=\"hljs-string\">\"_graphs/routeplanner\"</span>, \n <span class=\"hljs-string\">\"_rev\"</span> : <span class=\"hljs-string\">\"_WE2U3Tu--_\"</span>, \n <span class=\"hljs-string\">\"orphanCollections\"</span> : [ ], \n <span class=\"hljs-string\">\"edgeDefinitions\"</span> : [ \n { \n <span class=\"hljs-string\">\"collection\"</span> : <span class=\"hljs-string\">\"germanHighway\"</span>, \n <span class=\"hljs-string\">\"from\"</span> : [ \n <span class=\"hljs-string\">\"germanCity\"</span> \n ], \n <span class=\"hljs-string\">\"to\"</span> : [ \n <span class=\"hljs-string\">\"germanCity\"</span> \n ] \n }, \n { \n <span class=\"hljs-string\">\"collection\"</span> : <span class=\"hljs-string\">\"frenchHighway\"</span>, \n <span class=\"hljs-string\">\"from\"</span> : [ \n <span class=\"hljs-string\">\"frenchCity\"</span> \n ], \n <span class=\"hljs-string\">\"to\"</span> : [ \n <span class=\"hljs-string\">\"frenchCity\"</span> \n ] \n }, \n { \n <span class=\"hljs-string\">\"collection\"</span> : <span class=\"hljs-string\">\"internationalHighway\"</span>, \n <span class=\"hljs-string\">\"from\"</span> : [ \n <span class=\"hljs-string\">\"frenchCity\"</span>, \n <span class=\"hljs-string\">\"germanCity\"</span> \n ], \n <span class=\"hljs-string\">\"to\"</span> : [ \n <span class=\"hljs-string\">\"frenchCity\"</span>, \n <span class=\"hljs-string\">\"germanCity\"</span> \n ] \n } \n ], \n <span class=\"hljs-string\">\"numberOfShards\"</span> : <span class=\"hljs-number\">1</span>, \n <span class=\"hljs-string\">\"replicationFactor\"</span> : <span class=\"hljs-number\">1</span> \n }, \n { \n <span class=\"hljs-string\">\"_key\"</span> : <span class=\"hljs-string\">\"social\"</span>, \n <span class=\"hljs-string\">\"_id\"</span> : <span class=\"hljs-string\">\"_graphs/social\"</span>, \n <span class=\"hljs-string\">\"_rev\"</span> : <span class=\"hljs-string\">\"_WE2U3Ga--_\"</span>, \n <span class=\"hljs-string\">\"orphanCollections\"</span> : [ ], \n <span class=\"hljs-string\">\"edgeDefinitions\"</span> : [ \n { \n <span class=\"hljs-string\">\"collection\"</span> : <span class=\"hljs-string\">\"relation\"</span>, \n <span class=\"hljs-string\">\"from\"</span> : [ \n <span class=\"hljs-string\">\"female\"</span>, \n <span class=\"hljs-string\">\"male\"</span> \n ], \n <span class=\"hljs-string\">\"to\"</span> : [ \n <span class=\"hljs-string\">\"female\"</span>, \n <span class=\"hljs-string\">\"male\"</span> \n ] \n } \n ], \n <span class=\"hljs-string\">\"numberOfShards\"</span> : <span class=\"hljs-number\">1</span>, \n <span class=\"hljs-string\">\"replicationFactor\"</span> : <span class=\"hljs-number\">1</span> \n } \n ], \n <span class=\"hljs-string\">\"code\"</span> : <span class=\"hljs-number\">200</span> \n}\n</code></pre>\n\n\n\n\n",
"parameters": [],
"responses": {
"200": {
"description": "Is returned if the module is available and the graphs could be listed.\n\n"
}
},
"summary": "List all graphs",
"tags": [
"Graph"
],
"x-examples": [],
"x-filename": "Graph - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_list_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_definition_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_list_edge_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_replace_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_collection_add_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_replace_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_collection_remove_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_delete_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_definition_remove_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_delete_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_list_vertex_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_definition_add_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_drop_http_examples.md"
},
"post": {
"description": "\n\nThe creation of a graph requires the name of the graph and a\ndefinition of its edges.\n[See also edge definitions](../../Manual/Graphs/GeneralGraphs/Management.html#edge-definitions).\n\n\n**A JSON object with these properties is required:**\n\n - **orphanCollections**: An array of additional vertex collections.\n - **edgeDefinitions**: An array of definitions for the edge\n - **name**: Name of the graph.\n - **isSmart**: Define if the created graph should be smart.\n This only has effect in Enterprise version.\n - **options**:\n - **smartGraphAttribute**: The attribute name that is used to smartly shard the vertices of a graph.\n Every vertex in this Graph has to have this attribute.\n Cannot be modified later.\n - **numberOfShards**: The number of shards that is used for every collection within this graph.\n Cannot be modified later.\n\n\n\n\n\n**Example:**\n \n\n<pre><code class=\"json\">shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/gharial &lt;&lt;EOF\n{ \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"myGraph\"</span>, \n <span class=\"hljs-string\">\"edgeDefinitions\"</span> : [ \n { \n <span class=\"hljs-string\">\"collection\"</span> : <span class=\"hljs-string\">\"edges\"</span>, \n <span class=\"hljs-string\">\"from\"</span> : [ \n <span class=\"hljs-string\">\"startVertices\"</span> \n ], \n <span class=\"hljs-string\">\"to\"</span> : [ \n <span class=\"hljs-string\">\"endVertices\"</span> \n ] \n } \n ] \n}\nEOF\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">202</span> Accepted\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\netag: _WE2UzMm--_\nx-content-type-options: nosniff\n\n{ \n <span class=\"hljs-string\">\"error\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"graph\"</span> : { \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"myGraph\"</span>, \n <span class=\"hljs-string\">\"edgeDefinitions\"</span> : [ \n { \n <span class=\"hljs-string\">\"collection\"</span> : <span class=\"hljs-string\">\"edges\"</span>, \n <span class=\"hljs-string\">\"from\"</span> : [ \n <span class=\"hljs-string\">\"startVertices\"</span> \n ], \n <span class=\"hljs-string\">\"to\"</span> : [ \n <span class=\"hljs-string\">\"endVertices\"</span> \n ] \n } \n ], \n <span class=\"hljs-string\">\"orphanCollections\"</span> : [ ], \n <span class=\"hljs-string\">\"isSmart\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"numberOfShards\"</span> : <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-string\">\"replicationFactor\"</span> : <span class=\"hljs-number\">1</span>, \n <span class=\"hljs-string\">\"smartGraphAttribute\"</span> : <span class=\"hljs-string\">\"\"</span>, \n <span class=\"hljs-string\">\"_id\"</span> : <span class=\"hljs-string\">\"_graphs/myGraph\"</span>, \n <span class=\"hljs-string\">\"_rev\"</span> : <span class=\"hljs-string\">\"_WE2UzMm--_\"</span> \n }, \n <span class=\"hljs-string\">\"code\"</span> : <span class=\"hljs-number\">202</span> \n}\n</code></pre>\n\n\n\n\n**Example:**\n \n\n<pre><code class=\"json\">shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/gharial &lt;&lt;EOF\n{ \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"myGraph\"</span>, \n <span class=\"hljs-string\">\"edgeDefinitions\"</span> : [ \n { \n <span class=\"hljs-string\">\"collection\"</span> : <span class=\"hljs-string\">\"edges\"</span>, \n <span class=\"hljs-string\">\"from\"</span> : [ \n <span class=\"hljs-string\">\"startVertices\"</span> \n ], \n <span class=\"hljs-string\">\"to\"</span> : [ \n <span class=\"hljs-string\">\"endVertices\"</span> \n ] \n } \n ], \n <span class=\"hljs-string\">\"isSmart\"</span> : <span class=\"hljs-literal\">true</span>, \n <span class=\"hljs-string\">\"options\"</span> : { \n <span class=\"hljs-string\">\"numberOfShards\"</span> : <span class=\"hljs-number\">9</span>, \n <span class=\"hljs-string\">\"smartGraphAttribute\"</span> : <span class=\"hljs-string\">\"region\"</span> \n } \n}\nEOF\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">202</span> Accepted\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\netag: _WE2UzeW--_\nx-content-type-options: nosniff\n\n{ \n <span class=\"hljs-string\">\"error\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"graph\"</span> : { \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"myGraph\"</span>, \n <span class=\"hljs-string\">\"edgeDefinitions\"</span> : [ \n { \n <span class=\"hljs-string\">\"collection\"</span> : <span class=\"hljs-string\">\"edges\"</span>, \n <span class=\"hljs-string\">\"from\"</span> : [ \n <span class=\"hljs-string\">\"startVertices\"</span> \n ], \n <span class=\"hljs-string\">\"to\"</span> : [ \n <span class=\"hljs-string\">\"endVertices\"</span> \n ] \n } \n ], \n <span class=\"hljs-string\">\"orphanCollections\"</span> : [ ], \n <span class=\"hljs-string\">\"isSmart\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"numberOfShards\"</span> : <span class=\"hljs-number\">0</span>, \n <span class=\"hljs-string\">\"replicationFactor\"</span> : <span class=\"hljs-number\">1</span>, \n <span class=\"hljs-string\">\"smartGraphAttribute\"</span> : <span class=\"hljs-string\">\"\"</span>, \n <span class=\"hljs-string\">\"_id\"</span> : <span class=\"hljs-string\">\"_graphs/myGraph\"</span>, \n <span class=\"hljs-string\">\"_rev\"</span> : <span class=\"hljs-string\">\"_WE2UzeW--_\"</span> \n }, \n <span class=\"hljs-string\">\"code\"</span> : <span class=\"hljs-number\">202</span> \n}\n</code></pre>\n\n\n\n\n",
"parameters": [
{
"in": "body",
"name": "Json Request Body",
"required": true,
"schema": {
"$ref": "#/definitions/general_graph_create_http_examples"
},
"x-description-offset": 240
}
],
"responses": {
"201": {
"description": "Is returned if the graph could be created and waitForSync is enabled\nfor the `_graphs` collection. The response body contains the\ngraph configuration that has been stored.\n\n"
},
"202": {
"description": "Is returned if the graph could be created and waitForSync is disabled\nfor the `_graphs` collection. The response body contains the\ngraph configuration that has been stored.\n\n"
},
"409": {
"description": "Returned if there is a conflict storing the graph. This can occur\neither if a graph with this name is already stored, or if there is one\nedge definition with a the same\n[edge collection](../../Manual/Appendix/Glossary.html#edge-collection) but a\ndifferent signature used in any other graph.\n\n"
}
},
"summary": "Create a graph",
"tags": [
"Graph"
],
"x-examples": [],
"x-filename": "Graph - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_list_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_definition_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_list_edge_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_replace_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_collection_add_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_replace_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_collection_remove_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_delete_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_definition_remove_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_delete_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_list_vertex_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_definition_add_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_drop_http_examples.md"
}
},
"/_api/gharial/{graph-name}": {
"delete": {
"description": "\n\nRemoves a graph from the collection *_graphs*.\n\n\n\n\n**Example:**\n \n\n<pre><code class=\"json\">shell> curl -X DELETE --dump - http://localhost:8529/_api/gharial/social?dropCollections=true\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">202</span> Accepted\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\nx-content-type-options: nosniff\n\n{ \n <span class=\"hljs-string\">\"error\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"removed\"</span> : <span class=\"hljs-literal\">true</span>, \n <span class=\"hljs-string\">\"code\"</span> : <span class=\"hljs-number\">202</span> \n}\n</code></pre>\n\n\n\n",
"parameters": [],
"responses": {
"201": {
"description": "Is returned if the graph could be dropped and waitForSync is enabled\nfor the `_graphs` collection. \n\n"
},
"202": {
"description": "Returned if the graph could be dropped and waitForSync is disabled\nfor the `_graphs` collection.\n\n"
},
"404": {
"description": "Returned if no graph with this name could be found.\n\n"
}
},
"summary": "Drop a graph",
"tags": [
"Graph"
],
"x-examples": [],
"x-filename": "Graph - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_list_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_definition_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_list_edge_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_replace_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_collection_add_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_replace_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_collection_remove_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_delete_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_definition_remove_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_delete_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_list_vertex_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_definition_add_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_drop_http_examples.md"
},
"get": {
"description": "\n\nGets a graph from the collection *_graphs*.\nReturns the definition content of this graph.\n\n\n\n\n**Example:**\n \n\n<pre><code class=\"json\">shell> curl --dump - http://localhost:8529/_api/gharial/myGraph\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">200</span> OK\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\netag: _WE2U2ga--_\nx-content-type-options: nosniff\n\n{ \n <span class=\"hljs-string\">\"error\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"graph\"</span> : { \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"myGraph\"</span>, \n <span class=\"hljs-string\">\"edgeDefinitions\"</span> : [ \n { \n <span class=\"hljs-string\">\"collection\"</span> : <span class=\"hljs-string\">\"edges\"</span>, \n <span class=\"hljs-string\">\"from\"</span> : [ \n <span class=\"hljs-string\">\"startVertices\"</span> \n ], \n <span class=\"hljs-string\">\"to\"</span> : [ \n <span class=\"hljs-string\">\"endVertices\"</span> \n ] \n } \n ], \n <span class=\"hljs-string\">\"orphanCollections\"</span> : [ ], \n <span class=\"hljs-string\">\"isSmart\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"numberOfShards\"</span> : <span class=\"hljs-number\">1</span>, \n <span class=\"hljs-string\">\"replicationFactor\"</span> : <span class=\"hljs-number\">1</span>, \n <span class=\"hljs-string\">\"smartGraphAttribute\"</span> : <span class=\"hljs-string\">\"\"</span>, \n <span class=\"hljs-string\">\"_id\"</span> : <span class=\"hljs-string\">\"_graphs/myGraph\"</span>, \n <span class=\"hljs-string\">\"_rev\"</span> : <span class=\"hljs-string\">\"_WE2U2ga--_\"</span> \n }, \n <span class=\"hljs-string\">\"code\"</span> : <span class=\"hljs-number\">200</span> \n}\n</code></pre>\n\n\n\n\n",
"parameters": [],
"responses": {
"200": {
"description": "Returned if the graph could be found.\n\n"
},
"404": {
"description": "Returned if no graph with this name could be found.\n\n"
}
},
"summary": "Get a graph",
"tags": [
"Graph"
],
"x-examples": [],
"x-filename": "Graph - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_list_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_definition_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_list_edge_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_replace_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_collection_add_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_replace_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_collection_remove_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_delete_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_definition_remove_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_delete_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_list_vertex_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_definition_add_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_drop_http_examples.md"
}
},
"/_api/gharial/{graph-name}/edge": {
"get": {
"description": "\n\nLists all edge collections within this graph.\n\n\n\n\n**Example:**\n \n\n<pre><code class=\"json\">shell> curl --dump - http://localhost:8529/_api/gharial/social/edge\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">200</span> OK\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\nx-content-type-options: nosniff\n\n{ \n <span class=\"hljs-string\">\"error\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"collections\"</span> : [ \n <span class=\"hljs-string\">\"relation\"</span> \n ], \n <span class=\"hljs-string\">\"code\"</span> : <span class=\"hljs-number\">200</span> \n}\n</code></pre>\n\n\n\n\n",
"parameters": [],
"responses": {
"200": {
"description": "Is returned if the edge definitions could be listed.\n\n"
},
"404": {
"description": "Returned if no graph with this name could be found.\n\n"
}
},
"summary": "List edge definitions",
"tags": [
"Graph"
],
"x-examples": [],
"x-filename": "Graph - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_list_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_definition_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_list_edge_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_replace_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_collection_add_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_replace_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_collection_remove_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_delete_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_definition_remove_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_delete_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_list_vertex_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_definition_add_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_drop_http_examples.md"
},
"post": {
"description": "\n\nAdds an additional edge definition to the graph.\n\nThis edge definition has to contain a *collection* and an array of\neach *from* and *to* vertex collections. An edge definition can only\nbe added if this definition is either not used in any other graph, or\nit is used with exactly the same definition. It is not possible to\nstore a definition \"e\" from \"v1\" to \"v2\" in the one graph, and \"e\"\nfrom \"v2\" to \"v1\" in the other graph.\n\n\n**A JSON object with these properties is required:**\n\n - **to** (string): One or many vertex collections that can contain target vertices.\n - **from** (string): One or many vertex collections that can contain source vertices.\n - **collection**: The name of the edge collection to be used.\n\n\n\n\n\n**Example:**\n \n\n<pre><code class=\"json\">shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/gharial/social/edge &lt;&lt;EOF\n{ \n <span class=\"hljs-string\">\"collection\"</span> : <span class=\"hljs-string\">\"works_in\"</span>, \n <span class=\"hljs-string\">\"from\"</span> : [ \n <span class=\"hljs-string\">\"female\"</span>, \n <span class=\"hljs-string\">\"male\"</span> \n ], \n <span class=\"hljs-string\">\"to\"</span> : [ \n <span class=\"hljs-string\">\"city\"</span> \n ] \n}\nEOF\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">202</span> Accepted\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\netag: _WE2UyAi--_\nx-content-type-options: nosniff\n\n{ \n <span class=\"hljs-string\">\"error\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"graph\"</span> : { \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"social\"</span>, \n <span class=\"hljs-string\">\"edgeDefinitions\"</span> : [ \n { \n <span class=\"hljs-string\">\"collection\"</span> : <span class=\"hljs-string\">\"relation\"</span>, \n <span class=\"hljs-string\">\"from\"</span> : [ \n <span class=\"hljs-string\">\"female\"</span>, \n <span class=\"hljs-string\">\"male\"</span> \n ], \n <span class=\"hljs-string\">\"to\"</span> : [ \n <span class=\"hljs-string\">\"female\"</span>, \n <span class=\"hljs-string\">\"male\"</span> \n ] \n }, \n { \n <span class=\"hljs-string\">\"collection\"</span> : <span class=\"hljs-string\">\"works_in\"</span>, \n <span class=\"hljs-string\">\"from\"</span> : [ \n <span class=\"hljs-string\">\"female\"</span>, \n <span class=\"hljs-string\">\"male\"</span> \n ], \n <span class=\"hljs-string\">\"to\"</span> : [ \n <span class=\"hljs-string\">\"city\"</span> \n ] \n } \n ], \n <span class=\"hljs-string\">\"orphanCollections\"</span> : [ ], \n <span class=\"hljs-string\">\"isSmart\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"numberOfShards\"</span> : <span class=\"hljs-number\">1</span>, \n <span class=\"hljs-string\">\"replicationFactor\"</span> : <span class=\"hljs-number\">1</span>, \n <span class=\"hljs-string\">\"smartGraphAttribute\"</span> : <span class=\"hljs-string\">\"\"</span>, \n <span class=\"hljs-string\">\"_id\"</span> : <span class=\"hljs-string\">\"_graphs/social\"</span>, \n <span class=\"hljs-string\">\"_rev\"</span> : <span class=\"hljs-string\">\"_WE2UyAi--_\"</span> \n }, \n <span class=\"hljs-string\">\"code\"</span> : <span class=\"hljs-number\">202</span> \n}\n</code></pre>\n\n\n\n",
"parameters": [
{
"in": "body",
"name": "Json Request Body",
"required": true,
"schema": {
"$ref": "#/definitions/general_graph_edge_definition_add_http_examples"
},
"x-description-offset": 486
}
],
"responses": {
"201": {
"description": "Returned if the definition could be added successfully and\nwaitForSync is enabled for the `_graphs` collection.\n\n"
},
"202": {
"description": "Returned if the definition could be added successfully and\nwaitForSync is disabled for the `_graphs` collection.\n\n"
},
"400": {
"description": "Returned if the defininition could not be added, the edge collection\nis used in an other graph with a different signature.\n\n"
},
"404": {
"description": "Returned if no graph with this name could be found.\n\n"
}
},
"summary": "Add edge definition",
"tags": [
"Graph"
],
"x-examples": [],
"x-filename": "Graph - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_list_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_definition_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_list_edge_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_replace_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_collection_add_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_replace_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_collection_remove_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_delete_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_definition_remove_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_delete_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_list_vertex_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_definition_add_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_drop_http_examples.md"
}
},
"/_api/gharial/{graph-name}/edge/{collection-name}": {
"post": {
"description": "\n\nCreates a new edge in the collection.\nWithin the body the has to contain a *_from* and *_to* value referencing to valid vertices in the graph.\nFurthermore the edge has to be valid in the definition of this\n[edge collection](../../Manual/Appendix/Glossary.html#edge-collection).\n\n\n\n\n**Example:**\n \n\n<pre><code class=\"json\">shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/gharial/social/edge/relation &lt;&lt;EOF\n{ \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"friend\"</span>, \n <span class=\"hljs-string\">\"_from\"</span> : <span class=\"hljs-string\">\"female/alice\"</span>, \n <span class=\"hljs-string\">\"_to\"</span> : <span class=\"hljs-string\">\"female/diana\"</span> \n}\nEOF\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">202</span> Accepted\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\netag: _WE2Uxwi--_\nx-content-type-options: nosniff\n\n{ \n <span class=\"hljs-string\">\"error\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"edge\"</span> : { \n <span class=\"hljs-string\">\"_id\"</span> : <span class=\"hljs-string\">\"relation/7900\"</span>, \n <span class=\"hljs-string\">\"_key\"</span> : <span class=\"hljs-string\">\"7900\"</span>, \n <span class=\"hljs-string\">\"_rev\"</span> : <span class=\"hljs-string\">\"_WE2Uxwi--_\"</span> \n }, \n <span class=\"hljs-string\">\"code\"</span> : <span class=\"hljs-number\">202</span> \n}\n</code></pre>\n\n\n\n\n",
"parameters": [
{
"description": "The body has to be the JSON object to be stored.\n\n",
"in": "body",
"name": "Json Request Body",
"required": true,
"schema": {
"additionalProperties": {},
"type": "object"
},
"x-description-offset": 281
}
],
"responses": {
"201": {
"description": "Returned if the edge could be created.\n\n"
},
"202": {
"description": "Returned if the request was successful but waitForSync is false.\n\n"
},
"404": {
"description": "Returned if no graph with this name, no edge collection or no edge with this id could be found.\n\n"
}
},
"summary": "Create an edge",
"tags": [
"Graph"
],
"x-examples": [],
"x-filename": "Graph - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_list_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_definition_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_list_edge_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_replace_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_collection_add_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_replace_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_collection_remove_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_delete_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_definition_remove_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_delete_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_list_vertex_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_definition_add_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_drop_http_examples.md"
}
},
"/_api/gharial/{graph-name}/edge/{collection-name}/{edge-key}": {
"delete": {
"description": "\n\nRemoves an edge from the collection.\n\n\n\n\n**Example:**\n \n\n<pre><code class=\"json\">shell> curl -X DELETE --dump - http://localhost:8529/_api/gharial/social/edge/relation/8313\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">202</span> Accepted\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\nx-content-type-options: nosniff\n\n{ \n <span class=\"hljs-string\">\"error\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"removed\"</span> : <span class=\"hljs-literal\">true</span>, \n <span class=\"hljs-string\">\"code\"</span> : <span class=\"hljs-number\">202</span> \n}\n</code></pre>\n\n\n\n\n",
"parameters": [],
"responses": {
"200": {
"description": "Returned if the edge could be removed.\n\n"
},
"202": {
"description": "Returned if the request was successful but waitForSync is false.\n\n"
},
"404": {
"description": "Returned if no graph with this name, no edge collection or no edge with this id could be found.\n\n"
},
"412": {
"description": "Returned if if-match header is given, but the documents revision is different.\n\n"
}
},
"summary": "Remove an edge",
"tags": [
"Graph"
],
"x-examples": [],
"x-filename": "Graph - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_list_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_definition_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_list_edge_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_replace_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_collection_add_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_replace_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_collection_remove_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_delete_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_definition_remove_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_delete_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_list_vertex_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_definition_add_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_drop_http_examples.md"
},
"get": {
"description": "\n\nGets an edge from the given collection.\n\n\n\n\n**Example:**\n \n\n<pre><code class=\"json\">shell> curl --dump - http://localhost:8529/_api/gharial/social/edge/relation/8628\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">200</span> OK\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\netag: _WE2U2Qu--B\nx-content-type-options: nosniff\n\n{ \n <span class=\"hljs-string\">\"error\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"edge\"</span> : { \n <span class=\"hljs-string\">\"_key\"</span> : <span class=\"hljs-string\">\"8628\"</span>, \n <span class=\"hljs-string\">\"_id\"</span> : <span class=\"hljs-string\">\"relation/8628\"</span>, \n <span class=\"hljs-string\">\"_from\"</span> : <span class=\"hljs-string\">\"female/alice\"</span>, \n <span class=\"hljs-string\">\"_to\"</span> : <span class=\"hljs-string\">\"male/bob\"</span>, \n <span class=\"hljs-string\">\"_rev\"</span> : <span class=\"hljs-string\">\"_WE2U2Qu--B\"</span>, \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"married\"</span>, \n <span class=\"hljs-string\">\"vertex\"</span> : <span class=\"hljs-string\">\"alice\"</span> \n }, \n <span class=\"hljs-string\">\"code\"</span> : <span class=\"hljs-number\">200</span> \n}\n</code></pre>\n\n\n\n\n",
"parameters": [],
"responses": {
"200": {
"description": "Returned if the edge could be found.\n\n"
},
"404": {
"description": "Returned if no graph with this name, no edge collection or no edge with this id could be found.\n\n"
},
"412": {
"description": "Returned if if-match header is given, but the documents revision is different.\n\n"
}
},
"summary": "Get an edge",
"tags": [
"Graph"
],
"x-examples": [],
"x-filename": "Graph - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_list_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_definition_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_list_edge_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_replace_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_collection_add_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_replace_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_collection_remove_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_delete_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_definition_remove_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_delete_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_list_vertex_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_definition_add_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_drop_http_examples.md"
},
"patch": {
"description": "\n\nUpdates the data of the specific edge in the collection.\n\n\n\n\n**Example:**\n \n\n<pre><code class=\"json\">shell> curl -X PATCH --data-binary @- --dump - http://localhost:8529/_api/gharial/social/edge/relation/9272 &lt;&lt;EOF\n{ \n <span class=\"hljs-string\">\"since\"</span> : <span class=\"hljs-string\">\"01.01.2001\"</span> \n}\nEOF\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">202</span> Accepted\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\netag: _WE2U4yG--_\nx-content-type-options: nosniff\n\n{ \n <span class=\"hljs-string\">\"error\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"edge\"</span> : { \n <span class=\"hljs-string\">\"_id\"</span> : <span class=\"hljs-string\">\"relation/9272\"</span>, \n <span class=\"hljs-string\">\"_key\"</span> : <span class=\"hljs-string\">\"9272\"</span>, \n <span class=\"hljs-string\">\"_rev\"</span> : <span class=\"hljs-string\">\"_WE2U4yG--_\"</span>, \n <span class=\"hljs-string\">\"_oldRev\"</span> : <span class=\"hljs-string\">\"_WE2U4xy--F\"</span> \n }, \n <span class=\"hljs-string\">\"code\"</span> : <span class=\"hljs-number\">202</span> \n}\n</code></pre>\n\n\n\n\n",
"parameters": [
{
"description": "The body has to be a JSON object containing the attributes to be updated.\n\n",
"in": "body",
"name": "Json Request Body",
"required": true,
"schema": {
"additionalProperties": {},
"type": "object"
},
"x-description-offset": 60
}
],
"responses": {
"200": {
"description": "Returned if the edge could be updated.\n\n"
},
"202": {
"description": "Returned if the request was successful but waitForSync is false.\n\n"
},
"404": {
"description": "Returned if no graph with this name, no edge collection or no edge with this id could be found.\n\n"
}
},
"summary": "Modify an edge",
"tags": [
"Graph"
],
"x-examples": [],
"x-filename": "Graph - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_list_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_definition_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_list_edge_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_replace_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_collection_add_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_replace_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_collection_remove_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_delete_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_definition_remove_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_delete_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_list_vertex_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_definition_add_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_drop_http_examples.md"
},
"put": {
"description": "\n\nReplaces the data of an edge in the collection.\n\n\n\n\n**Example:**\n \n\n<pre><code class=\"json\">shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/gharial/social/edge/relation/9352 &lt;&lt;EOF\n{ \n <span class=\"hljs-string\">\"type\"</span> : <span class=\"hljs-string\">\"divorced\"</span>, \n <span class=\"hljs-string\">\"_from\"</span> : <span class=\"hljs-string\">\"female/alice\"</span>, \n <span class=\"hljs-string\">\"_to\"</span> : <span class=\"hljs-string\">\"male/bob\"</span> \n}\nEOF\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">202</span> Accepted\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\netag: _WE2U5Hy--_\nx-content-type-options: nosniff\n\n{ \n <span class=\"hljs-string\">\"error\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"edge\"</span> : { \n <span class=\"hljs-string\">\"_id\"</span> : <span class=\"hljs-string\">\"relation/9352\"</span>, \n <span class=\"hljs-string\">\"_key\"</span> : <span class=\"hljs-string\">\"9352\"</span>, \n <span class=\"hljs-string\">\"_rev\"</span> : <span class=\"hljs-string\">\"_WE2U5Hy--_\"</span>, \n <span class=\"hljs-string\">\"_oldRev\"</span> : <span class=\"hljs-string\">\"_WE2U5Ha--_\"</span> \n }, \n <span class=\"hljs-string\">\"code\"</span> : <span class=\"hljs-number\">202</span> \n}\n</code></pre>\n\n\n\n",
"parameters": [
{
"description": "The body has to be the JSON object to be stored.\n\n",
"in": "body",
"name": "Json Request Body",
"required": true,
"schema": {
"additionalProperties": {},
"type": "object"
},
"x-description-offset": 51
}
],
"responses": {
"201": {
"description": "Returned if the request was successful but waitForSync is true.\n\n"
},
"202": {
"description": "Returned if the request was successful but waitForSync is false.\n\n"
},
"404": {
"description": "Returned if no graph with this name, no edge collection or no edge with this id could be found.\n\n"
},
"412": {
"description": "Returned if if-match header is given, but the documents revision is different.\n\n"
}
},
"summary": "Replace an edge",
"tags": [
"Graph"
],
"x-examples": [],
"x-filename": "Graph - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_list_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_definition_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_list_edge_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_replace_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_collection_add_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_replace_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_collection_remove_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_delete_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_definition_remove_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_delete_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_list_vertex_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_definition_add_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_drop_http_examples.md"
}
},
"/_api/gharial/{graph-name}/edge/{definition-name}": {
"delete": {
"description": "\n\nRemove one edge definition from the graph. This will only remove the\nedge collection, the vertex collections remain untouched and can still\nbe used in your queries.\n\n\n\n\n**Example:**\n \n\n<pre><code class=\"json\">shell> curl -X DELETE --dump - http://localhost:8529/_api/gharial/social/edge/relation\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">202</span> Accepted\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\netag: _WE2U1QK--_\nx-content-type-options: nosniff\n\n{ \n <span class=\"hljs-string\">\"error\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"graph\"</span> : { \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"social\"</span>, \n <span class=\"hljs-string\">\"edgeDefinitions\"</span> : [ ], \n <span class=\"hljs-string\">\"orphanCollections\"</span> : [ \n <span class=\"hljs-string\">\"female\"</span>, \n <span class=\"hljs-string\">\"male\"</span> \n ], \n <span class=\"hljs-string\">\"isSmart\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"numberOfShards\"</span> : <span class=\"hljs-number\">1</span>, \n <span class=\"hljs-string\">\"replicationFactor\"</span> : <span class=\"hljs-number\">1</span>, \n <span class=\"hljs-string\">\"smartGraphAttribute\"</span> : <span class=\"hljs-string\">\"\"</span>, \n <span class=\"hljs-string\">\"_id\"</span> : <span class=\"hljs-string\">\"_graphs/social\"</span>, \n <span class=\"hljs-string\">\"_rev\"</span> : <span class=\"hljs-string\">\"_WE2U1QK--_\"</span> \n }, \n <span class=\"hljs-string\">\"code\"</span> : <span class=\"hljs-number\">202</span> \n}\n</code></pre>\n\n\n\n",
"parameters": [],
"responses": {
"201": {
"description": "Returned if the edge definition could be removed from the graph \nand waitForSync is true.\n\n"
},
"202": {
"description": "Returned if the edge definition could be removed from the graph and\nwaitForSync is false.\n\n"
},
"400": {
"description": "Returned if no edge definition with this name is found in the graph.\n\n"
},
"404": {
"description": "Returned if no graph with this name could be found.\n\n"
}
},
"summary": "Remove an edge definition from the graph",
"tags": [
"Graph"
],
"x-examples": [],
"x-filename": "Graph - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_list_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_definition_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_list_edge_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_replace_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_collection_add_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_replace_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_collection_remove_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_delete_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_definition_remove_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_delete_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_list_vertex_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_definition_add_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_drop_http_examples.md"
},
"put": {
"description": "\n\nChange one specific edge definition.\nThis will modify all occurrences of this definition in all graphs known to your database.\n\n\n**A JSON object with these properties is required:**\n\n - **to** (string): One or many vertex collections that can contain target vertices.\n - **from** (string): One or many vertex collections that can contain source vertices.\n - **collection**: The name of the edge collection to be used.\n\n\n\n\n\n**Example:**\n \n\n<pre><code class=\"json\">shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/gharial/social/edge/relation &lt;&lt;EOF\n{ \n <span class=\"hljs-string\">\"collection\"</span> : <span class=\"hljs-string\">\"relation\"</span>, \n <span class=\"hljs-string\">\"from\"</span> : [ \n <span class=\"hljs-string\">\"female\"</span>, \n <span class=\"hljs-string\">\"male\"</span>, \n <span class=\"hljs-string\">\"animal\"</span> \n ], \n <span class=\"hljs-string\">\"to\"</span> : [ \n <span class=\"hljs-string\">\"female\"</span>, \n <span class=\"hljs-string\">\"male\"</span>, \n <span class=\"hljs-string\">\"animal\"</span> \n ] \n}\nEOF\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">202</span> Accepted\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\netag: _WE2U6Bq--_\nx-content-type-options: nosniff\n\n{ \n <span class=\"hljs-string\">\"error\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"graph\"</span> : { \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"social\"</span>, \n <span class=\"hljs-string\">\"edgeDefinitions\"</span> : [ \n { \n <span class=\"hljs-string\">\"collection\"</span> : <span class=\"hljs-string\">\"relation\"</span>, \n <span class=\"hljs-string\">\"from\"</span> : [ \n <span class=\"hljs-string\">\"animal\"</span>, \n <span class=\"hljs-string\">\"female\"</span>, \n <span class=\"hljs-string\">\"male\"</span> \n ], \n <span class=\"hljs-string\">\"to\"</span> : [ \n <span class=\"hljs-string\">\"animal\"</span>, \n <span class=\"hljs-string\">\"female\"</span>, \n <span class=\"hljs-string\">\"male\"</span> \n ] \n } \n ], \n <span class=\"hljs-string\">\"orphanCollections\"</span> : [ ], \n <span class=\"hljs-string\">\"isSmart\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"numberOfShards\"</span> : <span class=\"hljs-number\">1</span>, \n <span class=\"hljs-string\">\"replicationFactor\"</span> : <span class=\"hljs-number\">1</span>, \n <span class=\"hljs-string\">\"smartGraphAttribute\"</span> : <span class=\"hljs-string\">\"\"</span>, \n <span class=\"hljs-string\">\"_id\"</span> : <span class=\"hljs-string\">\"_graphs/social\"</span>, \n <span class=\"hljs-string\">\"_rev\"</span> : <span class=\"hljs-string\">\"_WE2U6Bq--_\"</span> \n }, \n <span class=\"hljs-string\">\"code\"</span> : <span class=\"hljs-number\">202</span> \n}\n</code></pre>\n\n\n\n",
"parameters": [
{
"in": "body",
"name": "Json Request Body",
"required": true,
"schema": {
"$ref": "#/definitions/general_graph_edge_definition_modify_http_examples"
},
"x-description-offset": 184
}
],
"responses": {
"201": {
"description": "Returned if the request was successful and waitForSync is true.\n\n"
},
"202": {
"description": "Returned if the request was successful but waitForSync is false.\n\n"
},
"400": {
"description": "Returned if no edge definition with this name is found in the graph.\n\n"
},
"404": {
"description": "Returned if no graph with this name could be found.\n\n"
}
},
"summary": "Replace an edge definition",
"tags": [
"Graph"
],
"x-examples": [],
"x-filename": "Graph - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_list_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_definition_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_list_edge_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_replace_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_collection_add_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_replace_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_collection_remove_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_delete_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_definition_remove_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_delete_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_list_vertex_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_definition_add_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_drop_http_examples.md"
}
},
"/_api/gharial/{graph-name}/vertex": {
"get": {
"description": "\n\nLists all vertex collections within this graph.\n\n\n\n\n**Example:**\n \n\n<pre><code class=\"json\">shell> curl --dump - http://localhost:8529/_api/gharial/social/vertex\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">200</span> OK\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\nx-content-type-options: nosniff\n\n{ \n <span class=\"hljs-string\">\"error\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"collections\"</span> : [ \n <span class=\"hljs-string\">\"female\"</span>, \n <span class=\"hljs-string\">\"male\"</span> \n ], \n <span class=\"hljs-string\">\"code\"</span> : <span class=\"hljs-number\">200</span> \n}\n</code></pre>\n\n\n\n\n",
"parameters": [],
"responses": {
"200": {
"description": "Is returned if the collections could be listed.\n\n"
},
"404": {
"description": "Returned if no graph with this name could be found.\n\n"
}
},
"summary": "List vertex collections",
"tags": [
"Graph"
],
"x-examples": [],
"x-filename": "Graph - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_list_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_definition_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_list_edge_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_replace_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_collection_add_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_replace_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_collection_remove_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_delete_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_definition_remove_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_delete_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_list_vertex_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_definition_add_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_drop_http_examples.md"
},
"post": {
"description": "\n\nAdds a vertex collection to the set of collections of the graph. If\nthe collection does not exist, it will be created.\n\n\n\n\n**Example:**\n \n\n<pre><code class=\"json\">shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/gharial/social/vertex &lt;&lt;EOF\n{ \n <span class=\"hljs-string\">\"collection\"</span> : <span class=\"hljs-string\">\"otherVertices\"</span> \n}\nEOF\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">202</span> Accepted\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\netag: _WE2UyyS--_\nx-content-type-options: nosniff\n\n{ \n <span class=\"hljs-string\">\"error\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"graph\"</span> : { \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"social\"</span>, \n <span class=\"hljs-string\">\"edgeDefinitions\"</span> : [ \n { \n <span class=\"hljs-string\">\"collection\"</span> : <span class=\"hljs-string\">\"relation\"</span>, \n <span class=\"hljs-string\">\"from\"</span> : [ \n <span class=\"hljs-string\">\"female\"</span>, \n <span class=\"hljs-string\">\"male\"</span> \n ], \n <span class=\"hljs-string\">\"to\"</span> : [ \n <span class=\"hljs-string\">\"female\"</span>, \n <span class=\"hljs-string\">\"male\"</span> \n ] \n } \n ], \n <span class=\"hljs-string\">\"orphanCollections\"</span> : [ \n <span class=\"hljs-string\">\"otherVertices\"</span> \n ], \n <span class=\"hljs-string\">\"isSmart\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"numberOfShards\"</span> : <span class=\"hljs-number\">1</span>, \n <span class=\"hljs-string\">\"replicationFactor\"</span> : <span class=\"hljs-number\">1</span>, \n <span class=\"hljs-string\">\"smartGraphAttribute\"</span> : <span class=\"hljs-string\">\"\"</span>, \n <span class=\"hljs-string\">\"_id\"</span> : <span class=\"hljs-string\">\"_graphs/social\"</span>, \n <span class=\"hljs-string\">\"_rev\"</span> : <span class=\"hljs-string\">\"_WE2UyyS--_\"</span> \n }, \n <span class=\"hljs-string\">\"code\"</span> : <span class=\"hljs-number\">202</span> \n}\n</code></pre>\n\n\n\n",
"parameters": [],
"responses": {
"201": {
"description": "Returned if the edge collection could be added successfully and\nwaitForSync is true.\n\n"
},
"202": {
"description": "Returned if the edge collection could be added successfully and\nwaitForSync is false.\n\n"
},
"404": {
"description": "Returned if no graph with this name could be found.\n\n"
}
},
"summary": "Add vertex collection",
"tags": [
"Graph"
],
"x-examples": [],
"x-filename": "Graph - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_list_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_definition_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_list_edge_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_replace_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_collection_add_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_replace_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_collection_remove_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_delete_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_definition_remove_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_delete_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_list_vertex_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_definition_add_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_drop_http_examples.md"
}
},
"/_api/gharial/{graph-name}/vertex/{collection-name}": {
"delete": {
"description": "\n\nRemoves a vertex collection from the graph and optionally deletes the collection,\nif it is not used in any other graph.\n\n\n\n\n**Example:**\n You can remove vertex collections that are not used in any edge collection:\n\n<pre><code class=\"json\">shell> curl -X DELETE --dump - http://localhost:8529/_api/gharial/social/vertex/otherVertices\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">202</span> Accepted\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\netag: _WE2U5cC--_\nx-content-type-options: nosniff\n\n{ \n <span class=\"hljs-string\">\"error\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"graph\"</span> : { \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"social\"</span>, \n <span class=\"hljs-string\">\"edgeDefinitions\"</span> : [ \n { \n <span class=\"hljs-string\">\"collection\"</span> : <span class=\"hljs-string\">\"relation\"</span>, \n <span class=\"hljs-string\">\"from\"</span> : [ \n <span class=\"hljs-string\">\"female\"</span>, \n <span class=\"hljs-string\">\"male\"</span> \n ], \n <span class=\"hljs-string\">\"to\"</span> : [ \n <span class=\"hljs-string\">\"female\"</span>, \n <span class=\"hljs-string\">\"male\"</span> \n ] \n } \n ], \n <span class=\"hljs-string\">\"orphanCollections\"</span> : [ ], \n <span class=\"hljs-string\">\"isSmart\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"numberOfShards\"</span> : <span class=\"hljs-number\">1</span>, \n <span class=\"hljs-string\">\"replicationFactor\"</span> : <span class=\"hljs-number\">1</span>, \n <span class=\"hljs-string\">\"smartGraphAttribute\"</span> : <span class=\"hljs-string\">\"\"</span>, \n <span class=\"hljs-string\">\"_id\"</span> : <span class=\"hljs-string\">\"_graphs/social\"</span>, \n <span class=\"hljs-string\">\"_rev\"</span> : <span class=\"hljs-string\">\"_WE2U5cC--_\"</span> \n }, \n <span class=\"hljs-string\">\"code\"</span> : <span class=\"hljs-number\">202</span> \n}\n</code></pre>\n\n\n\n\n**Example:**\n You cannot remove vertex collections that are used in edge collections:\n\n<pre><code class=\"json\">shell> curl -X DELETE --dump - http://localhost:8529/_api/gharial/social/vertex/male\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">400</span> Bad Request\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\nx-content-type-options: nosniff\n\n{ \n <span class=\"hljs-string\">\"error\"</span> : <span class=\"hljs-literal\">true</span>, \n <span class=\"hljs-string\">\"errorNum\"</span> : <span class=\"hljs-number\">1928</span>, \n <span class=\"hljs-string\">\"errorMessage\"</span> : <span class=\"hljs-string\">\"not in orphan collection\"</span>, \n <span class=\"hljs-string\">\"code\"</span> : <span class=\"hljs-number\">400</span> \n}\n</code></pre>\n\n\n\n\n",
"parameters": [],
"responses": {
"201": {
"description": "Returned if the vertex collection was removed from the graph successfully\nand waitForSync is true.\n\n"
},
"202": {
"description": "Returned if the request was successful but waitForSync is false.\n\n"
},
"400": {
"description": "Returned if the vertex collection is still used in an edge definition.\nIn this case it cannot be removed from the graph yet, it has to be\nremoved from the edge definition first.\n\n"
},
"404": {
"description": "Returned if no graph with this name could be found.\n\n"
}
},
"summary": "Remove vertex collection",
"tags": [
"Graph"
],
"x-examples": [],
"x-filename": "Graph - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_list_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_definition_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_list_edge_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_replace_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_collection_add_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_replace_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_collection_remove_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_delete_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_definition_remove_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_delete_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_list_vertex_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_definition_add_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_drop_http_examples.md"
},
"post": {
"description": "\n\nAdds a vertex to the given collection.\n\n\n\n\n**Example:**\n \n\n<pre><code class=\"json\">shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/gharial/social/vertex/male &lt;&lt;EOF\n{ \n <span class=\"hljs-string\">\"name\"</span> : <span class=\"hljs-string\">\"Francis\"</span> \n}\nEOF\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">202</span> Accepted\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\netag: _WE2Uyfa--_\nx-content-type-options: nosniff\n\n{ \n <span class=\"hljs-string\">\"error\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"vertex\"</span> : { \n <span class=\"hljs-string\">\"_id\"</span> : <span class=\"hljs-string\">\"male/8079\"</span>, \n <span class=\"hljs-string\">\"_key\"</span> : <span class=\"hljs-string\">\"8079\"</span>, \n <span class=\"hljs-string\">\"_rev\"</span> : <span class=\"hljs-string\">\"_WE2Uyfa--_\"</span> \n }, \n <span class=\"hljs-string\">\"code\"</span> : <span class=\"hljs-number\">202</span> \n}\n</code></pre>\n\n\n\n\n",
"parameters": [
{
"description": "The body has to be the JSON object to be stored.\n\n",
"in": "body",
"name": "Json Request Body",
"required": true,
"schema": {
"additionalProperties": {},
"type": "object"
},
"x-description-offset": 42
}
],
"responses": {
"201": {
"description": "Returned if the vertex could be added and waitForSync is true.\n\n"
},
"202": {
"description": "Returned if the request was successful but waitForSync is false.\n\n"
},
"404": {
"description": "Returned if no graph or no vertex collection with this name could be found.\n\n"
}
},
"summary": "Create a vertex",
"tags": [
"Graph"
],
"x-examples": [],
"x-filename": "Graph - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_list_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_definition_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_list_edge_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_replace_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_collection_add_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_replace_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_collection_remove_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_delete_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_definition_remove_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_delete_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_list_vertex_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_definition_add_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_drop_http_examples.md"
}
},
"/_api/gharial/{graph-name}/vertex/{collection-name}/{vertex-key}": {
"delete": {
"description": "\n\nRemoves a vertex from the collection.\n\n\n\n\n**Example:**\n \n\n<pre><code class=\"json\">shell> curl -X DELETE --dump - http://localhost:8529/_api/gharial/social/vertex/female/alice\n\nHTTP/<span class=\"hljs-number\">1.1</span> <span class=\"hljs-number\">202</span> Accepted\ncontent-type: application/json; charset=utf<span class=\"hljs-number\">-8</span>\nx-content-type-options: nosniff\n\n{ \n <span class=\"hljs-string\">\"error\"</span> : <span class=\"hljs-literal\">false</span>, \n <span class=\"hljs-string\">\"removed\"</span> : <span class=\"hljs-literal\">true</span>, \n <span class=\"hljs-string\">\"code\"</span> : <span class=\"hljs-number\">202</span> \n}\n</code></pre>\n\n\n\n\n",
"parameters": [],
"responses": {
"200": {
"description": "Returned if the vertex could be removed.\n\n"
},
"202": {
"description": "Returned if the request was successful but waitForSync is false.\n\n"
},
"404": {
"description": "Returned if no graph with this name, no vertex collection or no vertex with this id could be found.\n\n"
},
"412": {
"description": "Returned if if-match header is given, but the documents revision is different.\n\n"
}
},
"summary": "Remove a vertex",
"tags": [
"Graph"
],
"x-examples": [],
"x-filename": "Graph - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_list_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_definition_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_list_edge_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_replace_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_collection_add_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_replace_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_collection_remove_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_delete_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_definition_remove_http_examples.md, /home/wil
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment