{ "basePath": "/", "definitions": { "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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_checksum.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_count.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_figures.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_name.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_properties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_revision.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_delete_api_collection.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_get_api_collections.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_post_api_collection.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_load.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_properties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_rename.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_rotate.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_truncate.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_unload.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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_all.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_any.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_first_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_fulltext.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_near.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_range.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_remove_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_replace_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_update_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_within.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_within_rectangle.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\RestLookupByKeys.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\RestRemoveByKeys.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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_all.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_any.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_first_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_fulltext.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_near.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_range.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_remove_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_replace_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_update_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_within.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_within_rectangle.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\RestLookupByKeys.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\RestRemoveByKeys.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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_all.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_any.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_first_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_fulltext.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_near.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_range.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_remove_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_replace_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_update_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_within.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_within_rectangle.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\RestLookupByKeys.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\RestRemoveByKeys.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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_all.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_any.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_first_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_fulltext.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_near.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_range.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_remove_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_replace_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_update_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_within.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_within_rectangle.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\RestLookupByKeys.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\RestRemoveByKeys.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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_all.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_any.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_first_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_fulltext.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_near.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_range.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_remove_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_replace_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_update_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_within.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_within_rectangle.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\RestLookupByKeys.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\RestRemoveByKeys.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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_all.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_any.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_first_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_fulltext.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_near.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_range.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_remove_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_replace_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_update_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_within.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_within_rectangle.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\RestLookupByKeys.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\RestRemoveByKeys.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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_all.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_any.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_first_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_fulltext.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_near.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_range.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_remove_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_replace_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_update_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_within.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_within_rectangle.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\RestLookupByKeys.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\RestRemoveByKeys.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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_all.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_any.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_first_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_fulltext.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_near.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_range.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_remove_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_replace_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_update_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_within.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_within_rectangle.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\RestLookupByKeys.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\RestRemoveByKeys.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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_all.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_any.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_first_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_fulltext.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_near.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_range.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_remove_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_replace_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_update_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_within.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_within_rectangle.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\RestLookupByKeys.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\RestRemoveByKeys.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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_all.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_any.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_first_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_fulltext.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_near.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_range.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_remove_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_replace_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_update_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_within.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_within_rectangle.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\RestLookupByKeys.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\RestRemoveByKeys.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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_all.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_any.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_first_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_fulltext.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_near.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_range.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_remove_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_replace_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_update_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_within.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_within_rectangle.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\RestLookupByKeys.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\RestRemoveByKeys.md" }, "JSF_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 it's 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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph Traversal\\JSF_HTTP_API_TRAVERSAL.md" }, "JSF_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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_create_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_drop_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_create_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_definition_add_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_definition_modify_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_definition_remove_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_delete_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_get_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_modify_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_replace_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_get_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_list_edge_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_list_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_list_vertex_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_collection_add_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_collection_remove_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_create_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_delete_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_get_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_modify_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_replace_http_examples.md" }, "JSF_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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_create_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_drop_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_create_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_definition_add_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_definition_modify_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_definition_remove_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_delete_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_get_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_modify_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_replace_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_get_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_list_edge_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_list_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_list_vertex_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_collection_add_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_collection_remove_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_create_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_delete_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_get_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_modify_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_replace_http_examples.md" }, "JSF_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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_create_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_drop_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_create_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_definition_add_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_definition_modify_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_definition_remove_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_delete_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_get_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_modify_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_replace_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_get_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_list_edge_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_list_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_list_vertex_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_collection_add_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_collection_remove_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_create_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_delete_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_get_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_modify_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_replace_http_examples.md" }, "JSF_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/JSF_get_api_database_new_USERS" }, "type": "array" } }, "required": [ "name" ], "type": "object", "x-filename": "Database - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Database\\JSF_get_api_database_current.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Database\\JSF_get_api_database_delete.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Database\\JSF_get_api_database_list.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Database\\JSF_get_api_database_new.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Database\\JSF_get_api_database_user.md" }, "JSF_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" }, "JSF_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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_delete_api_tasks.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_database_version.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_echo.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_long_echo.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_modules_flush.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_routing_reloads.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_server_id.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_server_role.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_sleep.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_statistics.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_statistics_description.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_time.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_cluster_endpoints.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_endpoint.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_initiate.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_return.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_tasks.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_tasks_all.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_engine.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_post_admin_execute.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_post_admin_test.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_post_api_new_tasks.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_put_api_new_tasks.md" }, "JSF_get_engine_rc_200": { "properties": { "name": { "description": "will be *mmfiles* or *rocksdb*\n\n", "type": "string" } }, "required": [ "name" ], "type": "object", "x-filename": "Administration - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_delete_api_tasks.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_database_version.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_echo.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_long_echo.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_modules_flush.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_routing_reloads.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_server_id.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_server_role.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_sleep.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_statistics.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_statistics_description.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_time.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_cluster_endpoints.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_endpoint.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_initiate.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_return.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_tasks.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_tasks_all.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_engine.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_post_admin_execute.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_post_admin_test.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_post_api_new_tasks.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_put_api_new_tasks.md" }, "JSF_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 that 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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\DeleteApiQueryCache.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\DeleteApiQueryKill.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\DeleteApiQuerySlow.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\GetApiQueryCacheProperties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\GetApiQueryCurrent.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\GetApiQueryProperties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\GetApiQuerySlow.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\JSF_delete_api_aqlfunction.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\JSF_get_api_aqlfunction.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\JSF_post_api_aqlfunction.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\JSF_post_api_explain.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\PostApiQueryProperties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\PutApiQueryCacheProperties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\PutApiQueryProperties.md" }, "JSF_post_api_collection": { "properties": { "doCompact": { "description": "whether or not the collection will be compacted (default is *true*)\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.\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*)\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)\n\n", "format": "int64", "type": "integer" }, "keyOptions": { "$ref": "#/definitions/JSF_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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_checksum.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_count.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_figures.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_name.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_properties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_revision.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_delete_api_collection.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_get_api_collections.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_post_api_collection.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_load.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_properties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_rename.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_rotate.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_truncate.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_unload.md" }, "JSF_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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_checksum.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_count.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_figures.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_name.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_properties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_revision.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_delete_api_collection.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_get_api_collections.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_post_api_collection.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_load.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_properties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_rename.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_rotate.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_truncate.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_unload.md" }, "JSF_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/JSF_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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Cursors\\JSF_post_api_cursor.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Cursors\\JSF_post_api_cursor_delete.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Cursors\\JSF_post_api_cursor_identifier.md" }, "JSF_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" }, "maxPlans": { "description": "Limits the maximum number of plans that are created by the AQL query optimizer.\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" } }, "type": "object", "x-filename": "Cursors - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Cursors\\JSF_post_api_cursor.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Cursors\\JSF_post_api_cursor_delete.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Cursors\\JSF_post_api_cursor_identifier.md" }, "JSF_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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Cursors\\JSF_post_api_cursor.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Cursors\\JSF_post_api_cursor_delete.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Cursors\\JSF_post_api_cursor_identifier.md" }, "JSF_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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Cursors\\JSF_post_api_cursor.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Cursors\\JSF_post_api_cursor_delete.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Cursors\\JSF_post_api_cursor_identifier.md" }, "JSF_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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\DeleteApiQueryCache.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\DeleteApiQueryKill.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\DeleteApiQuerySlow.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\GetApiQueryCacheProperties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\GetApiQueryCurrent.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\GetApiQueryProperties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\GetApiQuerySlow.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\JSF_delete_api_aqlfunction.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\JSF_get_api_aqlfunction.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\JSF_post_api_aqlfunction.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\JSF_post_api_explain.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\PostApiQueryProperties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\PutApiQueryCacheProperties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\PutApiQueryProperties.md" }, "JSF_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/JSF_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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Bulk\\JSF_batch_processing.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Bulk\\JSF_import_document.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Bulk\\JSF_import_json.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Bulk\\JSF_post_api_export.md" }, "JSF_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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Bulk\\JSF_batch_processing.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Bulk\\JSF_import_document.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Bulk\\JSF_import_json.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Bulk\\JSF_post_api_export.md" }, "JSF_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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_get_api_index.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_get_api_reads_index.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_post_api_index.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_post_api_index_delete.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_post_api_index_fulltext.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_post_api_index_geo.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_post_api_index_hash.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_post_api_index_persistent.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_post_api_index_skiplist.md" }, "JSF_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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_get_api_index.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_get_api_reads_index.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_post_api_index.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_post_api_index_delete.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_post_api_index_fulltext.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_post_api_index_geo.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_post_api_index_hash.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_post_api_index_persistent.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_post_api_index_skiplist.md" }, "JSF_post_api_index_hash": { "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 *\"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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_get_api_index.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_get_api_reads_index.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_post_api_index.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_post_api_index_delete.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_post_api_index_fulltext.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_post_api_index_geo.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_post_api_index_hash.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_post_api_index_persistent.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_post_api_index_skiplist.md" }, "JSF_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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_get_api_index.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_get_api_reads_index.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_post_api_index.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_post_api_index_delete.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_post_api_index_fulltext.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_post_api_index_geo.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_post_api_index_hash.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_post_api_index_persistent.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_post_api_index_skiplist.md" }, "JSF_post_api_index_skiplist": { "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 *\"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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_get_api_index.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_get_api_reads_index.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_post_api_index.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_post_api_index_delete.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_post_api_index_fulltext.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_post_api_index_geo.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_post_api_index_hash.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_post_api_index_persistent.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_post_api_index_skiplist.md" }, "JSF_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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_delete_api_tasks.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_database_version.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_echo.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_long_echo.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_modules_flush.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_routing_reloads.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_server_id.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_server_role.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_sleep.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_statistics.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_statistics_description.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_time.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_cluster_endpoints.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_endpoint.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_initiate.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_return.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_tasks.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_tasks_all.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_engine.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_post_admin_execute.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_post_admin_test.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_post_api_new_tasks.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_put_api_new_tasks.md" }, "JSF_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" }, "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" }, "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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Transactions\\JSF_post_api_transaction.md" }, "JSF_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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_delete_batch_replication.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_applier_state.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_cluster_inventory.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_dump.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_logger_first_tick.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_logger_returns.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_logger_return_state.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_logger_tick_ranges.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_post_batch_replication.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_applier.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_applier_adjust.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_applier_start.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_applier_stop.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_inventory.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_makeSlave.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_serverID.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_synchronize.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_batch_replication.md" }, "JSF_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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_delete_api_tasks.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_database_version.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_echo.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_long_echo.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_modules_flush.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_routing_reloads.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_server_id.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_server_role.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_sleep.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_statistics.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_statistics_description.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_time.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_cluster_endpoints.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_endpoint.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_initiate.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_return.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_tasks.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_tasks_all.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_engine.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_post_admin_execute.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_post_admin_test.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_post_api_new_tasks.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_put_api_new_tasks.md" }, "JSF_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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_delete_batch_replication.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_applier_state.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_cluster_inventory.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_dump.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_logger_first_tick.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_logger_returns.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_logger_return_state.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_logger_tick_ranges.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_post_batch_replication.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_applier.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_applier_adjust.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_applier_start.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_applier_stop.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_inventory.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_makeSlave.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_serverID.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_synchronize.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_batch_replication.md" }, "JSF_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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_delete_batch_replication.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_applier_state.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_cluster_inventory.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_dump.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_logger_first_tick.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_logger_returns.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_logger_return_state.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_logger_tick_ranges.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_post_batch_replication.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_applier.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_applier_adjust.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_applier_start.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_applier_stop.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_inventory.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_makeSlave.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_serverID.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_synchronize.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_batch_replication.md" }, "JSF_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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_delete_batch_replication.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_applier_state.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_cluster_inventory.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_dump.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_logger_first_tick.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_logger_returns.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_logger_return_state.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_logger_tick_ranges.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_post_batch_replication.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_applier.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_applier_adjust.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_applier_start.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_applier_stop.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_inventory.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_makeSlave.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_serverID.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_synchronize.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_batch_replication.md" }, "JSF_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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_delete_batch_replication.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_applier_state.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_cluster_inventory.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_dump.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_logger_first_tick.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_logger_returns.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_logger_return_state.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_logger_tick_ranges.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_post_batch_replication.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_applier.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_applier_adjust.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_applier_start.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_applier_stop.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_inventory.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_makeSlave.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_serverID.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_synchronize.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_batch_replication.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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\DeleteApiQueryCache.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\DeleteApiQueryKill.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\DeleteApiQuerySlow.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\GetApiQueryCacheProperties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\GetApiQueryCurrent.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\GetApiQueryProperties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\GetApiQuerySlow.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\JSF_delete_api_aqlfunction.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\JSF_get_api_aqlfunction.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\JSF_post_api_aqlfunction.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\JSF_post_api_explain.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\PostApiQueryProperties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\PutApiQueryCacheProperties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\PutApiQueryProperties.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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\DeleteApiQueryCache.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\DeleteApiQueryKill.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\DeleteApiQuerySlow.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\GetApiQueryCacheProperties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\GetApiQueryCurrent.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\GetApiQueryProperties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\GetApiQuerySlow.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\JSF_delete_api_aqlfunction.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\JSF_get_api_aqlfunction.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\JSF_post_api_aqlfunction.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\JSF_post_api_explain.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\PostApiQueryProperties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\PutApiQueryCacheProperties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\PutApiQueryProperties.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" }, "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", "maxSlowQueries", "slowQueryThreshold", "maxQueryStringLength" ], "type": "object", "x-filename": "AQL - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\DeleteApiQueryCache.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\DeleteApiQueryKill.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\DeleteApiQuerySlow.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\GetApiQueryCacheProperties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\GetApiQueryCurrent.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\GetApiQueryProperties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\GetApiQuerySlow.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\JSF_delete_api_aqlfunction.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\JSF_get_api_aqlfunction.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\JSF_post_api_aqlfunction.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\JSF_post_api_explain.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\PostApiQueryProperties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\PutApiQueryCacheProperties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\PutApiQueryProperties.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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_CREATE.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_DELETE.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_DELETE_MULTI.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_READ.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_READ_ALL.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_READ_HEAD.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_REPLACE.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_REPLACE_MULTI.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_UPDATE.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_UPDATE_MULTI.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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_all.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_any.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_first_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_fulltext.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_near.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_range.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_remove_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_replace_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_update_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_within.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_within_rectangle.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\RestLookupByKeys.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\RestRemoveByKeys.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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_all.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_any.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_first_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_fulltext.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_near.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_range.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_remove_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_replace_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_update_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_within.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_within_rectangle.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\RestLookupByKeys.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\RestRemoveByKeys.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\nstring will be used. If you pass the special value\n*ARANGODB_DEFAULT_ROOT_PASSWORD*, the password will be set the value\nstored 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\nAmazon.\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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\User Management\\README.md" }, "UserHandling_grantDatabase": { "properties": { "grant": { "description": "Use \"rw\" to grant read and write access rights, or \"ro\" to\ngrant read-only access right. To revoke access rights, use \"none\".\n\n", "type": "string" } }, "required": [ "grant" ], "type": "object", "x-filename": "User Management - C:/Users/User/arangodb/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 - C:/Users/User/arangodb/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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\User Management\\README.md" }, "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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_checksum.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_count.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_figures.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_name.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_properties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_revision.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_delete_api_collection.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_get_api_collections.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_post_api_collection.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_load.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_properties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_rename.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_rotate.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_truncate.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_unload.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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_checksum.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_count.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_figures.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_name.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_properties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_revision.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_delete_api_collection.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_get_api_collections.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_post_api_collection.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_load.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_properties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_rename.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_rotate.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_truncate.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_unload.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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_checksum.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_count.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_figures.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_name.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_properties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_revision.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_delete_api_collection.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_get_api_collections.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_post_api_collection.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_load.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_properties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_rename.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_rotate.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_truncate.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_unload.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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_checksum.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_count.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_figures.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_name.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_properties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_revision.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_delete_api_collection.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_get_api_collections.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_post_api_collection.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_load.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_properties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_rename.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_rotate.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_truncate.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_unload.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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_checksum.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_count.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_figures.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_name.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_properties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_revision.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_delete_api_collection.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_get_api_collections.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_post_api_collection.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_load.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_properties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_rename.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_rotate.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_truncate.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_unload.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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_checksum.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_count.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_figures.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_name.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_properties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_revision.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_delete_api_collection.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_get_api_collections.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_post_api_collection.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_load.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_properties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_rename.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_rotate.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_truncate.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_unload.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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_checksum.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_count.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_figures.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_name.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_properties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_revision.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_delete_api_collection.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_get_api_collections.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_post_api_collection.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_load.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_properties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_rename.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_rotate.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_truncate.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_unload.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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_checksum.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_count.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_figures.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_name.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_properties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_revision.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_delete_api_collection.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_get_api_collections.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_post_api_collection.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_load.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_properties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_rename.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_rotate.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_truncate.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_unload.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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_checksum.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_count.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_figures.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_name.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_properties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_revision.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_delete_api_collection.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_get_api_collections.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_post_api_collection.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_load.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_properties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_rename.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_rotate.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_truncate.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_unload.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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_checksum.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_count.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_figures.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_name.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_properties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_revision.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_delete_api_collection.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_get_api_collections.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_post_api_collection.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_load.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_properties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_rename.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_rotate.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_truncate.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_unload.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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\DeleteApiQueryCache.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\DeleteApiQueryKill.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\DeleteApiQuerySlow.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\GetApiQueryCacheProperties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\GetApiQueryCurrent.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\GetApiQueryProperties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\GetApiQuerySlow.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\JSF_delete_api_aqlfunction.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\JSF_get_api_aqlfunction.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\JSF_post_api_aqlfunction.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\JSF_post_api_explain.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\PostApiQueryProperties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\PutApiQueryCacheProperties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\PutApiQueryProperties.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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_create_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_drop_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_create_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_definition_add_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_definition_modify_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_definition_remove_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_delete_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_get_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_modify_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_replace_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_get_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_list_edge_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_list_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_list_vertex_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_collection_add_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_collection_remove_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_create_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_delete_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_get_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_modify_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_replace_http_examples.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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_all.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_any.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_first_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_fulltext.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_near.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_range.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_remove_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_replace_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_update_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_within.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_within_rectangle.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\RestLookupByKeys.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\RestRemoveByKeys.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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_all.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_any.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_first_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_fulltext.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_near.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_range.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_remove_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_replace_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_update_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_within.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_within_rectangle.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\RestLookupByKeys.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\RestRemoveByKeys.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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_all.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_any.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_first_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_fulltext.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_near.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_range.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_remove_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_replace_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_update_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_within.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_within_rectangle.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\RestLookupByKeys.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\RestRemoveByKeys.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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_all.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_any.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_first_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_fulltext.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_near.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_range.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_remove_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_replace_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_update_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_within.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_within_rectangle.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\RestLookupByKeys.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\RestRemoveByKeys.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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Cluster\\JSF_cluster_check_port_GET.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Cluster\\JSF_cluster_statistics_GET.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Cluster\\JSF_cluster_test_DELETE.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Cluster\\JSF_cluster_test_GET.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Cluster\\JSF_cluster_test_HEAD.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Cluster\\JSF_cluster_test_PATCH.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Cluster\\JSF_cluster_test_POST.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Cluster\\JSF_cluster_test_PUT.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/*. 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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Cluster\\JSF_cluster_check_port_GET.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Cluster\\JSF_cluster_statistics_GET.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Cluster\\JSF_cluster_test_DELETE.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Cluster\\JSF_cluster_test_GET.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Cluster\\JSF_cluster_test_HEAD.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Cluster\\JSF_cluster_test_PATCH.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Cluster\\JSF_cluster_test_POST.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Cluster\\JSF_cluster_test_PUT.md" }, "head": { "description": "\n\nSee GET method.\n\n\n", "parameters": [], "summary": " Execute cluster roundtrip", "tags": [ "Cluster" ], "x-examples": [], "x-filename": "Cluster - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Cluster\\JSF_cluster_check_port_GET.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Cluster\\JSF_cluster_statistics_GET.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Cluster\\JSF_cluster_test_DELETE.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Cluster\\JSF_cluster_test_GET.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Cluster\\JSF_cluster_test_HEAD.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Cluster\\JSF_cluster_test_PATCH.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Cluster\\JSF_cluster_test_POST.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Cluster\\JSF_cluster_test_PUT.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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Cluster\\JSF_cluster_check_port_GET.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Cluster\\JSF_cluster_statistics_GET.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Cluster\\JSF_cluster_test_DELETE.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Cluster\\JSF_cluster_test_GET.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Cluster\\JSF_cluster_test_HEAD.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Cluster\\JSF_cluster_test_PATCH.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Cluster\\JSF_cluster_test_POST.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Cluster\\JSF_cluster_test_PUT.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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Cluster\\JSF_cluster_check_port_GET.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Cluster\\JSF_cluster_statistics_GET.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Cluster\\JSF_cluster_test_DELETE.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Cluster\\JSF_cluster_test_GET.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Cluster\\JSF_cluster_test_HEAD.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Cluster\\JSF_cluster_test_PATCH.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Cluster\\JSF_cluster_test_POST.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Cluster\\JSF_cluster_test_PUT.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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Cluster\\JSF_cluster_check_port_GET.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Cluster\\JSF_cluster_statistics_GET.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Cluster\\JSF_cluster_test_DELETE.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Cluster\\JSF_cluster_test_GET.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Cluster\\JSF_cluster_test_HEAD.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Cluster\\JSF_cluster_test_PATCH.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Cluster\\JSF_cluster_test_POST.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Cluster\\JSF_cluster_test_PUT.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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Cluster\\JSF_cluster_check_port_GET.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Cluster\\JSF_cluster_statistics_GET.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Cluster\\JSF_cluster_test_DELETE.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Cluster\\JSF_cluster_test_GET.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Cluster\\JSF_cluster_test_HEAD.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Cluster\\JSF_cluster_test_PATCH.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Cluster\\JSF_cluster_test_POST.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Cluster\\JSF_cluster_test_PUT.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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Cluster\\JSF_cluster_check_port_GET.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Cluster\\JSF_cluster_statistics_GET.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Cluster\\JSF_cluster_test_DELETE.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Cluster\\JSF_cluster_test_GET.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Cluster\\JSF_cluster_test_HEAD.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Cluster\\JSF_cluster_test_PATCH.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Cluster\\JSF_cluster_test_POST.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Cluster\\JSF_cluster_test_PUT.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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_delete_api_tasks.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_database_version.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_echo.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_long_echo.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_modules_flush.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_routing_reloads.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_server_id.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_server_role.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_sleep.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_statistics.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_statistics_description.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_time.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_cluster_endpoints.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_endpoint.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_initiate.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_return.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_tasks.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_tasks_all.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_engine.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_post_admin_execute.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_post_admin_test.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_post_api_new_tasks.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_put_api_new_tasks.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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_delete_api_tasks.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_database_version.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_echo.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_long_echo.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_modules_flush.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_routing_reloads.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_server_id.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_server_role.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_sleep.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_statistics.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_statistics_description.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_time.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_cluster_endpoints.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_endpoint.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_initiate.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_return.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_tasks.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_tasks_all.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_engine.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_post_admin_execute.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_post_admin_test.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_post_api_new_tasks.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_put_api_new_tasks.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\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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_delete_api_tasks.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_database_version.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_echo.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_long_echo.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_modules_flush.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_routing_reloads.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_server_id.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_server_role.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_sleep.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_statistics.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_statistics_description.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_time.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_cluster_endpoints.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_endpoint.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_initiate.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_return.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_tasks.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_tasks_all.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_engine.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_post_admin_execute.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_post_admin_test.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_post_api_new_tasks.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_put_api_new_tasks.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- *lid*: a list of log entry identifiers. Each log message is uniquely\n identified by its @LIT{lid} and the identifiers are in ascending\n order.\n\n- *level*: a list of the log-levels for all log entries.\n\n- *timestamp*: a list of the timestamps as seconds since 1970-01-01 for all log\n entries.\n\n- *text* a list of the texts of all log entries\n\n- *topic* a list of the topics of all log entries\n\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" } ], "responses": { "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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_delete_api_tasks.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_database_version.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_echo.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_long_echo.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_modules_flush.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_routing_reloads.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_server_id.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_server_role.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_sleep.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_statistics.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_statistics_description.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_time.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_cluster_endpoints.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_endpoint.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_initiate.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_return.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_tasks.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_tasks_all.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_engine.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_post_admin_execute.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_post_admin_test.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_post_api_new_tasks.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_put_api_new_tasks.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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_delete_api_tasks.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_database_version.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_echo.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_long_echo.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_modules_flush.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_routing_reloads.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_server_id.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_server_role.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_sleep.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_statistics.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_statistics_description.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_time.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_cluster_endpoints.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_endpoint.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_initiate.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_return.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_tasks.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_tasks_all.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_engine.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_post_admin_execute.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_post_admin_test.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_post_api_new_tasks.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_put_api_new_tasks.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\n", "parameters": [], "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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_delete_api_tasks.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_database_version.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_echo.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_long_echo.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_modules_flush.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_routing_reloads.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_server_id.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_server_role.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_sleep.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_statistics.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_statistics_description.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_time.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_cluster_endpoints.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_endpoint.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_initiate.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_return.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_tasks.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_tasks_all.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_engine.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_post_admin_execute.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_post_admin_test.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_post_api_new_tasks.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_put_api_new_tasks.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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_delete_api_tasks.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_database_version.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_echo.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_long_echo.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_modules_flush.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_routing_reloads.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_server_id.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_server_role.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_sleep.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_statistics.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_statistics_description.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_time.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_cluster_endpoints.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_endpoint.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_initiate.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_return.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_tasks.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_tasks_all.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_engine.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_post_admin_execute.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_post_admin_test.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_post_api_new_tasks.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_put_api_new_tasks.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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_delete_api_tasks.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_database_version.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_echo.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_long_echo.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_modules_flush.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_routing_reloads.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_server_id.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_server_role.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_sleep.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_statistics.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_statistics_description.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_time.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_cluster_endpoints.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_endpoint.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_initiate.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_return.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_tasks.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_tasks_all.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_engine.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_post_admin_execute.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_post_admin_test.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_post_api_new_tasks.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_put_api_new_tasks.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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_delete_api_tasks.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_database_version.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_echo.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_long_echo.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_modules_flush.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_routing_reloads.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_server_id.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_server_role.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_sleep.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_statistics.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_statistics_description.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_time.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_cluster_endpoints.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_endpoint.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_initiate.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_return.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_tasks.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_tasks_all.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_engine.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_post_admin_execute.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_post_admin_test.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_post_api_new_tasks.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_put_api_new_tasks.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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_delete_api_tasks.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_database_version.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_echo.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_long_echo.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_modules_flush.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_routing_reloads.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_server_id.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_server_role.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_sleep.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_statistics.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_statistics_description.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_time.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_cluster_endpoints.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_endpoint.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_initiate.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_return.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_tasks.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_tasks_all.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_engine.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_post_admin_execute.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_post_admin_test.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_post_api_new_tasks.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_put_api_new_tasks.md" } }, "/_admin/shutdown": { "delete": { "description": "\n\nThis call initiates a clean shutdown sequence.\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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_delete_api_tasks.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_database_version.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_echo.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_long_echo.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_modules_flush.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_routing_reloads.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_server_id.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_server_role.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_sleep.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_statistics.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_statistics_description.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_time.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_cluster_endpoints.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_endpoint.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_initiate.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_return.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_tasks.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_tasks_all.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_engine.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_post_admin_execute.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_post_admin_test.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_post_api_new_tasks.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_put_api_new_tasks.md" } }, "/_admin/sleep": { "get": { "description": "\n\n\nThe call returns an object with the attribute *duration*. This takes\nas many seconds as the duration argument says.\n\n", "parameters": [ { "description": "wait `duration` seconds until the reply is sent.\n\n", "format": "integer", "in": "path", "name": "duration", "required": true, "type": "integer" } ], "responses": { "200": { "description": "Sleep was conducted successfully.\n\n\n" } }, "summary": " Sleep for a specified amount of seconds", "tags": [ "Administration" ], "x-examples": [], "x-filename": "Administration - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_delete_api_tasks.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_database_version.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_echo.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_long_echo.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_modules_flush.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_routing_reloads.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_server_id.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_server_role.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_sleep.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_statistics.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_statistics_description.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_time.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_cluster_endpoints.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_endpoint.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_initiate.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_return.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_tasks.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_tasks_all.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_engine.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_post_admin_execute.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_post_admin_test.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_post_api_new_tasks.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_put_api_new_tasks.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
shell> curl --dump - http://localhost:8529/_admin/statistics\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"time\" : 1495101976.733281, \n  \"enabled\" : true, \n  \"system\" : { \n    \"minorPageFaults\" : 102201, \n    \"majorPageFaults\" : 89, \n    \"userTime\" : 5.37, \n    \"systemTime\" : 1.68, \n    \"numberOfThreads\" : 39, \n    \"residentSize\" : 367796224, \n    \"residentSizePercent\" : 0.010904187560672258, \n    \"virtualSize\" : 2582093824 \n  }, \n  \"client\" : { \n    \"httpConnections\" : 1, \n    \"connectionTime\" : { \n      \"sum\" : 0, \n      \"count\" : 0, \n      \"counts\" : [ \n        0, \n        0, \n        0, \n        0 \n      ] \n    }, \n    \"totalTime\" : { \n      \"sum\" : 20.083841562271118, \n      \"count\" : 3793, \n      \"counts\" : [ \n        3528, \n        93, \n        140, \n        27, \n        4, \n        1, \n        0 \n      ] \n    }, \n    \"requestTime\" : { \n      \"sum\" : 0.03119635581970215, \n      \"count\" : 3793, \n      \"counts\" : [ \n        3792, \n        1, \n        0, \n        0, \n        0, \n        0, \n        0 \n      ] \n    }, \n    \"queueTime\" : { \n      \"sum\" : 0.0006351470947265625, \n      \"count\" : 9, \n      \"counts\" : [ \n        9, \n        0, \n        0, \n        0, \n        0, \n        0, \n        0 \n      ] \n    }, \n    \"ioTime\" : { \n      \"sum\" : 20.05201005935669, \n      \"count\" : 3793, \n      \"counts\" : [ \n        3529, \n        92, \n        140, \n        27, \n        4, \n        1, \n        0 \n      ] \n    }, \n    \"bytesSent\" : { \n      \"sum\" : 1444780, \n      \"count\" : 3793, \n      \"counts\" : [ \n        276, \n        3187, \n        324, \n        6, \n        0, \n        0 \n      ] \n    }, \n    \"bytesReceived\" : { \n      \"sum\" : 824056, \n      \"count\" : 3793, \n      \"counts\" : [ \n        3506, \n        287, \n        0, \n        0, \n        0, \n        0 \n      ] \n    } \n  }, \n  \"http\" : { \n    \"requestsTotal\" : 3793, \n    \"requestsAsync\" : 9, \n    \"requestsGet\" : 782, \n    \"requestsHead\" : 0, \n    \"requestsPost\" : 2794, \n    \"requestsPut\" : 66, \n    \"requestsPatch\" : 3, \n    \"requestsDelete\" : 148, \n    \"requestsOptions\" : 0, \n    \"requestsOther\" : 0 \n  }, \n  \"server\" : { \n    \"uptime\" : 54.41809391975403, \n    \"physicalMemory\" : 33729814528 \n  }, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_delete_api_tasks.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_database_version.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_echo.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_long_echo.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_modules_flush.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_routing_reloads.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_server_id.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_server_role.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_sleep.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_statistics.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_statistics_description.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_time.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_cluster_endpoints.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_endpoint.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_initiate.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_return.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_tasks.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_tasks_all.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_engine.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_post_admin_execute.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_post_admin_test.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_post_api_new_tasks.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_put_api_new_tasks.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
shell> curl --dump - http://localhost:8529/_admin/statistics-description\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"groups\" : [ \n    { \n      \"group\" : \"system\", \n      \"name\" : \"Process Statistics\", \n      \"description\" : \"Statistics about the ArangoDB process\" \n    }, \n    { \n      \"group\" : \"client\", \n      \"name\" : \"Client Connection Statistics\", \n      \"description\" : \"Statistics about the connections.\" \n    }, \n    { \n      \"group\" : \"http\", \n      \"name\" : \"HTTP Request Statistics\", \n      \"description\" : \"Statistics about the HTTP requests.\" \n    }, \n    { \n      \"group\" : \"server\", \n      \"name\" : \"Server Statistics\", \n      \"description\" : \"Statistics about the ArangoDB server\" \n    } \n  ], \n  \"figures\" : [ \n    { \n      \"group\" : \"system\", \n      \"identifier\" : \"userTime\", \n      \"name\" : \"User Time\", \n      \"description\" : \"Amount of time that this process has been scheduled in user mode, measured in seconds.\", \n      \"type\" : \"accumulated\", \n      \"units\" : \"seconds\" \n    }, \n    { \n      \"group\" : \"system\", \n      \"identifier\" : \"systemTime\", \n      \"name\" : \"System Time\", \n      \"description\" : \"Amount of time that this process has been scheduled in kernel mode, measured in seconds.\", \n      \"type\" : \"accumulated\", \n      \"units\" : \"seconds\" \n    }, \n    { \n      \"group\" : \"system\", \n      \"identifier\" : \"numberOfThreads\", \n      \"name\" : \"Number of Threads\", \n      \"description\" : \"Number of threads in the arangod process.\", \n      \"type\" : \"current\", \n      \"units\" : \"number\" \n    }, \n    { \n      \"group\" : \"system\", \n      \"identifier\" : \"residentSize\", \n      \"name\" : \"Resident Set Size\", \n      \"description\" : \"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.\", \n      \"type\" : \"current\", \n      \"units\" : \"bytes\" \n    }, \n    { \n      \"group\" : \"system\", \n      \"identifier\" : \"residentSizePercent\", \n      \"name\" : \"Resident Set Size\", \n      \"description\" : \"The percentage of physical memory used by the process as resident set size.\", \n      \"type\" : \"current\", \n      \"units\" : \"percent\" \n    }, \n    { \n      \"group\" : \"system\", \n      \"identifier\" : \"virtualSize\", \n      \"name\" : \"Virtual Memory Size\", \n      \"description\" : \"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.\", \n      \"type\" : \"current\", \n      \"units\" : \"bytes\" \n    }, \n    { \n      \"group\" : \"system\", \n      \"identifier\" : \"minorPageFaults\", \n      \"name\" : \"Minor Page Faults\", \n      \"description\" : \"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.\", \n      \"type\" : \"accumulated\", \n      \"units\" : \"number\" \n    }, \n    { \n      \"group\" : \"system\", \n      \"identifier\" : \"majorPageFaults\", \n      \"name\" : \"Major Page Faults\", \n      \"description\" : \"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.\", \n      \"type\" : \"accumulated\", \n      \"units\" : \"number\" \n    }, \n    { \n      \"group\" : \"client\", \n      \"identifier\" : \"httpConnections\", \n      \"name\" : \"Client Connections\", \n      \"description\" : \"The number of connections that are currently open.\", \n      \"type\" : \"current\", \n      \"units\" : \"number\" \n    }, \n    { \n      \"group\" : \"client\", \n      \"identifier\" : \"totalTime\", \n      \"name\" : \"Total Time\", \n      \"description\" : \"Total time needed to answer a request.\", \n      \"type\" : \"distribution\", \n      \"cuts\" : [ \n        0.01, \n        0.05, \n        0.1, \n        0.2, \n        0.5, \n        1 \n      ], \n      \"units\" : \"seconds\" \n    }, \n    { \n      \"group\" : \"client\", \n      \"identifier\" : \"requestTime\", \n      \"name\" : \"Request Time\", \n      \"description\" : \"Request time needed to answer a request.\", \n      \"type\" : \"distribution\", \n      \"cuts\" : [ \n        0.01, \n        0.05, \n        0.1, \n        0.2, \n        0.5, \n        1 \n      ], \n      \"units\" : \"seconds\" \n    }, \n    { \n      \"group\" : \"client\", \n      \"identifier\" : \"queueTime\", \n      \"name\" : \"Queue Time\", \n      \"description\" : \"Queue time needed to answer a request.\", \n      \"type\" : \"distribution\", \n      \"cuts\" : [ \n        0.01, \n        0.05, \n        0.1, \n        0.2, \n        0.5, \n        1 \n      ], \n      \"units\" : \"seconds\" \n    }, \n    { \n      \"group\" : \"client\", \n      \"identifier\" : \"bytesSent\", \n      \"name\" : \"Bytes Sent\", \n      \"description\" : \"Bytes sents for a request.\", \n      \"type\" : \"distribution\", \n      \"cuts\" : [ \n        250, \n        1000, \n        2000, \n        5000, \n        10000 \n      ], \n      \"units\" : \"bytes\" \n    }, \n    { \n      \"group\" : \"client\", \n      \"identifier\" : \"bytesReceived\", \n      \"name\" : \"Bytes Received\", \n      \"description\" : \"Bytes receiveds for a request.\", \n      \"type\" : \"distribution\", \n      \"cuts\" : [ \n        250, \n        1000, \n        2000, \n        5000, \n        10000 \n      ], \n      \"units\" : \"bytes\" \n    }, \n    { \n      \"group\" : \"client\", \n      \"identifier\" : \"connectionTime\", \n      \"name\" : \"Connection Time\", \n      \"description\" : \"Total connection time of a client.\", \n      \"type\" : \"distribution\", \n      \"cuts\" : [ \n        0.1, \n        1, \n        60 \n      ], \n      \"units\" : \"seconds\" \n    }, \n    { \n      \"group\" : \"http\", \n      \"identifier\" : \"requestsTotal\", \n      \"name\" : \"Total requests\", \n      \"description\" : \"Total number of HTTP requests.\", \n      \"type\" : \"accumulated\", \n      \"units\" : \"number\" \n    }, \n    { \n      \"group\" : \"http\", \n      \"identifier\" : \"requestsAsync\", \n      \"name\" : \"Async requests\", \n      \"description\" : \"Number of asynchronously executed HTTP requests.\", \n      \"type\" : \"accumulated\", \n      \"units\" : \"number\" \n    }, \n    { \n      \"group\" : \"http\", \n      \"identifier\" : \"requestsGet\", \n      \"name\" : \"HTTP GET requests\", \n      \"description\" : \"Number of HTTP GET requests.\", \n      \"type\" : \"accumulated\", \n      \"units\" : \"number\" \n    }, \n    { \n      \"group\" : \"http\", \n      \"identifier\" : \"requestsHead\", \n      \"name\" : \"HTTP HEAD requests\", \n      \"description\" : \"Number of HTTP HEAD requests.\", \n      \"type\" : \"accumulated\", \n      \"units\" : \"number\" \n    }, \n    { \n      \"group\" : \"http\", \n      \"identifier\" : \"requestsPost\", \n      \"name\" : \"HTTP POST requests\", \n      \"description\" : \"Number of HTTP POST requests.\", \n      \"type\" : \"accumulated\", \n      \"units\" : \"number\" \n    }, \n    { \n      \"group\" : \"http\", \n      \"identifier\" : \"requestsPut\", \n      \"name\" : \"HTTP PUT requests\", \n      \"description\" : \"Number of HTTP PUT requests.\", \n      \"type\" : \"accumulated\", \n      \"units\" : \"number\" \n    }, \n    { \n      \"group\" : \"http\", \n      \"identifier\" : \"requestsPatch\", \n      \"name\" : \"HTTP PATCH requests\", \n      \"description\" : \"Number of HTTP PATCH requests.\", \n      \"type\" : \"accumulated\", \n      \"units\" : \"number\" \n    }, \n    { \n      \"group\" : \"http\", \n      \"identifier\" : \"requestsDelete\", \n      \"name\" : \"HTTP DELETE requests\", \n      \"description\" : \"Number of HTTP DELETE requests.\", \n      \"type\" : \"accumulated\", \n      \"units\" : \"number\" \n    }, \n    { \n      \"group\" : \"http\", \n      \"identifier\" : \"requestsOptions\", \n      \"name\" : \"HTTP OPTIONS requests\", \n      \"description\" : \"Number of HTTP OPTIONS requests.\", \n      \"type\" : \"accumulated\", \n      \"units\" : \"number\" \n    }, \n    { \n      \"group\" : \"http\", \n      \"identifier\" : \"requestsOther\", \n      \"name\" : \"other HTTP requests\", \n      \"description\" : \"Number of other HTTP requests.\", \n      \"type\" : \"accumulated\", \n      \"units\" : \"number\" \n    }, \n    { \n      \"group\" : \"server\", \n      \"identifier\" : \"uptime\", \n      \"name\" : \"Server Uptime\", \n      \"description\" : \"Number of seconds elapsed since server start.\", \n      \"type\" : \"current\", \n      \"units\" : \"seconds\" \n    }, \n    { \n      \"group\" : \"server\", \n      \"identifier\" : \"physicalMemory\", \n      \"name\" : \"Physical Memory\", \n      \"description\" : \"Physical memory in bytes.\", \n      \"type\" : \"current\", \n      \"units\" : \"bytes\" \n    } \n  ], \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_delete_api_tasks.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_database_version.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_echo.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_long_echo.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_modules_flush.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_routing_reloads.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_server_id.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_server_role.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_sleep.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_statistics.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_statistics_description.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_time.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_cluster_endpoints.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_endpoint.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_initiate.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_return.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_tasks.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_tasks_all.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_engine.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_post_admin_execute.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_post_admin_test.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_post_api_new_tasks.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_put_api_new_tasks.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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_delete_api_tasks.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_database_version.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_echo.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_long_echo.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_modules_flush.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_routing_reloads.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_server_id.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_server_role.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_sleep.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_statistics.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_statistics_description.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_time.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_cluster_endpoints.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_endpoint.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_initiate.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_return.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_tasks.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_tasks_all.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_engine.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_post_admin_execute.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_post_admin_test.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_post_api_new_tasks.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_put_api_new_tasks.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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_delete_api_tasks.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_database_version.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_echo.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_long_echo.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_modules_flush.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_routing_reloads.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_server_id.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_server_role.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_sleep.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_statistics.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_statistics_description.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_time.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_cluster_endpoints.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_endpoint.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_initiate.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_return.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_tasks.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_tasks_all.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_engine.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_post_admin_execute.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_post_admin_test.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_post_api_new_tasks.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_put_api_new_tasks.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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\wal\\JSF_get_admin_wal_properties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\wal\\JSF_get_admin_wal_transactions.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\wal\\JSF_put_admin_wal_flush.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\wal\\JSF_put_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
shell> curl --dump - http://localhost:8529/_admin/wal/properties\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"allowOversizeEntries\" : true, \n  \"logfileSize\" : 33554432, \n  \"historicLogfiles\" : 10, \n  \"reserveLogfiles\" : 3, \n  \"syncInterval\" : 100, \n  \"throttleWait\" : 15000, \n  \"throttleWhenPending\" : 0 \n}\n
\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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\wal\\JSF_get_admin_wal_properties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\wal\\JSF_get_admin_wal_transactions.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\wal\\JSF_put_admin_wal_flush.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\wal\\JSF_put_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
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_admin/wal/properties <<EOF\n{ \n  \"logfileSize\" : 33554432, \n  \"allowOversizeEntries\" : true \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"allowOversizeEntries\" : true, \n  \"logfileSize\" : 33554432, \n  \"historicLogfiles\" : 10, \n  \"reserveLogfiles\" : 3, \n  \"syncInterval\" : 100, \n  \"throttleWait\" : 15000, \n  \"throttleWhenPending\" : 0 \n}\n
\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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\wal\\JSF_get_admin_wal_properties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\wal\\JSF_get_admin_wal_transactions.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\wal\\JSF_put_admin_wal_flush.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\wal\\JSF_put_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
shell> curl --dump - http://localhost:8529/_admin/wal/transactions\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"runningTransactions\" : 2, \n  \"minLastCollected\" : 23, \n  \"minLastSealed\" : null \n}\n
\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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\wal\\JSF_get_admin_wal_properties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\wal\\JSF_get_admin_wal_transactions.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\wal\\JSF_put_admin_wal_flush.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\wal\\JSF_put_admin_wal_properties.md" } }, "/_api/aqlfunction": { "get": { "description": "\n\nReturns all registered AQL user functions.\n\nThe call will return a JSON array with all user functions found. Each user\nfunction will at least have the following attributes:\n\n- *name*: The fully qualified name of the user function\n\n- *code*: A string representation of the function body\n\n\n\n\n#Example:\n \n\n
shell> curl --dump - http://localhost:8529/_api/aqlfunction\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n[ \n  { \n    \"name\" : \"myfunctions::temperature::celsiustofahrenheit\", \n    \"code\" : \"function (celsius) { return celsius * 1.8 + 32; }\" \n  } \n]\n
\n\n\n\n\n", "parameters": [ { "description": "Returns all registered AQL user functions from namespace *namespace*.\n\n", "in": "query", "name": "namespace", "required": false, "type": "string" } ], "responses": { "200": { "description": "if success *HTTP 200* is returned.\n\n" } }, "summary": " Return registered AQL user functions", "tags": [ "AQL" ], "x-examples": [], "x-filename": "AQL - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\DeleteApiQueryCache.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\DeleteApiQueryKill.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\DeleteApiQuerySlow.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\GetApiQueryCacheProperties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\GetApiQueryCurrent.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\GetApiQueryProperties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\GetApiQuerySlow.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\JSF_delete_api_aqlfunction.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\JSF_get_api_aqlfunction.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\JSF_post_api_aqlfunction.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\JSF_post_api_explain.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\PostApiQueryProperties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\PutApiQueryCacheProperties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\PutApiQueryProperties.md" }, "post": { "description": "\n**A json post document with these Properties is required:**\n\n - **isDeterministic**: an optional boolean value to indicate that 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, the 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\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\n\n\n\n#Example:\n \n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/aqlfunction <<EOF\n{ \n  \"name\" : \"myfunctions::temperature::celsiustofahrenheit\", \n  \"code\" : \"function (celsius) { return celsius * 1.8 + 32; }\" \n}\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n", "parameters": [ { "in": "body", "name": "Json Request Body", "required": true, "schema": { "$ref": "#/definitions/JSF_post_api_aqlfunction" }, "x-description-offset": 61 } ], "responses": { "200": { "description": "If the function already existed and was replaced by the\ncall, the server will respond with *HTTP 200*.\n\n" }, "201": { "description": "If the function can be registered by the server, the server will respond with\n*HTTP 201*.\n\n" }, "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" } }, "summary": " Create AQL user function", "tags": [ "AQL" ], "x-examples": [], "x-filename": "AQL - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\DeleteApiQueryCache.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\DeleteApiQueryKill.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\DeleteApiQuerySlow.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\GetApiQueryCacheProperties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\GetApiQueryCurrent.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\GetApiQueryProperties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\GetApiQuerySlow.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\JSF_delete_api_aqlfunction.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\JSF_get_api_aqlfunction.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\JSF_post_api_aqlfunction.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\JSF_post_api_explain.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\PostApiQueryProperties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\PutApiQueryCacheProperties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\PutApiQueryProperties.md" } }, "/_api/aqlfunction/{name}": { "delete": { "description": "\n\n\nRemoves an existing AQL user function, identified by *name*.\n\nIn case of success, the 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\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\n\n\n\n#Example:\n deletes a function:\n\n
shell> curl -X DELETE --dump - http://localhost:8529/_api/aqlfunction/square::x::y\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n#Example:\n function not found:\n\n
shell> curl -X DELETE --dump - http://localhost:8529/_api/aqlfunction/myfunction::x::y\n\nHTTP/1.1 404 Not Found\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"error\" : true, \n  \"code\" : 404, \n  \"errorNum\" : 1582, \n  \"errorMessage\" : \"user function '%s()' not found\" \n}\n
\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": "If set to *true*, then the function name provided in *name* is treated as\na namespace prefix, and all functions in the specified namespace will be deleted.\nIf set to *false*, the function name provided in *name* must be fully\nqualified, including any namespaces.\n\n", "in": "query", "name": "group", "required": false, "type": "string" } ], "responses": { "200": { "description": "If the function can be removed by the server, the server will respond with\n*HTTP 200*.\n\n" }, "400": { "description": "If the user function name is malformed, the server will respond with *HTTP 400*.\n\n" }, "404": { "description": "If the specified user user function does not exist, the server will respond with *HTTP 404*.\n\n" } }, "summary": " Remove existing AQL user function", "tags": [ "AQL" ], "x-examples": [], "x-filename": "AQL - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\DeleteApiQueryCache.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\DeleteApiQueryKill.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\DeleteApiQuerySlow.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\GetApiQueryCacheProperties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\GetApiQueryCurrent.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\GetApiQueryProperties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\GetApiQuerySlow.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\JSF_delete_api_aqlfunction.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\JSF_get_api_aqlfunction.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\JSF_post_api_aqlfunction.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\JSF_post_api_explain.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\PostApiQueryProperties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\PutApiQueryCacheProperties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\PutApiQueryProperties.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
shell> curl -X POST --header 'Content-Type: multipart/form-data; boundary=SomeBoundaryValue' --data-binary @- --dump - http://localhost:8529/_api/batch <<EOF\n--SomeBoundaryValue\nContent-Type: application/x-arango-batchpart\nContent-Id: myId1\n\nGET /_api/version HTTP/1.1\n\n--SomeBoundaryValue\nContent-Type: application/x-arango-batchpart\nContent-Id: myId2\n\nDELETE /_api/collection/products HTTP/1.1\n\n--SomeBoundaryValue\nContent-Type: application/x-arango-batchpart\nContent-Id: someId\n\nPOST /_api/collection/products HTTP/1.1\n\n{\"name\": \"products\" }\n\n--SomeBoundaryValue\nContent-Type: application/x-arango-batchpart\nContent-Id: nextId\n\nGET /_api/collection/products/figures HTTP/1.1\n\n--SomeBoundaryValue\nContent-Type: application/x-arango-batchpart\nContent-Id: otherId\n\nDELETE /_api/collection/products HTTP/1.1\n--SomeBoundaryValue--\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.2.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: 88\\r\\n\\r\\n{\\\"error\\\":true,\\\"code\\\":404,\\\"errorNum\\\":1203,\\\"errorMessage\\\":\\\"unknown collection 'products'\\\"}\\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\\nLocation: /_db/_system/_api/collection/products\\r\\nConnection: \\r\\nContent-Type: application/json; charset=utf-8\\r\\nContent-Length: 132\\r\\n\\r\\n{\\\"id\\\":\\\"9190\\\",\\\"name\\\":\\\"products\\\",\\\"waitForSync\\\":false,\\\"isVolatile\\\":false,\\\"isSystem\\\":false,\\\"status\\\":3,\\\"type\\\":2,\\\"error\\\":false,\\\"code\\\":200}\\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: /_db/_system/_api/collection/products/figures\\r\\nConnection: \\r\\nContent-Type: application/json; charset=utf-8\\r\\nContent-Length: 694\\r\\n\\r\\n{\\\"id\\\":\\\"9190\\\",\\\"name\\\":\\\"products\\\",\\\"isSystem\\\":false,\\\"doCompact\\\":true,\\\"isVolatile\\\":false,\\\"journalSize\\\":33554432,\\\"keyOptions\\\":{\\\"type\\\":\\\"traditional\\\",\\\"allowUserKeys\\\":true},\\\"waitForSync\\\":false,\\\"indexBuckets\\\":8,\\\"count\\\":0,\\\"figures\\\":{\\\"indexes\\\":{\\\"count\\\":1,\\\"size\\\":32128},\\\"compactionStatus\\\":{\\\"message\\\":\\\"compaction not yet started\\\",\\\"time\\\":\\\"2017-05-18T10:06:16Z\\\"},\\\"documentReferences\\\":0,\\\"waitingFor\\\":\\\"-\\\",\\\"alive\\\":{\\\"count\\\":0,\\\"size\\\":0},\\\"dead\\\":{\\\"count\\\":0,\\\"size\\\":0,\\\"deletion\\\":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},\\\"status\\\":3,\\\"type\\\":2,\\\"error\\\":false,\\\"code\\\":200}\\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: 38\\r\\n\\r\\n{\\\"id\\\":\\\"9190\\\",\\\"error\\\":false,\\\"code\\\":200}\\r\\n--SomeBoundaryValue--\"\n
\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
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/batch <<EOF\n--SomeBoundaryValue\nContent-Type: application/x-arango-batchpart\n\nDELETE /_api/collection/notexisting1 HTTP/1.1\n\n--SomeBoundaryValue\nContent-Type: application/x-arango-batchpart\n\nDELETE _api/collection/notexisting2 HTTP/1.1\n--SomeBoundaryValue--\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: 92\\r\\n\\r\\n{\\\"error\\\":true,\\\"code\\\":404,\\\"errorNum\\\":1203,\\\"errorMessage\\\":\\\"unknown collection 'notexisting1'\\\"}\\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
\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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Bulk\\JSF_batch_processing.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Bulk\\JSF_import_document.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Bulk\\JSF_import_json.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Bulk\\JSF_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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_delete_api_tasks.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_database_version.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_echo.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_long_echo.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_modules_flush.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_routing_reloads.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_server_id.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_server_role.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_sleep.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_statistics.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_statistics_description.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_time.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_cluster_endpoints.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_endpoint.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_initiate.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_return.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_tasks.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_tasks_all.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_engine.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_post_admin_execute.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_post_admin_test.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_post_api_new_tasks.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_put_api_new_tasks.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
shell> curl --dump - http://localhost:8529/_api/collection\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"result\" : [ \n    { \n      \"id\" : \"61\", \n      \"name\" : \"_apps\", \n      \"isSystem\" : true, \n      \"status\" : 3, \n      \"type\" : 2 \n    }, \n    { \n      \"id\" : \"36\", \n      \"name\" : \"_aqlfunctions\", \n      \"isSystem\" : true, \n      \"status\" : 3, \n      \"type\" : 2 \n    }, \n    { \n      \"id\" : \"54\", \n      \"name\" : \"_frontend\", \n      \"isSystem\" : true, \n      \"status\" : 3, \n      \"type\" : 2 \n    }, \n    { \n      \"id\" : \"3\", \n      \"name\" : \"_graphs\", \n      \"isSystem\" : true, \n      \"status\" : 3, \n      \"type\" : 2 \n    }, \n    { \n      \"id\" : \"58\", \n      \"name\" : \"_jobs\", \n      \"isSystem\" : true, \n      \"status\" : 3, \n      \"type\" : 2 \n    }, \n    { \n      \"id\" : \"20\", \n      \"name\" : \"_modules\", \n      \"isSystem\" : true, \n      \"status\" : 3, \n      \"type\" : 2 \n    }, \n    { \n      \"id\" : \"56\", \n      \"name\" : \"_queues\", \n      \"isSystem\" : true, \n      \"status\" : 3, \n      \"type\" : 2 \n    }, \n    { \n      \"id\" : \"22\", \n      \"name\" : \"_routing\", \n      \"isSystem\" : true, \n      \"status\" : 3, \n      \"type\" : 2 \n    }, \n    { \n      \"id\" : \"43\", \n      \"name\" : \"_statistics\", \n      \"isSystem\" : true, \n      \"status\" : 3, \n      \"type\" : 2 \n    }, \n    { \n      \"id\" : \"49\", \n      \"name\" : \"_statistics15\", \n      \"isSystem\" : true, \n      \"status\" : 3, \n      \"type\" : 2 \n    }, \n    { \n      \"id\" : \"38\", \n      \"name\" : \"_statisticsRaw\", \n      \"isSystem\" : true, \n      \"status\" : 3, \n      \"type\" : 2 \n    }, \n    { \n      \"id\" : \"6\", \n      \"name\" : \"_users\", \n      \"isSystem\" : true, \n      \"status\" : 3, \n      \"type\" : 2 \n    }, \n    { \n      \"id\" : \"94\", \n      \"name\" : \"animals\", \n      \"isSystem\" : false, \n      \"status\" : 3, \n      \"type\" : 2 \n    }, \n    { \n      \"id\" : \"89\", \n      \"name\" : \"demo\", \n      \"isSystem\" : false, \n      \"status\" : 3, \n      \"type\" : 2 \n    } \n  ], \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_checksum.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_count.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_figures.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_name.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_properties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_revision.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_delete_api_collection.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_get_api_collections.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_post_api_collection.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_load.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_properties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_rename.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_rotate.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_truncate.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_unload.md" }, "post": { "description": "\n**A json post document 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 - **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 - **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 - **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\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
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/collection <<EOF\n{ \n  \"name\" : \"testCollectionBasics\" \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nlocation: /_db/_system/_api/collection/testCollectionBasics\nx-content-type-options: nosniff\n\n{ \n  \"id\" : \"9196\", \n  \"name\" : \"testCollectionBasics\", \n  \"waitForSync\" : false, \n  \"isVolatile\" : false, \n  \"isSystem\" : false, \n  \"status\" : 3, \n  \"type\" : 2, \n  \"error\" : false, \n  \"code\" : 200 \n}\nshell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/collection <<EOF\n{ \n  \"name\" : \"testCollectionEdges\", \n  \"type\" : 3 \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nlocation: /_db/_system/_api/collection/testCollectionEdges\nx-content-type-options: nosniff\n\n{ \n  \"id\" : \"9198\", \n  \"name\" : \"testCollectionEdges\", \n  \"waitForSync\" : false, \n  \"isVolatile\" : false, \n  \"isSystem\" : false, \n  \"status\" : 3, \n  \"type\" : 3, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n#Example:\n \n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/collection <<EOF\n{ \n  \"name\" : \"testCollectionUsers\", \n  \"keyOptions\" : { \n    \"type\" : \"autoincrement\", \n    \"increment\" : 5, \n    \"allowUserKeys\" : true \n  } \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nlocation: /_db/_system/_api/collection/testCollectionUsers\nx-content-type-options: nosniff\n\n{ \n  \"id\" : \"9202\", \n  \"name\" : \"testCollectionUsers\", \n  \"waitForSync\" : false, \n  \"isVolatile\" : false, \n  \"isSystem\" : false, \n  \"status\" : 3, \n  \"type\" : 2, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n", "parameters": [ { "in": "body", "name": "Json Request Body", "required": true, "schema": { "$ref": "#/definitions/JSF_post_api_collection" }, "x-description-offset": 61 }, { "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" } ], "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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_checksum.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_count.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_figures.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_name.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_properties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_revision.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_delete_api_collection.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_get_api_collections.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_post_api_collection.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_load.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_properties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_rename.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_rotate.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_truncate.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_unload.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
shell> curl -X DELETE --dump - http://localhost:8529/_api/collection/9205\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"id\" : \"9205\", \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n#Example:\n Using a name:\n\n
shell> curl -X DELETE --dump - http://localhost:8529/_api/collection/products1\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"id\" : \"9208\", \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n#Example:\n Dropping a system collection\n\n
shell> curl -X DELETE --dump - http://localhost:8529/_api/collection/_example?isSystem=true\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"id\" : \"9212\", \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_checksum.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_count.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_figures.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_name.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_properties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_revision.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_delete_api_collection.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_get_api_collections.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_post_api_collection.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_load.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_properties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_rename.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_rotate.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_truncate.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_unload.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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_checksum.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_count.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_figures.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_name.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_properties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_revision.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_delete_api_collection.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_get_api_collections.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_post_api_collection.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_load.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_properties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_rename.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_rotate.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_truncate.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_unload.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
shell> curl --dump - http://localhost:8529/_api/collection/products/checksum\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"id\" : \"9215\", \n  \"name\" : \"products\", \n  \"isSystem\" : false, \n  \"status\" : 3, \n  \"type\" : 2, \n  \"checksum\" : \"1139512748954497272\", \n  \"revision\" : \"_V_qDrSu---\", \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n#Example:\n Retrieving the checksum of a collection including the collection data,\nbut not the revisions:\n\n
shell> curl --dump - http://localhost:8529/_api/collection/products/checksum?withRevisions=false&withData=true\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"id\" : \"9223\", \n  \"name\" : \"products\", \n  \"isSystem\" : false, \n  \"status\" : 3, \n  \"type\" : 2, \n  \"checksum\" : \"17008603927355321383\", \n  \"revision\" : \"_V_qDrbi---\", \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_checksum.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_count.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_figures.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_name.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_properties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_revision.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_delete_api_collection.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_get_api_collections.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_post_api_collection.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_load.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_properties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_rename.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_rotate.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_truncate.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_unload.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
shell> curl --dump - http://localhost:8529/_api/collection/products/count\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nlocation: /_db/_system/_api/collection/products/count\nx-content-type-options: nosniff\n\n{ \n  \"id\" : \"9231\", \n  \"name\" : \"products\", \n  \"isSystem\" : false, \n  \"doCompact\" : true, \n  \"isVolatile\" : false, \n  \"journalSize\" : 33554432, \n  \"keyOptions\" : { \n    \"type\" : \"traditional\", \n    \"allowUserKeys\" : true \n  }, \n  \"waitForSync\" : true, \n  \"indexBuckets\" : 8, \n  \"count\" : 100, \n  \"status\" : 3, \n  \"type\" : 2, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_checksum.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_count.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_figures.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_name.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_properties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_revision.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_delete_api_collection.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_get_api_collections.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_post_api_collection.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_load.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_properties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_rename.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_rotate.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_truncate.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_unload.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
shell> curl --dump - http://localhost:8529/_api/collection/products/figures\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nlocation: /_db/_system/_api/collection/products/figures\nx-content-type-options: nosniff\n\n{ \n  \"id\" : \"9537\", \n  \"name\" : \"products\", \n  \"isSystem\" : false, \n  \"doCompact\" : true, \n  \"isVolatile\" : false, \n  \"journalSize\" : 33554432, \n  \"keyOptions\" : { \n    \"type\" : \"traditional\", \n    \"allowUserKeys\" : true \n  }, \n  \"waitForSync\" : false, \n  \"indexBuckets\" : 8, \n  \"count\" : 1, \n  \"figures\" : { \n    \"indexes\" : { \n      \"count\" : 1, \n      \"size\" : 32128 \n    }, \n    \"compactionStatus\" : { \n      \"message\" : \"skipped compaction because collection has no datafiles\", \n      \"time\" : \"2017-05-18T10:06:23Z\" \n    }, \n    \"documentReferences\" : 1, \n    \"waitingFor\" : \"document-reference\", \n    \"alive\" : { \n      \"count\" : 0, \n      \"size\" : 0 \n    }, \n    \"dead\" : { \n      \"count\" : 0, \n      \"size\" : 0, \n      \"deletion\" : 0 \n    }, \n    \"datafiles\" : { \n      \"count\" : 0, \n      \"fileSize\" : 0 \n    }, \n    \"journals\" : { \n      \"count\" : 1, \n      \"fileSize\" : 33554432 \n    }, \n    \"compactors\" : { \n      \"count\" : 0, \n      \"fileSize\" : 0 \n    }, \n    \"revisions\" : { \n      \"count\" : 1, \n      \"size\" : 48192 \n    }, \n    \"lastTick\" : 9542, \n    \"uncollectedLogfileEntries\" : 1 \n  }, \n  \"status\" : 3, \n  \"type\" : 2, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_checksum.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_count.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_figures.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_name.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_properties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_revision.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_delete_api_collection.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_get_api_collections.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_post_api_collection.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_load.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_properties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_rename.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_rotate.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_truncate.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_unload.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
shell> curl -X PUT --dump - http://localhost:8529/_api/collection/products/load\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"id\" : \"9573\", \n  \"name\" : \"products\", \n  \"isSystem\" : false, \n  \"count\" : 0, \n  \"status\" : 3, \n  \"type\" : 2, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_checksum.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_count.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_figures.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_name.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_properties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_revision.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_delete_api_collection.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_get_api_collections.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_post_api_collection.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_load.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_properties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_rename.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_rotate.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_truncate.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_unload.md" } }, "/_api/collection/{collection-name}/properties": { "get": { "description": "\n\nIn addition to the above, the result will always contain the\n*waitForSync*, *doCompact*, *journalSize*, and *isVolatile* attributes.\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\n- *journalSize*: The maximal size setting for journals / datafiles\n in bytes.\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\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
shell> curl --dump - http://localhost:8529/_api/collection/9561/properties\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nlocation: /_db/_system/_api/collection/products/properties\nx-content-type-options: nosniff\n\n{ \n  \"id\" : \"9561\", \n  \"name\" : \"products\", \n  \"isSystem\" : false, \n  \"doCompact\" : true, \n  \"isVolatile\" : false, \n  \"journalSize\" : 33554432, \n  \"keyOptions\" : { \n    \"type\" : \"traditional\", \n    \"allowUserKeys\" : true \n  }, \n  \"waitForSync\" : true, \n  \"indexBuckets\" : 8, \n  \"status\" : 3, \n  \"type\" : 2, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n#Example:\n Using a name:\n\n
shell> curl --dump - http://localhost:8529/_api/collection/products/properties\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nlocation: /_db/_system/_api/collection/products/properties\nx-content-type-options: nosniff\n\n{ \n  \"id\" : \"9565\", \n  \"name\" : \"products\", \n  \"isSystem\" : false, \n  \"doCompact\" : true, \n  \"isVolatile\" : false, \n  \"journalSize\" : 33554432, \n  \"keyOptions\" : { \n    \"type\" : \"traditional\", \n    \"allowUserKeys\" : true \n  }, \n  \"waitForSync\" : true, \n  \"indexBuckets\" : 8, \n  \"status\" : 3, \n  \"type\" : 2, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_checksum.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_count.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_figures.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_name.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_properties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_revision.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_delete_api_collection.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_get_api_collections.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_post_api_collection.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_load.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_properties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_rename.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_rotate.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_truncate.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_unload.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
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/collection/products/properties <<EOF\n{ \n  \"waitForSync\" : true \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"id\" : \"9578\", \n  \"name\" : \"products\", \n  \"isSystem\" : false, \n  \"doCompact\" : true, \n  \"isVolatile\" : false, \n  \"journalSize\" : 33554432, \n  \"keyOptions\" : { \n    \"type\" : \"traditional\", \n    \"allowUserKeys\" : true \n  }, \n  \"waitForSync\" : true, \n  \"indexBuckets\" : 8, \n  \"status\" : 3, \n  \"type\" : 2, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_checksum.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_count.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_figures.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_name.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_properties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_revision.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_delete_api_collection.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_get_api_collections.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_post_api_collection.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_load.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_properties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_rename.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_rotate.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_truncate.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_unload.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
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/collection/products1/rename <<EOF\n{ \n  \"name\" : \"newname\" \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"id\" : \"9584\", \n  \"name\" : \"newname\", \n  \"isSystem\" : false, \n  \"status\" : 3, \n  \"type\" : 2, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_checksum.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_count.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_figures.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_name.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_properties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_revision.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_delete_api_collection.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_get_api_collections.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_post_api_collection.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_load.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_properties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_rename.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_rotate.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_truncate.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_unload.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
shell> curl --dump - http://localhost:8529/_api/collection/products/revision\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"id\" : \"9569\", \n  \"name\" : \"products\", \n  \"isSystem\" : false, \n  \"status\" : 3, \n  \"type\" : 2, \n  \"revision\" : \"0\", \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_checksum.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_count.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_figures.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_name.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_properties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_revision.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_delete_api_collection.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_get_api_collections.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_post_api_collection.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_load.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_properties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_rename.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_rotate.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_truncate.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_unload.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 not available in a cluster.\n\n\n\n\n#Example:\n Rotating the journal:\n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/collection/products/rotate <<EOF\n{ \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"result\" : true, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n#Example:\n Rotating if no journal exists:\n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/collection/products/rotate <<EOF\n{ \n}\nEOF\n\nHTTP/1.1 400 Bad Request\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"error\" : true, \n  \"code\" : 400, \n  \"errorNum\" : 1105, \n  \"errorMessage\" : \"could not rotate journal: no journal\" \n}\n
\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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_checksum.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_count.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_figures.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_name.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_properties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_revision.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_delete_api_collection.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_get_api_collections.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_post_api_collection.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_load.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_properties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_rename.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_rotate.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_truncate.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_unload.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
shell> curl -X PUT --dump - http://localhost:8529/_api/collection/products/truncate\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"id\" : \"9589\", \n  \"name\" : \"products\", \n  \"isSystem\" : false, \n  \"status\" : 3, \n  \"type\" : 2, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_checksum.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_count.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_figures.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_name.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_properties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_revision.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_delete_api_collection.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_get_api_collections.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_post_api_collection.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_load.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_properties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_rename.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_rotate.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_truncate.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_unload.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
shell> curl -X PUT --dump - http://localhost:8529/_api/collection/products/unload\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"id\" : \"9593\", \n  \"name\" : \"products\", \n  \"isSystem\" : false, \n  \"status\" : 4, \n  \"type\" : 2, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_checksum.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_count.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_figures.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_name.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_properties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSA_get_api_collection_revision.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_delete_api_collection.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_get_api_collections.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_post_api_collection.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_load.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_properties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_rename.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_rotate.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_truncate.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Collections\\JSF_put_api_collection_unload.md" } }, "/_api/cursor": { "post": { "description": "\n**A json post document 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 - **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 - **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 - **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
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/cursor <<EOF\n{ \n  \"query\" : \"FOR p IN products LIMIT 2 RETURN p\", \n  \"count\" : true, \n  \"batchSize\" : 2 \n}\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"result\" : [ \n    { \n      \"_key\" : \"9656\", \n      \"_id\" : \"products/9656\", \n      \"_rev\" : \"_V_qD1ii---\", \n      \"hello1\" : \"world1\" \n    }, \n    { \n      \"_key\" : \"9660\", \n      \"_id\" : \"products/9660\", \n      \"_rev\" : \"_V_qD1ii--_\", \n      \"hello2\" : \"world1\" \n    } \n  ], \n  \"hasMore\" : false, \n  \"count\" : 2, \n  \"cached\" : false, \n  \"extra\" : { \n    \"stats\" : { \n      \"writesExecuted\" : 0, \n      \"writesIgnored\" : 0, \n      \"scannedFull\" : 2, \n      \"scannedIndex\" : 0, \n      \"filtered\" : 0, \n      \"httpRequests\" : 0, \n      \"executionTime\" : 0.0002598762512207031 \n    }, \n    \"warnings\" : [ ] \n  }, \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n#Example:\n Execute a query and extract a part of the result\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/cursor <<EOF\n{ \n  \"query\" : \"FOR p IN products LIMIT 5 RETURN p\", \n  \"count\" : true, \n  \"batchSize\" : 2 \n}\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"error\" : false, \n  \"code\" : 201, \n  \"result\" : [ \n    { \n      \"_key\" : \"9648\", \n      \"_id\" : \"products/9648\", \n      \"_rev\" : \"_V_qD1a----\", \n      \"hello5\" : \"world1\" \n    }, \n    { \n      \"_key\" : \"9635\", \n      \"_id\" : \"products/9635\", \n      \"_rev\" : \"_V_qD1Z2---\", \n      \"hello1\" : \"world1\" \n    } \n  ], \n  \"hasMore\" : true, \n  \"id\" : \"9651\", \n  \"count\" : 5, \n  \"extra\" : { \n    \"stats\" : { \n      \"writesExecuted\" : 0, \n      \"writesIgnored\" : 0, \n      \"scannedFull\" : 5, \n      \"scannedIndex\" : 0, \n      \"filtered\" : 0, \n      \"httpRequests\" : 0, \n      \"executionTime\" : 0.000308990478515625 \n    }, \n    \"warnings\" : [ ] \n  }, \n  \"cached\" : false \n}\n
\n\n\n\n\n#Example:\n Using the query option \"fullCount\"\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/cursor <<EOF\n{ \n  \"query\" : \"FOR i IN 1..1000 FILTER i > 500 LIMIT 10 RETURN i\", \n  \"count\" : true, \n  \"options\" : { \n    \"fullCount\" : true \n  } \n}\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"result\" : [ \n    501, \n    502, \n    503, \n    504, \n    505, \n    506, \n    507, \n    508, \n    509, \n    510 \n  ], \n  \"hasMore\" : false, \n  \"count\" : 10, \n  \"cached\" : false, \n  \"extra\" : { \n    \"stats\" : { \n      \"writesExecuted\" : 0, \n      \"writesIgnored\" : 0, \n      \"scannedFull\" : 0, \n      \"scannedIndex\" : 0, \n      \"filtered\" : 500, \n      \"httpRequests\" : 0, \n      \"fullCount\" : 500, \n      \"executionTime\" : 0.0007569789886474609 \n    }, \n    \"warnings\" : [ ] \n  }, \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n#Example:\n Enabling and disabling optimizer rules\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/cursor <<EOF\n{ \n  \"query\" : \"FOR i IN 1..10 LET a = 1 LET b = 2 FILTER a + b == 3 RETURN i\", \n  \"count\" : true, \n  \"options\" : { \n    \"maxPlans\" : 1, \n    \"optimizer\" : { \n      \"rules\" : [ \n        \"-all\", \n        \"+remove-unnecessary-filters\" \n      ] \n    } \n  } \n}\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"result\" : [ \n    1, \n    2, \n    3, \n    4, \n    5, \n    6, \n    7, \n    8, \n    9, \n    10 \n  ], \n  \"hasMore\" : false, \n  \"count\" : 10, \n  \"cached\" : false, \n  \"extra\" : { \n    \"stats\" : { \n      \"writesExecuted\" : 0, \n      \"writesIgnored\" : 0, \n      \"scannedFull\" : 0, \n      \"scannedIndex\" : 0, \n      \"filtered\" : 0, \n      \"httpRequests\" : 0, \n      \"executionTime\" : 0.0015621185302734375 \n    }, \n    \"warnings\" : [ ] \n  }, \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n#Example:\n Execute a data-modification query and retrieve the number of\nmodified documents\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/cursor <<EOF\n{ \n  \"query\" : \"FOR p IN products REMOVE p IN products\" \n}\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"result\" : [ ], \n  \"hasMore\" : false, \n  \"cached\" : false, \n  \"extra\" : { \n    \"stats\" : { \n      \"writesExecuted\" : 2, \n      \"writesIgnored\" : 0, \n      \"scannedFull\" : 2, \n      \"scannedIndex\" : 0, \n      \"filtered\" : 0, \n      \"httpRequests\" : 0, \n      \"executionTime\" : 0.00045013427734375 \n    }, \n    \"warnings\" : [ ] \n  }, \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n#Example:\n Execute a data-modification query with option *ignoreErrors*\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/cursor <<EOF\n{ \n  \"query\" : \"REMOVE 'bar' IN products OPTIONS { ignoreErrors: true }\" \n}\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"result\" : [ ], \n  \"hasMore\" : false, \n  \"cached\" : false, \n  \"extra\" : { \n    \"stats\" : { \n      \"writesExecuted\" : 0, \n      \"writesIgnored\" : 1, \n      \"scannedFull\" : 0, \n      \"scannedIndex\" : 0, \n      \"filtered\" : 0, \n      \"httpRequests\" : 0, \n      \"executionTime\" : 0.00031685829162597656 \n    }, \n    \"warnings\" : [ ] \n  }, \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n#Example:\n Bad query - Missing body\n\n
shell> curl -X POST --dump - http://localhost:8529/_api/cursor\n\nHTTP/1.1 400 Bad Request\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"error\" : true, \n  \"errorMessage\" : \"query is empty\", \n  \"code\" : 400, \n  \"errorNum\" : 1502 \n}\n
\n\n\n\n\n#Example:\n Bad query - Unknown collection\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/cursor <<EOF\n{ \n  \"query\" : \"FOR u IN unknowncoll LIMIT 2 RETURN u\", \n  \"count\" : true, \n  \"batchSize\" : 2 \n}\nEOF\n\nHTTP/1.1 404 Not Found\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"error\" : true, \n  \"errorMessage\" : \"collection not found: unknowncoll (while parsing)\", \n  \"code\" : 404, \n  \"errorNum\" : 1203 \n}\n
\n\n\n\n\n#Example:\n Bad query - Execute a data-modification query that attempts to remove a non-existing\ndocument\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/cursor <<EOF\n{ \n  \"query\" : \"REMOVE 'foo' IN products\" \n}\nEOF\n\nHTTP/1.1 404 Not Found\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"error\" : true, \n  \"errorMessage\" : \"document not found (while executing)\", \n  \"code\" : 404, \n  \"errorNum\" : 1202 \n}\n
\n\n\n\n\n\n", "parameters": [ { "in": "body", "name": "Json Request Body", "required": true, "schema": { "$ref": "#/definitions/JSF_post_api_cursor" }, "x-description-offset": 61 } ], "produces": [ "application/json" ], "responses": { "201": { "description": "is returned if the result set can be created by the server.\n\n", "schema": { "$ref": "#/definitions/JSF_post_api_cursor_rc_201" }, "x-description-offset": 300 }, "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/JSF_post_api_cursor_rc_400" }, "x-description-offset": 355 }, "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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Cursors\\JSF_post_api_cursor.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Cursors\\JSF_post_api_cursor_delete.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Cursors\\JSF_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
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/cursor <<EOF\n{ \n  \"query\" : \"FOR p IN products LIMIT 5 RETURN p\", \n  \"count\" : true, \n  \"batchSize\" : 2 \n}\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"error\" : false, \n  \"code\" : 201, \n  \"result\" : [ \n    { \n      \"_key\" : \"9681\", \n      \"_id\" : \"products/9681\", \n      \"_rev\" : \"_V_qD1x---_\", \n      \"hello5\" : \"world1\" \n    }, \n    { \n      \"_key\" : \"9675\", \n      \"_id\" : \"products/9675\", \n      \"_rev\" : \"_V_qD1w6--_\", \n      \"hello3\" : \"world1\" \n    } \n  ], \n  \"hasMore\" : true, \n  \"id\" : \"9684\", \n  \"count\" : 5, \n  \"extra\" : { \n    \"stats\" : { \n      \"writesExecuted\" : 0, \n      \"writesIgnored\" : 0, \n      \"scannedFull\" : 5, \n      \"scannedIndex\" : 0, \n      \"filtered\" : 0, \n      \"httpRequests\" : 0, \n      \"executionTime\" : 0.0002689361572265625 \n    }, \n    \"warnings\" : [ ] \n  }, \n  \"cached\" : false \n}\nshell> curl -X DELETE --dump - http://localhost:8529/_api/cursor/9684\n\n
\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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Cursors\\JSF_post_api_cursor.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Cursors\\JSF_post_api_cursor_delete.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Cursors\\JSF_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
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/cursor <<EOF\n{ \n  \"query\" : \"FOR p IN products LIMIT 5 RETURN p\", \n  \"count\" : true, \n  \"batchSize\" : 2 \n}\nEOF\n\nshell> curl -X PUT --dump - http://localhost:8529/_api/cursor/9735\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"error\" : false, \n  \"code\" : 200, \n  \"result\" : [ \n    { \n      \"_key\" : \"9719\", \n      \"_id\" : \"products/9719\", \n      \"_rev\" : \"_V_qD2WG---\", \n      \"hello1\" : \"world1\" \n    }, \n    { \n      \"_key\" : \"9726\", \n      \"_id\" : \"products/9726\", \n      \"_rev\" : \"_V_qD2WK--_\", \n      \"hello3\" : \"world1\" \n    } \n  ], \n  \"hasMore\" : true, \n  \"id\" : \"9735\", \n  \"count\" : 5, \n  \"extra\" : { \n    \"stats\" : { \n      \"writesExecuted\" : 0, \n      \"writesIgnored\" : 0, \n      \"scannedFull\" : 5, \n      \"scannedIndex\" : 0, \n      \"filtered\" : 0, \n      \"httpRequests\" : 0, \n      \"executionTime\" : 0.00028204917907714844 \n    }, \n    \"warnings\" : [ ] \n  }, \n  \"cached\" : false \n}\n
\n\n\n\n\n#Example:\n Missing identifier\n\n
shell> curl -X PUT --dump - http://localhost:8529/_api/cursor\n\nHTTP/1.1 400 Bad Request\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"error\" : true, \n  \"errorMessage\" : \"expecting PUT /_api/cursor/<cursor-id>\", \n  \"code\" : 400, \n  \"errorNum\" : 400 \n}\n
\n\n\n\n\n#Example:\n Unknown identifier\n\n
shell> curl -X PUT --dump - http://localhost:8529/_api/cursor/123123\n\nHTTP/1.1 404 Not Found\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"error\" : true, \n  \"errorMessage\" : \"cursor not found\", \n  \"code\" : 404, \n  \"errorNum\" : 1600 \n}\n
\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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Cursors\\JSF_post_api_cursor.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Cursors\\JSF_post_api_cursor_delete.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Cursors\\JSF_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-databases-available-to-a-user) to fetch the list of the available databases now.\n\n\n\n\n#Example:\n \n\n
shell> curl --dump - http://localhost:8529/_api/database\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"result\" : [ \n    \"_system\" \n  ], \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Database\\JSF_get_api_database_current.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Database\\JSF_get_api_database_delete.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Database\\JSF_get_api_database_list.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Database\\JSF_get_api_database_new.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Database\\JSF_get_api_database_user.md" }, "post": { "description": "\n**A json post document 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
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/database <<EOF\n{ \n  \"name\" : \"example\" \n}\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"result\" : true, \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n#Example:\n Creating a database named *mydb* with two users.\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/database <<EOF\n{ \n  \"name\" : \"mydb\", \n  \"users\" : [ \n    { \n      \"username\" : \"admin\", \n      \"passwd\" : \"secret\", \n      \"active\" : true \n    }, \n    { \n      \"username\" : \"tester\", \n      \"passwd\" : \"test001\", \n      \"active\" : false \n    } \n  ] \n}\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"result\" : true, \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n", "parameters": [ { "in": "body", "name": "Json Request Body", "required": true, "schema": { "$ref": "#/definitions/JSF_get_api_database_new" }, "x-description-offset": 61 } ], "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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Database\\JSF_get_api_database_current.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Database\\JSF_get_api_database_delete.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Database\\JSF_get_api_database_list.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Database\\JSF_get_api_database_new.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Database\\JSF_get_api_database_user.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
shell> curl --dump - http://localhost:8529/_api/database/current\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"result\" : { \n    \"name\" : \"_system\", \n    \"id\" : \"1\", \n    \"path\" : \"/tmp/arangosh_6TZ2Oh/tmp-2088-4136787427/data/databases/database-1\", \n    \"isSystem\" : true \n  }, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Database\\JSF_get_api_database_current.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Database\\JSF_get_api_database_delete.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Database\\JSF_get_api_database_list.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Database\\JSF_get_api_database_new.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Database\\JSF_get_api_database_user.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
shell> curl --dump - http://localhost:8529/_api/database/user\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"result\" : [ \n    \"_system\" \n  ], \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Database\\JSF_get_api_database_current.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Database\\JSF_get_api_database_delete.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Database\\JSF_get_api_database_list.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Database\\JSF_get_api_database_new.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Database\\JSF_get_api_database_user.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
shell> curl -X DELETE --dump - http://localhost:8529/_api/database/example\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"result\" : true, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Database\\JSF_get_api_database_current.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Database\\JSF_get_api_database_delete.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Database\\JSF_get_api_database_list.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Database\\JSF_get_api_database_new.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Database\\JSF_get_api_database_user.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
shell> curl -X DELETE --dump - http://localhost:8529/_api/document/products/9884\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\netag: \"_V_qD4qi---\"\nlocation: /_db/_system/_api/document/products/9884\nx-content-type-options: nosniff\n\n{ \n  \"_id\" : \"products/9884\", \n  \"_key\" : \"9884\", \n  \"_rev\" : \"_V_qD4qi---\" \n}\n
\n\n\n\n\n#Example:\n Unknown document handle:\n\n
shell> curl -X DELETE --dump - http://localhost:8529/_api/document/products/9903\n\nHTTP/1.1 404 Not Found\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"error\" : true, \n  \"errorMessage\" : \"document not found\", \n  \"code\" : 404, \n  \"errorNum\" : 1202 \n}\n
\n\n\n\n\n#Example:\n Revision conflict:\n\n
shell> curl -X DELETE --header 'If-Match: \"_V_qD4hu--_\"' --dump - http://localhost:8529/_api/document/products/9873\n\nHTTP/1.1 412 Precondition Failed\ncontent-type: application/json; charset=utf-8\netag: \"_V_qD4hu---\"\nx-content-type-options: nosniff\n\n{ \n  \"error\" : true, \n  \"code\" : 412, \n  \"errorNum\" : 1200, \n  \"errorMessage\" : \"precondition failed\", \n  \"_id\" : \"products/9873\", \n  \"_key\" : \"9873\", \n  \"_rev\" : \"_V_qD4hu---\" \n}\n
\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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_CREATE.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_DELETE.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_DELETE_MULTI.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_READ.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_READ_ALL.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_READ_HEAD.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_REPLACE.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_REPLACE_MULTI.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_UPDATE.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_UPDATE_MULTI.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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_CREATE.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_DELETE.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_DELETE_MULTI.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_READ.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_READ_ALL.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_READ_HEAD.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_REPLACE.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_REPLACE_MULTI.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_UPDATE.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_UPDATE_MULTI.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
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/document/products <<EOF\n{ \"Hello\": \"World\" }\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\netag: \"_V_qD52G---\"\nlocation: /_db/_system/_api/document/products/9952\nx-content-type-options: nosniff\n\n{ \n  \"_id\" : \"products/9952\", \n  \"_key\" : \"9952\", \n  \"_rev\" : \"_V_qD52G---\" \n}\n
\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
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/document/products <<EOF\n{ \"Hello\": \"World\" }\nEOF\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\netag: \"_V_qD5le---\"\nlocation: /_db/_system/_api/document/products/9942\nx-content-type-options: nosniff\n\n{ \n  \"_id\" : \"products/9942\", \n  \"_key\" : \"9942\", \n  \"_rev\" : \"_V_qD5le---\" \n}\n
\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
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/document/products?waitForSync=true <<EOF\n{ \"Hello\": \"World\" }\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\netag: \"_V_qD6Ru---\"\nlocation: /_db/_system/_api/document/products/9979\nx-content-type-options: nosniff\n\n{ \n  \"_id\" : \"products/9979\", \n  \"_key\" : \"9979\", \n  \"_rev\" : \"_V_qD6Ru---\" \n}\n
\n\n\n\n\n#Example:\n Unknown collection name\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/document/products <<EOF\n{ \"Hello\": \"World\" }\nEOF\n\nHTTP/1.1 404 Not Found\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"error\" : true, \n  \"errorMessage\" : \"collection not found: products\", \n  \"code\" : 404, \n  \"errorNum\" : 1203 \n}\n
\n\n\n\n\n#Example:\n Illegal document\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/document/products <<EOF\n{ 1: \"World\" }\nEOF\n\nHTTP/1.1 400 Bad Request\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"error\" : true, \n  \"errorMessage\" : \"VPackError error: Expecting '\\\"' or '}'\", \n  \"code\" : 400, \n  \"errorNum\" : 600 \n}\n
\n\n\n\n\n#Example:\n Insert multiple documents:\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/document/products <<EOF\n[{\"Hello\":\"Earth\"}, {\"Hello\":\"Venus\"}, {\"Hello\":\"Mars\"}]\nEOF\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n[ \n  { \n    \"_id\" : \"products/9959\", \n    \"_key\" : \"9959\", \n    \"_rev\" : \"_V_qD6_u---\" \n  }, \n  { \n    \"_id\" : \"products/9963\", \n    \"_key\" : \"9963\", \n    \"_rev\" : \"_V_qD6_u--_\" \n  }, \n  { \n    \"_id\" : \"products/9965\", \n    \"_key\" : \"9965\", \n    \"_rev\" : \"_V_qD6_u--A\" \n  } \n]\n
\n\n\n\n\n#Example:\n Use of returnNew:\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/document/products?returnNew=true <<EOF\n{\"Hello\":\"World\"}\nEOF\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\netag: \"_V_qD6HS---\"\nlocation: /_db/_system/_api/document/products/9972\nx-content-type-options: nosniff\n\n{ \n  \"_id\" : \"products/9972\", \n  \"_key\" : \"9972\", \n  \"_rev\" : \"_V_qD6HS---\", \n  \"new\" : { \n    \"_key\" : \"9972\", \n    \"_id\" : \"products/9972\", \n    \"_rev\" : \"_V_qD6HS---\", \n    \"Hello\" : \"World\" \n  } \n}\n
\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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_CREATE.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_DELETE.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_DELETE_MULTI.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_READ.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_READ_ALL.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_READ_HEAD.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_REPLACE.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_REPLACE_MULTI.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_UPDATE.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_UPDATE_MULTI.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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_CREATE.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_DELETE.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_DELETE_MULTI.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_READ.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_READ_ALL.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_READ_HEAD.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_REPLACE.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_REPLACE_MULTI.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_UPDATE.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_UPDATE_MULTI.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
shell> curl -X DELETE --dump - http://localhost:8529/_api/document/products/9853\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\netag: \"_V_qD4Ky---\"\nlocation: /_db/_system/_api/document/products/9853\nx-content-type-options: nosniff\n\n{ \n  \"_id\" : \"products/9853\", \n  \"_key\" : \"9853\", \n  \"_rev\" : \"_V_qD4Ky---\" \n}\n
\n\n\n\n\n#Example:\n Unknown document handle:\n\n
shell> curl -X DELETE --dump - http://localhost:8529/_api/document/products/9893\n\nHTTP/1.1 404 Not Found\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"error\" : true, \n  \"errorMessage\" : \"document not found\", \n  \"code\" : 404, \n  \"errorNum\" : 1202 \n}\n
\n\n\n\n\n#Example:\n Revision conflict:\n\n
shell> curl -X DELETE --header 'If-Match: \"_V_qD4Z----\"' --dump - http://localhost:8529/_api/document/products/9862\n\nHTTP/1.1 412 Precondition Failed\ncontent-type: application/json; charset=utf-8\netag: \"_V_qD4Y6---\"\nx-content-type-options: nosniff\n\n{ \n  \"error\" : true, \n  \"code\" : 412, \n  \"errorNum\" : 1200, \n  \"errorMessage\" : \"precondition failed\", \n  \"_id\" : \"products/9862\", \n  \"_key\" : \"9862\", \n  \"_rev\" : \"_V_qD4Y6---\" \n}\n
\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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_CREATE.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_DELETE.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_DELETE_MULTI.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_READ.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_READ_ALL.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_READ_HEAD.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_REPLACE.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_REPLACE_MULTI.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_UPDATE.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_UPDATE_MULTI.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
shell> curl --dump - http://localhost:8529/_api/document/products/9986\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\netag: \"_V_qD6dG---\"\nx-content-type-options: nosniff\n\n{ \n  \"_key\" : \"9986\", \n  \"_id\" : \"products/9986\", \n  \"_rev\" : \"_V_qD6dG---\", \n  \"hello\" : \"world\" \n}\n
\n\n\n\n\n#Example:\n Use a document handle and an etag:\n\n
shell> curl --header 'If-None-Match: \"_V_qD7Am---\"' --dump - http://localhost:8529/_api/document/products/10030\n\n
\n\n\n\n\n#Example:\n Unknown document handle:\n\n
shell> curl --dump - http://localhost:8529/_api/document/products/unknownhandle\n\nHTTP/1.1 404 Not Found\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"error\" : true, \n  \"errorMessage\" : \"collection not found: products\", \n  \"code\" : 404, \n  \"errorNum\" : 1203 \n}\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. 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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_CREATE.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_DELETE.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_DELETE_MULTI.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_READ.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_READ_ALL.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_READ_HEAD.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_REPLACE.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_REPLACE_MULTI.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_UPDATE.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_UPDATE_MULTI.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
shell> curl -X HEAD --dump - http://localhost:8529/_api/document/products/10022\n\n
\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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_CREATE.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_DELETE.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_DELETE_MULTI.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_READ.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_READ_ALL.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_READ_HEAD.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_REPLACE.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_REPLACE_MULTI.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_UPDATE.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_UPDATE_MULTI.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\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 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
shell> curl -X PATCH --data-binary @- --dump - http://localhost:8529/_api/document/products/9913 <<EOF\n{ \n  \"hello\" : \"world\" \n}\nEOF\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\netag: \"_V_qD5QC---\"\nlocation: /_db/_system/_api/document/products/9913\nx-content-type-options: nosniff\n\n{ \n  \"_id\" : \"products/9913\", \n  \"_key\" : \"9913\", \n  \"_rev\" : \"_V_qD5QC---\", \n  \"_oldRev\" : \"_V_qD5Q----\" \n}\nshell> curl -X PATCH --data-binary @- --dump - http://localhost:8529/_api/document/products/9913 <<EOF\n{ \n  \"numbers\" : { \n    \"one\" : 1, \n    \"two\" : 2, \n    \"three\" : 3, \n    \"empty\" : null \n  } \n}\nEOF\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\netag: \"_V_qD5QO---\"\nlocation: /_db/_system/_api/document/products/9913\nx-content-type-options: nosniff\n\n{ \n  \"_id\" : \"products/9913\", \n  \"_key\" : \"9913\", \n  \"_rev\" : \"_V_qD5QO---\", \n  \"_oldRev\" : \"_V_qD5QC---\" \n}\nshell> curl --dump - http://localhost:8529/_api/document/products/9913\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\netag: \"_V_qD5QO---\"\nx-content-type-options: nosniff\n\n{ \n  \"_key\" : \"9913\", \n  \"_id\" : \"products/9913\", \n  \"_rev\" : \"_V_qD5QO---\", \n  \"one\" : \"world\", \n  \"hello\" : \"world\", \n  \"numbers\" : { \n    \"one\" : 1, \n    \"two\" : 2, \n    \"three\" : 3, \n    \"empty\" : null \n  } \n}\nshell> curl -X PATCH --data-binary @- --dump - http://localhost:8529/_api/document/products/9913?keepNull=false <<EOF\n{ \n  \"hello\" : null, \n  \"numbers\" : { \n    \"four\" : 4 \n  } \n}\nEOF\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\netag: \"_V_qD5Qq---\"\nlocation: /_db/_system/_api/document/products/9913\nx-content-type-options: nosniff\n\n{ \n  \"_id\" : \"products/9913\", \n  \"_key\" : \"9913\", \n  \"_rev\" : \"_V_qD5Qq---\", \n  \"_oldRev\" : \"_V_qD5QO---\" \n}\nshell> curl --dump - http://localhost:8529/_api/document/products/9913\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\netag: \"_V_qD5Qq---\"\nx-content-type-options: nosniff\n\n{ \n  \"_key\" : \"9913\", \n  \"_id\" : \"products/9913\", \n  \"_rev\" : \"_V_qD5Qq---\", \n  \"one\" : \"world\", \n  \"numbers\" : { \n    \"empty\" : null, \n    \"one\" : 1, \n    \"three\" : 3, \n    \"two\" : 2, \n    \"four\" : 4 \n  } \n}\n
\n\n\n\n\n#Example:\n Merging attributes of an object using `mergeObjects`:\n\n
shell> curl --dump - http://localhost:8529/_api/document/products/9928\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\netag: \"_V_qD5bi---\"\nx-content-type-options: nosniff\n\n{ \n  \"_key\" : \"9928\", \n  \"_id\" : \"products/9928\", \n  \"_rev\" : \"_V_qD5bi---\", \n  \"inhabitants\" : { \n    \"china\" : 1366980000, \n    \"india\" : 1263590000, \n    \"usa\" : 319220000 \n  } \n}\nshell> curl -X PATCH --data-binary @- --dump - http://localhost:8529/_api/document/products/9928?mergeObjects=true <<EOF\n{ \n  \"inhabitants\" : { \n    \"indonesia\" : 252164800, \n    \"brazil\" : 203553000 \n  } \n}\nEOF\n\nshell> curl --dump - http://localhost:8529/_api/document/products/9928\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\netag: \"_V_qD5by---\"\nx-content-type-options: nosniff\n\n{ \n  \"_key\" : \"9928\", \n  \"_id\" : \"products/9928\", \n  \"_rev\" : \"_V_qD5by---\", \n  \"inhabitants\" : { \n    \"china\" : 1366980000, \n    \"india\" : 1263590000, \n    \"usa\" : 319220000, \n    \"indonesia\" : 252164800, \n    \"brazil\" : 203553000 \n  } \n}\nshell> curl -X PATCH --data-binary @- --dump - http://localhost:8529/_api/document/products/9928?mergeObjects=false <<EOF\n{ \n  \"inhabitants\" : { \n    \"pakistan\" : 188346000 \n  } \n}\nEOF\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\netag: \"_V_qD5cG---\"\nlocation: /_db/_system/_api/document/products/9928\nx-content-type-options: nosniff\n\n{ \n  \"_id\" : \"products/9928\", \n  \"_key\" : \"9928\", \n  \"_rev\" : \"_V_qD5cG---\", \n  \"_oldRev\" : \"_V_qD5by---\" \n}\nshell> curl --dump - http://localhost:8529/_api/document/products/9928\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\netag: \"_V_qD5cG---\"\nx-content-type-options: nosniff\n\n{ \n  \"_key\" : \"9928\", \n  \"_id\" : \"products/9928\", \n  \"_rev\" : \"_V_qD5cG---\", \n  \"inhabitants\" : { \n    \"pakistan\" : 188346000 \n  } \n}\n
\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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_CREATE.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_DELETE.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_DELETE_MULTI.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_READ.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_READ_ALL.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_READ_HEAD.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_REPLACE.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_REPLACE_MULTI.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_UPDATE.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_UPDATE_MULTI.md" }, "put": { "description": "\n\nReplaces the document with 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
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/document/products/10038 <<EOF\n{\"Hello\": \"you\"}\nEOF\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\netag: \"_V_qD7Ki---\"\nlocation: /_db/_system/_api/document/products/10038\nx-content-type-options: nosniff\n\n{ \n  \"_id\" : \"products/10038\", \n  \"_key\" : \"10038\", \n  \"_rev\" : \"_V_qD7Ki---\", \n  \"_oldRev\" : \"_V_qD7Ke---\" \n}\n
\n\n\n\n\n#Example:\n Unknown document handle\n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/document/products/10058 <<EOF\n{}\nEOF\n\nHTTP/1.1 404 Not Found\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"error\" : true, \n  \"errorMessage\" : \"document not found\", \n  \"code\" : 404, \n  \"errorNum\" : 1202 \n}\n
\n\n\n\n\n#Example:\n Produce a revision conflict\n\n
shell> curl -X PUT --header 'If-Match: \"_V_qD7Ta---\"' --data-binary @- --dump - http://localhost:8529/_api/document/products/10047 <<EOF\n{\"other\":\"content\"}\nEOF\n\nHTTP/1.1 412 Precondition Failed\ncontent-type: application/json; charset=utf-8\netag: \"_V_qD7TW---\"\nx-content-type-options: nosniff\n\n{ \n  \"error\" : true, \n  \"code\" : 412, \n  \"errorNum\" : 1200, \n  \"errorMessage\" : \"precondition failed\", \n  \"_id\" : \"products/10047\", \n  \"_key\" : \"10047\", \n  \"_rev\" : \"_V_qD7TW---\" \n}\n
\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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_CREATE.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_DELETE.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_DELETE_MULTI.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_READ.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_READ_ALL.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_READ_HEAD.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_REPLACE.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_REPLACE_MULTI.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_UPDATE.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_UPDATE_MULTI.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
shell> curl --dump - http://localhost:8529/_api/edges/edges?vertex=vertices/1\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"edges\" : [ \n    { \n      \"_key\" : \"6\", \n      \"_id\" : \"edges/6\", \n      \"_from\" : \"vertices/2\", \n      \"_to\" : \"vertices/1\", \n      \"_rev\" : \"_V_qD7oS---\", \n      \"$label\" : \"v2 -> v1\" \n    }, \n    { \n      \"_key\" : \"7\", \n      \"_id\" : \"edges/7\", \n      \"_from\" : \"vertices/4\", \n      \"_to\" : \"vertices/1\", \n      \"_rev\" : \"_V_qD7oS--_\", \n      \"$label\" : \"v4 -> v1\" \n    }, \n    { \n      \"_key\" : \"5\", \n      \"_id\" : \"edges/5\", \n      \"_from\" : \"vertices/1\", \n      \"_to\" : \"vertices/3\", \n      \"_rev\" : \"_V_qD7oO---\", \n      \"$label\" : \"v1 -> v3\" \n    } \n  ], \n  \"error\" : false, \n  \"code\" : 200, \n  \"stats\" : { \n    \"scannedIndex\" : 3, \n    \"filtered\" : 0 \n  } \n}\n
\n\n\n\n\n#Example:\n In edges\n\n
shell> curl --dump - http://localhost:8529/_api/edges/edges?vertex=vertices/1&direction=in\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"edges\" : [ \n    { \n      \"_key\" : \"6\", \n      \"_id\" : \"edges/6\", \n      \"_from\" : \"vertices/2\", \n      \"_to\" : \"vertices/1\", \n      \"_rev\" : \"_V_qD8gG--_\", \n      \"$label\" : \"v2 -> v1\" \n    }, \n    { \n      \"_key\" : \"7\", \n      \"_id\" : \"edges/7\", \n      \"_from\" : \"vertices/4\", \n      \"_to\" : \"vertices/1\", \n      \"_rev\" : \"_V_qD8gK---\", \n      \"$label\" : \"v4 -> v1\" \n    } \n  ], \n  \"error\" : false, \n  \"code\" : 200, \n  \"stats\" : { \n    \"scannedIndex\" : 2, \n    \"filtered\" : 0 \n  } \n}\n
\n\n\n\n\n#Example:\n Out edges\n\n
shell> curl --dump - http://localhost:8529/_api/edges/edges?vertex=vertices/1&direction=out\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"edges\" : [ \n    { \n      \"_key\" : \"5\", \n      \"_id\" : \"edges/5\", \n      \"_from\" : \"vertices/1\", \n      \"_to\" : \"vertices/3\", \n      \"_rev\" : \"_V_qD8u2---\", \n      \"$label\" : \"v1 -> v3\" \n    } \n  ], \n  \"error\" : false, \n  \"code\" : 200, \n  \"stats\" : { \n    \"scannedIndex\" : 1, \n    \"filtered\" : 0 \n  } \n}\n
\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 - C:/Users/User/arangodb/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
shell> curl --dump - http://localhost:8529/_api/endpoint\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n[ \n  { \n    \"endpoint\" : \"http://127.0.0.1:8563\" \n  } \n]\n
\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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_delete_api_tasks.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_database_version.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_echo.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_long_echo.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_modules_flush.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_routing_reloads.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_server_id.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_server_role.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_sleep.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_statistics.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_statistics_description.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_time.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_cluster_endpoints.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_endpoint.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_initiate.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_return.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_tasks.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_tasks_all.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_engine.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_post_admin_execute.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_post_admin_test.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_post_api_new_tasks.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_put_api_new_tasks.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
shell> curl --dump - http://localhost:8529/_api/engine\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"name\" : \"mmfiles\", \n  \"supports\" : { \n    \"dfdb\" : true, \n    \"indexes\" : [ \n      \"primary\", \n      \"edge\", \n      \"hash\", \n      \"skiplist\", \n      \"persistent\", \n      \"geo\", \n      \"fulltext\" \n    ] \n  } \n}\n
\n\n\n\n\n", "parameters": [], "produces": [ "application/json" ], "responses": { "200": { "description": "is returned in all cases.\n\n", "schema": { "$ref": "#/definitions/JSF_get_engine_rc_200" }, "x-description-offset": 179 } }, "summary": " Return server database engine type", "tags": [ "Administration" ], "x-examples": [], "x-filename": "Administration - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_delete_api_tasks.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_database_version.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_echo.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_long_echo.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_modules_flush.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_routing_reloads.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_server_id.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_server_role.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_sleep.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_statistics.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_statistics_description.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_time.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_cluster_endpoints.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_endpoint.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_initiate.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_return.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_tasks.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_tasks_all.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_engine.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_post_admin_execute.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_post_admin_test.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_post_api_new_tasks.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_put_api_new_tasks.md" } }, "/_api/explain": { "post": { "description": "\n**A json post document 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
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/explain <<EOF\n{ \n  \"query\" : \"FOR p IN products RETURN p\" \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"plan\" : { \n    \"nodes\" : [ \n      { \n        \"type\" : \"SingletonNode\", \n        \"dependencies\" : [ ], \n        \"id\" : 1, \n        \"estimatedCost\" : 1, \n        \"estimatedNrItems\" : 1 \n      }, \n      { \n        \"type\" : \"EnumerateCollectionNode\", \n        \"dependencies\" : [ \n          1 \n        ], \n        \"id\" : 2, \n        \"estimatedCost\" : 12, \n        \"estimatedNrItems\" : 10, \n        \"database\" : \"_system\", \n        \"collection\" : \"products\", \n        \"outVariable\" : { \n          \"id\" : 0, \n          \"name\" : \"p\" \n        }, \n        \"random\" : false, \n        \"satellite\" : false \n      }, \n      { \n        \"type\" : \"ReturnNode\", \n        \"dependencies\" : [ \n          2 \n        ], \n        \"id\" : 3, \n        \"estimatedCost\" : 22, \n        \"estimatedNrItems\" : 10, \n        \"inVariable\" : { \n          \"id\" : 0, \n          \"name\" : \"p\" \n        } \n      } \n    ], \n    \"rules\" : [ ], \n    \"collections\" : [ \n      { \n        \"name\" : \"products\", \n        \"type\" : \"read\" \n      } \n    ], \n    \"variables\" : [ \n      { \n        \"id\" : 0, \n        \"name\" : \"p\" \n      } \n    ], \n    \"estimatedCost\" : 22, \n    \"estimatedNrItems\" : 10, \n    \"initialize\" : true \n  }, \n  \"warnings\" : [ ], \n  \"stats\" : { \n    \"rulesExecuted\" : 27, \n    \"rulesSkipped\" : 0, \n    \"plansCreated\" : 1 \n  }, \n  \"cacheable\" : true, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n#Example:\n A plan with some optimizer rules applied\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/explain <<EOF\n{ \n  \"query\" : \"FOR p IN products LET a = p.id FILTER a == 4 LET name = p.name SORT p.id LIMIT 1 RETURN name\" \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"plan\" : { \n    \"nodes\" : [ \n      { \n        \"type\" : \"SingletonNode\", \n        \"dependencies\" : [ ], \n        \"id\" : 1, \n        \"estimatedCost\" : 1, \n        \"estimatedNrItems\" : 1 \n      }, \n      { \n        \"type\" : \"IndexNode\", \n        \"dependencies\" : [ \n          1 \n        ], \n        \"id\" : 11, \n        \"estimatedCost\" : 1.5, \n        \"estimatedNrItems\" : 1, \n        \"database\" : \"_system\", \n        \"collection\" : \"products\", \n        \"satellite\" : false, \n        \"outVariable\" : { \n          \"id\" : 0, \n          \"name\" : \"p\" \n        }, \n        \"indexes\" : [ \n          { \n            \"id\" : \"10151\", \n            \"type\" : \"skiplist\", \n            \"fields\" : [ \n              \"id\" \n            ], \n            \"unique\" : false, \n            \"sparse\" : false \n          } \n        ], \n        \"condition\" : { \n          \"type\" : \"n-ary or\", \n          \"subNodes\" : [ \n            { \n              \"type\" : \"n-ary and\", \n              \"subNodes\" : [ \n                { \n                  \"type\" : \"compare ==\", \n                  \"subNodes\" : [ \n                    { \n                      \"type\" : \"attribute access\", \n                      \"name\" : \"id\", \n                      \"subNodes\" : [ \n                        { \n                          \"type\" : \"reference\", \n                          \"name\" : \"p\", \n                          \"id\" : 0 \n                        } \n                      ] \n                    }, \n                    { \n                      \"type\" : \"value\", \n                      \"value\" : 4 \n                    } \n                  ] \n                } \n              ] \n            } \n          ] \n        }, \n        \"reverse\" : false \n      }, \n      { \n        \"type\" : \"CalculationNode\", \n        \"dependencies\" : [ \n          11 \n        ], \n        \"id\" : 4, \n        \"estimatedCost\" : 2.5, \n        \"estimatedNrItems\" : 1, \n        \"expression\" : { \n          \"type\" : \"compare ==\", \n          \"subNodes\" : [ \n            { \n              \"type\" : \"attribute access\", \n              \"name\" : \"id\", \n              \"subNodes\" : [ \n                { \n                  \"type\" : \"reference\", \n                  \"name\" : \"p\", \n                  \"id\" : 0 \n                } \n              ] \n            }, \n            { \n              \"type\" : \"value\", \n              \"value\" : 4 \n            } \n          ] \n        }, \n        \"outVariable\" : { \n          \"id\" : 4, \n          \"name\" : \"3\" \n        }, \n        \"canThrow\" : false, \n        \"expressionType\" : \"simple\" \n      }, \n      { \n        \"type\" : \"FilterNode\", \n        \"dependencies\" : [ \n          4 \n        ], \n        \"id\" : 5, \n        \"estimatedCost\" : 3.5, \n        \"estimatedNrItems\" : 1, \n        \"inVariable\" : { \n          \"id\" : 4, \n          \"name\" : \"3\" \n        } \n      }, \n      { \n        \"type\" : \"LimitNode\", \n        \"dependencies\" : [ \n          5 \n        ], \n        \"id\" : 9, \n        \"estimatedCost\" : 4.5, \n        \"estimatedNrItems\" : 1, \n        \"offset\" : 0, \n        \"limit\" : 1, \n        \"fullCount\" : false \n      }, \n      { \n        \"type\" : \"CalculationNode\", \n        \"dependencies\" : [ \n          9 \n        ], \n        \"id\" : 6, \n        \"estimatedCost\" : 5.5, \n        \"estimatedNrItems\" : 1, \n        \"expression\" : { \n          \"type\" : \"attribute access\", \n          \"name\" : \"name\", \n          \"subNodes\" : [ \n            { \n              \"type\" : \"reference\", \n              \"name\" : \"p\", \n              \"id\" : 0 \n            } \n          ] \n        }, \n        \"outVariable\" : { \n          \"id\" : 2, \n          \"name\" : \"name\" \n        }, \n        \"canThrow\" : false, \n        \"expressionType\" : \"attribute\" \n      }, \n      { \n        \"type\" : \"ReturnNode\", \n        \"dependencies\" : [ \n          6 \n        ], \n        \"id\" : 10, \n        \"estimatedCost\" : 6.5, \n        \"estimatedNrItems\" : 1, \n        \"inVariable\" : { \n          \"id\" : 2, \n          \"name\" : \"name\" \n        } \n      } \n    ], \n    \"rules\" : [ \n      \"move-calculations-up\", \n      \"remove-redundant-calculations\", \n      \"remove-unnecessary-calculations\", \n      \"move-calculations-up-2\", \n      \"use-indexes\", \n      \"use-index-for-sort\", \n      \"remove-unnecessary-calculations-2\", \n      \"move-calculations-down\" \n    ], \n    \"collections\" : [ \n      { \n        \"name\" : \"products\", \n        \"type\" : \"read\" \n      } \n    ], \n    \"variables\" : [ \n      { \n        \"id\" : 6, \n        \"name\" : \"5\" \n      }, \n      { \n        \"id\" : 4, \n        \"name\" : \"3\" \n      }, \n      { \n        \"id\" : 2, \n        \"name\" : \"name\" \n      }, \n      { \n        \"id\" : 1, \n        \"name\" : \"a\" \n      }, \n      { \n        \"id\" : 0, \n        \"name\" : \"p\" \n      } \n    ], \n    \"estimatedCost\" : 6.5, \n    \"estimatedNrItems\" : 1, \n    \"initialize\" : true \n  }, \n  \"warnings\" : [ ], \n  \"stats\" : { \n    \"rulesExecuted\" : 27, \n    \"rulesSkipped\" : 0, \n    \"plansCreated\" : 1 \n  }, \n  \"cacheable\" : true, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n#Example:\n Using some options\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/explain <<EOF\n{ \n  \"query\" : \"FOR p IN products LET a = p.id FILTER a == 4 LET name = p.name SORT p.id LIMIT 1 RETURN name\", \n  \"options\" : { \n    \"maxNumberOfPlans\" : 2, \n    \"allPlans\" : true, \n    \"optimizer\" : { \n      \"rules\" : [ \n        \"-all\", \n        \"+use-index-for-sort\", \n        \"+use-index-range\" \n      ] \n    } \n  } \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"plans\" : [ \n    { \n      \"nodes\" : [ \n        { \n          \"type\" : \"SingletonNode\", \n          \"dependencies\" : [ ], \n          \"id\" : 1, \n          \"estimatedCost\" : 1, \n          \"estimatedNrItems\" : 1 \n        }, \n        { \n          \"type\" : \"IndexNode\", \n          \"dependencies\" : [ \n            1 \n          ], \n          \"id\" : 11, \n          \"estimatedCost\" : 11, \n          \"estimatedNrItems\" : 10, \n          \"database\" : \"_system\", \n          \"collection\" : \"products\", \n          \"satellite\" : false, \n          \"outVariable\" : { \n            \"id\" : 0, \n            \"name\" : \"p\" \n          }, \n          \"indexes\" : [ \n            { \n              \"id\" : \"10192\", \n              \"type\" : \"skiplist\", \n              \"fields\" : [ \n                \"id\" \n              ], \n              \"unique\" : false, \n              \"sparse\" : false \n            } \n          ], \n          \"condition\" : { \n          }, \n          \"reverse\" : false \n        }, \n        { \n          \"type\" : \"CalculationNode\", \n          \"dependencies\" : [ \n            11 \n          ], \n          \"id\" : 3, \n          \"estimatedCost\" : 21, \n          \"estimatedNrItems\" : 10, \n          \"expression\" : { \n            \"type\" : \"attribute access\", \n            \"name\" : \"id\", \n            \"subNodes\" : [ \n              { \n                \"type\" : \"reference\", \n                \"name\" : \"p\", \n                \"id\" : 0 \n              } \n            ] \n          }, \n          \"outVariable\" : { \n            \"id\" : 1, \n            \"name\" : \"a\" \n          }, \n          \"canThrow\" : false, \n          \"expressionType\" : \"attribute\" \n        }, \n        { \n          \"type\" : \"CalculationNode\", \n          \"dependencies\" : [ \n            3 \n          ], \n          \"id\" : 4, \n          \"estimatedCost\" : 31, \n          \"estimatedNrItems\" : 10, \n          \"expression\" : { \n            \"type\" : \"compare ==\", \n            \"subNodes\" : [ \n              { \n                \"type\" : \"reference\", \n                \"name\" : \"a\", \n                \"id\" : 1 \n              }, \n              { \n                \"type\" : \"value\", \n                \"value\" : 4 \n              } \n            ] \n          }, \n          \"outVariable\" : { \n            \"id\" : 4, \n            \"name\" : \"3\" \n          }, \n          \"canThrow\" : false, \n          \"expressionType\" : \"simple\" \n        }, \n        { \n          \"type\" : \"FilterNode\", \n          \"dependencies\" : [ \n            4 \n          ], \n          \"id\" : 5, \n          \"estimatedCost\" : 41, \n          \"estimatedNrItems\" : 10, \n          \"inVariable\" : { \n            \"id\" : 4, \n            \"name\" : \"3\" \n          } \n        }, \n        { \n          \"type\" : \"CalculationNode\", \n          \"dependencies\" : [ \n            5 \n          ], \n          \"id\" : 6, \n          \"estimatedCost\" : 51, \n          \"estimatedNrItems\" : 10, \n          \"expression\" : { \n            \"type\" : \"attribute access\", \n            \"name\" : \"name\", \n            \"subNodes\" : [ \n              { \n                \"type\" : \"reference\", \n                \"name\" : \"p\", \n                \"id\" : 0 \n              } \n            ] \n          }, \n          \"outVariable\" : { \n            \"id\" : 2, \n            \"name\" : \"name\" \n          }, \n          \"canThrow\" : false, \n          \"expressionType\" : \"attribute\" \n        }, \n        { \n          \"type\" : \"CalculationNode\", \n          \"dependencies\" : [ \n            6 \n          ], \n          \"id\" : 7, \n          \"estimatedCost\" : 61, \n          \"estimatedNrItems\" : 10, \n          \"expression\" : { \n            \"type\" : \"attribute access\", \n            \"name\" : \"id\", \n            \"subNodes\" : [ \n              { \n                \"type\" : \"reference\", \n                \"name\" : \"p\", \n                \"id\" : 0 \n              } \n            ] \n          }, \n          \"outVariable\" : { \n            \"id\" : 6, \n            \"name\" : \"5\" \n          }, \n          \"canThrow\" : false, \n          \"expressionType\" : \"attribute\" \n        }, \n        { \n          \"type\" : \"LimitNode\", \n          \"dependencies\" : [ \n            7 \n          ], \n          \"id\" : 9, \n          \"estimatedCost\" : 62, \n          \"estimatedNrItems\" : 1, \n          \"offset\" : 0, \n          \"limit\" : 1, \n          \"fullCount\" : false \n        }, \n        { \n          \"type\" : \"ReturnNode\", \n          \"dependencies\" : [ \n            9 \n          ], \n          \"id\" : 10, \n          \"estimatedCost\" : 63, \n          \"estimatedNrItems\" : 1, \n          \"inVariable\" : { \n            \"id\" : 2, \n            \"name\" : \"name\" \n          } \n        } \n      ], \n      \"rules\" : [ \n        \"use-index-for-sort\" \n      ], \n      \"collections\" : [ \n        { \n          \"name\" : \"products\", \n          \"type\" : \"read\" \n        } \n      ], \n      \"variables\" : [ \n        { \n          \"id\" : 6, \n          \"name\" : \"5\" \n        }, \n        { \n          \"id\" : 4, \n          \"name\" : \"3\" \n        }, \n        { \n          \"id\" : 2, \n          \"name\" : \"name\" \n        }, \n        { \n          \"id\" : 1, \n          \"name\" : \"a\" \n        }, \n        { \n          \"id\" : 0, \n          \"name\" : \"p\" \n        } \n      ], \n      \"estimatedCost\" : 63, \n      \"estimatedNrItems\" : 1, \n      \"initialize\" : true \n    } \n  ], \n  \"warnings\" : [ ], \n  \"stats\" : { \n    \"rulesExecuted\" : 1, \n    \"rulesSkipped\" : 26, \n    \"plansCreated\" : 1 \n  }, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n#Example:\n Returning all plans\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/explain <<EOF\n{ \n  \"query\" : \"FOR p IN products FILTER p.id == 25 RETURN p\", \n  \"options\" : { \n    \"allPlans\" : true \n  } \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"plans\" : [ \n    { \n      \"nodes\" : [ \n        { \n          \"type\" : \"SingletonNode\", \n          \"dependencies\" : [ ], \n          \"id\" : 1, \n          \"estimatedCost\" : 1, \n          \"estimatedNrItems\" : 1 \n        }, \n        { \n          \"type\" : \"IndexNode\", \n          \"dependencies\" : [ \n            1 \n          ], \n          \"id\" : 6, \n          \"estimatedCost\" : 1.99, \n          \"estimatedNrItems\" : 1, \n          \"database\" : \"_system\", \n          \"collection\" : \"products\", \n          \"satellite\" : false, \n          \"outVariable\" : { \n            \"id\" : 0, \n            \"name\" : \"p\" \n          }, \n          \"indexes\" : [ \n            { \n              \"id\" : \"10137\", \n              \"type\" : \"hash\", \n              \"fields\" : [ \n                \"id\" \n              ], \n              \"selectivityEstimate\" : 1, \n              \"unique\" : false, \n              \"sparse\" : false \n            } \n          ], \n          \"condition\" : { \n            \"type\" : \"n-ary or\", \n            \"subNodes\" : [ \n              { \n                \"type\" : \"n-ary and\", \n                \"subNodes\" : [ \n                  { \n                    \"type\" : \"compare ==\", \n                    \"subNodes\" : [ \n                      { \n                        \"type\" : \"attribute access\", \n                        \"name\" : \"id\", \n                        \"subNodes\" : [ \n                          { \n                            \"type\" : \"reference\", \n                            \"name\" : \"p\", \n                            \"id\" : 0 \n                          } \n                        ] \n                      }, \n                      { \n                        \"type\" : \"value\", \n                        \"value\" : 25 \n                      } \n                    ] \n                  } \n                ] \n              } \n            ] \n          }, \n          \"reverse\" : false \n        }, \n        { \n          \"type\" : \"ReturnNode\", \n          \"dependencies\" : [ \n            6 \n          ], \n          \"id\" : 5, \n          \"estimatedCost\" : 2.99, \n          \"estimatedNrItems\" : 1, \n          \"inVariable\" : { \n            \"id\" : 0, \n            \"name\" : \"p\" \n          } \n        } \n      ], \n      \"rules\" : [ \n        \"use-indexes\", \n        \"remove-filter-covered-by-index\", \n        \"remove-unnecessary-calculations-2\" \n      ], \n      \"collections\" : [ \n        { \n          \"name\" : \"products\", \n          \"type\" : \"read\" \n        } \n      ], \n      \"variables\" : [ \n        { \n          \"id\" : 2, \n          \"name\" : \"1\" \n        }, \n        { \n          \"id\" : 0, \n          \"name\" : \"p\" \n        } \n      ], \n      \"estimatedCost\" : 2.99, \n      \"estimatedNrItems\" : 1, \n      \"initialize\" : true \n    } \n  ], \n  \"warnings\" : [ ], \n  \"stats\" : { \n    \"rulesExecuted\" : 27, \n    \"rulesSkipped\" : 0, \n    \"plansCreated\" : 1 \n  }, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n#Example:\n A query that produces a warning\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/explain <<EOF\n{ \n  \"query\" : \"FOR i IN 1..10 RETURN 1 / 0\" \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"plan\" : { \n    \"nodes\" : [ \n      { \n        \"type\" : \"SingletonNode\", \n        \"dependencies\" : [ ], \n        \"id\" : 1, \n        \"estimatedCost\" : 1, \n        \"estimatedNrItems\" : 1 \n      }, \n      { \n        \"type\" : \"CalculationNode\", \n        \"dependencies\" : [ \n          1 \n        ], \n        \"id\" : 2, \n        \"estimatedCost\" : 2, \n        \"estimatedNrItems\" : 1, \n        \"expression\" : { \n          \"type\" : \"range\", \n          \"subNodes\" : [ \n            { \n              \"type\" : \"value\", \n              \"value\" : 1 \n            }, \n            { \n              \"type\" : \"value\", \n              \"value\" : 10 \n            } \n          ] \n        }, \n        \"outVariable\" : { \n          \"id\" : 2, \n          \"name\" : \"1\" \n        }, \n        \"canThrow\" : false, \n        \"expressionType\" : \"simple\" \n      }, \n      { \n        \"type\" : \"CalculationNode\", \n        \"dependencies\" : [ \n          2 \n        ], \n        \"id\" : 4, \n        \"estimatedCost\" : 3, \n        \"estimatedNrItems\" : 1, \n        \"expression\" : { \n          \"type\" : \"value\", \n          \"value\" : null \n        }, \n        \"outVariable\" : { \n          \"id\" : 4, \n          \"name\" : \"3\" \n        }, \n        \"canThrow\" : false, \n        \"expressionType\" : \"json\" \n      }, \n      { \n        \"type\" : \"EnumerateListNode\", \n        \"dependencies\" : [ \n          4 \n        ], \n        \"id\" : 3, \n        \"estimatedCost\" : 13, \n        \"estimatedNrItems\" : 10, \n        \"inVariable\" : { \n          \"id\" : 2, \n          \"name\" : \"1\" \n        }, \n        \"outVariable\" : { \n          \"id\" : 0, \n          \"name\" : \"i\" \n        } \n      }, \n      { \n        \"type\" : \"ReturnNode\", \n        \"dependencies\" : [ \n          3 \n        ], \n        \"id\" : 5, \n        \"estimatedCost\" : 23, \n        \"estimatedNrItems\" : 10, \n        \"inVariable\" : { \n          \"id\" : 4, \n          \"name\" : \"3\" \n        } \n      } \n    ], \n    \"rules\" : [ \n      \"move-calculations-up\", \n      \"move-calculations-up-2\" \n    ], \n    \"collections\" : [ ], \n    \"variables\" : [ \n      { \n        \"id\" : 4, \n        \"name\" : \"3\" \n      }, \n      { \n        \"id\" : 2, \n        \"name\" : \"1\" \n      }, \n      { \n        \"id\" : 0, \n        \"name\" : \"i\" \n      } \n    ], \n    \"estimatedCost\" : 23, \n    \"estimatedNrItems\" : 10, \n    \"initialize\" : true \n  }, \n  \"warnings\" : [ \n    { \n      \"code\" : 1562, \n      \"message\" : \"division by zero\" \n    } \n  ], \n  \"stats\" : { \n    \"rulesExecuted\" : 27, \n    \"rulesSkipped\" : 0, \n    \"plansCreated\" : 1 \n  }, \n  \"cacheable\" : false, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n#Example:\n Invalid query (missing bind parameter)\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/explain <<EOF\n{ \n  \"query\" : \"FOR p IN products FILTER p.id == @id LIMIT 2 RETURN p.n\" \n}\nEOF\n\nHTTP/1.1 400 Bad Request\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"error\" : true, \n  \"code\" : 400, \n  \"errorNum\" : 1551, \n  \"errorMessage\" : \"no value specified for declared bind parameter 'id' (while parsing)\" \n}\n
\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
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/explain <<EOF\n{ \"query\" : \"FOR i IN [ 1, 2, 3 ] FILTER 1 == 2 RETURN i\" }\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"plan\" : { \n    \"nodes\" : [ \n      { \n        \"type\" : \"SingletonNode\", \n        \"dependencies\" : [ ], \n        \"id\" : 1, \n        \"estimatedCost\" : 1, \n        \"estimatedNrItems\" : 1 \n      }, \n      { \n        \"type\" : \"CalculationNode\", \n        \"dependencies\" : [ \n          1 \n        ], \n        \"id\" : 2, \n        \"estimatedCost\" : 2, \n        \"estimatedNrItems\" : 1, \n        \"expression\" : { \n          \"type\" : \"array\", \n          \"subNodes\" : [ \n            { \n              \"type\" : \"value\", \n              \"value\" : 1 \n            }, \n            { \n              \"type\" : \"value\", \n              \"value\" : 2 \n            }, \n            { \n              \"type\" : \"value\", \n              \"value\" : 3 \n            } \n          ] \n        }, \n        \"outVariable\" : { \n          \"id\" : 2, \n          \"name\" : \"1\" \n        }, \n        \"canThrow\" : false, \n        \"expressionType\" : \"json\" \n      }, \n      { \n        \"type\" : \"NoResultsNode\", \n        \"dependencies\" : [ \n          2 \n        ], \n        \"id\" : 7, \n        \"estimatedCost\" : 0.5, \n        \"estimatedNrItems\" : 0 \n      }, \n      { \n        \"type\" : \"EnumerateListNode\", \n        \"dependencies\" : [ \n          7 \n        ], \n        \"id\" : 3, \n        \"estimatedCost\" : 0.5, \n        \"estimatedNrItems\" : 0, \n        \"inVariable\" : { \n          \"id\" : 2, \n          \"name\" : \"1\" \n        }, \n        \"outVariable\" : { \n          \"id\" : 0, \n          \"name\" : \"i\" \n        } \n      }, \n      { \n        \"type\" : \"ReturnNode\", \n        \"dependencies\" : [ \n          3 \n        ], \n        \"id\" : 6, \n        \"estimatedCost\" : 0.5, \n        \"estimatedNrItems\" : 0, \n        \"inVariable\" : { \n          \"id\" : 0, \n          \"name\" : \"i\" \n        } \n      } \n    ], \n    \"rules\" : [ \n      \"move-calculations-up\", \n      \"move-filters-up\", \n      \"remove-unnecessary-filters\", \n      \"remove-unnecessary-calculations\" \n    ], \n    \"collections\" : [ ], \n    \"variables\" : [ \n      { \n        \"id\" : 4, \n        \"name\" : \"3\" \n      }, \n      { \n        \"id\" : 2, \n        \"name\" : \"1\" \n      }, \n      { \n        \"id\" : 0, \n        \"name\" : \"i\" \n      } \n    ], \n    \"estimatedCost\" : 0.5, \n    \"estimatedNrItems\" : 0, \n    \"initialize\" : true \n  }, \n  \"warnings\" : [ ], \n  \"stats\" : { \n    \"rulesExecuted\" : 27, \n    \"rulesSkipped\" : 0, \n    \"plansCreated\" : 1 \n  }, \n  \"cacheable\" : true, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n", "parameters": [ { "in": "body", "name": "Json Request Body", "required": true, "schema": { "$ref": "#/definitions/JSF_post_api_explain" }, "x-description-offset": 61 } ], "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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\DeleteApiQueryCache.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\DeleteApiQueryKill.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\DeleteApiQuerySlow.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\GetApiQueryCacheProperties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\GetApiQueryCurrent.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\GetApiQueryProperties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\GetApiQuerySlow.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\JSF_delete_api_aqlfunction.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\JSF_get_api_aqlfunction.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\JSF_post_api_aqlfunction.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\JSF_post_api_explain.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\PostApiQueryProperties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\PutApiQueryCacheProperties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\PutApiQueryProperties.md" } }, "/_api/export": { "post": { "description": "\n**A json post document 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/JSF_post_api_export" }, "x-description-offset": 61 }, { "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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Bulk\\JSF_batch_processing.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Bulk\\JSF_import_document.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Bulk\\JSF_import_json.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Bulk\\JSF_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": [], "responses": { "200": { "description": "Returned if the request was successful.\n\n\n" } }, "summary": " List installed services", "tags": [ "Foxx" ], "x-examples": [], "x-filename": "Foxx - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_bundle.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_commit.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_configuration_get.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_configuration_replace.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_configuration_update.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_dependencies_get.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_dependencies_replace.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_dependencies_update.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_development_disable.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_development_enable.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_readme.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_scripts_list.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_scripts_run.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_details.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_install.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_list.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_replace.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_uninstall.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_upgrade.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_swagger.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_tests_run.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 (stringified) JSON object describing configuration values\n- *dependencies*: a (stringified) 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\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.\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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_bundle.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_commit.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_configuration_get.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_configuration_replace.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_configuration_update.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_dependencies_get.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_dependencies_replace.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_dependencies_update.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_development_disable.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_development_enable.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_readme.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_scripts_list.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_scripts_run.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_details.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_install.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_list.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_replace.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_uninstall.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_upgrade.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_swagger.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_tests_run.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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_bundle.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_commit.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_configuration_get.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_configuration_replace.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_configuration_update.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_dependencies_get.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_dependencies_replace.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_dependencies_update.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_development_disable.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_development_enable.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_readme.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_scripts_list.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_scripts_run.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_details.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_install.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_list.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_replace.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_uninstall.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_upgrade.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_swagger.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_tests_run.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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_bundle.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_commit.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_configuration_get.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_configuration_replace.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_configuration_update.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_dependencies_get.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_dependencies_replace.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_dependencies_update.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_development_disable.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_development_enable.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_readme.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_scripts_list.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_scripts_run.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_details.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_install.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_list.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_replace.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_uninstall.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_upgrade.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_swagger.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_tests_run.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\n", "in": "query", "name": "mount", "required": true, "type": "string" } ], "summary": " Update configuration options", "tags": [ "Foxx" ], "x-examples": [], "x-filename": "Foxx - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_bundle.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_commit.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_configuration_get.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_configuration_replace.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_configuration_update.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_dependencies_get.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_dependencies_replace.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_dependencies_update.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_development_disable.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_development_enable.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_readme.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_scripts_list.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_scripts_run.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_details.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_install.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_list.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_replace.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_uninstall.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_upgrade.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_swagger.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_tests_run.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\n", "in": "query", "name": "mount", "required": true, "type": "string" } ], "summary": " Replace configuration options", "tags": [ "Foxx" ], "x-examples": [], "x-filename": "Foxx - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_bundle.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_commit.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_configuration_get.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_configuration_replace.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_configuration_update.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_dependencies_get.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_dependencies_replace.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_dependencies_update.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_development_disable.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_development_enable.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_readme.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_scripts_list.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_scripts_run.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_details.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_install.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_list.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_replace.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_uninstall.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_upgrade.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_swagger.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_tests_run.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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_bundle.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_commit.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_configuration_get.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_configuration_replace.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_configuration_update.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_dependencies_get.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_dependencies_replace.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_dependencies_update.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_development_disable.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_development_enable.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_readme.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_scripts_list.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_scripts_run.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_details.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_install.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_list.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_replace.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_uninstall.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_upgrade.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_swagger.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_tests_run.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\n", "in": "query", "name": "mount", "required": true, "type": "string" } ], "summary": " Update dependencies options", "tags": [ "Foxx" ], "x-examples": [], "x-filename": "Foxx - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_bundle.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_commit.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_configuration_get.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_configuration_replace.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_configuration_update.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_dependencies_get.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_dependencies_replace.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_dependencies_update.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_development_disable.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_development_enable.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_readme.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_scripts_list.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_scripts_run.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_details.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_install.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_list.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_replace.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_uninstall.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_upgrade.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_swagger.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_tests_run.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\n", "in": "query", "name": "mount", "required": true, "type": "string" } ], "summary": " Replace dependencies options", "tags": [ "Foxx" ], "x-examples": [], "x-filename": "Foxx - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_bundle.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_commit.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_configuration_get.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_configuration_replace.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_configuration_update.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_dependencies_get.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_dependencies_replace.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_dependencies_update.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_development_disable.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_development_enable.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_readme.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_scripts_list.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_scripts_run.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_details.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_install.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_list.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_replace.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_uninstall.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_upgrade.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_swagger.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_tests_run.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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_bundle.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_commit.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_configuration_get.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_configuration_replace.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_configuration_update.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_dependencies_get.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_dependencies_replace.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_dependencies_update.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_development_disable.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_development_enable.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_readme.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_scripts_list.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_scripts_run.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_details.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_install.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_list.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_replace.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_uninstall.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_upgrade.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_swagger.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_tests_run.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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_bundle.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_commit.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_configuration_get.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_configuration_replace.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_configuration_update.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_dependencies_get.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_dependencies_replace.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_dependencies_update.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_development_disable.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_development_enable.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_readme.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_scripts_list.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_scripts_run.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_details.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_install.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_list.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_replace.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_uninstall.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_upgrade.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_swagger.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_tests_run.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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_bundle.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_commit.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_configuration_get.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_configuration_replace.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_configuration_update.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_dependencies_get.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_dependencies_replace.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_dependencies_update.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_development_disable.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_development_enable.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_readme.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_scripts_list.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_scripts_run.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_details.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_install.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_list.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_replace.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_uninstall.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_upgrade.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_swagger.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_tests_run.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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_bundle.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_commit.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_configuration_get.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_configuration_replace.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_configuration_update.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_dependencies_get.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_dependencies_replace.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_dependencies_update.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_development_disable.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_development_enable.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_readme.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_scripts_list.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_scripts_run.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_details.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_install.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_list.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_replace.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_uninstall.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_upgrade.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_swagger.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_tests_run.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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_bundle.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_commit.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_configuration_get.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_configuration_replace.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_configuration_update.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_dependencies_get.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_dependencies_replace.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_dependencies_update.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_development_disable.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_development_enable.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_readme.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_scripts_list.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_scripts_run.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_details.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_install.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_list.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_replace.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_uninstall.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_upgrade.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_swagger.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_tests_run.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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_bundle.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_commit.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_configuration_get.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_configuration_replace.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_configuration_update.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_dependencies_get.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_dependencies_replace.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_dependencies_update.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_development_disable.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_development_enable.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_readme.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_scripts_list.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_scripts_run.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_details.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_install.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_list.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_replace.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_uninstall.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_upgrade.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_swagger.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_tests_run.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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_bundle.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_commit.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_configuration_get.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_configuration_replace.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_configuration_update.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_dependencies_get.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_dependencies_replace.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_dependencies_update.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_development_disable.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_development_enable.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_readme.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_scripts_list.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_scripts_run.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_details.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_install.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_list.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_replace.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_uninstall.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_upgrade.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_swagger.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_tests_run.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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_bundle.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_commit.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_configuration_get.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_configuration_replace.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_configuration_update.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_dependencies_get.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_dependencies_replace.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_dependencies_update.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_development_disable.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_development_enable.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_readme.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_scripts_list.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_scripts_run.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_details.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_install.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_list.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_replace.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_uninstall.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_upgrade.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_swagger.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_tests_run.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 (stringified) JSON object describing configuration values\n- *dependencies*: a (stringified) 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\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.\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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_bundle.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_commit.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_configuration_get.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_configuration_replace.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_configuration_update.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_dependencies_get.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_dependencies_replace.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_dependencies_update.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_development_disable.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_development_enable.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_readme.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_scripts_list.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_scripts_run.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_details.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_install.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_list.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_replace.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_uninstall.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_upgrade.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_swagger.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_tests_run.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 (stringified) JSON object describing configuration values\n- *dependencies*: a (stringified) 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\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.\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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_bundle.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_commit.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_configuration_get.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_configuration_replace.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_configuration_update.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_dependencies_get.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_dependencies_replace.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_dependencies_update.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_development_disable.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_development_enable.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_readme.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_scripts_list.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_scripts_run.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_details.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_install.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_list.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_replace.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_uninstall.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_upgrade.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_swagger.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_tests_run.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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_bundle.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_commit.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_configuration_get.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_configuration_replace.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_configuration_update.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_dependencies_get.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_dependencies_replace.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_dependencies_update.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_development_disable.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_development_enable.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_readme.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_scripts_list.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_scripts_run.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_details.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_install.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_list.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_replace.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_uninstall.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_upgrade.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_swagger.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_tests_run.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*: a 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" } ], "responses": { "200": { "description": "Returned if the request was sucessful.\n\n\n" } }, "summary": " Run service tests", "tags": [ "Foxx" ], "x-examples": [], "x-filename": "Foxx - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_bundle.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_commit.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_configuration_get.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_configuration_replace.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_configuration_update.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_dependencies_get.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_dependencies_replace.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_dependencies_update.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_development_disable.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_development_enable.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_readme.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_scripts_list.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_scripts_run.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_details.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_install.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_list.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_replace.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_uninstall.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_service_upgrade.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_swagger.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Foxx\\api_foxx_tests_run.md" } }, "/_api/gharial": { "get": { "description": "\n\nLists all graph names stored in this database.\n\n\n\n\n#Example:\n \n\n
shell> curl --dump - http://localhost:8529/_api/gharial\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"error\" : false, \n  \"graphs\" : [ \n    { \n      \"_key\" : \"routeplanner\", \n      \"_id\" : \"_graphs/routeplanner\", \n      \"_rev\" : \"_V_qDHoO---\", \n      \"orphanCollections\" : [ ], \n      \"edgeDefinitions\" : [ \n        { \n          \"collection\" : \"germanHighway\", \n          \"from\" : [ \n            \"germanCity\" \n          ], \n          \"to\" : [ \n            \"germanCity\" \n          ] \n        }, \n        { \n          \"collection\" : \"frenchHighway\", \n          \"from\" : [ \n            \"frenchCity\" \n          ], \n          \"to\" : [ \n            \"frenchCity\" \n          ] \n        }, \n        { \n          \"collection\" : \"internationalHighway\", \n          \"from\" : [ \n            \"frenchCity\", \n            \"germanCity\" \n          ], \n          \"to\" : [ \n            \"frenchCity\", \n            \"germanCity\" \n          ] \n        } \n      ] \n    }, \n    { \n      \"_key\" : \"social\", \n      \"_id\" : \"_graphs/social\", \n      \"_rev\" : \"_V_qDHY----\", \n      \"orphanCollections\" : [ ], \n      \"edgeDefinitions\" : [ \n        { \n          \"collection\" : \"relation\", \n          \"from\" : [ \n            \"female\", \n            \"male\" \n          ], \n          \"to\" : [ \n            \"female\", \n            \"male\" \n          ] \n        } \n      ] \n    } \n  ], \n  \"code\" : 200 \n}\n
\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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_create_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_drop_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_create_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_definition_add_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_definition_modify_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_definition_remove_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_delete_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_get_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_modify_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_replace_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_get_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_list_edge_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_list_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_list_vertex_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_collection_add_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_collection_remove_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_create_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_delete_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_get_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_modify_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_replace_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 post document 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
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/gharial <<EOF\n{ \n  \"name\" : \"myGraph\", \n  \"edgeDefinitions\" : [ \n    { \n      \"collection\" : \"edges\", \n      \"from\" : [ \n        \"startVertices\" \n      ], \n      \"to\" : [ \n        \"endVertices\" \n      ] \n    } \n  ] \n}\nEOF\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\netag: _V_qDDu6---\nx-content-type-options: nosniff\n\n{ \n  \"error\" : false, \n  \"graph\" : { \n    \"name\" : \"myGraph\", \n    \"edgeDefinitions\" : [ \n      { \n        \"collection\" : \"edges\", \n        \"from\" : [ \n          \"startVertices\" \n        ], \n        \"to\" : [ \n          \"endVertices\" \n        ] \n      } \n    ], \n    \"orphanCollections\" : [ ], \n    \"isSmart\" : false, \n    \"numberOfShards\" : 0, \n    \"smartGraphAttribute\" : \"\", \n    \"_id\" : \"_graphs/myGraph\", \n    \"_rev\" : \"_V_qDDu6---\" \n  }, \n  \"code\" : 202 \n}\n
\n\n\n\n\n#Example:\n \n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/gharial <<EOF\n{ \n  \"name\" : \"myGraph\", \n  \"edgeDefinitions\" : [ \n    { \n      \"collection\" : \"edges\", \n      \"from\" : [ \n        \"startVertices\" \n      ], \n      \"to\" : [ \n        \"endVertices\" \n      ] \n    } \n  ], \n  \"isSmart\" : true, \n  \"options\" : { \n    \"numberOfShards\" : 9, \n    \"smartGraphAttribute\" : \"region\" \n  } \n}\nEOF\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\netag: _V_qDEEa---\nx-content-type-options: nosniff\n\n{ \n  \"error\" : false, \n  \"graph\" : { \n    \"name\" : \"myGraph\", \n    \"edgeDefinitions\" : [ \n      { \n        \"collection\" : \"edges\", \n        \"from\" : [ \n          \"startVertices\" \n        ], \n        \"to\" : [ \n          \"endVertices\" \n        ] \n      } \n    ], \n    \"orphanCollections\" : [ ], \n    \"isSmart\" : false, \n    \"numberOfShards\" : 0, \n    \"smartGraphAttribute\" : \"\", \n    \"_id\" : \"_graphs/myGraph\", \n    \"_rev\" : \"_V_qDEEa---\" \n  }, \n  \"code\" : 202 \n}\n
\n\n\n\n\n", "parameters": [ { "in": "body", "name": "Json Request Body", "required": true, "schema": { "$ref": "#/definitions/JSF_general_graph_create_http_examples" }, "x-description-offset": 247 } ], "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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_create_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_drop_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_create_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_definition_add_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_definition_modify_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_definition_remove_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_delete_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_get_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_modify_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_replace_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_get_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_list_edge_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_list_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_list_vertex_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_collection_add_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_collection_remove_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_create_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_delete_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_get_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_modify_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_replace_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
shell> curl -X DELETE --dump - http://localhost:8529/_api/gharial/social?dropCollections=true\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"error\" : false, \n  \"removed\" : true, \n  \"code\" : 202 \n}\n
\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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_create_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_drop_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_create_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_definition_add_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_definition_modify_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_definition_remove_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_delete_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_get_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_modify_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_replace_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_get_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_list_edge_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_list_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_list_vertex_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_collection_add_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_collection_remove_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_create_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_delete_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_get_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_modify_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_replace_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
shell> curl --dump - http://localhost:8529/_api/gharial/myGraph\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\netag: _V_qDGmC---\nx-content-type-options: nosniff\n\n{ \n  \"error\" : false, \n  \"graph\" : { \n    \"name\" : \"myGraph\", \n    \"edgeDefinitions\" : [ \n      { \n        \"collection\" : \"edges\", \n        \"from\" : [ \n          \"startVertices\" \n        ], \n        \"to\" : [ \n          \"endVertices\" \n        ] \n      } \n    ], \n    \"orphanCollections\" : [ ], \n    \"isSmart\" : false, \n    \"numberOfShards\" : 0, \n    \"smartGraphAttribute\" : \"\", \n    \"_id\" : \"_graphs/myGraph\", \n    \"_rev\" : \"_V_qDGmC---\" \n  }, \n  \"code\" : 200 \n}\n
\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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_create_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_drop_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_create_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_definition_add_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_definition_modify_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_definition_remove_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_delete_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_get_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_modify_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_replace_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_get_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_list_edge_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_list_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_list_vertex_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_collection_add_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_collection_remove_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_create_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_delete_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_get_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_modify_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_replace_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
shell> curl --dump - http://localhost:8529/_api/gharial/social/edge\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"error\" : false, \n  \"collections\" : [ \n    \"relation\" \n  ], \n  \"code\" : 200 \n}\n
\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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_create_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_drop_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_create_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_definition_add_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_definition_modify_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_definition_remove_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_delete_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_get_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_modify_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_replace_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_get_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_list_edge_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_list_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_list_vertex_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_collection_add_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_collection_remove_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_create_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_delete_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_get_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_modify_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_replace_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 post document 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
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/gharial/social/edge <<EOF\n{ \n  \"collection\" : \"works_in\", \n  \"from\" : [ \n    \"female\", \n    \"male\" \n  ], \n  \"to\" : [ \n    \"city\" \n  ] \n}\nEOF\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\netag: _V_qDB56---\nx-content-type-options: nosniff\n\n{ \n  \"error\" : false, \n  \"graph\" : { \n    \"name\" : \"social\", \n    \"edgeDefinitions\" : [ \n      { \n        \"collection\" : \"relation\", \n        \"from\" : [ \n          \"female\", \n          \"male\" \n        ], \n        \"to\" : [ \n          \"female\", \n          \"male\" \n        ] \n      }, \n      { \n        \"collection\" : \"works_in\", \n        \"from\" : [ \n          \"female\", \n          \"male\" \n        ], \n        \"to\" : [ \n          \"city\" \n        ] \n      } \n    ], \n    \"orphanCollections\" : [ ], \n    \"isSmart\" : false, \n    \"numberOfShards\" : 0, \n    \"smartGraphAttribute\" : \"\", \n    \"_id\" : \"_graphs/social\", \n    \"_rev\" : \"_V_qDB56---\" \n  }, \n  \"code\" : 202 \n}\n
\n\n\n\n", "parameters": [ { "in": "body", "name": "Json Request Body", "required": true, "schema": { "$ref": "#/definitions/JSF_general_graph_edge_definition_add_http_examples" }, "x-description-offset": 493 } ], "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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_create_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_drop_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_create_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_definition_add_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_definition_modify_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_definition_remove_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_delete_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_get_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_modify_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_replace_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_get_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_list_edge_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_list_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_list_vertex_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_collection_add_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_collection_remove_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_create_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_delete_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_get_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_modify_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_replace_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
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/gharial/social/edge/relation <<EOF\n{ \n  \"type\" : \"friend\", \n  \"_from\" : \"female/alice\", \n  \"_to\" : \"female/diana\" \n}\nEOF\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\netag: _V_qDBga---\nx-content-type-options: nosniff\n\n{ \n  \"error\" : false, \n  \"edge\" : { \n    \"_id\" : \"relation/7706\", \n    \"_key\" : \"7706\", \n    \"_rev\" : \"_V_qDBga---\" \n  }, \n  \"code\" : 202 \n}\n
\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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_create_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_drop_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_create_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_definition_add_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_definition_modify_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_definition_remove_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_delete_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_get_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_modify_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_replace_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_get_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_list_edge_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_list_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_list_vertex_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_collection_add_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_collection_remove_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_create_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_delete_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_get_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_modify_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_replace_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
shell> curl -X DELETE --dump - http://localhost:8529/_api/gharial/social/edge/relation/aliceAndBob\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"error\" : false, \n  \"removed\" : true, \n  \"code\" : 202 \n}\n
\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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_create_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_drop_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_create_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_definition_add_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_definition_modify_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_definition_remove_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_delete_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_get_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_modify_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_replace_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_get_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_list_edge_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_list_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_list_vertex_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_collection_add_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_collection_remove_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_create_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_delete_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_get_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_modify_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_replace_http_examples.md" }, "get": { "description": "\n\nGets an edge from the given collection.\n\n\n\n\n#Example:\n \n\n
shell> curl --dump - http://localhost:8529/_api/gharial/social/edge/relation/aliceAndBob\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\netag: _V_qDGOK---\nx-content-type-options: nosniff\n\n{ \n  \"error\" : false, \n  \"edge\" : { \n    \"_key\" : \"aliceAndBob\", \n    \"_id\" : \"relation/aliceAndBob\", \n    \"_from\" : \"female/alice\", \n    \"_to\" : \"male/bob\", \n    \"_rev\" : \"_V_qDGOK---\", \n    \"type\" : \"married\" \n  }, \n  \"code\" : 200 \n}\n
\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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_create_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_drop_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_create_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_definition_add_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_definition_modify_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_definition_remove_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_delete_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_get_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_modify_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_replace_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_get_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_list_edge_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_list_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_list_vertex_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_collection_add_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_collection_remove_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_create_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_delete_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_get_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_modify_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_replace_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
shell> curl -X PATCH --data-binary @- --dump - http://localhost:8529/_api/gharial/social/edge/relation/aliceAndBob <<EOF\n{ \n  \"since\" : \"01.01.2001\" \n}\nEOF\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\netag: _V_qDJsK---\nx-content-type-options: nosniff\n\n{ \n  \"error\" : false, \n  \"edge\" : { \n    \"_id\" : \"relation/aliceAndBob\", \n    \"_key\" : \"aliceAndBob\", \n    \"_rev\" : \"_V_qDJsK---\", \n    \"_oldRev\" : \"_V_qDJru---\" \n  }, \n  \"code\" : 202 \n}\n
\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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_create_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_drop_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_create_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_definition_add_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_definition_modify_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_definition_remove_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_delete_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_get_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_modify_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_replace_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_get_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_list_edge_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_list_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_list_vertex_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_collection_add_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_collection_remove_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_create_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_delete_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_get_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_modify_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_replace_http_examples.md" }, "put": { "description": "\n\nReplaces the data of an edge in the collection.\n\n\n\n\n#Example:\n \n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/gharial/social/edge/relation/aliceAndBob <<EOF\n{ \n  \"type\" : \"divorced\", \n  \"_from\" : \"female/alice\", \n  \"_to\" : \"male/bob\" \n}\nEOF\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\netag: _V_qDKGe---\nx-content-type-options: nosniff\n\n{ \n  \"error\" : false, \n  \"edge\" : { \n    \"_id\" : \"relation/aliceAndBob\", \n    \"_key\" : \"aliceAndBob\", \n    \"_rev\" : \"_V_qDKGe---\", \n    \"_oldRev\" : \"_V_qDKG----\" \n  }, \n  \"code\" : 202 \n}\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": 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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_create_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_drop_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_create_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_definition_add_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_definition_modify_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_definition_remove_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_delete_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_get_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_modify_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_replace_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_get_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_list_edge_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_list_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_list_vertex_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_collection_add_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_collection_remove_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_create_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_delete_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_get_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_modify_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_replace_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
shell> curl -X DELETE --dump - http://localhost:8529/_api/gharial/social/edge/relation\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\netag: _V_qDFnO---\nx-content-type-options: nosniff\n\n{ \n  \"error\" : false, \n  \"graph\" : { \n    \"name\" : \"social\", \n    \"edgeDefinitions\" : [ ], \n    \"orphanCollections\" : [ \n      \"female\", \n      \"male\" \n    ], \n    \"isSmart\" : false, \n    \"numberOfShards\" : 0, \n    \"smartGraphAttribute\" : \"\", \n    \"_id\" : \"_graphs/social\", \n    \"_rev\" : \"_V_qDFnO---\" \n  }, \n  \"code\" : 202 \n}\n
\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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_create_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_drop_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_create_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_definition_add_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_definition_modify_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_definition_remove_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_delete_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_get_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_modify_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_replace_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_get_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_list_edge_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_list_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_list_vertex_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_collection_add_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_collection_remove_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_create_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_delete_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_get_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_modify_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_replace_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 post document 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
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/gharial/social/edge/relation <<EOF\n{ \n  \"collection\" : \"relation\", \n  \"from\" : [ \n    \"female\", \n    \"male\", \n    \"animal\" \n  ], \n  \"to\" : [ \n    \"female\", \n    \"male\", \n    \"animal\" \n  ] \n}\nEOF\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\netag: _V_qDLgG---\nx-content-type-options: nosniff\n\n{ \n  \"error\" : false, \n  \"graph\" : { \n    \"name\" : \"social\", \n    \"edgeDefinitions\" : [ \n      { \n        \"collection\" : \"relation\", \n        \"from\" : [ \n          \"animal\", \n          \"female\", \n          \"male\" \n        ], \n        \"to\" : [ \n          \"animal\", \n          \"female\", \n          \"male\" \n        ] \n      } \n    ], \n    \"orphanCollections\" : [ ], \n    \"isSmart\" : false, \n    \"numberOfShards\" : 0, \n    \"smartGraphAttribute\" : \"\", \n    \"_id\" : \"_graphs/social\", \n    \"_rev\" : \"_V_qDLgG---\" \n  }, \n  \"code\" : 202 \n}\n
\n\n\n\n", "parameters": [ { "in": "body", "name": "Json Request Body", "required": true, "schema": { "$ref": "#/definitions/JSF_general_graph_edge_definition_modify_http_examples" }, "x-description-offset": 191 } ], "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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_create_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_drop_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_create_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_definition_add_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_definition_modify_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_definition_remove_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_delete_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_get_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_modify_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_replace_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_get_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_list_edge_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_list_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_list_vertex_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_collection_add_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_collection_remove_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_create_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_delete_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_get_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_modify_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_replace_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
shell> curl --dump - http://localhost:8529/_api/gharial/social/vertex\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"error\" : false, \n  \"collections\" : [ \n    \"female\", \n    \"male\" \n  ], \n  \"code\" : 200 \n}\n
\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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_create_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_drop_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_create_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_definition_add_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_definition_modify_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_definition_remove_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_delete_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_get_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_modify_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_replace_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_get_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_list_edge_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_list_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_list_vertex_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_collection_add_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_collection_remove_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_create_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_delete_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_get_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_modify_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_replace_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
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/gharial/social/vertex <<EOF\n{ \n  \"collection\" : \"otherVertices\" \n}\nEOF\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\netag: _V_qDDNy---\nx-content-type-options: nosniff\n\n{ \n  \"error\" : false, \n  \"graph\" : { \n    \"name\" : \"social\", \n    \"edgeDefinitions\" : [ \n      { \n        \"collection\" : \"relation\", \n        \"from\" : [ \n          \"female\", \n          \"male\" \n        ], \n        \"to\" : [ \n          \"female\", \n          \"male\" \n        ] \n      } \n    ], \n    \"orphanCollections\" : [ \n      \"otherVertices\" \n    ], \n    \"isSmart\" : false, \n    \"numberOfShards\" : 0, \n    \"smartGraphAttribute\" : \"\", \n    \"_id\" : \"_graphs/social\", \n    \"_rev\" : \"_V_qDDNy---\" \n  }, \n  \"code\" : 202 \n}\n
\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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_create_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_drop_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_create_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_definition_add_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_definition_modify_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_definition_remove_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_delete_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_get_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_modify_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_replace_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_get_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_list_edge_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_list_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_list_vertex_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_collection_add_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_collection_remove_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_create_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_delete_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_get_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_modify_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_replace_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
shell> curl -X DELETE --dump - http://localhost:8529/_api/gharial/social/vertex/otherVertices\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\netag: _V_qDKja---\nx-content-type-options: nosniff\n\n{ \n  \"error\" : false, \n  \"graph\" : { \n    \"name\" : \"social\", \n    \"edgeDefinitions\" : [ \n      { \n        \"collection\" : \"relation\", \n        \"from\" : [ \n          \"female\", \n          \"male\" \n        ], \n        \"to\" : [ \n          \"female\", \n          \"male\" \n        ] \n      } \n    ], \n    \"orphanCollections\" : [ ], \n    \"isSmart\" : false, \n    \"numberOfShards\" : 0, \n    \"smartGraphAttribute\" : \"\", \n    \"_id\" : \"_graphs/social\", \n    \"_rev\" : \"_V_qDKja---\" \n  }, \n  \"code\" : 202 \n}\n
\n\n\n\n\n#Example:\n You cannot remove vertex collections that are used in edge collections:\n\n
shell> curl -X DELETE --dump - http://localhost:8529/_api/gharial/social/vertex/male\n\nHTTP/1.1 400 Bad Request\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"error\" : true, \n  \"errorNum\" : 1928, \n  \"errorMessage\" : \"not in orphan collection\", \n  \"code\" : 400 \n}\n
\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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_create_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_drop_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_create_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_definition_add_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_definition_modify_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_definition_remove_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_delete_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_get_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_modify_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_replace_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_get_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_list_edge_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_list_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_list_vertex_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_collection_add_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_collection_remove_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_create_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_delete_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_get_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_modify_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_replace_http_examples.md" }, "post": { "description": "\n\nAdds a vertex to the given collection.\n\n\n\n\n#Example:\n \n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/gharial/social/vertex/male <<EOF\n{ \n  \"name\" : \"Francis\" \n}\nEOF\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\netag: _V_qDC2e---\nx-content-type-options: nosniff\n\n{ \n  \"error\" : false, \n  \"vertex\" : { \n    \"_id\" : \"male/7834\", \n    \"_key\" : \"7834\", \n    \"_rev\" : \"_V_qDC2e---\" \n  }, \n  \"code\" : 202 \n}\n
\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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_create_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_drop_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_create_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_definition_add_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_definition_modify_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_definition_remove_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_delete_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_get_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_modify_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_replace_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_get_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_list_edge_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_list_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_list_vertex_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_collection_add_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_collection_remove_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_create_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_delete_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_get_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_modify_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_replace_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
shell> curl -X DELETE --dump - http://localhost:8529/_api/gharial/social/vertex/female/alice\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"error\" : false, \n  \"removed\" : true, \n  \"code\" : 202 \n}\n
\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 - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_create_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_drop_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_create_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_definition_add_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_definition_modify_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_definition_remove_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_delete_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_get_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_modify_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_replace_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_get_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_list_edge_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_list_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_list_vertex_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_collection_add_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_collection_remove_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_create_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_delete_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_get_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_modify_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_replace_http_examples.md" }, "get": { "description": "\n\nGets a vertex from the given collection.\n\n\n\n\n#Example:\n \n\n
shell> curl --dump - http://localhost:8529/_api/gharial/social/vertex/female/alice\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\netag: _V_qDH-a---\nx-content-type-options: nosniff\n\n{ \n  \"error\" : false, \n  \"vertex\" : { \n    \"_key\" : \"alice\", \n    \"_id\" : \"female/alice\", \n    \"_rev\" : \"_V_qDH-a---\", \n    \"name\" : \"Alice\" \n  }, \n  \"code\" : 200 \n}\n
\n\n\n\n\n", "parameters": [], "responses": { "200": { "description": "Returned if the vertex could be found.\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": " Get a vertex", "tags": [ "Graph" ], "x-examples": [], "x-filename": "Graph - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_create_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_drop_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_create_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_definition_add_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_definition_modify_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_definition_remove_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_delete_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_get_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_modify_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_replace_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_get_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_list_edge_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_list_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_list_vertex_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_collection_add_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_collection_remove_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_create_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_delete_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_get_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_modify_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_replace_http_examples.md" }, "patch": { "description": "\n\nUpdates the data of the specific vertex in the collection.\n\n\n\n\n#Example:\n \n\n
shell> curl -X PATCH --data-binary @- --dump - http://localhost:8529/_api/gharial/social/vertex/female/alice <<EOF\n{ \n  \"age\" : 26 \n}\nEOF\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\netag: _V_qDJUO---\nx-content-type-options: nosniff\n\n{ \n  \"error\" : false, \n  \"vertex\" : { \n    \"_id\" : \"female/alice\", \n    \"_key\" : \"alice\", \n    \"_rev\" : \"_V_qDJUO---\", \n    \"_oldRev\" : \"_V_qDJU----\" \n  }, \n  \"code\" : 202 \n}\n
\n\n\n\n\n", "parameters": [ { "description": "The body has to contain a JSON object containing exactly the attributes that should be replaced.\n\n", "in": "body", "name": "Json Request Body", "required": true, "schema": { "additionalProperties": {}, "type": "object" }, "x-description-offset": 62 } ], "responses": { "200": { "description": "Returned if the vertex 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 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": " Modify a vertex", "tags": [ "Graph" ], "x-examples": [], "x-filename": "Graph - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_create_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_drop_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_create_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_definition_add_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_definition_modify_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_definition_remove_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_delete_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_get_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_modify_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_replace_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_get_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_list_edge_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_list_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_list_vertex_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_collection_add_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_collection_remove_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_create_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_delete_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_get_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_modify_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_replace_http_examples.md" }, "put": { "description": "\n\nReplaces the data of a vertex in the collection.\n\n\n\n\n#Example:\n \n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/gharial/social/vertex/female/alice <<EOF\n{ \n  \"name\" : \"Alice Cooper\", \n  \"age\" : 26 \n}\nEOF\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\netag: _V_qDL8m---\nx-content-type-options: nosniff\n\n{ \n  \"error\" : false, \n  \"vertex\" : { \n    \"_id\" : \"female/alice\", \n    \"_key\" : \"alice\", \n    \"_rev\" : \"_V_qDL8m---\", \n    \"_oldRev\" : \"_V_qDL8C---\" \n  }, \n  \"code\" : 202 \n}\n
\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": 52 } ], "responses": { "200": { "description": "Returned if the vertex could be replaced.\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": " Replace a vertex", "tags": [ "Graph" ], "x-examples": [], "x-filename": "Graph - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_create_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_drop_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_create_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_definition_add_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_definition_modify_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_definition_remove_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_delete_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_get_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_modify_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_edge_replace_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_get_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_list_edge_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_list_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_list_vertex_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_collection_add_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_collection_remove_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_create_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_delete_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_get_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_modify_http_examples.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph\\JSF_general_graph_vertex_replace_http_examples.md" } }, "/_api/import#document": { "post": { "description": "\n\n**NOTE** Swagger examples won't work due to the anchor.\n\n\nCreates documents in the collection identified by `collection-name`.\nThe first line of the request body must contain a JSON-encoded array of\nattribute names. All following lines in the request body must contain\nJSON-encoded arrays of attribute values. Each line is interpreted as a\nseparate document, and the values specified will be mapped to the array\nof attribute names specified in the first header line.\n\nThe response is a JSON object with the following attributes:\n\n- `created`: number of documents imported.\n\n- `errors`: number of documents that were not imported due to an error.\n\n- `empty`: number of empty lines found in the input (will only contain a\n value greater zero for types `documents` or `auto`).\n\n- `updated`: number of updated/replaced documents (in case `onDuplicate`\n was set to either `update` or `replace`).\n\n- `ignored`: number of failed but ignored insert operations (in case\n `onDuplicate` was set to `ignore`).\n\n- `details`: if query parameter `details` is set to true, the result will\n contain a `details` attribute which is an array with more detailed\n information about which documents could not be inserted.\n\nNote: this API is currently not supported on cluster coordinators.\n\n\n\n\n#Example:\n Importing two documents, with attributes `_key`, `value1` and `value2` each. One\nline in the import data is empty\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/import?collection=products <<EOF\n[ \"_key\", \"value1\", \"value2\" ]\n[ \"abc\", 25, \"test\" ]\n\n[ \"foo\", \"bar\", \"baz\" ]\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"error\" : false, \n  \"created\" : 2, \n  \"errors\" : 0, \n  \"empty\" : 1, \n  \"updated\" : 0, \n  \"ignored\" : 0 \n}\n
\n\n\n\n\n#Example:\n Importing into an edge collection, with attributes `_from`, `_to` and `name`\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/import?collection=links <<EOF\n[ \"_from\", \"_to\", \"name\" ]\n[ \"products/123\",\"products/234\", \"some name\" ]\n[ \"products/332\", \"products/abc\", \"other name\" ]\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"error\" : false, \n  \"created\" : 2, \n  \"errors\" : 0, \n  \"empty\" : 0, \n  \"updated\" : 0, \n  \"ignored\" : 0 \n}\n
\n\n\n\n\n#Example:\n Importing into an edge collection, omitting `_from` or `_to`\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/import?collection=links&details=true <<EOF\n[ \"name\" ]\n[ \"some name\" ]\n[ \"other name\" ]\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"error\" : false, \n  \"created\" : 0, \n  \"errors\" : 2, \n  \"empty\" : 0, \n  \"updated\" : 0, \n  \"ignored\" : 0, \n  \"details\" : [ \n    \"at position 1: missing '_from' or '_to' attribute, offending document: {\\\"name\\\":\\\"some name\\\"}\", \n    \"at position 2: missing '_from' or '_to' attribute, offending document: {\\\"name\\\":\\\"other name\\\"}\" \n  ] \n}\n
\n\n\n\n\n#Example:\n Violating a unique constraint, but allow partial imports\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/import?collection=products&details=true <<EOF\n[ \"_key\", \"value1\", \"value2\" ]\n[ \"abc\", 25, \"test\" ]\n[\"abc\", \"bar\", \"baz\" ]\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"error\" : false, \n  \"created\" : 1, \n  \"errors\" : 1, \n  \"empty\" : 0, \n  \"updated\" : 0, \n  \"ignored\" : 0, \n  \"details\" : [ \n    \"at position 1: creating document failed with error 'unique constraint violated', offending document: {\\\"_key\\\":\\\"abc\\\",\\\"value1\\\":\\\"bar\\\",\\\"value2\\\":\\\"baz\\\"}\" \n  ] \n}\n
\n\n\n\n\n#Example:\n Violating a unique constraint, not allowing partial imports\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/import?collection=products&complete=true <<EOF\n[ \"_key\", \"value1\", \"value2\" ]\n[ \"abc\", 25, \"test\" ]\n[\"abc\", \"bar\", \"baz\" ]\nEOF\n\nHTTP/1.1 409 Conflict\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"error\" : true, \n  \"errorMessage\" : \"cannot create document, unique constraint violated\", \n  \"code\" : 409, \n  \"errorNum\" : 1210 \n}\n
\n\n\n\n\n#Example:\n Using a non-existing collection\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/import?collection=products <<EOF\n[ \"_key\", \"value1\", \"value2\" ]\n[ \"abc\", 25, \"test\" ]\n[\"foo\", \"bar\", \"baz\" ]\nEOF\n\nHTTP/1.1 404 Not Found\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"error\" : true, \n  \"errorMessage\" : \"collection not found: products\", \n  \"code\" : 404, \n  \"errorNum\" : 1203 \n}\n
\n\n\n\n\n#Example:\n Using a malformed body\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/import?collection=products <<EOF\n{ \"_key\": \"foo\", \"value1\": \"bar\" }\nEOF\n\nHTTP/1.1 400 Bad Request\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"error\" : true, \n  \"errorMessage\" : \"no JSON array found in second line\", \n  \"code\" : 400, \n  \"errorNum\" : 400 \n}\n
\n\n\n\n\n", "parameters": [ { "description": "The body must consist of JSON-encoded arrays of attribute values, with one\nline per document. The first row of the request must be a JSON-encoded\narray of attribute names. These attribute names are used for the data in the\nsubsequent lines.\n\n", "in": "body", "name": "Json Request Body", "required": true, "schema": { "additionalProperties": {}, "type": "object" }, "x-description-offset": 0 }, { "description": "The collection name.\n\n", "in": "query", "name": "collection", "required": true, "type": "string" }, { "description": "An optional prefix for the values in `_from` attributes. If specified, the\nvalue is automatically prepended to each `_from` input value. This allows\nspecifying just the keys for `_from`.\n\n", "in": "query", "name": "fromPrefix", "required": false, "type": "string" }, { "description": "An optional prefix for the values in `_to` attributes. If specified, the\nvalue is automatically prepended to each `_to` input value. This allows\nspecifying just the keys for `_to`.\n\n", "in": "query", "name": "toPrefix", "required": false, "type": "string" }, { "description": "If this parameter has a value of `true` or `yes`, then all data in the\ncollection will be removed prior to the import. Note that any existing\nindex definitions will be preseved.\n\n", "in": "query", "name": "overwrite", "required": false, "type": "boolean" }, { "description": "Wait until documents have been synced to disk before returning.\n\n", "in": "query", "name": "waitForSync", "required": false, "type": "boolean" }, { "description": "Controls what action is carried out in case of a unique key constraint\nviolation. Possible values are:\n\n- *error*: this will not import the current document because of the unique\n key constraint violation. This is the default setting.\n\n- *update*: this will update an existing document in the database with the\n data specified in the request. Attributes of the existing document that\n are not present in the request will be preseved.\n\n- *replace*: this will replace an existing document in the database with the\n data specified in the request.\n\n- *ignore*: this will not update an existing document and simply ignore the\n error caused by the unique key constraint violation.\n\nNote that *update*, *replace* and *ignore* will only work when the\nimport document in the request contains the *_key* attribute. *update* and\n*replace* may also fail because of secondary unique key constraint\nviolations.\n\n", "in": "query", "name": "onDuplicate", "required": false, "type": "string" }, { "description": "If set to `true` or `yes`, it will make the whole import fail if any error\noccurs. Otherwise the import will continue even if some documents cannot\nbe imported.\n\n", "in": "query", "name": "complete", "required": false, "type": "boolean" }, { "description": "If set to `true` or `yes`, the result will include an attribute `details`\nwith details about documents that could not be imported.\n\n", "in": "query", "name": "details", "required": false, "type": "boolean" } ], "responses": { "201": { "description": "is returned if all documents could be imported successfully.\n\n" }, "400": { "description": "is returned if `type` contains an invalid value, no `collection` is\nspecified, the documents are incorrectly encoded, or the request\nis malformed.\n\n" }, "404": { "description": "is returned if `collection` or the `_from` or `_to` attributes of an\nimported edge refer to an unknown collection.\n\n" }, "409": { "description": "is returned if the import would trigger a unique key violation and\n`complete` is set to `true`.\n\n" }, "500": { "description": "is returned if the server cannot auto-generate a document key (out of keys\nerror) for a document with no user-defined key.\n\n" } }, "summary": "imports document values", "tags": [ "Bulk" ], "x-examples": [], "x-filename": "Bulk - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Bulk\\JSF_batch_processing.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Bulk\\JSF_import_document.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Bulk\\JSF_import_json.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Bulk\\JSF_post_api_export.md" } }, "/_api/import#json": { "post": { "description": "\n\n**NOTE** Swagger examples won't work due to the anchor.\n\n\nCreates documents in the collection identified by `collection-name`.\nThe JSON representations of the documents must be passed as the body of the\nPOST request. The request body can either consist of multiple lines, with\neach line being a single stand-alone JSON object, or a singe JSON array with\nsub-objects.\n\nThe response is a JSON object with the following attributes:\n\n- `created`: number of documents imported.\n\n- `errors`: number of documents that were not imported due to an error.\n\n- `empty`: number of empty lines found in the input (will only contain a\n value greater zero for types `documents` or `auto`).\n\n- `updated`: number of updated/replaced documents (in case `onDuplicate`\n was set to either `update` or `replace`).\n\n- `ignored`: number of failed but ignored insert operations (in case\n `onDuplicate` was set to `ignore`).\n\n- `details`: if query parameter `details` is set to true, the result will\n contain a `details` attribute which is an array with more detailed\n information about which documents could not be inserted.\n\nNote: this API is currently not supported on cluster coordinators.\n\n\n\n\n#Example:\n Importing documents with heterogenous attributes from a JSON array\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/import?collection=products&type=list <<EOF\n[ \n  { \n    \"_key\" : \"abc\", \n    \"value1\" : 25, \n    \"value2\" : \"test\", \n    \"allowed\" : true \n  }, \n  { \n    \"_key\" : \"foo\", \n    \"name\" : \"baz\" \n  }, \n  { \n    \"name\" : { \n      \"detailed\" : \"detailed name\", \n      \"short\" : \"short name\" \n    } \n  } \n]\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"error\" : false, \n  \"created\" : 3, \n  \"errors\" : 0, \n  \"empty\" : 0, \n  \"updated\" : 0, \n  \"ignored\" : 0 \n}\n
\n\n\n\n\n#Example:\n Importing documents from individual JSON lines\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/import?collection=products&type=documents <<EOF\n{ \"_key\": \"abc\", \"value1\": 25, \"value2\": \"test\",\"allowed\": true }\n{ \"_key\": \"foo\", \"name\": \"baz\" }\n\n{ \"name\": { \"detailed\": \"detailed name\", \"short\": \"short name\" } }\n\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"error\" : false, \n  \"created\" : 3, \n  \"errors\" : 0, \n  \"empty\" : 1, \n  \"updated\" : 0, \n  \"ignored\" : 0 \n}\n
\n\n\n\n\n#Example:\n Using the auto type detection\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/import?collection=products&type=auto <<EOF\n[ \n  { \n    \"_key\" : \"abc\", \n    \"value1\" : 25, \n    \"value2\" : \"test\", \n    \"allowed\" : true \n  }, \n  { \n    \"_key\" : \"foo\", \n    \"name\" : \"baz\" \n  }, \n  { \n    \"name\" : { \n      \"detailed\" : \"detailed name\", \n      \"short\" : \"short name\" \n    } \n  } \n]\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"error\" : false, \n  \"created\" : 3, \n  \"errors\" : 0, \n  \"empty\" : 0, \n  \"updated\" : 0, \n  \"ignored\" : 0 \n}\n
\n\n\n\n\n#Example:\n Importing into an edge collection, with attributes `_from`, `_to` and `name`\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/import?collection=links&type=documents <<EOF\n{ \"_from\": \"products/123\", \"_to\": \"products/234\" }\n{\"_from\": \"products/332\", \"_to\": \"products/abc\",   \"name\": \"other name\" }\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"error\" : false, \n  \"created\" : 2, \n  \"errors\" : 0, \n  \"empty\" : 0, \n  \"updated\" : 0, \n  \"ignored\" : 0 \n}\n
\n\n\n\n\n#Example:\n Importing into an edge collection, omitting `_from` or `_to`\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/import?collection=links&type=list&details=true <<EOF\n[ \n  { \n    \"name\" : \"some name\" \n  } \n]\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"error\" : false, \n  \"created\" : 0, \n  \"errors\" : 1, \n  \"empty\" : 0, \n  \"updated\" : 0, \n  \"ignored\" : 0, \n  \"details\" : [ \n    \"at position 1: missing '_from' or '_to' attribute, offending document: {\\\"name\\\":\\\"some name\\\"}\" \n  ] \n}\n
\n\n\n\n\n#Example:\n Violating a unique constraint, but allow partial imports\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/import?collection=products&type=documents&details=true <<EOF\n{ \"_key\": \"abc\", \"value1\": 25, \"value2\": \"test\" }\n{ \"_key\": \"abc\", \"value1\": \"bar\", \"value2\": \"baz\" }\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"error\" : false, \n  \"created\" : 1, \n  \"errors\" : 1, \n  \"empty\" : 0, \n  \"updated\" : 0, \n  \"ignored\" : 0, \n  \"details\" : [ \n    \"at position 1: creating document failed with error 'unique constraint violated', offending document: {\\\"_key\\\":\\\"abc\\\",\\\"value1\\\":\\\"bar\\\",\\\"value2\\\":\\\"baz\\\"}\" \n  ] \n}\n
\n\n\n\n\n#Example:\n Violating a unique constraint, not allowing partial imports\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/import?collection=products&type=documents&complete=true <<EOF\n{ \"_key\": \"abc\", \"value1\": 25, \"value2\": \"test\" }\n{ \"_key\": \"abc\", \"value1\": \"bar\", \"value2\": \"baz\" }\nEOF\n\nHTTP/1.1 409 Conflict\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"error\" : true, \n  \"errorMessage\" : \"cannot create document, unique constraint violated\", \n  \"code\" : 409, \n  \"errorNum\" : 1210 \n}\n
\n\n\n\n\n#Example:\n Using a non-existing collection\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/import?collection=products&type=documents <<EOF\n{ \"name\": \"test\" }\nEOF\n\nHTTP/1.1 404 Not Found\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"error\" : true, \n  \"errorMessage\" : \"collection not found: products\", \n  \"code\" : 404, \n  \"errorNum\" : 1203 \n}\n
\n\n\n\n\n#Example:\n Using a malformed body\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/import?collection=products&type=list <<EOF\n{ }\nEOF\n\nHTTP/1.1 400 Bad Request\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"error\" : true, \n  \"errorMessage\" : \"expecting a JSON array in the request\", \n  \"code\" : 400, \n  \"errorNum\" : 400 \n}\n
\n\n\n\n\n", "parameters": [ { "description": "The body must either be a JSON-encoded array of objects or a string with\nmultiple JSON objects separated by newlines.\n\n", "in": "body", "name": "Json Request Body", "required": true, "schema": { "additionalProperties": {}, "type": "object" }, "x-description-offset": 0 }, { "description": "Determines how the body of the request will be interpreted. `type` can have\nthe following values:\n- `documents`: when this type is used, each line in the request body is\n expected to be an individual JSON-encoded document. Multiple JSON objects\n in the request body need to be separated by newlines.\n- `list`: when this type is used, the request body must contain a single\n JSON-encoded array of individual objects to import.\n- `auto`: if set, this will automatically determine the body type (either\n `documents` or `list`).\n\n", "in": "query", "name": "type", "required": true, "type": "string" }, { "description": "The collection name.\n\n", "in": "query", "name": "collection", "required": true, "type": "string" }, { "description": "An optional prefix for the values in `_from` attributes. If specified, the\nvalue is automatically prepended to each `_from` input value. This allows\nspecifying just the keys for `_from`.\n\n", "in": "query", "name": "fromPrefix", "required": false, "type": "string" }, { "description": "An optional prefix for the values in `_to` attributes. If specified, the\nvalue is automatically prepended to each `_to` input value. This allows\nspecifying just the keys for `_to`.\n\n", "in": "query", "name": "toPrefix", "required": false, "type": "string" }, { "description": "If this parameter has a value of `true` or `yes`, then all data in the\ncollection will be removed prior to the import. Note that any existing\nindex definitions will be preseved.\n\n", "in": "query", "name": "overwrite", "required": false, "type": "boolean" }, { "description": "Wait until documents have been synced to disk before returning.\n\n", "in": "query", "name": "waitForSync", "required": false, "type": "boolean" }, { "description": "Controls what action is carried out in case of a unique key constraint\nviolation. Possible values are:\n\n- *error*: this will not import the current document because of the unique\n key constraint violation. This is the default setting.\n\n- *update*: this will update an existing document in the database with the \n data specified in the request. Attributes of the existing document that\n are not present in the request will be preseved.\n\n- *replace*: this will replace an existing document in the database with the\n data specified in the request. \n\n- *ignore*: this will not update an existing document and simply ignore the\n error caused by a unique key constraint violation.\n\nNote that that *update*, *replace* and *ignore* will only work when the\nimport document in the request contains the *_key* attribute. *update* and\n*replace* may also fail because of secondary unique key constraint violations.\n\n", "in": "query", "name": "onDuplicate", "required": false, "type": "string" }, { "description": "If set to `true` or `yes`, it will make the whole import fail if any error\noccurs. Otherwise the import will continue even if some documents cannot\nbe imported.\n\n", "in": "query", "name": "complete", "required": false, "type": "boolean" }, { "description": "If set to `true` or `yes`, the result will include an attribute `details`\nwith details about documents that could not be imported.\n\n", "in": "query", "name": "details", "required": false, "type": "boolean" } ], "responses": { "201": { "description": "is returned if all documents could be imported successfully.\n\n" }, "400": { "description": "is returned if `type` contains an invalid value, no `collection` is\nspecified, the documents are incorrectly encoded, or the request\nis malformed.\n\n" }, "404": { "description": "is returned if `collection` or the `_from` or `_to` attributes of an\nimported edge refer to an unknown collection.\n\n" }, "409": { "description": "is returned if the import would trigger a unique key violation and\n`complete` is set to `true`.\n\n" }, "500": { "description": "is returned if the server cannot auto-generate a document key (out of keys\nerror) for a document with no user-defined key.\n\n" } }, "summary": "imports documents from JSON", "tags": [ "Bulk" ], "x-examples": [], "x-filename": "Bulk - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Bulk\\JSF_batch_processing.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Bulk\\JSF_import_document.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Bulk\\JSF_import_json.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Bulk\\JSF_post_api_export.md" } }, "/_api/index": { "get": { "description": "\n\n\nReturns an object with an attribute *indexes* containing an array of all\nindex descriptions for the given collection. The same information is also\navailable in the *identifiers* as an object with the index handles as\nkeys.\n\n\n\n\n#Example:\n Return information about all indexes\n\n
shell> curl --dump - http://localhost:8529/_api/index?collection=products\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"indexes\" : [ \n    { \n      \"id\" : \"products/0\", \n      \"type\" : \"primary\", \n      \"fields\" : [ \n        \"_key\" \n      ], \n      \"selectivityEstimate\" : 1, \n      \"unique\" : true, \n      \"sparse\" : false \n    }, \n    { \n      \"id\" : \"products/10426\", \n      \"type\" : \"hash\", \n      \"fields\" : [ \n        \"name\" \n      ], \n      \"selectivityEstimate\" : 1, \n      \"unique\" : false, \n      \"sparse\" : false \n    }, \n    { \n      \"id\" : \"products/10429\", \n      \"type\" : \"skiplist\", \n      \"fields\" : [ \n        \"price\" \n      ], \n      \"unique\" : false, \n      \"sparse\" : true \n    } \n  ], \n  \"identifiers\" : { \n    \"products/0\" : { \n      \"id\" : \"products/0\", \n      \"type\" : \"primary\", \n      \"fields\" : [ \n        \"_key\" \n      ], \n      \"selectivityEstimate\" : 1, \n      \"unique\" : true, \n      \"sparse\" : false \n    }, \n    \"products/10426\" : { \n      \"id\" : \"products/10426\", \n      \"type\" : \"hash\", \n      \"fields\" : [ \n        \"name\" \n      ], \n      \"selectivityEstimate\" : 1, \n      \"unique\" : false, \n      \"sparse\" : false \n    }, \n    \"products/10429\" : { \n      \"id\" : \"products/10429\", \n      \"type\" : \"skiplist\", \n      \"fields\" : [ \n        \"price\" \n      ], \n      \"unique\" : false, \n      \"sparse\" : true \n    } \n  }, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n", "parameters": [ { "description": "The collection name.\n\n", "in": "query", "name": "collection", "required": true, "type": "string" } ], "responses": { "200": { "description": "returns a json object containing a list of indexes on that collection.\n\n" } }, "summary": " Read all indexes of a collection", "tags": [ "Indexes" ], "x-examples": [], "x-filename": "Indexes - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_get_api_index.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_get_api_reads_index.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_post_api_index.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_post_api_index_delete.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_post_api_index_fulltext.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_post_api_index_geo.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_post_api_index_hash.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_post_api_index_persistent.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_post_api_index_skiplist.md" } }, "/_api/index#fulltext": { "post": { "description": "\n**A json post document with these Properties is required:**\n\n - **fields** (string): an array of attribute names. Currently, the array is limited\n to exactly one attribute.\n - **type**: must be equal to *\"fulltext\"*.\n - **minLength**: Minimum character length of words to index. Will default\n to a server-defined value if unspecified. It is thus recommended to set\n this value explicitly when creating the index.\n\n\n\n\n**NOTE** Swagger examples won't work due to the anchor.\n\n\nCreates a fulltext index for the collection *collection-name*, if\nit does not already exist. The call expects an object containing the index\ndetails.\n\n\n\n\n#Example:\n Creating a fulltext index\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/index?collection=products <<EOF\n{ \n  \"type\" : \"fulltext\", \n  \"fields\" : [ \n    \"text\" \n  ] \n}\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"id\" : \"products/10448\", \n  \"type\" : \"fulltext\", \n  \"fields\" : [ \n    \"text\" \n  ], \n  \"unique\" : false, \n  \"sparse\" : true, \n  \"minLength\" : 2, \n  \"isNewlyCreated\" : true, \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n", "parameters": [ { "description": "The collection name.\n\n", "in": "query", "name": "collection-name", "required": true, "type": "string" }, { "in": "body", "name": "Json Request Body", "required": true, "schema": { "$ref": "#/definitions/JSF_post_api_index_fulltext" }, "x-description-offset": 61 } ], "responses": { "200": { "description": "If the index already exists, then a *HTTP 200* is\nreturned.\n\n" }, "201": { "description": "If the index does not already exist and could be created, then a *HTTP 201*\nis returned.\n\n" }, "404": { "description": "If the *collection-name* is unknown, then a *HTTP 404* is returned.\n\n" } }, "summary": " Create fulltext index", "tags": [ "Indexes" ], "x-examples": [], "x-filename": "Indexes - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_get_api_index.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_get_api_reads_index.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_post_api_index.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_post_api_index_delete.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_post_api_index_fulltext.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_post_api_index_geo.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_post_api_index_hash.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_post_api_index_persistent.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_post_api_index_skiplist.md" } }, "/_api/index#general": { "post": { "description": "\n\n**NOTE** Swagger examples won't work due to the anchor.\n\n\nCreates a new index in the collection *collection*. Expects\nan object containing the index details.\n\nThe type of the index to be created must specified in the *type*\nattribute of the index details. Depending on the index type, additional\nother attributes may need to specified in the request in order to create\nthe index.\n\nIndexes require the to be indexed attribute(s) in the *fields* attribute\nof the index details. Depending on the index type, a single attribute or\nmultiple attributes can be indexed. In the latter case, an array of\nstrings is expected.\n\nIndexing the system attribute *_id* is not supported for user-defined indexes. \nManually creating an index using *_id* as an index attribute will fail with \nan error.\n\nSome indexes can be created as unique or non-unique variants. Uniqueness\ncan be controlled for most indexes by specifying the *unique* flag in the\nindex details. Setting it to *true* will create a unique index.\nSetting it to *false* or omitting the *unique* attribute will\ncreate a non-unique index.\n\n**Note**: The following index types do not support uniqueness, and using\nthe *unique* attribute with these types may lead to an error:\n\n- geo indexes\n- fulltext indexes\n\n**Note**: Unique indexes on non-shard keys are not supported in a\ncluster.\n\nHash, skiplist and persistent indexes can optionally be created in a sparse\nvariant. A sparse index will be created if the *sparse* attribute in\nthe index details is set to *true*. Sparse indexes do not index documents\nfor which any of the index attributes is either not set or is *null*. \n\n", "parameters": [ { "description": "The collection name.\n\n", "in": "query", "name": "collection", "required": true, "type": "string" }, { "description": "\n", "in": "body", "name": "Json Request Body", "required": true, "schema": { "additionalProperties": {}, "type": "object" }, "x-description-offset": 0 } ], "responses": { "200": { "description": "If the index already exists, then an *HTTP 200* is returned.\n\n" }, "201": { "description": "If the index does not already exist and could be created, then an *HTTP 201*\nis returned.\n\n" }, "400": { "description": "If an invalid index description is posted or attributes are used that the\ntarget index will not support, then an *HTTP 400* is returned.\n\n" }, "404": { "description": "If *collection* is unknown, then an *HTTP 404* is returned.\n\n\n" } }, "summary": " Create index", "tags": [ "Indexes" ], "x-examples": [], "x-filename": "Indexes - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_get_api_index.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_get_api_reads_index.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_post_api_index.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_post_api_index_delete.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_post_api_index_fulltext.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_post_api_index_geo.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_post_api_index_hash.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_post_api_index_persistent.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_post_api_index_skiplist.md" } }, "/_api/index#geo": { "post": { "description": "\n**A json post document with these Properties is required:**\n\n - **fields** (string): An array with one or two attribute paths.\n If it is an array with one attribute path *location*, then a geo-spatial\n index on all documents is created using *location* as path to the\n coordinates. The value of the attribute must be an array with at least two\n double values. The array must contain the latitude (first value) and the\n longitude (second value). All documents, which do not have the attribute\n path or with value that are not suitable, are ignored.\n If it is an array with two attribute paths *latitude* and *longitude*,\n then a geo-spatial index on all documents is created using *latitude*\n and *longitude* as paths the latitude and the longitude. The value of\n the attribute *latitude* and of the attribute *longitude* must a\n double. All documents, which do not have the attribute paths or which\n values are not suitable, are ignored.\n - **type**: must be equal to *\"geo\"*.\n - **geoJson**: If a geo-spatial index on a *location* is constructed\n and *geoJson* is *true*, then the order within the array is longitude\n followed by latitude. This corresponds to the format described in\n http://geojson.org/geojson-spec.html#positions\n\n\n\n\n**NOTE** Swagger examples won't work due to the anchor.\n\n\nCreates a geo-spatial index in the collection *collection-name*, if\nit does not already exist. Expects an object containing the index details.\n\nGeo indexes are always sparse, meaning that documents that do not contain\nthe index attributes or have non-numeric values in the index attributes\nwill not be indexed.\n\n\n\n\n#Example:\n Creating a geo index with a location attribute\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/index?collection=products <<EOF\n{ \n  \"type\" : \"geo\", \n  \"fields\" : [ \n    \"b\" \n  ] \n}\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"id\" : \"products/10442\", \n  \"type\" : \"geo1\", \n  \"fields\" : [ \n    \"b\" \n  ], \n  \"geoJson\" : false, \n  \"constraint\" : false, \n  \"unique\" : false, \n  \"ignoreNull\" : true, \n  \"sparse\" : true, \n  \"isNewlyCreated\" : true, \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n#Example:\n Creating a geo index with latitude and longitude attributes\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/index?collection=products <<EOF\n{ \n  \"type\" : \"geo\", \n  \"fields\" : [ \n    \"e\", \n    \"f\" \n  ] \n}\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"id\" : \"products/10436\", \n  \"type\" : \"geo2\", \n  \"fields\" : [ \n    \"e\", \n    \"f\" \n  ], \n  \"constraint\" : false, \n  \"unique\" : false, \n  \"ignoreNull\" : true, \n  \"sparse\" : true, \n  \"isNewlyCreated\" : true, \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n", "parameters": [ { "description": "The collection name.\n\n\n", "in": "query", "name": "collection", "required": true, "type": "string" }, { "in": "body", "name": "Json Request Body", "required": true, "schema": { "$ref": "#/definitions/JSF_post_api_index_geo" }, "x-description-offset": 61 } ], "responses": { "200": { "description": "If the index already exists, then a *HTTP 200* is returned.\n\n" }, "201": { "description": "If the index does not already exist and could be created, then a *HTTP 201*\nis returned.\n\n" }, "404": { "description": "If the *collection-name* is unknown, then a *HTTP 404* is returned.\n\n" } }, "summary": " Create geo-spatial index", "tags": [ "Indexes" ], "x-examples": [], "x-filename": "Indexes - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_get_api_index.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_get_api_reads_index.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_post_api_index.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_post_api_index_delete.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_post_api_index_fulltext.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_post_api_index_geo.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_post_api_index_hash.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_post_api_index_persistent.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_post_api_index_skiplist.md" } }, "/_api/index#hash": { "post": { "description": "\n**A json post document with these Properties is required:**\n\n - **fields** (string): an array of attribute paths.\n - **unique**: if *true*, then create a unique index.\n - **type**: must be equal to *\"hash\"*.\n - **sparse**: if *true*, then create a sparse index.\n\n\n\n\n**NOTE** Swagger examples won't work due to the anchor.\n\n\nCreates a hash index for the collection *collection-name* if it\ndoes not already exist. The call expects an object containing the index\ndetails.\n\nIn a sparse index all documents will be excluded from the index that do not \ncontain at least one of the specified index attributes (i.e. *fields*) or that \nhave a value of *null* in any of the specified index attributes. Such documents \nwill not be indexed, and not be taken into account for uniqueness checks if\nthe *unique* flag is set.\n\nIn a non-sparse index, these documents will be indexed (for non-present\nindexed attributes, a value of *null* will be used) and will be taken into\naccount for uniqueness checks if the *unique* flag is set.\n\n**Note**: unique indexes on non-shard keys are not supported in a cluster.\n\n\n\n\n#Example:\n Creating an unique constraint\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/index?collection=products <<EOF\n{ \n  \"type\" : \"hash\", \n  \"unique\" : true, \n  \"fields\" : [ \n    \"a\", \n    \"b\" \n  ] \n}\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"id\" : \"products/10472\", \n  \"type\" : \"hash\", \n  \"fields\" : [ \n    \"a\", \n    \"b\" \n  ], \n  \"selectivityEstimate\" : 1, \n  \"unique\" : true, \n  \"sparse\" : false, \n  \"isNewlyCreated\" : true, \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n#Example:\n Creating a non-unique hash index\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/index?collection=products <<EOF\n{ \n  \"type\" : \"hash\", \n  \"unique\" : false, \n  \"fields\" : [ \n    \"a\", \n    \"b\" \n  ] \n}\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"id\" : \"products/10454\", \n  \"type\" : \"hash\", \n  \"fields\" : [ \n    \"a\", \n    \"b\" \n  ], \n  \"selectivityEstimate\" : 1, \n  \"unique\" : false, \n  \"sparse\" : false, \n  \"isNewlyCreated\" : true, \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n#Example:\n Creating a sparse index\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/index?collection=products <<EOF\n{ \n  \"type\" : \"hash\", \n  \"unique\" : false, \n  \"sparse\" : true, \n  \"fields\" : [ \n    \"a\" \n  ] \n}\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"id\" : \"products/10478\", \n  \"type\" : \"hash\", \n  \"fields\" : [ \n    \"a\" \n  ], \n  \"selectivityEstimate\" : 1, \n  \"unique\" : false, \n  \"sparse\" : true, \n  \"isNewlyCreated\" : true, \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n", "parameters": [ { "description": "The collection name.\n\n", "in": "query", "name": "collection-name", "required": true, "type": "string" }, { "in": "body", "name": "Json Request Body", "required": true, "schema": { "$ref": "#/definitions/JSF_post_api_index_hash" }, "x-description-offset": 61 } ], "responses": { "200": { "description": "If the index already exists, then a *HTTP 200* is returned.\n\n" }, "201": { "description": "If the index does not already exist and could be created, then a *HTTP 201*\nis returned.\n\n" }, "400": { "description": "If the collection already contains documents and you try to create a unique\nhash index in such a way that there are documents violating the uniqueness,\nthen a *HTTP 400* is returned.\n\n" }, "404": { "description": "If the *collection-name* is unknown, then a *HTTP 404* is returned.\n\n" } }, "summary": " Create hash index", "tags": [ "Indexes" ], "x-examples": [], "x-filename": "Indexes - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_get_api_index.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_get_api_reads_index.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_post_api_index.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_post_api_index_delete.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_post_api_index_fulltext.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_post_api_index_geo.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_post_api_index_hash.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_post_api_index_persistent.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_post_api_index_skiplist.md" } }, "/_api/index#persistent": { "post": { "description": "\n**A json post document with these Properties is required:**\n\n - **fields** (string): an array of attribute paths.\n - **unique**: if *true*, then create a unique index.\n - **type**: must be equal to *\"persistent\"*.\n - **sparse**: if *true*, then create a sparse index.\n\n\n\n\n\nCreates a persistent index for the collection *collection-name*, if\nit does not already exist. The call expects an object containing the index\ndetails.\n\nIn a sparse index all documents will be excluded from the index that do not \ncontain at least one of the specified index attributes (i.e. *fields*) or that \nhave a value of *null* in any of the specified index attributes. Such documents \nwill not be indexed, and not be taken into account for uniqueness checks if\nthe *unique* flag is set.\n\nIn a non-sparse index, these documents will be indexed (for non-present\nindexed attributes, a value of *null* will be used) and will be taken into\naccount for uniqueness checks if the *unique* flag is set.\n\n**Note**: unique indexes on non-shard keys are not supported in a cluster.\n\n\n\n\n#Example:\n Creating a persistent index\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/index?collection=products <<EOF\n{ \n  \"type\" : \"persistent\", \n  \"unique\" : false, \n  \"fields\" : [ \n    \"a\", \n    \"b\" \n  ] \n}\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"id\" : \"products/10460\", \n  \"type\" : \"persistent\", \n  \"fields\" : [ \n    \"a\", \n    \"b\" \n  ], \n  \"unique\" : false, \n  \"sparse\" : false, \n  \"isNewlyCreated\" : true, \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n#Example:\n Creating a sparse persistent index\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/index?collection=products <<EOF\n{ \n  \"type\" : \"persistent\", \n  \"unique\" : false, \n  \"sparse\" : true, \n  \"fields\" : [ \n    \"a\" \n  ] \n}\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"id\" : \"products/10484\", \n  \"type\" : \"persistent\", \n  \"fields\" : [ \n    \"a\" \n  ], \n  \"unique\" : false, \n  \"sparse\" : true, \n  \"isNewlyCreated\" : true, \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n", "parameters": [ { "description": "The collection name.\n\n", "in": "query", "name": "collection-name", "required": true, "type": "string" }, { "in": "body", "name": "Json Request Body", "required": true, "schema": { "$ref": "#/definitions/JSF_post_api_index_persistent" }, "x-description-offset": 61 } ], "responses": { "200": { "description": "If the index already exists, then a *HTTP 200* is\nreturned.\n\n" }, "201": { "description": "If the index does not already exist and could be created, then a *HTTP 201*\nis returned.\n\n" }, "400": { "description": "If the collection already contains documents and you try to create a unique\npersistent index in such a way that there are documents violating the\nuniqueness, then a *HTTP 400* is returned.\n\n" }, "404": { "description": "If the *collection-name* is unknown, then a *HTTP 404* is returned.\n\n" } }, "summary": " Create a persistent index", "tags": [ "Indexes" ], "x-examples": [], "x-filename": "Indexes - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_get_api_index.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_get_api_reads_index.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_post_api_index.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_post_api_index_delete.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_post_api_index_fulltext.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_post_api_index_geo.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_post_api_index_hash.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_post_api_index_persistent.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_post_api_index_skiplist.md" } }, "/_api/index#skiplist": { "post": { "description": "\n**A json post document with these Properties is required:**\n\n - **fields** (string): an array of attribute paths.\n - **unique**: if *true*, then create a unique index.\n - **type**: must be equal to *\"skiplist\"*.\n - **sparse**: if *true*, then create a sparse index.\n\n\n\n\n\nCreates a skip-list index for the collection *collection-name*, if\nit does not already exist. The call expects an object containing the index\ndetails.\n\nIn a sparse index all documents will be excluded from the index that do not \ncontain at least one of the specified index attributes (i.e. *fields*) or that \nhave a value of *null* in any of the specified index attributes. Such documents \nwill not be indexed, and not be taken into account for uniqueness checks if\nthe *unique* flag is set.\n\nIn a non-sparse index, these documents will be indexed (for non-present\nindexed attributes, a value of *null* will be used) and will be taken into\naccount for uniqueness checks if the *unique* flag is set.\n\n**Note**: unique indexes on non-shard keys are not supported in a cluster.\n\n\n\n\n#Example:\n Creating a skiplist index\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/index?collection=products <<EOF\n{ \n  \"type\" : \"skiplist\", \n  \"unique\" : false, \n  \"fields\" : [ \n    \"a\", \n    \"b\" \n  ] \n}\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"id\" : \"products/10466\", \n  \"type\" : \"skiplist\", \n  \"fields\" : [ \n    \"a\", \n    \"b\" \n  ], \n  \"unique\" : false, \n  \"sparse\" : false, \n  \"isNewlyCreated\" : true, \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n#Example:\n Creating a sparse skiplist index\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/index?collection=products <<EOF\n{ \n  \"type\" : \"skiplist\", \n  \"unique\" : false, \n  \"sparse\" : true, \n  \"fields\" : [ \n    \"a\" \n  ] \n}\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"id\" : \"products/10490\", \n  \"type\" : \"skiplist\", \n  \"fields\" : [ \n    \"a\" \n  ], \n  \"unique\" : false, \n  \"sparse\" : true, \n  \"isNewlyCreated\" : true, \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n", "parameters": [ { "description": "The collection name.\n\n", "in": "query", "name": "collection-name", "required": true, "type": "string" }, { "in": "body", "name": "Json Request Body", "required": true, "schema": { "$ref": "#/definitions/JSF_post_api_index_skiplist" }, "x-description-offset": 61 } ], "responses": { "200": { "description": "If the index already exists, then a *HTTP 200* is\nreturned.\n\n" }, "201": { "description": "If the index does not already exist and could be created, then a *HTTP 201*\nis returned.\n\n" }, "400": { "description": "If the collection already contains documents and you try to create a unique\nskip-list index in such a way that there are documents violating the\nuniqueness, then a *HTTP 400* is returned.\n\n" }, "404": { "description": "If the *collection-name* is unknown, then a *HTTP 404* is returned.\n\n" } }, "summary": " Create skip list", "tags": [ "Indexes" ], "x-examples": [], "x-filename": "Indexes - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_get_api_index.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_get_api_reads_index.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_post_api_index.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_post_api_index_delete.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_post_api_index_fulltext.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_post_api_index_geo.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_post_api_index_hash.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_post_api_index_persistent.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_post_api_index_skiplist.md" } }, "/_api/index/{index-handle}": { "delete": { "description": "\n\n\nDeletes an index with *index-handle*.\n\n\n\n\n#Example:\n \n\n
shell> curl -X DELETE --dump - http://localhost:8529/_api/index/products/10496\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"id\" : \"products/10496\", \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n", "parameters": [ { "description": "The index handle.\n\n", "format": "string", "in": "path", "name": "index-handle", "required": true, "type": "string" } ], "responses": { "200": { "description": "If the index could be deleted, then an *HTTP 200* is\nreturned.\n\n" }, "404": { "description": "If the *index-handle* is unknown, then an *HTTP 404* is returned.\n" } }, "summary": " Delete index", "tags": [ "Indexes" ], "x-examples": [], "x-filename": "Indexes - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_get_api_index.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_get_api_reads_index.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_post_api_index.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_post_api_index_delete.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_post_api_index_fulltext.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_post_api_index_geo.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_post_api_index_hash.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_post_api_index_persistent.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_post_api_index_skiplist.md" }, "get": { "description": "\n\n\nThe result is an object describing the index. It has at least the following\nattributes:\n\n- *id*: the identifier of the index\n\n- *type*: the index type\n\nAll other attributes are type-dependent. For example, some indexes provide\n*unique* or *sparse* flags, whereas others don't. Some indexes also provide \na selectivity estimate in the *selectivityEstimate* attribute of the result.\n\n\n\n\n#Example:\n \n\n
shell> curl --dump - http://localhost:8529/_api/index/products/0\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"id\" : \"products/0\", \n  \"type\" : \"primary\", \n  \"fields\" : [ \n    \"_key\" \n  ], \n  \"selectivityEstimate\" : 1, \n  \"unique\" : true, \n  \"sparse\" : false, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n", "parameters": [ { "description": "The index-handle.\n\n", "format": "string", "in": "path", "name": "index-handle", "required": true, "type": "string" } ], "responses": { "200": { "description": "If the index exists, then a *HTTP 200* is returned.\n\n" }, "404": { "description": "If the index does not exist, then a *HTTP 404*\nis returned.\n\n" } }, "summary": "Read index", "tags": [ "Indexes" ], "x-examples": [], "x-filename": "Indexes - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_get_api_index.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_get_api_reads_index.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_post_api_index.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_post_api_index_delete.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_post_api_index_fulltext.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_post_api_index_geo.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_post_api_index_hash.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_post_api_index_persistent.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Indexes\\JSF_post_api_index_skiplist.md" } }, "/_api/job/{job-id}": { "get": { "description": "\n\nReturns the processing status of the specified job. The processing status\ncan be\ndetermined by peeking into the HTTP response code of the response.\n\n\n\n\n#Example:\n Querying the status of a done job:\n\n
shell> curl -X PUT --header 'x-arango-async: store' --dump - http://localhost:8529/_api/version\n\nHTTP/1.1 202 Accepted\ncontent-type: text/plain; charset=utf-8\nx-arango-async-id: 149510192229376\nx-content-type-options: nosniff\n\nshell> curl -X PUT --dump - http://localhost:8529/_api/job/149510192229376\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-arango-async-id: 149510192229376\nx-content-type-options: nosniff\n\n{ \n  \"server\" : \"arango\", \n  \"version\" : \"3.2.devel\", \n  \"license\" : \"community\" \n}\n
\n\n\n\n\n#Example:\n Querying the status of a pending job:\n(we create a sleep job therefore...)\n\n
shell> curl --header 'x-arango-async: store' --dump - http://localhost:8529/_admin/sleep?duration=30\n\nHTTP/1.1 202 Accepted\ncontent-type: text/plain; charset=utf-8\nx-arango-async-id: 149510192229381\nx-content-type-options: nosniff\n\nshell> curl --dump - http://localhost:8529/_api/job/149510192229381\n\nHTTP/1.1 204 No Content\ncontent-type: text/plain; charset=utf-8\nx-content-type-options: nosniff\n\n
\n\n\n\n\n", "parameters": [ { "description": "The async job id.\n\n", "format": "string", "in": "path", "name": "job-id", "required": true, "type": "string" } ], "responses": { "200": { "description": "is returned if the job requested via job-id has been executed\nand its result is ready to fetch.\n\n" }, "204": { "description": "is returned if the job requested via job-id is still in the queue of pending\n(or not yet finished) jobs.\n\n" }, "404": { "description": "is returned if the job was not found or already deleted or fetched from the\njob result list.\n\n" } }, "summary": " Returns async job", "tags": [ "job" ], "x-examples": [], "x-filename": "job - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\job\\JSF_job_cancel.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\job\\JSF_job_delete.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\job\\JSF_job_fetch_result.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\job\\JSF_job_getByType.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\job\\JSF_job_getStatusById.md" }, "put": { "description": "\n\nReturns the result of an async job identified by job-id. If the async job\nresult is present on the server, the result will be removed from the list of\nresult. That means this method can be called for each job-id once.\nThe method will return the original job result's headers and body, plus the\nadditional HTTP header x-arango-async-job-id. If this header is present,\nthen\nthe job was found and the response contains the original job's result. If\nthe header is not present, the job was not found and the response contains\nstatus information from the job manager.\n\n\n\n\n#Example:\n Not providing a job-id:\n\n
shell> curl -X PUT --dump - http://localhost:8529/_api/job\n\nHTTP/1.1 400 Bad Request\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"error\" : true, \n  \"errorMessage\" : \"bad parameter\", \n  \"code\" : 400, \n  \"errorNum\" : 400 \n}\n
\n\n\n\n\n#Example:\n Providing a job-id for a non-existing job:\n\n
shell> curl -X PUT --dump - http://localhost:8529/_api/job/notthere\n\nHTTP/1.1 404 Not Found\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"error\" : true, \n  \"errorMessage\" : \"not found\", \n  \"code\" : 404, \n  \"errorNum\" : 404 \n}\n
\n\n\n\n\n#Example:\n Fetching the result of an HTTP GET job:\n\n
shell> curl -X PUT --header 'x-arango-async: store' --dump - http://localhost:8529/_api/version\n\nHTTP/1.1 202 Accepted\ncontent-type: text/plain; charset=utf-8\nx-arango-async-id: 149510192229349\nx-content-type-options: nosniff\n\nshell> curl -X PUT --dump - http://localhost:8529/_api/job/149510192229349\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-arango-async-id: 149510192229349\nx-content-type-options: nosniff\n\n{ \n  \"server\" : \"arango\", \n  \"version\" : \"3.2.devel\", \n  \"license\" : \"community\" \n}\n
\n\n\n\n\n#Example:\n Fetching the result of an HTTP POST job that failed:\n\n
shell> curl -X PUT --header 'x-arango-async: store' --data-binary @- --dump - http://localhost:8529/_api/collection <<EOF\n{ \n  \"name\" : \" this name is invalid \" \n}\nEOF\n\nHTTP/1.1 202 Accepted\ncontent-type: text/plain; charset=utf-8\nx-arango-async-id: 149510192229354\nx-content-type-options: nosniff\n\nshell> curl -X PUT --dump - http://localhost:8529/_api/job/149510192229354\n\nHTTP/1.1 400 Bad Request\ncontent-type: application/json; charset=utf-8\nx-arango-async-id: 149510192229354\nx-content-type-options: nosniff\n\n{ \n  \"error\" : true, \n  \"code\" : 400, \n  \"errorNum\" : 400, \n  \"errorMessage\" : \"expected PUT /_api/collection/<collection-name>/<action>\" \n}\n
\n\n\n\n\n", "parameters": [ { "description": "The async job id.\n\n", "format": "string", "in": "path", "name": "job-id", "required": true, "type": "string" } ], "responses": { "204": { "description": "is returned if the job requested via job-id is still in the queue of pending\n(or not yet finished) jobs. In this case, no x-arango-async-id HTTP header\nwill be returned.\n\n" }, "400": { "description": "is returned if no job-id was specified in the request. In this case,\nno x-arango-async-id HTTP header will be returned.\n\n" }, "404": { "description": "is returned if the job was not found or already deleted or fetched from\nthe job result list. In this case, no x-arango-async-id HTTP header will\nbe returned.\n\n" } }, "summary": " Return result of an async job", "tags": [ "job" ], "x-examples": [], "x-filename": "job - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\job\\JSF_job_cancel.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\job\\JSF_job_delete.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\job\\JSF_job_fetch_result.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\job\\JSF_job_getByType.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\job\\JSF_job_getStatusById.md" } }, "/_api/job/{job-id}/cancel": { "put": { "description": "\n\nCancels the currently running job identified by job-id. Note that it still\nmight take some time to actually cancel the running async job.\n\n\n\n\n#Example:\n \n\n
shell> curl -X POST --header 'x-arango-async: store' --data-binary @- --dump - http://localhost:8529/_api/cursor <<EOF\n{ \n  \"query\" : \"FOR i IN 1..10 FOR j IN 1..10 LET x = sleep(1.0) FILTER i == 5 && j == 5 RETURN 42\" \n}\nEOF\n\nHTTP/1.1 202 Accepted\ncontent-type: text/plain; charset=utf-8\nx-arango-async-id: 149510192229312\nx-content-type-options: nosniff\n\nshell> curl --dump - http://localhost:8529/_api/job/pending\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n[ \n  \"149510192229312\" \n]\nshell> curl -X PUT --dump - http://localhost:8529/_api/job/149510192229312/cancel\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"result\" : true \n}\nshell> curl --dump - http://localhost:8529/_api/job/pending\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n[ \n  \"149510192229312\" \n]\n
\n\n\n\n\n", "parameters": [ { "description": "The async job id.\n\n", "format": "string", "in": "path", "name": "job-id", "required": true, "type": "string" } ], "responses": { "200": { "description": "cancel has been initiated.\n\n" }, "400": { "description": "is returned if no job-id was specified in the request. In this case,\nno x-arango-async-id HTTP header will be returned.\n\n" }, "404": { "description": "is returned if the job was not found or already deleted or fetched from\nthe job result list. In this case, no x-arango-async-id HTTP header will\nbe returned.\n\n" } }, "summary": " Cancel async job", "tags": [ "job" ], "x-examples": [], "x-filename": "job - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\job\\JSF_job_cancel.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\job\\JSF_job_delete.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\job\\JSF_job_fetch_result.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\job\\JSF_job_getByType.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\job\\JSF_job_getStatusById.md" } }, "/_api/job/{type}": { "delete": { "description": "\n\nDeletes either all job results, expired job results, or the result of a\nspecific job.\nClients can use this method to perform an eventual garbage collection of job\nresults.\n\n\n\n\n#Example:\n Deleting all jobs:\n\n
shell> curl -X PUT --header 'x-arango-async: store' --dump - http://localhost:8529/_api/version\n\nHTTP/1.1 202 Accepted\ncontent-type: text/plain; charset=utf-8\nx-arango-async-id: 149510192229321\nx-content-type-options: nosniff\n\nshell> curl -X DELETE --dump - http://localhost:8529/_api/job/all\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"result\" : true \n}\n
\n\n\n\n\n#Example:\n Deleting expired jobs:\n\n
shell> curl -X PUT --header 'x-arango-async: store' --dump - http://localhost:8529/_api/version\n\nHTTP/1.1 202 Accepted\ncontent-type: text/plain; charset=utf-8\nx-arango-async-id: 149510192229326\nx-content-type-options: nosniff\n\nshell> curl --dump - http://localhost:8529/_admin/time\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"time\" : 1495101946.547352, \n  \"error\" : false, \n  \"code\" : 200 \n}\nshell> curl -X DELETE --dump - http://localhost:8529/_api/job/expired?stamp=1495101946.547352\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"result\" : true \n}\nshell> curl --dump - http://localhost:8529/_api/job/pending\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n[ ]\n
\n\n\n\n\n#Example:\n Deleting the result of a specific job:\n\n
shell> curl -X PUT --header 'x-arango-async: store' --dump - http://localhost:8529/_api/version\n\nHTTP/1.1 202 Accepted\ncontent-type: text/plain; charset=utf-8\nx-arango-async-id: 149510192229335\nx-content-type-options: nosniff\n\nshell> curl -X DELETE --dump - http://localhost:8529/_api/job/149510192229335\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"result\" : true \n}\n
\n\n\n\n\n#Example:\n Deleting the result of a non-existing job:\n\n
shell> curl -X DELETE --dump - http://localhost:8529/_api/job/AreYouThere\n\nHTTP/1.1 404 Not Found\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"error\" : true, \n  \"errorMessage\" : \"not found\", \n  \"code\" : 404, \n  \"errorNum\" : 404 \n}\n
\n\n\n\n\n", "parameters": [ { "description": "The type of jobs to delete. type can be:\n* *all*: Deletes all jobs results. Currently executing or queued async \n jobs will not be stopped by this call.\n* *expired*: Deletes expired results. To determine the expiration status of a \n result, pass the stamp query parameter. stamp needs to be a UNIX timestamp, \n and all async job results created at a lower timestamp will be deleted.\n* *an actual job-id*: In this case, the call will remove the result of the\n specified async job. If the job is currently executing or queued, it will\n not be aborted.\n\n", "format": "string", "in": "path", "name": "type", "required": true, "type": "string" } ], "responses": { "200": { "description": "is returned if the deletion operation was carried out successfully.\nThis code will also be returned if no results were deleted.\n\n" }, "400": { "description": "is returned if type is not specified or has an invalid value.\n\n" }, "404": { "description": "is returned if type is a job-id but no async job with the specified id was\nfound.\n\n" } }, "summary": " Deletes async job", "tags": [ "job" ], "x-examples": [], "x-filename": "job - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\job\\JSF_job_cancel.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\job\\JSF_job_delete.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\job\\JSF_job_fetch_result.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\job\\JSF_job_getByType.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\job\\JSF_job_getStatusById.md" }, "get": { "description": "\n\nReturns the list of ids of async jobs with a specific status (either done or\npending).\nThe list can be used by the client to get an overview of the job system\nstatus and\nto retrieve completed job results later.\n\n\n\n\n#Example:\n Fetching the list of done jobs:\n\n
shell> curl -X PUT --header 'x-arango-async: store' --dump - http://localhost:8529/_api/version\n\nHTTP/1.1 202 Accepted\ncontent-type: text/plain; charset=utf-8\nx-arango-async-id: 149510192229359\nx-content-type-options: nosniff\n\nshell> curl --dump - http://localhost:8529/_api/job/done\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n[ \n  \"149510192229359\" \n]\n
\n\n\n\n\n#Example:\n Fetching the list of pending jobs:\n\n
shell> curl -X PUT --header 'x-arango-async: store' --dump - http://localhost:8529/_api/version\n\nHTTP/1.1 202 Accepted\ncontent-type: text/plain; charset=utf-8\nx-arango-async-id: 149510192229364\nx-content-type-options: nosniff\n\nshell> curl --dump - http://localhost:8529/_api/job/pending\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n[ ]\n
\n\n\n\n\n#Example:\n Querying the status of a pending job:\n(we create a sleep job therefore...)\n\n
shell> curl --header 'x-arango-async: store' --dump - http://localhost:8529/_admin/sleep?duration=30\n\nHTTP/1.1 202 Accepted\ncontent-type: text/plain; charset=utf-8\nx-arango-async-id: 149510192229369\nx-content-type-options: nosniff\n\nshell> curl --dump - http://localhost:8529/_api/job/pending\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n[ \n  \"149510192229369\" \n]\nshell> curl -X DELETE --dump - http://localhost:8529/_api/job/149510192229369\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"result\" : true \n}\n
\n\n\n\n\n", "parameters": [ { "description": "The type of jobs to return. The type can be either done or pending. Setting\nthe type to done will make the method return the ids of already completed\nasync\njobs for which results can be fetched. Setting the type to pending will\nreturn\nthe ids of not yet finished async jobs.\n\n", "format": "string", "in": "path", "name": "type", "required": true, "type": "string" } ], "responses": { "200": { "description": "is returned if the list can be compiled successfully. Note: the list might\nbe empty.\n\n" }, "400": { "description": "is returned if type is not specified or has an invalid value.\n\n" } }, "summary": " Returns list of async jobs", "tags": [ "job" ], "x-examples": [], "x-filename": "job - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\job\\JSF_job_cancel.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\job\\JSF_job_delete.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\job\\JSF_job_fetch_result.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\job\\JSF_job_getByType.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\job\\JSF_job_getStatusById.md" } }, "/_api/query": { "post": { "description": "\n\nThis endpoint is for query validation only. To actually query the database,\nsee `/api/cursor`.\n\n\n**A json post document with these Properties is required:**\n\n - **query**: To validate a query string without executing it, the query string can be\n passed to the server via an HTTP POST request.\n\n\n\n\n\n#Example:\n a Valid query\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/query <<EOF\n{ \"query\" : \"FOR p IN products FILTER p.name == @name LIMIT 2 RETURN p.n\" }\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"error\" : false, \n  \"code\" : 200, \n  \"parsed\" : true, \n  \"collections\" : [ \n    \"products\" \n  ], \n  \"bindVars\" : [ \n    \"name\" \n  ], \n  \"ast\" : [ \n    { \n      \"type\" : \"root\", \n      \"subNodes\" : [ \n        { \n          \"type\" : \"for\", \n          \"subNodes\" : [ \n            { \n              \"type\" : \"variable\", \n              \"name\" : \"p\", \n              \"id\" : 0 \n            }, \n            { \n              \"type\" : \"collection\", \n              \"name\" : \"products\" \n            } \n          ] \n        }, \n        { \n          \"type\" : \"filter\", \n          \"subNodes\" : [ \n            { \n              \"type\" : \"compare ==\", \n              \"subNodes\" : [ \n                { \n                  \"type\" : \"attribute access\", \n                  \"name\" : \"name\", \n                  \"subNodes\" : [ \n                    { \n                      \"type\" : \"reference\", \n                      \"name\" : \"p\", \n                      \"id\" : 0 \n                    } \n                  ] \n                }, \n                { \n                  \"type\" : \"parameter\", \n                  \"name\" : \"name\" \n                } \n              ] \n            } \n          ] \n        }, \n        { \n          \"type\" : \"limit\", \n          \"subNodes\" : [ \n            { \n              \"type\" : \"value\", \n              \"value\" : 0 \n            }, \n            { \n              \"type\" : \"value\", \n              \"value\" : 2 \n            } \n          ] \n        }, \n        { \n          \"type\" : \"return\", \n          \"subNodes\" : [ \n            { \n              \"type\" : \"attribute access\", \n              \"name\" : \"n\", \n              \"subNodes\" : [ \n                { \n                  \"type\" : \"reference\", \n                  \"name\" : \"p\", \n                  \"id\" : 0 \n                } \n              ] \n            } \n          ] \n        } \n      ] \n    } \n  ] \n}\n
\n\n\n\n\n#Example:\n an Invalid query\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/query <<EOF\n{ \"query\" : \"FOR p IN products FILTER p.name = @name LIMIT 2 RETURN p.n\" }\nEOF\n\nHTTP/1.1 400 Bad Request\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"error\" : true, \n  \"errorMessage\" : \"syntax error, unexpected assignment near '= @name LIMIT 2 RETURN p.n' at position 1:33\", \n  \"code\" : 400, \n  \"errorNum\" : 1501 \n}\n
\n\n\n\n\n", "parameters": [ { "in": "body", "name": "Json Request Body", "required": true, "schema": { "$ref": "#/definitions/PostApiQueryProperties" }, "x-description-offset": 159 } ], "responses": { "200": { "description": "If the query is valid, the server will respond with *HTTP 200* and\nreturn the names of the bind parameters it found in the query (if any) in\nthe *bindVars* attribute of the response. It will also return an array\nof the collections used in the query in the *collections* attribute.\nIf a query can be parsed successfully, the *ast* attribute of the returned\nJSON will contain the abstract syntax tree representation of the query.\nThe format of the *ast* is subject to change in future versions of\nArangoDB, but it can be used to inspect how ArangoDB interprets a given\nquery. Note that the abstract syntax tree will be returned without any\noptimizations applied to it.\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.\n\n" } }, "summary": " Parse an AQL query", "tags": [ "AQL" ], "x-examples": [], "x-filename": "AQL - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\DeleteApiQueryCache.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\DeleteApiQueryKill.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\DeleteApiQuerySlow.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\GetApiQueryCacheProperties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\GetApiQueryCurrent.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\GetApiQueryProperties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\GetApiQuerySlow.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\JSF_delete_api_aqlfunction.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\JSF_get_api_aqlfunction.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\JSF_post_api_aqlfunction.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\JSF_post_api_explain.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\PostApiQueryProperties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\PutApiQueryCacheProperties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\PutApiQueryProperties.md" } }, "/_api/query-cache": { "delete": { "description": "\n\nclears the query cache\n", "parameters": [], "responses": { "200": { "description": "The server will respond with *HTTP 200* when the cache was cleared\nsuccessfully.\n\n" }, "400": { "description": "The server will respond with *HTTP 400* in case of a malformed request.\n\n\n" } }, "summary": " Clears any results in the AQL query cache", "tags": [ "AQL" ], "x-examples": [], "x-filename": "AQL - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\DeleteApiQueryCache.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\DeleteApiQueryKill.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\DeleteApiQuerySlow.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\GetApiQueryCacheProperties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\GetApiQueryCurrent.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\GetApiQueryProperties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\GetApiQuerySlow.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\JSF_delete_api_aqlfunction.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\JSF_get_api_aqlfunction.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\JSF_post_api_aqlfunction.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\JSF_post_api_explain.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\PostApiQueryProperties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\PutApiQueryCacheProperties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\PutApiQueryProperties.md" } }, "/_api/query-cache/properties": { "get": { "description": "\n\nReturns the global AQL query cache configuration. The configuration is a\nJSON object with the following properties:\n\n- *mode*: the mode the AQL query cache operates in. The mode is one of the following\n values: *off*, *on* or *demand*.\n\n- *maxResults*: the maximum number of query results that will be stored per database-specific\n cache.\n\n", "parameters": [], "responses": { "200": { "description": "Is returned if the properties can be retrieved successfully.\n\n" }, "400": { "description": "The server will respond with *HTTP 400* in case of a malformed request,\n\n\n\n" } }, "summary": " Returns the global properties for the AQL query cache", "tags": [ "AQL" ], "x-examples": [], "x-filename": "AQL - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\DeleteApiQueryCache.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\DeleteApiQueryKill.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\DeleteApiQuerySlow.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\GetApiQueryCacheProperties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\GetApiQueryCurrent.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\GetApiQueryProperties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\GetApiQuerySlow.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\JSF_delete_api_aqlfunction.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\JSF_get_api_aqlfunction.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\JSF_post_api_aqlfunction.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\JSF_post_api_explain.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\PostApiQueryProperties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\PutApiQueryCacheProperties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\PutApiQueryProperties.md" }, "put": { "description": "\n\nAfter the properties have been changed, the current set of properties will\nbe returned in the HTTP response.\n\nNote: changing the properties may invalidate all results in the cache.\nThe global properties for AQL query cache.\nThe properties need to be passed in the attribute *properties* in the body\nof the HTTP request. *properties* needs to be a JSON object with the following\nproperties:\n\n\n**A json post document with these Properties is required:**\n\n - **mode**: the mode the AQL query cache should operate in. Possible values are *off*, *on* or *demand*.\n - **maxResults**: the maximum number of query results that will be stored per database-specific cache.\n\n\n", "parameters": [ { "in": "body", "name": "Json Request Body", "required": true, "schema": { "$ref": "#/definitions/PutApiQueryCacheProperties" }, "x-description-offset": 454 } ], "responses": { "200": { "description": "Is returned if the properties were changed successfully.\n\n" }, "400": { "description": "The server will respond with *HTTP 400* in case of a malformed request,\n\n\n\n" } }, "summary": " Globally adjusts the AQL query result cache properties", "tags": [ "AQL" ], "x-examples": [], "x-filename": "AQL - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\DeleteApiQueryCache.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\DeleteApiQueryKill.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\DeleteApiQuerySlow.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\GetApiQueryCacheProperties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\GetApiQueryCurrent.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\GetApiQueryProperties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\GetApiQuerySlow.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\JSF_delete_api_aqlfunction.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\JSF_get_api_aqlfunction.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\JSF_post_api_aqlfunction.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\JSF_post_api_explain.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\PostApiQueryProperties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\PutApiQueryCacheProperties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\PutApiQueryProperties.md" } }, "/_api/query/current": { "get": { "description": "\n\nReturns an array containing the AQL queries currently running in the selected\ndatabase. Each query is a JSON object with the following attributes:\n\n- *id*: the query's id\n\n- *query*: the query string (potentially truncated)\n\n- *bindVars*: the bind parameter values used by the query\n\n- *started*: the date and time when the query was started\n\n- *runTime*: the query's run time up to the point the list of queries was\n queried\n\n- *state*: the query's current execution state (as a string)\n\n", "parameters": [], "responses": { "200": { "description": "Is returned when the list of queries can be retrieved successfully.\n\n" }, "400": { "description": "The server will respond with *HTTP 400* in case of a malformed request,\n\n\n\n" } }, "summary": " Returns the currently running AQL queries", "tags": [ "AQL" ], "x-examples": [], "x-filename": "AQL - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\DeleteApiQueryCache.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\DeleteApiQueryKill.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\DeleteApiQuerySlow.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\GetApiQueryCacheProperties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\GetApiQueryCurrent.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\GetApiQueryProperties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\GetApiQuerySlow.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\JSF_delete_api_aqlfunction.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\JSF_get_api_aqlfunction.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\JSF_post_api_aqlfunction.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\JSF_post_api_explain.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\PostApiQueryProperties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\PutApiQueryCacheProperties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\PutApiQueryProperties.md" } }, "/_api/query/properties": { "get": { "description": "\n\nReturns the current query tracking configuration. The configuration is a\nJSON object with the following properties:\n\n- *enabled*: if set to *true*, then queries will be tracked. If set to\n *false*, neither queries nor slow queries will be tracked.\n\n- *trackSlowQueries*: if set to *true*, then slow queries will be tracked\n in 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*\n property must also be set to *true*.\n\n- *maxSlowQueries*: the maximum number of slow queries to keep in the list\n of slow queries. If the list of slow queries is full, the oldest entry in\n it will be discarded when additional slow queries occur.\n\n- *slowQueryThreshold*: the threshold value for treating a query as slow. A\n query with a runtime greater or equal to this threshold value will be\n put into the list of slow queries when slow query tracking is enabled.\n The value for *slowQueryThreshold* is specified in seconds.\n\n- *maxQueryStringLength*: the maximum query string length to keep in the\n list of queries. Query strings can have arbitrary lengths, and this property\n can be used to save memory in case very long query strings are used. The\n value is specified in bytes.\n\n", "parameters": [], "responses": { "200": { "description": "Is returned if properties were retrieved successfully.\n\n" }, "400": { "description": "The server will respond with *HTTP 400* in case of a malformed request,\n\n\n\n" } }, "summary": " Returns the properties for the AQL query tracking", "tags": [ "AQL" ], "x-examples": [], "x-filename": "AQL - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\DeleteApiQueryCache.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\DeleteApiQueryKill.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\DeleteApiQuerySlow.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\GetApiQueryCacheProperties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\GetApiQueryCurrent.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\GetApiQueryProperties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\GetApiQuerySlow.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\JSF_delete_api_aqlfunction.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\JSF_get_api_aqlfunction.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\JSF_post_api_aqlfunction.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\JSF_post_api_explain.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\PostApiQueryProperties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\PutApiQueryCacheProperties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\PutApiQueryProperties.md" }, "put": { "description": "\n**A json post document with these Properties is required:**\n\n - **slowQueryThreshold**: The threshold value for treating a query as slow. A\n query with a runtime greater or equal to this threshold value will be\n put into the list of slow queries when slow query tracking is enabled.\n The value for *slowQueryThreshold* is specified in seconds.\n - **enabled**: If set to *true*, then queries will be tracked. If set to\n *false*, neither queries nor slow queries will be tracked.\n - **maxSlowQueries**: The maximum number of slow queries to keep in the list\n of slow queries. If the list of slow queries is full, the oldest entry in\n it will be discarded when additional slow queries occur.\n - **trackSlowQueries**: If set to *true*, then slow queries will be tracked\n in 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*\n property must also be set to *true*.\n - **maxQueryStringLength**: The maximum query string length to keep in the list of queries.\n Query strings can have arbitrary lengths, and this property\n can be used to save memory in case very long query strings are used. The\n value is specified in bytes.\n\n\n\n\nThe properties need to be passed in the attribute *properties* in the body\nof the HTTP request. *properties* needs to be a JSON object.\n\nAfter the properties have been changed, the current set of properties will\nbe returned in the HTTP response.\n\n", "parameters": [ { "in": "body", "name": "Json Request Body", "required": true, "schema": { "$ref": "#/definitions/PutApiQueryProperties" }, "x-description-offset": 61 } ], "responses": { "200": { "description": "Is returned if the properties were changed successfully.\n\n" }, "400": { "description": "The server will respond with *HTTP 400* in case of a malformed request,\n\n\n\n" } }, "summary": " Changes the properties for the AQL query tracking", "tags": [ "AQL" ], "x-examples": [], "x-filename": "AQL - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\DeleteApiQueryCache.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\DeleteApiQueryKill.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\DeleteApiQuerySlow.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\GetApiQueryCacheProperties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\GetApiQueryCurrent.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\GetApiQueryProperties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\GetApiQuerySlow.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\JSF_delete_api_aqlfunction.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\JSF_get_api_aqlfunction.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\JSF_post_api_aqlfunction.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\JSF_post_api_explain.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\PostApiQueryProperties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\PutApiQueryCacheProperties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\PutApiQueryProperties.md" } }, "/_api/query/slow": { "delete": { "description": "\n\nClears the list of slow AQL queries\n\n", "parameters": [], "responses": { "200": { "description": "The server will respond with *HTTP 200* when the list of queries was\ncleared successfully.\n\n" }, "400": { "description": "The server will respond with *HTTP 400* in case of a malformed request.\n\n\n" } }, "summary": " Clears the list of slow AQL queries", "tags": [ "AQL" ], "x-examples": [], "x-filename": "AQL - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\DeleteApiQueryCache.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\DeleteApiQueryKill.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\DeleteApiQuerySlow.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\GetApiQueryCacheProperties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\GetApiQueryCurrent.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\GetApiQueryProperties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\GetApiQuerySlow.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\JSF_delete_api_aqlfunction.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\JSF_get_api_aqlfunction.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\JSF_post_api_aqlfunction.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\JSF_post_api_explain.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\PostApiQueryProperties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\PutApiQueryCacheProperties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\PutApiQueryProperties.md" }, "get": { "description": "\n\nReturns an array containing the last AQL queries that are finished and\nhave exceeded the slow query threshold in the selected database.\nThe maximum amount of queries in the list can be controlled by setting\nthe query tracking property `maxSlowQueries`. The threshold for treating\na query as *slow* can be adjusted by setting the query tracking property\n`slowQueryThreshold`.\n\nEach query is a JSON object with the following attributes:\n\n- *id*: the query's id\n\n- *query*: the query string (potentially truncated)\n\n- *bindVars*: the bind parameter values used by the query\n\n- *started*: the date and time when the query was started\n\n- *runTime*: the query's total run time \n\n- *state*: the query's current execution state (will always be \"finished\"\n for the list of slow queries)\n\n", "parameters": [], "responses": { "200": { "description": "Is returned when the list of queries can be retrieved successfully.\n\n" }, "400": { "description": "The server will respond with *HTTP 400* in case of a malformed request,\n\n\n\n" } }, "summary": " Returns the list of slow AQL queries", "tags": [ "AQL" ], "x-examples": [], "x-filename": "AQL - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\DeleteApiQueryCache.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\DeleteApiQueryKill.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\DeleteApiQuerySlow.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\GetApiQueryCacheProperties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\GetApiQueryCurrent.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\GetApiQueryProperties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\GetApiQuerySlow.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\JSF_delete_api_aqlfunction.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\JSF_get_api_aqlfunction.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\JSF_post_api_aqlfunction.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\JSF_post_api_explain.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\PostApiQueryProperties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\PutApiQueryCacheProperties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\PutApiQueryProperties.md" } }, "/_api/query/{query-id}": { "delete": { "description": "\n\nKills a running query. The query will be terminated at the next cancelation\npoint.\n\n", "parameters": [ { "description": "The id of the query.\n\n", "format": "string", "in": "path", "name": "query-id", "required": true, "type": "string" } ], "responses": { "200": { "description": "The server will respond with *HTTP 200* when the query was still running when\nthe kill request was executed and the query's kill flag was set.\n\n" }, "400": { "description": "The server will respond with *HTTP 400* in case of a malformed request.\n\n" }, "404": { "description": "The server will respond with *HTTP 404* when no query with the specified\nid was found.\n\n\n" } }, "summary": " Kills a running AQL query", "tags": [ "AQL" ], "x-examples": [], "x-filename": "AQL - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\DeleteApiQueryCache.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\DeleteApiQueryKill.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\DeleteApiQuerySlow.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\GetApiQueryCacheProperties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\GetApiQueryCurrent.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\GetApiQueryProperties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\GetApiQuerySlow.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\JSF_delete_api_aqlfunction.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\JSF_get_api_aqlfunction.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\JSF_post_api_aqlfunction.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\JSF_post_api_explain.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\PostApiQueryProperties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\PutApiQueryCacheProperties.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\AQL\\PutApiQueryProperties.md" } }, "/_api/replication/applier-config": { "get": { "description": "\n\nReturns the configuration of the replication applier.\n\nThe body of the response is a JSON object with the configuration. The\nfollowing attributes may be present in the configuration:\n\n- *endpoint*: the logger server to connect to (e.g. \"tcp://192.168.173.13:8529\").\n\n- *database*: the name of the database to connect to (e.g. \"_system\").\n\n- *username*: an optional ArangoDB username to use when connecting to the endpoint.\n\n- *password*: the password to use when connecting to the endpoint.\n\n- *maxConnectRetries*: the maximum number of connection attempts the applier\n will make in a row. If the applier cannot establish a connection to the\n endpoint in this number of attempts, it will stop itself.\n\n- *connectTimeout*: the timeout (in seconds) when attempting to connect to the\n endpoint. This value is used for each connection attempt.\n\n- *requestTimeout*: the timeout (in seconds) for individual requests to the endpoint.\n\n- *chunkSize*: the requested maximum size for log transfer packets that\n is used when the endpoint is contacted.\n\n- *autoStart*: whether or not to auto-start the replication applier on\n (next and following) server starts\n\n- *adaptivePolling*: whether or not the replication applier will use\n adaptive polling.\n\n- *includeSystem*: whether or not system collection operations will be applied\n\n- *autoResync*: whether or not the slave should perform a full automatic\n resynchronization with the master in case the master cannot serve log data\n requested by the slave, or when the replication is started and no tick\n value\n can be found.\n\n- *autoResyncRetries*: number of resynchronization retries that will be performed\n in a row when automatic resynchronization is enabled and kicks in. Setting this\n to *0* will effectively disable *autoResync*. Setting it to some other value\n will limit the number of retries that are performed. This helps preventing endless\n retries in case resynchronizations always fail.\n\n- *initialSyncMaxWaitTime*: the maximum wait time (in seconds) that the initial\n synchronization will wait for a response from the master when fetching initial\n collection data.\n This wait time can be used to control after what time the initial synchronization\n will give up waiting for a response and fail. This value is relevant even\n for continuous replication when *autoResync* is set to *true* because this\n may re-start the initial synchronization when the master cannot provide\n log data the slave requires.\n This value will be ignored if set to *0*.\n\n- *connectionRetryWaitTime*: the time (in seconds) that the applier will\n intentionally idle before it retries connecting to the master in case of\n connection problems.\n This value will be ignored if set to *0*.\n\n- *idleMinWaitTime*: the minimum wait time (in seconds) that the applier will\n intentionally idle before fetching more log data from the master in case\n the master has already sent all its log data. This wait time can be used\n to control the frequency with which the replication applier sends HTTP log\n fetch requests to the master in case there is no write activity on the master.\n This value will be ignored if set to *0*.\n\n- *idleMaxWaitTime*: the maximum wait time (in seconds) that the applier will\n intentionally idle before fetching more log data from the master in case the\n master has already sent all its log data and there have been previous log\n fetch attempts that resulted in no more log data. This wait time can be used\n to control the maximum frequency with which the replication applier sends HTTP\n log fetch requests to the master in case there is no write activity on the\n master for longer periods. This configuration value will only be used if the\n option *adaptivePolling* is set to *true*.\n This value will be ignored if set to *0*.\n\n- *requireFromPresent*: if set to *true*, then the replication applier will check\n at start whether the start tick from which it starts or resumes replication is\n 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\n appropriate error message. If set to *false*, then the replication applier will\n still start, and ignore the data loss.\n\n- *verbose*: if set to *true*, then a log line will be emitted for all operations\n performed by the replication applier. This should be used for debugging\n replication\n problems only.\n\n- *restrictType*: the configuration for *restrictCollections*\n\n- *restrictCollections*: the optional array of collections to include or exclude,\n based on the setting of *restrictType*\n\n\n\n\n#Example:\n \n\n
shell> curl --dump - http://localhost:8529/_api/replication/applier-config\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"requestTimeout\" : 600, \n  \"connectTimeout\" : 10, \n  \"ignoreErrors\" : 0, \n  \"maxConnectRetries\" : 100, \n  \"sslProtocol\" : 0, \n  \"chunkSize\" : 0, \n  \"autoStart\" : false, \n  \"adaptivePolling\" : true, \n  \"autoResync\" : false, \n  \"autoResyncRetries\" : 2, \n  \"includeSystem\" : true, \n  \"requireFromPresent\" : false, \n  \"verbose\" : false, \n  \"incremental\" : false, \n  \"useCollectionId\" : true, \n  \"restrictType\" : \"\", \n  \"restrictCollections\" : [ ], \n  \"connectionRetryWaitTime\" : 15, \n  \"initialSyncMaxWaitTime\" : 300, \n  \"idleMinWaitTime\" : 1, \n  \"idleMaxWaitTime\" : 2.5 \n}\n
\n\n\n\n\n", "parameters": [], "responses": { "200": { "description": "is returned if the request was executed successfully.\n\n" }, "405": { "description": "is returned when an invalid HTTP method is used.\n\n" }, "500": { "description": "is returned if an error occurred while assembling the response.\n\n" } }, "summary": " Return configuration of replication applier", "tags": [ "Replication" ], "x-examples": [], "x-filename": "Replication - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_delete_batch_replication.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_applier_state.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_cluster_inventory.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_dump.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_logger_first_tick.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_logger_returns.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_logger_return_state.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_logger_tick_ranges.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_post_batch_replication.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_applier.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_applier_adjust.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_applier_start.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_applier_stop.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_inventory.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_makeSlave.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_serverID.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_synchronize.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_batch_replication.md" }, "put": { "description": "\n**A json post document with these Properties is required:**\n\n - **username**: an optional ArangoDB username to use when connecting to the endpoint.\n - **includeSystem**: whether or not system collection operations will be applied\n - **endpoint**: the logger server to connect to (e.g. \"tcp://192.168.173.13:8529\"). The endpoint must be specified.\n - **verbose**: if set to *true*, then a log line will be emitted for all operations \n performed by the replication applier. This should be used for debugging replication\n problems only.\n - **connectTimeout**: the timeout (in seconds) when attempting to connect to the\n endpoint. This value is used for each connection attempt.\n - **autoResync**: whether or not the slave should perform a full automatic resynchronization\n with the master in case the master cannot serve log data requested by the\n slave,\n or when the replication is started and no tick value can be found.\n - **database**: the name of the database on the endpoint. If not specified, defaults to the current local database name.\n - **idleMinWaitTime**: the minimum wait time (in seconds) that the applier will intentionally idle\n before fetching more log data from the master in case the master has\n already sent all its log data. This wait time can be used to control the\n frequency with which the replication applier sends HTTP log fetch requests\n to the master in case there is no write activity on the master.\n This value will be ignored if set to *0*.\n - **requestTimeout**: the timeout (in seconds) for individual requests to the endpoint.\n - **requireFromPresent**: if set to *true*, then the replication applier will check\n at start whether the start tick from which it starts or resumes replication is\n 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\n appropriate error message. If set to *false*, then the replication applier will\n still start, and ignore the data loss.\n - **idleMaxWaitTime**: the maximum wait time (in seconds) that the applier will intentionally idle \n before fetching more log data from the master in case the master has \n already sent all its log data and there have been previous log fetch attempts\n that resulted in no more log data. This wait time can be used to control the\n maximum frequency with which the replication applier sends HTTP log fetch\n requests to the master in case there is no write activity on the master for\n longer periods. This configuration value will only be used if the option\n *adaptivePolling* is set to *true*.\n This value will be ignored if set to *0*.\n - **restrictType**: the configuration for *restrictCollections*; Has to be either *include* or *exclude*\n - **initialSyncMaxWaitTime**: the maximum wait time (in seconds) that the initial synchronization will\n wait for a response from the master when fetching initial collection data.\n This wait time can be used to control after what time the initial\n synchronization\n will give up waiting for a response and fail. This value is relevant even\n for continuous replication when *autoResync* is set to *true* because this\n may re-start the initial synchronization when the master cannot provide\n log data the slave requires.\n This value will be ignored if set to *0*.\n - **maxConnectRetries**: the maximum number of connection attempts the applier\n will make in a row. If the applier cannot establish a connection to the\n endpoint in this number of attempts, it will stop itself.\n - **restrictCollections** (string): the array of collections to include or exclude,\n based on the setting of *restrictType*\n - **autoStart**: whether or not to auto-start the replication applier on\n (next and following) server starts\n - **adaptivePolling**: if set to *true*, the replication applier will fall\n to sleep for an increasingly long period in case the logger server at the\n endpoint does not have any more replication events to apply. Using\n adaptive polling is thus useful to reduce the amount of work for both the\n applier and the logger server for cases when there are only infrequent\n changes. The downside is that when using adaptive polling, it might take\n longer for the replication applier to detect that there are new replication\n events on the logger server.\n Setting *adaptivePolling* to false will make the replication applier\n contact the logger server in a constant interval, regardless of whether\n the logger server provides updates frequently or seldom.\n - **password**: the password to use when connecting to the endpoint.\n - **connectionRetryWaitTime**: the time (in seconds) that the applier will intentionally idle before\n it retries connecting to the master in case of connection problems.\n This value will be ignored if set to *0*.\n - **autoResyncRetries**: number of resynchronization retries that will be performed in a row when\n automatic resynchronization is enabled and kicks in. Setting this to *0*\n will\n effectively disable *autoResync*. Setting it to some other value will limit\n the number of retries that are performed. This helps preventing endless\n retries\n in case resynchronizations always fail.\n - **chunkSize**: the requested maximum size for log transfer packets that\n is used when the endpoint is contacted.\n\n\n\n\nSets the configuration of the replication applier. The configuration can\nonly be changed while the applier is not running. The updated configuration\nwill be saved immediately but only become active with the next start of the\napplier.\n\nIn case of success, the body of the response is a JSON object with the updated\nconfiguration.\n\n\n\n\n#Example:\n \n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/replication/applier-config <<EOF\n{ \n  \"endpoint\" : \"tcp://127.0.0.1:8529\", \n  \"username\" : \"replicationApplier\", \n  \"password\" : \"applier1234@foxx\", \n  \"chunkSize\" : 4194304, \n  \"autoStart\" : false, \n  \"adaptivePolling\" : true \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"endpoint\" : \"tcp://127.0.0.1:8529\", \n  \"database\" : \"_system\", \n  \"username\" : \"replicationApplier\", \n  \"requestTimeout\" : 600, \n  \"connectTimeout\" : 10, \n  \"ignoreErrors\" : 0, \n  \"maxConnectRetries\" : 100, \n  \"sslProtocol\" : 0, \n  \"chunkSize\" : 4194304, \n  \"autoStart\" : false, \n  \"adaptivePolling\" : true, \n  \"autoResync\" : false, \n  \"autoResyncRetries\" : 2, \n  \"includeSystem\" : true, \n  \"requireFromPresent\" : false, \n  \"verbose\" : false, \n  \"incremental\" : false, \n  \"useCollectionId\" : true, \n  \"restrictType\" : \"\", \n  \"restrictCollections\" : [ ], \n  \"connectionRetryWaitTime\" : 15, \n  \"initialSyncMaxWaitTime\" : 300, \n  \"idleMinWaitTime\" : 1, \n  \"idleMaxWaitTime\" : 2.5 \n}\n
\n\n\n\n\n", "parameters": [ { "in": "body", "name": "Json Request Body", "required": true, "schema": { "$ref": "#/definitions/JSF_put_api_replication_applier_adjust" }, "x-description-offset": 61 } ], "responses": { "200": { "description": "is returned if the request was executed successfully.\n\n" }, "400": { "description": "is returned if the configuration is incomplete or malformed, or if the\nreplication applier is currently running.\n\n" }, "405": { "description": "is returned when an invalid HTTP method is used.\n\n" }, "500": { "description": "is returned if an error occurred while assembling the response.\n\n" } }, "summary": " Adjust configuration of replication applier", "tags": [ "Replication" ], "x-examples": [], "x-filename": "Replication - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_delete_batch_replication.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_applier_state.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_cluster_inventory.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_dump.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_logger_first_tick.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_logger_returns.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_logger_return_state.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_logger_tick_ranges.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_post_batch_replication.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_applier.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_applier_adjust.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_applier_start.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_applier_stop.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_inventory.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_makeSlave.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_serverID.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_synchronize.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_batch_replication.md" } }, "/_api/replication/applier-start": { "put": { "description": "\n\nStarts the replication applier. This will return immediately if the\nreplication applier is already running.\n\nIf the replication applier is not already running, the applier configuration\nwill be checked, and if it is complete, the applier will be started in a\nbackground thread. This means that even if the applier will encounter any\nerrors while running, they will not be reported in the response to this\nmethod.\n\nTo detect replication applier errors after the applier was started, use the\n*/_api/replication/applier-state* API instead.\n\n\n\n\n#Example:\n \n\n
shell> curl -X PUT --dump - http://localhost:8529/_api/replication/applier-start\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"state\" : { \n    \"running\" : true, \n    \"lastAppliedContinuousTick\" : null, \n    \"lastProcessedContinuousTick\" : null, \n    \"lastAvailableContinuousTick\" : null, \n    \"safeResumeTick\" : null, \n    \"progress\" : { \n      \"time\" : \"2017-05-18T10:05:22Z\", \n      \"message\" : \"applier initially created\", \n      \"failedConnects\" : 0 \n    }, \n    \"totalRequests\" : 0, \n    \"totalFailedConnects\" : 0, \n    \"totalEvents\" : 0, \n    \"totalOperationsExcluded\" : 0, \n    \"lastError\" : { \n      \"errorNum\" : 0 \n    }, \n    \"time\" : \"2017-05-18T10:06:43Z\" \n  }, \n  \"server\" : { \n    \"version\" : \"3.2.devel\", \n    \"serverId\" : \"49888925541999\" \n  }, \n  \"endpoint\" : \"tcp://127.0.0.1:8529\", \n  \"database\" : \"_system\" \n}\n
\n\n\n\n\n", "parameters": [ { "description": "The remote *lastLogTick* value from which to start applying. If not specified,\nthe last saved tick from the previous applier run is used. If there is no\nprevious applier state saved, the applier will start at the beginning of the\nlogger server's log.\n\n", "in": "query", "name": "from", "required": false, "type": "string" } ], "responses": { "200": { "description": "is returned if the request was executed successfully.\n\n" }, "400": { "description": "is returned if the replication applier is not fully configured or the\nconfiguration is invalid.\n\n" }, "405": { "description": "is returned when an invalid HTTP method is used.\n\n" }, "500": { "description": "is returned if an error occurred while assembling the response.\n\n" } }, "summary": " Start replication applier", "tags": [ "Replication" ], "x-examples": [], "x-filename": "Replication - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_delete_batch_replication.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_applier_state.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_cluster_inventory.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_dump.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_logger_first_tick.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_logger_returns.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_logger_return_state.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_logger_tick_ranges.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_post_batch_replication.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_applier.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_applier_adjust.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_applier_start.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_applier_stop.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_inventory.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_makeSlave.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_serverID.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_synchronize.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_batch_replication.md" } }, "/_api/replication/applier-state": { "get": { "description": "\n\nReturns the state of the replication applier, regardless of whether the\napplier is currently running or not.\n\nThe response is a JSON object with the following attributes:\n\n- *state*: a JSON object with the following sub-attributes:\n\n - *running*: whether or not the applier is active and running\n\n - *lastAppliedContinuousTick*: the last tick value from the continuous\n replication log the applier has applied.\n\n - *lastProcessedContinuousTick*: the last tick value from the continuous\n replication log the applier has processed.\n\n Regularly, the last applied and last processed tick values should be\n identical. For transactional operations, the replication applier will first\n process incoming log events before applying them, so the processed tick\n value might be higher than the applied tick value. This will be the case\n until the applier encounters the *transaction commit* log event for the\n transaction.\n\n - *lastAvailableContinuousTick*: the last tick value the logger server can\n provide.\n\n - *time*: the time on the applier server.\n\n - *totalRequests*: the total number of requests the applier has made to the\n endpoint.\n\n - *totalFailedConnects*: the total number of failed connection attempts the\n applier has made.\n\n - *totalEvents*: the total number of log events the applier has processed.\n\n - *totalOperationsExcluded*: the total number of log events excluded because\n of *restrictCollections*.\n\n - *progress*: a JSON object with details about the replication applier progress.\n It contains the following sub-attributes if there is progress to report:\n\n - *message*: a textual description of the progress\n\n - *time*: the date and time the progress was logged\n\n - *failedConnects*: the current number of failed connection attempts\n\n - *lastError*: a JSON object with details about the last error that happened on\n the applier. It contains the following sub-attributes if there was an error:\n\n - *errorNum*: a numerical error code\n\n - *errorMessage*: a textual error description\n\n - *time*: the date and time the error occurred\n\n In case no error has occurred, *lastError* will be empty.\n\n- *server*: a JSON object with the following sub-attributes:\n\n - *version*: the applier server's version\n\n - *serverId*: the applier server's id\n\n- *endpoint*: the endpoint the applier is connected to (if applier is\n active) or will connect to (if applier is currently inactive)\n\n- *database*: the name of the database the applier is connected to (if applier is\n active) or will connect to (if applier is currently inactive)\n\n\n\n\n#Example:\n Fetching the state of an inactive applier:\n\n
shell> curl --dump - http://localhost:8529/_api/replication/applier-state\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"state\" : { \n    \"running\" : false, \n    \"lastAppliedContinuousTick\" : null, \n    \"lastProcessedContinuousTick\" : null, \n    \"lastAvailableContinuousTick\" : null, \n    \"safeResumeTick\" : null, \n    \"progress\" : { \n      \"time\" : \"2017-05-18T10:06:43Z\", \n      \"message\" : \"applier shut down\", \n      \"failedConnects\" : 0 \n    }, \n    \"totalRequests\" : 0, \n    \"totalFailedConnects\" : 0, \n    \"totalEvents\" : 0, \n    \"totalOperationsExcluded\" : 0, \n    \"lastError\" : { \n      \"errorNum\" : 1402, \n      \"time\" : \"2017-05-18T10:06:43Z\", \n      \"errorMessage\" : \"got invalid response from master at tcp://127.0.0.1:8529: HTTP 401: Unauthorized\" \n    }, \n    \"time\" : \"2017-05-18T10:06:43Z\" \n  }, \n  \"server\" : { \n    \"version\" : \"3.2.devel\", \n    \"serverId\" : \"49888925541999\" \n  }, \n  \"endpoint\" : \"tcp://127.0.0.1:8529\", \n  \"database\" : \"_system\" \n}\n
\n\n\n\n\n#Example:\n Fetching the state of an active applier:\n\n
shell> curl --dump - http://localhost:8529/_api/replication/applier-state\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"state\" : { \n    \"running\" : true, \n    \"lastAppliedContinuousTick\" : null, \n    \"lastProcessedContinuousTick\" : null, \n    \"lastAvailableContinuousTick\" : null, \n    \"safeResumeTick\" : null, \n    \"progress\" : { \n      \"time\" : \"2017-05-18T10:06:43Z\", \n      \"message\" : \"fetching master state information\", \n      \"failedConnects\" : 0 \n    }, \n    \"totalRequests\" : 0, \n    \"totalFailedConnects\" : 0, \n    \"totalEvents\" : 0, \n    \"totalOperationsExcluded\" : 0, \n    \"lastError\" : { \n      \"errorNum\" : 0 \n    }, \n    \"time\" : \"2017-05-18T10:06:43Z\" \n  }, \n  \"server\" : { \n    \"version\" : \"3.2.devel\", \n    \"serverId\" : \"49888925541999\" \n  }, \n  \"endpoint\" : \"tcp://127.0.0.1:8529\", \n  \"database\" : \"_system\" \n}\n
\n\n\n\n\n", "parameters": [], "responses": { "200": { "description": "is returned if the request was executed successfully.\n\n" }, "405": { "description": "is returned when an invalid HTTP method is used.\n\n" }, "500": { "description": "is returned if an error occurred while assembling the response.\n\n" } }, "summary": " State of the replication applier", "tags": [ "Replication" ], "x-examples": [], "x-filename": "Replication - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_delete_batch_replication.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_applier_state.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_cluster_inventory.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_dump.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_logger_first_tick.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_logger_returns.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_logger_return_state.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_logger_tick_ranges.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_post_batch_replication.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_applier.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_applier_adjust.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_applier_start.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_applier_stop.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_inventory.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_makeSlave.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_serverID.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_synchronize.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_batch_replication.md" } }, "/_api/replication/applier-stop": { "put": { "description": "\n\nStops the replication applier. This will return immediately if the\nreplication applier is not running.\n\n\n\n\n#Example:\n \n\n
shell> curl -X PUT --dump - http://localhost:8529/_api/replication/applier-stop\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"state\" : { \n    \"running\" : false, \n    \"lastAppliedContinuousTick\" : null, \n    \"lastProcessedContinuousTick\" : null, \n    \"lastAvailableContinuousTick\" : null, \n    \"safeResumeTick\" : null, \n    \"progress\" : { \n      \"time\" : \"2017-05-18T10:06:43Z\", \n      \"message\" : \"applier shut down\", \n      \"failedConnects\" : 0 \n    }, \n    \"totalRequests\" : 0, \n    \"totalFailedConnects\" : 0, \n    \"totalEvents\" : 0, \n    \"totalOperationsExcluded\" : 0, \n    \"lastError\" : { \n      \"errorNum\" : 1402, \n      \"time\" : \"2017-05-18T10:06:43Z\", \n      \"errorMessage\" : \"got invalid response from master at tcp://127.0.0.1:8529: HTTP 401: Unauthorized\" \n    }, \n    \"time\" : \"2017-05-18T10:06:43Z\" \n  }, \n  \"server\" : { \n    \"version\" : \"3.2.devel\", \n    \"serverId\" : \"49888925541999\" \n  }, \n  \"endpoint\" : \"tcp://127.0.0.1:8529\", \n  \"database\" : \"_system\" \n}\n
\n\n\n\n\n", "parameters": [], "responses": { "200": { "description": "is returned if the request was executed successfully.\n\n" }, "405": { "description": "is returned when an invalid HTTP method is used.\n\n" }, "500": { "description": "is returned if an error occurred while assembling the response.\n\n" } }, "summary": " Stop replication applier", "tags": [ "Replication" ], "x-examples": [], "x-filename": "Replication - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_delete_batch_replication.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_applier_state.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_cluster_inventory.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_dump.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_logger_first_tick.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_logger_returns.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_logger_return_state.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_logger_tick_ranges.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_post_batch_replication.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_applier.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_applier_adjust.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_applier_start.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_applier_stop.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_inventory.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_makeSlave.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_serverID.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_synchronize.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_batch_replication.md" } }, "/_api/replication/batch": { "post": { "description": "\n**A json post document with these Properties is required:**\n\n - **ttl**: the time-to-live for the new batch (in seconds)\n A JSON object with the batch configuration.\n\n\n\n\nCreates a new dump batch and returns the batch's id.\n\nThe response is a JSON object with the following attributes:\n\n- *id*: the id of the batch\n\n**Note**: on a coordinator, this request must have the query parameter\n*DBserver* which must be an ID of a DBserver.\nThe very same request is forwarded synchronously to that DBserver.\nIt is an error if this attribute is not bound in the coordinator case.\n\n", "parameters": [ { "in": "body", "name": "Json Request Body", "required": true, "schema": { "$ref": "#/definitions/JSF_post_batch_replication" }, "x-description-offset": 61 } ], "responses": { "204": { "description": "is returned if the batch was created successfully.\n\n" }, "400": { "description": "is returned if the ttl value is invalid or if *DBserver* attribute\nis not specified or illegal on a coordinator.\n\n" }, "405": { "description": "is returned when an invalid HTTP method is used.\n\n\n" } }, "summary": " Create new dump batch", "tags": [ "Replication" ], "x-examples": [], "x-filename": "Replication - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_delete_batch_replication.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_applier_state.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_cluster_inventory.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_dump.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_logger_first_tick.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_logger_returns.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_logger_return_state.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_logger_tick_ranges.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_post_batch_replication.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_applier.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_applier_adjust.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_applier_start.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_applier_stop.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_inventory.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_makeSlave.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_serverID.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_synchronize.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_batch_replication.md" } }, "/_api/replication/batch/{id}": { "delete": { "description": "\n\nDeletes the existing dump batch, allowing compaction and cleanup to resume.\n\n**Note**: on a coordinator, this request must have the query parameter\n*DBserver* which must be an ID of a DBserver.\nThe very same request is forwarded synchronously to that DBserver.\nIt is an error if this attribute is not bound in the coordinator case.\n\n", "parameters": [ { "description": "The id of the batch.\n\n", "format": "string", "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "204": { "description": "is returned if the batch was deleted successfully.\n\n" }, "400": { "description": "is returned if the batch was not found.\n\n" }, "405": { "description": "is returned when an invalid HTTP method is used.\n\n\n" } }, "summary": " Deletes an existing dump batch", "tags": [ "Replication" ], "x-examples": [], "x-filename": "Replication - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_delete_batch_replication.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_applier_state.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_cluster_inventory.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_dump.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_logger_first_tick.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_logger_returns.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_logger_return_state.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_logger_tick_ranges.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_post_batch_replication.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_applier.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_applier_adjust.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_applier_start.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_applier_stop.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_inventory.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_makeSlave.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_serverID.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_synchronize.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_batch_replication.md" }, "put": { "description": "\n**A json post document with these Properties is required:**\n\n - **ttl**: the time-to-live for the new batch (in seconds)\n\n\n\n\nExtends the ttl of an existing dump batch, using the batch's id and\nthe provided ttl value.\n\nIf the batch's ttl can be extended successfully, the response is empty.\n\n**Note**: on a coordinator, this request must have the query parameter\n*DBserver* which must be an ID of a DBserver.\nThe very same request is forwarded synchronously to that DBserver.\nIt is an error if this attribute is not bound in the coordinator case.\n\n", "parameters": [ { "in": "body", "name": "Json Request Body", "required": true, "schema": { "$ref": "#/definitions/JSF_put_batch_replication" }, "x-description-offset": 61 }, { "description": "The id of the batch.\n\n", "format": "string", "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "204": { "description": "is returned if the batch's ttl was extended successfully.\n\n" }, "400": { "description": "is returned if the ttl value is invalid or the batch was not found.\n\n" }, "405": { "description": "is returned when an invalid HTTP method is used.\n\n\n" } }, "summary": " Prolong existing dump batch", "tags": [ "Replication" ], "x-examples": [], "x-filename": "Replication - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_delete_batch_replication.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_applier_state.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_cluster_inventory.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_dump.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_logger_first_tick.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_logger_returns.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_logger_return_state.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_logger_tick_ranges.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_post_batch_replication.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_applier.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_applier_adjust.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_applier_start.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_applier_stop.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_inventory.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_makeSlave.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_serverID.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_synchronize.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_batch_replication.md" } }, "/_api/replication/clusterInventory": { "get": { "description": "\n\nReturns the array of collections and indexes available on the cluster.\n\nThe response will be an array of JSON objects, one for each collection.\nEach collection containscontains exactly two keys \"parameters\" and\n\"indexes\". This\ninformation comes from Plan/Collections/{DB-Name}/* in the agency,\njust that the *indexes* attribute there is relocated to adjust it to\nthe data format of arangodump.\n\n", "parameters": [ { "description": "Include system collections in the result. The default value is *true*.\n\n", "in": "query", "name": "includeSystem", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "is returned if the request was executed successfully.\n\n" }, "405": { "description": "is returned when an invalid HTTP method is used.\n\n" }, "500": { "description": "is returned if an error occurred while assembling the response.\n\n\n" } }, "summary": " Return cluster inventory of collections and indexes", "tags": [ "Replication" ], "x-examples": [], "x-filename": "Replication - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_delete_batch_replication.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_applier_state.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_cluster_inventory.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_dump.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_logger_first_tick.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_logger_returns.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_logger_return_state.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_logger_tick_ranges.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_post_batch_replication.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_applier.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_applier_adjust.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_applier_start.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_applier_stop.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_inventory.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_makeSlave.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_serverID.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_synchronize.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_batch_replication.md" } }, "/_api/replication/dump": { "get": { "description": "\n\nReturns the data from the collection for the requested range.\n\nWhen the *from* query parameter is not used, collection events are returned from\nthe beginning. When the *from* parameter is used, the result will only contain\ncollection entries which have higher tick values than the specified *from* value\n(note: the log entry with a tick value equal to *from* will be excluded).\n\nThe *to* query parameter can be used to optionally restrict the upper bound of\nthe result to a certain tick value. If used, the result will only contain\ncollection entries with tick values up to (including) *to*.\n\nThe *chunkSize* query parameter can be used to control the size of the result.\nIt must be specified in bytes. The *chunkSize* value will only be honored\napproximately. Otherwise a too low *chunkSize* value could cause the server\nto not be able to put just one entry into the result and return it.\nTherefore, the *chunkSize* value will only be consulted after an entry has\nbeen written into the result. If the result size is then bigger than\n*chunkSize*, the server will respond with as many entries as there are\nin the response already. If the result size is still smaller than *chunkSize*,\nthe server will try to return more data if there's more data left to return.\n\nIf *chunkSize* is not specified, some server-side default value will be used.\n\nThe *Content-Type* of the result is *application/x-arango-dump*. This is an\neasy-to-process format, with all entries going onto separate lines in the\nresponse body.\n\nEach line itself is a JSON object, with at least the following attributes:\n\n- *tick*: the operation's tick attribute\n\n- *key*: the key of the document/edge or the key used in the deletion operation\n\n- *rev*: the revision id of the document/edge or the deletion operation\n\n- *data*: the actual document/edge data for types 2300 and 2301. The full\n document/edge data will be returned even for updates.\n\n- *type*: the type of entry. Possible values for *type* are:\n\n - 2300: document insertion/update\n\n - 2301: edge insertion/update\n\n - 2302: document/edge deletion\n\n**Note**: there will be no distinction between inserts and updates when calling this method.\n\n\n\n\n#Example:\n Empty collection:\n\n
shell> curl --dump - http://localhost:8529/_api/replication/dump?collection=testCollection\n\nHTTP/1.1 204 No Content\ncontent-type: application/x-arango-dump; charset=utf-8\nx-arango-replication-checkmore: false\nx-arango-replication-lastincluded: 0\nx-content-type-options: nosniff\n\n
\n\n\n\n\n#Example:\n Non-empty collection:\n\n
shell> curl --dump - http://localhost:8529/_api/replication/dump?collection=testCollection\n\nHTTP/1.1 200 OK\ncontent-type: application/x-arango-dump; charset=utf-8\nx-arango-replication-checkmore: false\nx-arango-replication-lastincluded: 10533\nx-content-type-options: nosniff\n\n\"{\\\"tick\\\":\\\"10527\\\",\\\"type\\\":2300,\\\"data\\\":{\\\"_id\\\":\\\"testCollection/123456\\\",\\\"_key\\\":\\\"123456\\\",\\\"_rev\\\":\\\"_V_qEEIS--_\\\",\\\"b\\\":1,\\\"c\\\":false,\\\"d\\\":\\\"additional value\\\"}}\\n{\\\"tick\\\":\\\"10531\\\",\\\"type\\\":2302,\\\"data\\\":{\\\"_key\\\":\\\"foobar\\\",\\\"_rev\\\":\\\"_V_qEEIW--_\\\"}}\\n{\\\"tick\\\":\\\"10533\\\",\\\"type\\\":2302,\\\"data\\\":{\\\"_key\\\":\\\"abcdef\\\",\\\"_rev\\\":\\\"_V_qEEIa---\\\"}}\\n\"\n
\n\n\n\n\n", "parameters": [ { "description": "The name or id of the collection to dump.\n\n", "in": "query", "name": "collection", "required": true, "type": "string" }, { "description": "Lower bound tick value for results.\n\n", "in": "query", "name": "from", "required": false, "type": "number" }, { "description": "Upper bound tick value for results.\n\n", "in": "query", "name": "to", "required": false, "type": "number" }, { "description": "Approximate maximum size of the returned result.\n\n", "in": "query", "name": "chunkSize", "required": false, "type": "number" }, { "description": "Include system collections in the result. The default value is *true*.\n\n", "in": "query", "name": "includeSystem", "required": false, "type": "boolean" }, { "description": "Produce an error when dumped edges refer to now-unknown collections.\n\n", "in": "query", "name": "failOnUnknown", "required": false, "type": "boolean" }, { "description": "Whether or not to include tick values in the dump. The default value is *true*.\n\n", "in": "query", "name": "ticks", "required": false, "type": "boolean" }, { "description": "Whether or not to flush the WAL before dumping. The default value is *true*.\n\n", "in": "query", "name": "flush", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "is returned if the request was executed successfully and data was returned. The header\n`x-arango-replication-lastincluded` is set to the tick of the last document returned.\n\n" }, "204": { "description": "is returned if the request was executed successfully, but there was no content available.\nThe header `x-arango-replication-lastincluded` is `0` in this case.\n\n" }, "400": { "description": "is returned if either the *from* or *to* values are invalid.\n\n" }, "404": { "description": "is returned when the collection could not be found.\n\n" }, "405": { "description": "is returned when an invalid HTTP method is used.\n\n" }, "500": { "description": "is returned if an error occurred while assembling the response.\n\n" } }, "summary": " Return data of a collection", "tags": [ "Replication" ], "x-examples": [], "x-filename": "Replication - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_delete_batch_replication.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_applier_state.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_cluster_inventory.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_dump.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_logger_first_tick.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_logger_returns.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_logger_return_state.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_logger_tick_ranges.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_post_batch_replication.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_applier.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_applier_adjust.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_applier_start.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_applier_stop.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_inventory.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_makeSlave.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_serverID.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_synchronize.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_batch_replication.md" } }, "/_api/replication/inventory": { "get": { "description": "\n\nReturns the array of collections and indexes available on the server. This\narray can be used by replication clients to initiate an initial sync with the\nserver.\n\nThe response will contain a JSON object with the *collection* and *state* and\n*tick* attributes.\n\n*collections* is a array of collections with the following sub-attributes:\n\n- *parameters*: the collection properties\n\n- *indexes*: a array of the indexes of a the collection. Primary indexes and edges indexes\n are not included in this array.\n\nThe *state* attribute contains the current state of the replication logger. It\ncontains the following sub-attributes:\n\n- *running*: whether or not the replication logger is currently active. Note:\n since ArangoDB 2.2, the value will always be *true*\n\n- *lastLogTick*: the value of the last tick the replication logger has written\n\n- *time*: the current time on the server\n\nReplication clients should note the *lastLogTick* value returned. They can then\nfetch collections' data using the dump method up to the value of lastLogTick, and\nquery the continuous replication log for log events after this tick value.\n\nTo create a full copy of the collections on the server, a replication client\ncan execute these steps:\n\n- call the */inventory* API method. This returns the *lastLogTick* value and the\n array of collections and indexes from the server.\n\n- for each collection returned by */inventory*, create the collection locally and\n call */dump* to stream the collection data to the client, up to the value of\n *lastLogTick*.\n After that, the client can create the indexes on the collections as they were\n reported by */inventory*.\n\nIf the clients wants to continuously stream replication log events from the logger\nserver, the following additional steps need to be carried out:\n\n- the client should call */logger-follow* initially to fetch the first batch of\n replication events that were logged after the client's call to */inventory*.\n\n The call to */logger-follow* should use a *from* parameter with the value of the\n *lastLogTick* as reported by */inventory*. The call to */logger-follow* will return the\n *x-arango-replication-lastincluded* which will contain the last tick value included\n in the response.\n\n- the client can then continuously call */logger-follow* to incrementally fetch new\n replication events that occurred after the last transfer.\n\n Calls should use a *from* parameter with the value of the *x-arango-replication-lastincluded*\n header of the previous response. If there are no more replication events, the\n response will be empty and clients can go to sleep for a while and try again\n later.\n\n**Note**: on a coordinator, this request must have the query parameter\n*DBserver* which must be an ID of a DBserver.\nThe very same request is forwarded synchronously to that DBserver.\nIt is an error if this attribute is not bound in the coordinator case.\n\n\n\n\n#Example:\n \n\n
shell> curl --dump - http://localhost:8529/_api/replication/inventory\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"collections\" : [ \n    { \n      \"parameters\" : { \n        \"allowUserKeys\" : true, \n        \"cid\" : \"36\", \n        \"count\" : 0, \n        \"deleted\" : false, \n        \"doCompact\" : true, \n        \"id\" : \"36\", \n        \"indexBuckets\" : 8, \n        \"indexes\" : [ \n          { \n            \"fields\" : [ \n              \"_key\" \n            ], \n            \"id\" : \"0\", \n            \"selectivityEstimate\" : 1, \n            \"sparse\" : false, \n            \"type\" : \"primary\", \n            \"unique\" : true \n          } \n        ], \n        \"isSmart\" : false, \n        \"isSystem\" : true, \n        \"isVolatile\" : false, \n        \"journalSize\" : 1048576, \n        \"keyOptions\" : { \n          \"allowUserKeys\" : true, \n          \"type\" : \"traditional\" \n        }, \n        \"name\" : \"_aqlfunctions\", \n        \"numberOfShards\" : 1, \n        \"planId\" : \"36\", \n        \"replicationFactor\" : 2, \n        \"shardKeys\" : [ \n          \"_key\" \n        ], \n        \"shards\" : { \n        }, \n        \"status\" : 3, \n        \"type\" : 2, \n        \"version\" : 6, \n        \"waitForSync\" : false \n      }, \n      \"indexes\" : [ ] \n    }, \n    { \n      \"parameters\" : { \n        \"allowUserKeys\" : true, \n        \"cid\" : \"54\", \n        \"count\" : 0, \n        \"deleted\" : false, \n        \"doCompact\" : true, \n        \"id\" : \"54\", \n        \"indexBuckets\" : 8, \n        \"indexes\" : [ \n          { \n            \"fields\" : [ \n              \"_key\" \n            ], \n            \"id\" : \"0\", \n            \"selectivityEstimate\" : 1, \n            \"sparse\" : false, \n            \"type\" : \"primary\", \n            \"unique\" : true \n          } \n        ], \n        \"isSmart\" : false, \n        \"isSystem\" : true, \n        \"isVolatile\" : false, \n        \"journalSize\" : 1048576, \n        \"keyOptions\" : { \n          \"allowUserKeys\" : true, \n          \"type\" : \"traditional\" \n        }, \n        \"name\" : \"_frontend\", \n        \"numberOfShards\" : 1, \n        \"planId\" : \"54\", \n        \"replicationFactor\" : 2, \n        \"shardKeys\" : [ \n          \"_key\" \n        ], \n        \"shards\" : { \n        }, \n        \"status\" : 3, \n        \"type\" : 2, \n        \"version\" : 6, \n        \"waitForSync\" : false \n      }, \n      \"indexes\" : [ ] \n    }, \n    { \n      \"parameters\" : { \n        \"allowUserKeys\" : true, \n        \"cid\" : \"3\", \n        \"count\" : 0, \n        \"deleted\" : false, \n        \"doCompact\" : true, \n        \"id\" : \"3\", \n        \"indexBuckets\" : 8, \n        \"indexes\" : [ \n          { \n            \"fields\" : [ \n              \"_key\" \n            ], \n            \"id\" : \"0\", \n            \"selectivityEstimate\" : 1, \n            \"sparse\" : false, \n            \"type\" : \"primary\", \n            \"unique\" : true \n          } \n        ], \n        \"isSmart\" : false, \n        \"isSystem\" : true, \n        \"isVolatile\" : false, \n        \"journalSize\" : 1048576, \n        \"keyOptions\" : { \n          \"allowUserKeys\" : true, \n          \"type\" : \"traditional\" \n        }, \n        \"name\" : \"_graphs\", \n        \"numberOfShards\" : 1, \n        \"planId\" : \"3\", \n        \"replicationFactor\" : 2, \n        \"shardKeys\" : [ \n          \"_key\" \n        ], \n        \"shards\" : { \n        }, \n        \"status\" : 3, \n        \"type\" : 2, \n        \"version\" : 6, \n        \"waitForSync\" : false \n      }, \n      \"indexes\" : [ ] \n    }, \n    { \n      \"parameters\" : { \n        \"allowUserKeys\" : true, \n        \"cid\" : \"20\", \n        \"count\" : 0, \n        \"deleted\" : false, \n        \"doCompact\" : true, \n        \"id\" : \"20\", \n        \"indexBuckets\" : 8, \n        \"indexes\" : [ \n          { \n            \"fields\" : [ \n              \"_key\" \n            ], \n            \"id\" : \"0\", \n            \"selectivityEstimate\" : 1, \n            \"sparse\" : false, \n            \"type\" : \"primary\", \n            \"unique\" : true \n          } \n        ], \n        \"isSmart\" : false, \n        \"isSystem\" : true, \n        \"isVolatile\" : false, \n        \"journalSize\" : 1048576, \n        \"keyOptions\" : { \n          \"allowUserKeys\" : true, \n          \"type\" : \"traditional\" \n        }, \n        \"name\" : \"_modules\", \n        \"numberOfShards\" : 1, \n        \"planId\" : \"20\", \n        \"replicationFactor\" : 2, \n        \"shardKeys\" : [ \n          \"_key\" \n        ], \n        \"shards\" : { \n        }, \n        \"status\" : 3, \n        \"type\" : 2, \n        \"version\" : 6, \n        \"waitForSync\" : false \n      }, \n      \"indexes\" : [ ] \n    }, \n    { \n      \"parameters\" : { \n        \"allowUserKeys\" : true, \n        \"cid\" : \"22\", \n        \"count\" : 0, \n        \"deleted\" : false, \n        \"doCompact\" : true, \n        \"id\" : \"22\", \n        \"indexBuckets\" : 8, \n        \"indexes\" : [ \n          { \n            \"fields\" : [ \n              \"_key\" \n            ], \n            \"id\" : \"0\", \n            \"selectivityEstimate\" : 1, \n            \"sparse\" : false, \n            \"type\" : \"primary\", \n            \"unique\" : true \n          } \n        ], \n        \"isSmart\" : false, \n        \"isSystem\" : true, \n        \"isVolatile\" : false, \n        \"journalSize\" : 4194304, \n        \"keyOptions\" : { \n          \"allowUserKeys\" : true, \n          \"type\" : \"traditional\" \n        }, \n        \"name\" : \"_routing\", \n        \"numberOfShards\" : 1, \n        \"planId\" : \"22\", \n        \"replicationFactor\" : 2, \n        \"shardKeys\" : [ \n          \"_key\" \n        ], \n        \"shards\" : { \n        }, \n        \"status\" : 3, \n        \"type\" : 2, \n        \"version\" : 6, \n        \"waitForSync\" : false \n      }, \n      \"indexes\" : [ ] \n    }, \n    { \n      \"parameters\" : { \n        \"allowUserKeys\" : true, \n        \"cid\" : \"6\", \n        \"count\" : 0, \n        \"deleted\" : false, \n        \"doCompact\" : true, \n        \"id\" : \"6\", \n        \"indexBuckets\" : 8, \n        \"indexes\" : [ \n          { \n            \"fields\" : [ \n              \"_key\" \n            ], \n            \"id\" : \"0\", \n            \"selectivityEstimate\" : 1, \n            \"sparse\" : false, \n            \"type\" : \"primary\", \n            \"unique\" : true \n          }, \n          { \n            \"fields\" : [ \n              \"user\" \n            ], \n            \"id\" : \"9\", \n            \"selectivityEstimate\" : 1, \n            \"sparse\" : true, \n            \"type\" : \"hash\", \n            \"unique\" : true \n          } \n        ], \n        \"isSmart\" : false, \n        \"isSystem\" : true, \n        \"isVolatile\" : false, \n        \"journalSize\" : 4194304, \n        \"keyOptions\" : { \n          \"allowUserKeys\" : true, \n          \"type\" : \"traditional\" \n        }, \n        \"name\" : \"_users\", \n        \"numberOfShards\" : 1, \n        \"planId\" : \"6\", \n        \"replicationFactor\" : 2, \n        \"shardKeys\" : [ \n          \"user\" \n        ], \n        \"shards\" : { \n        }, \n        \"status\" : 3, \n        \"type\" : 2, \n        \"version\" : 6, \n        \"waitForSync\" : false \n      }, \n      \"indexes\" : [ \n        { \n          \"fields\" : [ \n            \"user\" \n          ], \n          \"id\" : \"9\", \n          \"selectivityEstimate\" : 1, \n          \"sparse\" : true, \n          \"type\" : \"hash\", \n          \"unique\" : true \n        } \n      ] \n    }, \n    { \n      \"parameters\" : { \n        \"allowUserKeys\" : true, \n        \"cid\" : \"94\", \n        \"count\" : 0, \n        \"deleted\" : false, \n        \"doCompact\" : true, \n        \"id\" : \"94\", \n        \"indexBuckets\" : 8, \n        \"indexes\" : [ \n          { \n            \"fields\" : [ \n              \"_key\" \n            ], \n            \"id\" : \"0\", \n            \"selectivityEstimate\" : 1, \n            \"sparse\" : false, \n            \"type\" : \"primary\", \n            \"unique\" : true \n          } \n        ], \n        \"isSmart\" : false, \n        \"isSystem\" : false, \n        \"isVolatile\" : false, \n        \"journalSize\" : 33554432, \n        \"keyOptions\" : { \n          \"allowUserKeys\" : true, \n          \"type\" : \"traditional\" \n        }, \n        \"name\" : \"animals\", \n        \"numberOfShards\" : 1, \n        \"planId\" : \"94\", \n        \"replicationFactor\" : 1, \n        \"shardKeys\" : [ \n          \"_key\" \n        ], \n        \"shards\" : { \n        }, \n        \"status\" : 3, \n        \"type\" : 2, \n        \"version\" : 6, \n        \"waitForSync\" : false \n      }, \n      \"indexes\" : [ ] \n    }, \n    { \n      \"parameters\" : { \n        \"allowUserKeys\" : true, \n        \"cid\" : \"89\", \n        \"count\" : 0, \n        \"deleted\" : false, \n        \"doCompact\" : true, \n        \"id\" : \"89\", \n        \"indexBuckets\" : 8, \n        \"indexes\" : [ \n          { \n            \"fields\" : [ \n              \"_key\" \n            ], \n            \"id\" : \"0\", \n            \"selectivityEstimate\" : 1, \n            \"sparse\" : false, \n            \"type\" : \"primary\", \n            \"unique\" : true \n          } \n        ], \n        \"isSmart\" : false, \n        \"isSystem\" : false, \n        \"isVolatile\" : false, \n        \"journalSize\" : 33554432, \n        \"keyOptions\" : { \n          \"allowUserKeys\" : true, \n          \"type\" : \"traditional\" \n        }, \n        \"name\" : \"demo\", \n        \"numberOfShards\" : 1, \n        \"planId\" : \"89\", \n        \"replicationFactor\" : 1, \n        \"shardKeys\" : [ \n          \"_key\" \n        ], \n        \"shards\" : { \n        }, \n        \"status\" : 3, \n        \"type\" : 2, \n        \"version\" : 6, \n        \"waitForSync\" : false \n      }, \n      \"indexes\" : [ ] \n    } \n  ], \n  \"state\" : { \n    \"running\" : true, \n    \"lastLogTick\" : \"10545\", \n    \"lastUncommittedLogTick\" : \"10547\", \n    \"totalEvents\" : 3766, \n    \"time\" : \"2017-05-18T10:06:45Z\" \n  }, \n  \"tick\" : \"10547\" \n}\n
\n\n\n\n\n#Example:\n With some additional indexes:\n\n
shell> curl --dump - http://localhost:8529/_api/replication/inventory\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"collections\" : [ \n    { \n      \"parameters\" : { \n        \"allowUserKeys\" : true, \n        \"cid\" : \"36\", \n        \"count\" : 0, \n        \"deleted\" : false, \n        \"doCompact\" : true, \n        \"id\" : \"36\", \n        \"indexBuckets\" : 8, \n        \"indexes\" : [ \n          { \n            \"fields\" : [ \n              \"_key\" \n            ], \n            \"id\" : \"0\", \n            \"selectivityEstimate\" : 1, \n            \"sparse\" : false, \n            \"type\" : \"primary\", \n            \"unique\" : true \n          } \n        ], \n        \"isSmart\" : false, \n        \"isSystem\" : true, \n        \"isVolatile\" : false, \n        \"journalSize\" : 1048576, \n        \"keyOptions\" : { \n          \"allowUserKeys\" : true, \n          \"type\" : \"traditional\" \n        }, \n        \"name\" : \"_aqlfunctions\", \n        \"numberOfShards\" : 1, \n        \"planId\" : \"36\", \n        \"replicationFactor\" : 2, \n        \"shardKeys\" : [ \n          \"_key\" \n        ], \n        \"shards\" : { \n        }, \n        \"status\" : 3, \n        \"type\" : 2, \n        \"version\" : 6, \n        \"waitForSync\" : false \n      }, \n      \"indexes\" : [ ] \n    }, \n    { \n      \"parameters\" : { \n        \"allowUserKeys\" : true, \n        \"cid\" : \"54\", \n        \"count\" : 0, \n        \"deleted\" : false, \n        \"doCompact\" : true, \n        \"id\" : \"54\", \n        \"indexBuckets\" : 8, \n        \"indexes\" : [ \n          { \n            \"fields\" : [ \n              \"_key\" \n            ], \n            \"id\" : \"0\", \n            \"selectivityEstimate\" : 1, \n            \"sparse\" : false, \n            \"type\" : \"primary\", \n            \"unique\" : true \n          } \n        ], \n        \"isSmart\" : false, \n        \"isSystem\" : true, \n        \"isVolatile\" : false, \n        \"journalSize\" : 1048576, \n        \"keyOptions\" : { \n          \"allowUserKeys\" : true, \n          \"type\" : \"traditional\" \n        }, \n        \"name\" : \"_frontend\", \n        \"numberOfShards\" : 1, \n        \"planId\" : \"54\", \n        \"replicationFactor\" : 2, \n        \"shardKeys\" : [ \n          \"_key\" \n        ], \n        \"shards\" : { \n        }, \n        \"status\" : 3, \n        \"type\" : 2, \n        \"version\" : 6, \n        \"waitForSync\" : false \n      }, \n      \"indexes\" : [ ] \n    }, \n    { \n      \"parameters\" : { \n        \"allowUserKeys\" : true, \n        \"cid\" : \"3\", \n        \"count\" : 0, \n        \"deleted\" : false, \n        \"doCompact\" : true, \n        \"id\" : \"3\", \n        \"indexBuckets\" : 8, \n        \"indexes\" : [ \n          { \n            \"fields\" : [ \n              \"_key\" \n            ], \n            \"id\" : \"0\", \n            \"selectivityEstimate\" : 1, \n            \"sparse\" : false, \n            \"type\" : \"primary\", \n            \"unique\" : true \n          } \n        ], \n        \"isSmart\" : false, \n        \"isSystem\" : true, \n        \"isVolatile\" : false, \n        \"journalSize\" : 1048576, \n        \"keyOptions\" : { \n          \"allowUserKeys\" : true, \n          \"type\" : \"traditional\" \n        }, \n        \"name\" : \"_graphs\", \n        \"numberOfShards\" : 1, \n        \"planId\" : \"3\", \n        \"replicationFactor\" : 2, \n        \"shardKeys\" : [ \n          \"_key\" \n        ], \n        \"shards\" : { \n        }, \n        \"status\" : 3, \n        \"type\" : 2, \n        \"version\" : 6, \n        \"waitForSync\" : false \n      }, \n      \"indexes\" : [ ] \n    }, \n    { \n      \"parameters\" : { \n        \"allowUserKeys\" : true, \n        \"cid\" : \"20\", \n        \"count\" : 0, \n        \"deleted\" : false, \n        \"doCompact\" : true, \n        \"id\" : \"20\", \n        \"indexBuckets\" : 8, \n        \"indexes\" : [ \n          { \n            \"fields\" : [ \n              \"_key\" \n            ], \n            \"id\" : \"0\", \n            \"selectivityEstimate\" : 1, \n            \"sparse\" : false, \n            \"type\" : \"primary\", \n            \"unique\" : true \n          } \n        ], \n        \"isSmart\" : false, \n        \"isSystem\" : true, \n        \"isVolatile\" : false, \n        \"journalSize\" : 1048576, \n        \"keyOptions\" : { \n          \"allowUserKeys\" : true, \n          \"type\" : \"traditional\" \n        }, \n        \"name\" : \"_modules\", \n        \"numberOfShards\" : 1, \n        \"planId\" : \"20\", \n        \"replicationFactor\" : 2, \n        \"shardKeys\" : [ \n          \"_key\" \n        ], \n        \"shards\" : { \n        }, \n        \"status\" : 3, \n        \"type\" : 2, \n        \"version\" : 6, \n        \"waitForSync\" : false \n      }, \n      \"indexes\" : [ ] \n    }, \n    { \n      \"parameters\" : { \n        \"allowUserKeys\" : true, \n        \"cid\" : \"22\", \n        \"count\" : 0, \n        \"deleted\" : false, \n        \"doCompact\" : true, \n        \"id\" : \"22\", \n        \"indexBuckets\" : 8, \n        \"indexes\" : [ \n          { \n            \"fields\" : [ \n              \"_key\" \n            ], \n            \"id\" : \"0\", \n            \"selectivityEstimate\" : 1, \n            \"sparse\" : false, \n            \"type\" : \"primary\", \n            \"unique\" : true \n          } \n        ], \n        \"isSmart\" : false, \n        \"isSystem\" : true, \n        \"isVolatile\" : false, \n        \"journalSize\" : 4194304, \n        \"keyOptions\" : { \n          \"allowUserKeys\" : true, \n          \"type\" : \"traditional\" \n        }, \n        \"name\" : \"_routing\", \n        \"numberOfShards\" : 1, \n        \"planId\" : \"22\", \n        \"replicationFactor\" : 2, \n        \"shardKeys\" : [ \n          \"_key\" \n        ], \n        \"shards\" : { \n        }, \n        \"status\" : 3, \n        \"type\" : 2, \n        \"version\" : 6, \n        \"waitForSync\" : false \n      }, \n      \"indexes\" : [ ] \n    }, \n    { \n      \"parameters\" : { \n        \"allowUserKeys\" : true, \n        \"cid\" : \"6\", \n        \"count\" : 0, \n        \"deleted\" : false, \n        \"doCompact\" : true, \n        \"id\" : \"6\", \n        \"indexBuckets\" : 8, \n        \"indexes\" : [ \n          { \n            \"fields\" : [ \n              \"_key\" \n            ], \n            \"id\" : \"0\", \n            \"selectivityEstimate\" : 1, \n            \"sparse\" : false, \n            \"type\" : \"primary\", \n            \"unique\" : true \n          }, \n          { \n            \"fields\" : [ \n              \"user\" \n            ], \n            \"id\" : \"9\", \n            \"selectivityEstimate\" : 1, \n            \"sparse\" : true, \n            \"type\" : \"hash\", \n            \"unique\" : true \n          } \n        ], \n        \"isSmart\" : false, \n        \"isSystem\" : true, \n        \"isVolatile\" : false, \n        \"journalSize\" : 4194304, \n        \"keyOptions\" : { \n          \"allowUserKeys\" : true, \n          \"type\" : \"traditional\" \n        }, \n        \"name\" : \"_users\", \n        \"numberOfShards\" : 1, \n        \"planId\" : \"6\", \n        \"replicationFactor\" : 2, \n        \"shardKeys\" : [ \n          \"user\" \n        ], \n        \"shards\" : { \n        }, \n        \"status\" : 3, \n        \"type\" : 2, \n        \"version\" : 6, \n        \"waitForSync\" : false \n      }, \n      \"indexes\" : [ \n        { \n          \"fields\" : [ \n            \"user\" \n          ], \n          \"id\" : \"9\", \n          \"selectivityEstimate\" : 1, \n          \"sparse\" : true, \n          \"type\" : \"hash\", \n          \"unique\" : true \n        } \n      ] \n    }, \n    { \n      \"parameters\" : { \n        \"allowUserKeys\" : true, \n        \"cid\" : \"94\", \n        \"count\" : 0, \n        \"deleted\" : false, \n        \"doCompact\" : true, \n        \"id\" : \"94\", \n        \"indexBuckets\" : 8, \n        \"indexes\" : [ \n          { \n            \"fields\" : [ \n              \"_key\" \n            ], \n            \"id\" : \"0\", \n            \"selectivityEstimate\" : 1, \n            \"sparse\" : false, \n            \"type\" : \"primary\", \n            \"unique\" : true \n          } \n        ], \n        \"isSmart\" : false, \n        \"isSystem\" : false, \n        \"isVolatile\" : false, \n        \"journalSize\" : 33554432, \n        \"keyOptions\" : { \n          \"allowUserKeys\" : true, \n          \"type\" : \"traditional\" \n        }, \n        \"name\" : \"animals\", \n        \"numberOfShards\" : 1, \n        \"planId\" : \"94\", \n        \"replicationFactor\" : 1, \n        \"shardKeys\" : [ \n          \"_key\" \n        ], \n        \"shards\" : { \n        }, \n        \"status\" : 3, \n        \"type\" : 2, \n        \"version\" : 6, \n        \"waitForSync\" : false \n      }, \n      \"indexes\" : [ ] \n    }, \n    { \n      \"parameters\" : { \n        \"allowUserKeys\" : true, \n        \"cid\" : \"89\", \n        \"count\" : 0, \n        \"deleted\" : false, \n        \"doCompact\" : true, \n        \"id\" : \"89\", \n        \"indexBuckets\" : 8, \n        \"indexes\" : [ \n          { \n            \"fields\" : [ \n              \"_key\" \n            ], \n            \"id\" : \"0\", \n            \"selectivityEstimate\" : 1, \n            \"sparse\" : false, \n            \"type\" : \"primary\", \n            \"unique\" : true \n          } \n        ], \n        \"isSmart\" : false, \n        \"isSystem\" : false, \n        \"isVolatile\" : false, \n        \"journalSize\" : 33554432, \n        \"keyOptions\" : { \n          \"allowUserKeys\" : true, \n          \"type\" : \"traditional\" \n        }, \n        \"name\" : \"demo\", \n        \"numberOfShards\" : 1, \n        \"planId\" : \"89\", \n        \"replicationFactor\" : 1, \n        \"shardKeys\" : [ \n          \"_key\" \n        ], \n        \"shards\" : { \n        }, \n        \"status\" : 3, \n        \"type\" : 2, \n        \"version\" : 6, \n        \"waitForSync\" : false \n      }, \n      \"indexes\" : [ ] \n    }, \n    { \n      \"parameters\" : { \n        \"allowUserKeys\" : true, \n        \"cid\" : \"10548\", \n        \"count\" : 0, \n        \"deleted\" : false, \n        \"doCompact\" : true, \n        \"id\" : \"10548\", \n        \"indexBuckets\" : 8, \n        \"indexes\" : [ \n          { \n            \"fields\" : [ \n              \"_key\" \n            ], \n            \"id\" : \"0\", \n            \"selectivityEstimate\" : 1, \n            \"sparse\" : false, \n            \"type\" : \"primary\", \n            \"unique\" : true \n          }, \n          { \n            \"fields\" : [ \n              \"name\" \n            ], \n            \"id\" : \"10551\", \n            \"selectivityEstimate\" : 1, \n            \"sparse\" : false, \n            \"type\" : \"hash\", \n            \"unique\" : false \n          }, \n          { \n            \"fields\" : [ \n              \"a\", \n              \"b\" \n            ], \n            \"id\" : \"10554\", \n            \"sparse\" : false, \n            \"type\" : \"skiplist\", \n            \"unique\" : true \n          } \n        ], \n        \"isSmart\" : false, \n        \"isSystem\" : false, \n        \"isVolatile\" : false, \n        \"journalSize\" : 33554432, \n        \"keyOptions\" : { \n          \"allowUserKeys\" : true, \n          \"type\" : \"traditional\" \n        }, \n        \"name\" : \"IndexedCollection1\", \n        \"numberOfShards\" : 1, \n        \"planId\" : \"10548\", \n        \"replicationFactor\" : 1, \n        \"shardKeys\" : [ \n          \"_key\" \n        ], \n        \"shards\" : { \n        }, \n        \"status\" : 3, \n        \"type\" : 2, \n        \"version\" : 6, \n        \"waitForSync\" : false \n      }, \n      \"indexes\" : [ \n        { \n          \"fields\" : [ \n            \"name\" \n          ], \n          \"id\" : \"10551\", \n          \"selectivityEstimate\" : 1, \n          \"sparse\" : false, \n          \"type\" : \"hash\", \n          \"unique\" : false \n        }, \n        { \n          \"fields\" : [ \n            \"a\", \n            \"b\" \n          ], \n          \"id\" : \"10554\", \n          \"sparse\" : false, \n          \"type\" : \"skiplist\", \n          \"unique\" : true \n        } \n      ] \n    }, \n    { \n      \"parameters\" : { \n        \"allowUserKeys\" : true, \n        \"cid\" : \"10556\", \n        \"count\" : 0, \n        \"deleted\" : false, \n        \"doCompact\" : true, \n        \"id\" : \"10556\", \n        \"indexBuckets\" : 8, \n        \"indexes\" : [ \n          { \n            \"fields\" : [ \n              \"_key\" \n            ], \n            \"id\" : \"0\", \n            \"selectivityEstimate\" : 1, \n            \"sparse\" : false, \n            \"type\" : \"primary\", \n            \"unique\" : true \n          }, \n          { \n            \"fields\" : [ \n              \"text\" \n            ], \n            \"id\" : \"10559\", \n            \"minLength\" : 10, \n            \"sparse\" : true, \n            \"type\" : \"fulltext\", \n            \"unique\" : false \n          }, \n          { \n            \"fields\" : [ \n              \"a\" \n            ], \n            \"id\" : \"10562\", \n            \"sparse\" : false, \n            \"type\" : \"skiplist\", \n            \"unique\" : false \n          } \n        ], \n        \"isSmart\" : false, \n        \"isSystem\" : false, \n        \"isVolatile\" : false, \n        \"journalSize\" : 33554432, \n        \"keyOptions\" : { \n          \"allowUserKeys\" : true, \n          \"type\" : \"traditional\" \n        }, \n        \"name\" : \"IndexedCollection2\", \n        \"numberOfShards\" : 1, \n        \"planId\" : \"10556\", \n        \"replicationFactor\" : 1, \n        \"shardKeys\" : [ \n          \"_key\" \n        ], \n        \"shards\" : { \n        }, \n        \"status\" : 3, \n        \"type\" : 2, \n        \"version\" : 6, \n        \"waitForSync\" : false \n      }, \n      \"indexes\" : [ \n        { \n          \"fields\" : [ \n            \"text\" \n          ], \n          \"id\" : \"10559\", \n          \"minLength\" : 10, \n          \"sparse\" : true, \n          \"type\" : \"fulltext\", \n          \"unique\" : false \n        }, \n        { \n          \"fields\" : [ \n            \"a\" \n          ], \n          \"id\" : \"10562\", \n          \"sparse\" : false, \n          \"type\" : \"skiplist\", \n          \"unique\" : false \n        } \n      ] \n    } \n  ], \n  \"state\" : { \n    \"running\" : true, \n    \"lastLogTick\" : \"10557\", \n    \"lastUncommittedLogTick\" : \"10563\", \n    \"totalEvents\" : 3772, \n    \"time\" : \"2017-05-18T10:06:46Z\" \n  }, \n  \"tick\" : \"10563\" \n}\n
\n\n\n\n\n", "parameters": [ { "description": "Include system collections in the result. The default value is *true*.\n\n", "in": "query", "name": "includeSystem", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "is returned if the request was executed successfully.\n\n" }, "405": { "description": "is returned when an invalid HTTP method is used.\n\n" }, "500": { "description": "is returned if an error occurred while assembling the response.\n\n" } }, "summary": " Return inventory of collections and indexes", "tags": [ "Replication" ], "x-examples": [], "x-filename": "Replication - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_delete_batch_replication.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_applier_state.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_cluster_inventory.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_dump.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_logger_first_tick.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_logger_returns.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_logger_return_state.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_logger_tick_ranges.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_post_batch_replication.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_applier.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_applier_adjust.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_applier_start.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_applier_stop.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_inventory.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_makeSlave.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_serverID.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_synchronize.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_batch_replication.md" } }, "/_api/replication/logger-first-tick": { "get": { "description": "\n\nReturns the first available tick value that can be served from the server's\nreplication log. This method can be called by replication clients after to\ndetermine if certain data (identified by a tick value) is still available\nfor replication.\n\nThe result is a JSON object containing the attribute *firstTick*. This\nattribute contains the minimum tick value available in the server's\nreplication\nlog.\n\n**Note**: this method is not supported on a coordinator in a cluster.\n\n\n\n\n#Example:\n Returning the first available tick\n\n
shell> curl --dump - http://localhost:8529/_api/replication/logger-first-tick\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n\"{\\\"firstTick\\\":\\\"5\\\"}\"\n
\n\n\n\n\n", "parameters": [], "responses": { "200": { "description": "is returned if the request was executed successfully.\n\n" }, "405": { "description": "is returned when an invalid HTTP method is used.\n\n" }, "500": { "description": "is returned if an error occurred while assembling the response.\n\n" }, "501": { "description": "is returned when this operation is called on a coordinator in a cluster.\n\n" } }, "summary": " Returns the first available tick value", "tags": [ "Replication" ], "x-examples": [], "x-filename": "Replication - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_delete_batch_replication.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_applier_state.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_cluster_inventory.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_dump.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_logger_first_tick.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_logger_returns.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_logger_return_state.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_logger_tick_ranges.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_post_batch_replication.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_applier.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_applier_adjust.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_applier_start.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_applier_stop.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_inventory.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_makeSlave.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_serverID.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_synchronize.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_batch_replication.md" } }, "/_api/replication/logger-follow": { "get": { "description": "\n\nReturns data from the server's replication log. This method can be called\nby replication clients after an initial synchronization of data. The method\nwill return all \"recent\" log entries from the logger server, and the clients\ncan replay and apply these entries locally so they get to the same data\nstate as the logger server.\n\nClients can call this method repeatedly to incrementally fetch all changes\nfrom the logger server. In this case, they should provide the *from* value so\nthey will only get returned the log events since their last fetch.\n\nWhen the *from* query parameter is not used, the logger server will return log\nentries starting at the beginning of its replication log. When the *from*\nparameter is used, the logger server will only return log entries which have\nhigher tick values than the specified *from* value (note: the log entry with a\ntick value equal to *from* will be excluded). Use the *from* value when\nincrementally fetching log data.\n\nThe *to* query parameter can be used to optionally restrict the upper bound of\nthe result to a certain tick value. If used, the result will contain only log events\nwith tick values up to (including) *to*. In incremental fetching, there is no\nneed to use the *to* parameter. It only makes sense in special situations,\nwhen only parts of the change log are required.\n\nThe *chunkSize* query parameter can be used to control the size of the result.\nIt must be specified in bytes. The *chunkSize* value will only be honored\napproximately. Otherwise a too low *chunkSize* value could cause the server\nto not be able to put just one log entry into the result and return it.\nTherefore, the *chunkSize* value will only be consulted after a log entry has\nbeen written into the result. If the result size is then bigger than\n*chunkSize*, the server will respond with as many log entries as there are\nin the response already. If the result size is still smaller than *chunkSize*,\nthe server will try to return more data if there's more data left to return.\n\nIf *chunkSize* is not specified, some server-side default value will be used.\n\nThe *Content-Type* of the result is *application/x-arango-dump*. This is an\neasy-to-process format, with all log events going onto separate lines in the\nresponse body. Each log event itself is a JSON object, with at least the\nfollowing attributes:\n\n- *tick*: the log event tick value\n\n- *type*: the log event type\n\nIndividual log events will also have additional attributes, depending on the\nevent type. A few common attributes which are used for multiple events types\nare:\n\n- *cid*: id of the collection the event was for\n\n- *tid*: id of the transaction the event was contained in\n\n- *key*: document key\n\n- *rev*: document revision id\n\n- *data*: the original document data\n\nA more detailed description of the individual replication event types and their\ndata structures can be found in the manual.\n\nThe response will also contain the following HTTP headers:\n\n- *x-arango-replication-active*: whether or not the logger is active. Clients\n can use this flag as an indication for their polling frequency. If the\n logger is not active and there are no more replication events available, it\n might be sensible for a client to abort, or to go to sleep for a long time\n and try again later to check whether the logger has been activated.\n\n- *x-arango-replication-lastincluded*: the tick value of the last included\n value in the result. In incremental log fetching, this value can be used\n as the *from* value for the following request. **Note** that if the result is\n empty, the value will be *0*. This value should not be used as *from* value\n by clients in the next request (otherwise the server would return the log\n events from the start of the log again).\n\n- *x-arango-replication-lasttick*: the last tick value the logger server has\n logged (not necessarily included in the result). By comparing the the last\n tick and last included tick values, clients have an approximate indication of\n how many events there are still left to fetch.\n\n- *x-arango-replication-checkmore*: whether or not there already exists more\n log data which the client could fetch immediately. If there is more log data\n available, the client could call *logger-follow* again with an adjusted *from*\n value to fetch remaining log entries until there are no more.\n\n If there isn't any more log data to fetch, the client might decide to go\n to sleep for a while before calling the logger again.\n\n**Note**: this method is not supported on a coordinator in a cluster.\n\n\n\n\n#Example:\n No log events available\n\n
shell> curl --dump - http://localhost:8529/_api/replication/logger-follow?from=10586\n\nHTTP/1.1 204 No Content\nx-arango-replication-active: true\nx-content-type-options: nosniff\nx-arango-replication-frompresent: true\nx-arango-replication-lasttick: 10586\nx-arango-replication-lastincluded: 0\nx-arango-replication-checkmore: false\ncontent-type: application/x-arango-dump; charset=utf-8\n\n
\n\n\n\n\n#Example:\n A few log events\n\n
shell> curl --dump - http://localhost:8529/_api/replication/logger-follow?from=10586\n\nHTTP/1.1 200 OK\nx-arango-replication-active: true\nx-content-type-options: nosniff\nx-arango-replication-frompresent: true\nx-arango-replication-lasttick: 10598\nx-arango-replication-lastincluded: 10598\nx-arango-replication-checkmore: false\ncontent-type: application/x-arango-dump; charset=utf-8\n\n\"{\\\"tick\\\":\\\"10588\\\",\\\"type\\\":2000,\\\"database\\\":\\\"1\\\",\\\"cid\\\":\\\"10587\\\",\\\"cname\\\":\\\"products\\\",\\\"data\\\":{\\\"allowUserKeys\\\":true,\\\"cid\\\":\\\"10587\\\",\\\"count\\\":0,\\\"deleted\\\":false,\\\"doCompact\\\":true,\\\"id\\\":\\\"10587\\\",\\\"indexBuckets\\\":8,\\\"indexes\\\":[{\\\"fields\\\":[\\\"_key\\\"],\\\"id\\\":\\\"0\\\",\\\"selectivityEstimate\\\":1,\\\"sparse\\\":false,\\\"type\\\":\\\"primary\\\",\\\"unique\\\":true}],\\\"isSmart\\\":false,\\\"isSystem\\\":false,\\\"isVolatile\\\":false,\\\"journalSize\\\":33554432,\\\"keyOptions\\\":{\\\"allowUserKeys\\\":true,\\\"type\\\":\\\"traditional\\\"},\\\"name\\\":\\\"products\\\",\\\"numberOfShards\\\":1,\\\"planId\\\":\\\"10587\\\",\\\"replicationFactor\\\":1,\\\"shardKeys\\\":[\\\"_key\\\"],\\\"shards\\\":{},\\\"status\\\":3,\\\"type\\\":2,\\\"version\\\":6,\\\"waitForSync\\\":false}}\\n{\\\"tick\\\":\\\"10591\\\",\\\"type\\\":2300,\\\"tid\\\":\\\"0\\\",\\\"database\\\":\\\"1\\\",\\\"cid\\\":\\\"10587\\\",\\\"cname\\\":\\\"products\\\",\\\"data\\\":{\\\"_id\\\":\\\"_unknown/p1\\\",\\\"_key\\\":\\\"p1\\\",\\\"_rev\\\":\\\"_V_qEIcG---\\\",\\\"name\\\":\\\"flux compensator\\\"}}\\n{\\\"tick\\\":\\\"10593\\\",\\\"type\\\":2300,\\\"tid\\\":\\\"0\\\",\\\"database\\\":\\\"1\\\",\\\"cid\\\":\\\"10587\\\",\\\"cname\\\":\\\"products\\\",\\\"data\\\":{\\\"_id\\\":\\\"_unknown/p2\\\",\\\"_key\\\":\\\"p2\\\",\\\"_rev\\\":\\\"_V_qEIcG--_\\\",\\\"hp\\\":5100,\\\"name\\\":\\\"hybrid hovercraft\\\"}}\\n{\\\"tick\\\":\\\"10595\\\",\\\"type\\\":2302,\\\"tid\\\":\\\"0\\\",\\\"database\\\":\\\"1\\\",\\\"cid\\\":\\\"10587\\\",\\\"cname\\\":\\\"products\\\",\\\"data\\\":{\\\"_key\\\":\\\"p1\\\",\\\"_rev\\\":\\\"_V_qEIcK---\\\"}}\\n{\\\"tick\\\":\\\"10597\\\",\\\"type\\\":2300,\\\"tid\\\":\\\"0\\\",\\\"database\\\":\\\"1\\\",\\\"cid\\\":\\\"10587\\\",\\\"cname\\\":\\\"products\\\",\\\"data\\\":{\\\"_id\\\":\\\"_unknown/p2\\\",\\\"_key\\\":\\\"p2\\\",\\\"_rev\\\":\\\"_V_qEIcK--_\\\",\\\"hp\\\":5100,\\\"name\\\":\\\"broken hovercraft\\\"}}\\n{\\\"tick\\\":\\\"10598\\\",\\\"type\\\":2001,\\\"database\\\":\\\"1\\\",\\\"cid\\\":\\\"10587\\\",\\\"cname\\\":\\\"products\\\",\\\"data\\\":{\\\"id\\\":\\\"10587\\\",\\\"name\\\":\\\"products\\\"}}\\n\"\n
\n\n\n\n\n#Example:\n More events than would fit into the response\n\n
shell> curl --dump - http://localhost:8529/_api/replication/logger-follow?from=10565&chunkSize=400\n\nHTTP/1.1 200 OK\nx-arango-replication-active: true\nx-content-type-options: nosniff\nx-arango-replication-frompresent: true\nx-arango-replication-lasttick: 10586\nx-arango-replication-lastincluded: 10567\nx-arango-replication-checkmore: true\ncontent-type: application/x-arango-dump; charset=utf-8\n\n\"{\\\"tick\\\":\\\"10567\\\",\\\"type\\\":2000,\\\"database\\\":\\\"1\\\",\\\"cid\\\":\\\"10566\\\",\\\"cname\\\":\\\"products\\\",\\\"data\\\":{\\\"allowUserKeys\\\":true,\\\"cid\\\":\\\"10566\\\",\\\"count\\\":0,\\\"deleted\\\":false,\\\"doCompact\\\":true,\\\"id\\\":\\\"10566\\\",\\\"indexBuckets\\\":8,\\\"indexes\\\":[{\\\"fields\\\":[\\\"_key\\\"],\\\"id\\\":\\\"0\\\",\\\"selectivityEstimate\\\":1,\\\"sparse\\\":false,\\\"type\\\":\\\"primary\\\",\\\"unique\\\":true}],\\\"isSmart\\\":false,\\\"isSystem\\\":false,\\\"isVolatile\\\":false,\\\"journalSize\\\":33554432,\\\"keyOptions\\\":{\\\"allowUserKeys\\\":true,\\\"type\\\":\\\"traditional\\\"},\\\"name\\\":\\\"products\\\",\\\"numberOfShards\\\":1,\\\"planId\\\":\\\"10566\\\",\\\"replicationFactor\\\":1,\\\"shardKeys\\\":[\\\"_key\\\"],\\\"shards\\\":{},\\\"status\\\":3,\\\"type\\\":2,\\\"version\\\":6,\\\"waitForSync\\\":false}}\\n\"\n
\n\n\n\n\n", "parameters": [ { "description": "Lower bound tick value for results.\n\n", "in": "query", "name": "from", "required": false, "type": "number" }, { "description": "Upper bound tick value for results.\n\n", "in": "query", "name": "to", "required": false, "type": "number" }, { "description": "Approximate maximum size of the returned result.\n\n", "in": "query", "name": "chunkSize", "required": false, "type": "number" }, { "description": "Include system collections in the result. The default value is *true*.\n\n", "in": "query", "name": "includeSystem", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "is returned if the request was executed successfully, and there are log\nevents available for the requested range. The response body will not be empty\nin this case.\n\n" }, "204": { "description": "is returned if the request was executed successfully, but there are no log\nevents available for the requested range. The response body will be empty\nin this case.\n\n" }, "400": { "description": "is returned if either the *from* or *to* values are invalid.\n\n" }, "405": { "description": "is returned when an invalid HTTP method is used.\n\n" }, "500": { "description": "is returned if an error occurred while assembling the response.\n\n" }, "501": { "description": "is returned when this operation is called on a coordinator in a cluster.\n\n" } }, "summary": " Returns log entries", "tags": [ "Replication" ], "x-examples": [], "x-filename": "Replication - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_delete_batch_replication.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_applier_state.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_cluster_inventory.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_dump.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_logger_first_tick.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_logger_returns.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_logger_return_state.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_logger_tick_ranges.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_post_batch_replication.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_applier.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_applier_adjust.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_applier_start.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_applier_stop.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_inventory.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_makeSlave.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_serverID.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_synchronize.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_batch_replication.md" } }, "/_api/replication/logger-state": { "get": { "description": "\n\nReturns the current state of the server's replication logger. The state will\ninclude information about whether the logger is running and about the last\nlogged tick value. This tick value is important for incremental fetching of\ndata.\n\nThe body of the response contains a JSON object with the following\nattributes:\n\n- *state*: the current logger state as a JSON object with the following\n sub-attributes:\n\n - *running*: whether or not the logger is running\n\n - *lastLogTick*: the tick value of the latest tick the logger has logged.\n This value can be used for incremental fetching of log data.\n\n - *totalEvents*: total number of events logged since the server was started.\n The value is not reset between multiple stops and re-starts of the logger.\n\n - *time*: the current date and time on the logger server\n\n- *server*: a JSON object with the following sub-attributes:\n\n - *version*: the logger server's version\n\n - *serverId*: the logger server's id\n\n- *clients*: returns the last fetch status by replication clients connected to\n the logger. Each client is returned as a JSON object with the following attributes:\n\n - *serverId*: server id of client\n\n - *lastServedTick*: last tick value served to this client via the *logger-follow* API\n\n - *time*: date and time when this client last called the *logger-follow* API\n\n\n\n\n#Example:\n Returns the state of the replication logger.\n\n
shell> curl --dump - http://localhost:8529/_api/replication/logger-state\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"state\" : { \n    \"running\" : true, \n    \"lastLogTick\" : \"10598\", \n    \"lastUncommittedLogTick\" : \"10598\", \n    \"totalEvents\" : 3788, \n    \"time\" : \"2017-05-18T10:06:48Z\" \n  }, \n  \"server\" : { \n    \"version\" : \"3.2.devel\", \n    \"serverId\" : \"49888925541999\" \n  }, \n  \"clients\" : [ ] \n}\n
\n\n\n\n\n", "parameters": [], "responses": { "200": { "description": "is returned if the logger state could be determined successfully.\n\n" }, "405": { "description": "is returned when an invalid HTTP method is used.\n\n" }, "500": { "description": "is returned if the logger state could not be determined.\n\n" } }, "summary": " Return replication logger state", "tags": [ "Replication" ], "x-examples": [], "x-filename": "Replication - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_delete_batch_replication.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_applier_state.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_cluster_inventory.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_dump.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_logger_first_tick.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_logger_returns.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_logger_return_state.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_logger_tick_ranges.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_post_batch_replication.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_applier.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_applier_adjust.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_applier_start.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_applier_stop.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_inventory.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_makeSlave.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_serverID.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_synchronize.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_batch_replication.md" } }, "/_api/replication/logger-tick-ranges": { "get": { "description": "\n\nReturns the currently available ranges of tick values for all currently\navailable WAL logfiles. The tick values can be used to determine if certain\ndata (identified by tick value) are still available for replication.\n\nThe body of the response contains a JSON array. Each array member is an\nobject\nthat describes a single logfile. Each object has the following attributes:\n\n* *datafile*: name of the logfile\n\n* *status*: status of the datafile, in textual form (e.g. \"sealed\", \"open\")\n\n* *tickMin*: minimum tick value contained in logfile\n\n* *tickMax*: maximum tick value contained in logfile\n\n\n\n\n#Example:\n Returns the available tick ranges.\n\n
shell> curl --dump - http://localhost:8529/_api/replication/logger-tick-ranges\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n[ \n  { \n    \"datafile\" : \"/tmp/arangosh_6TZ2Oh/tmp-2088-4136787427/data/journals/logfile-2.db\", \n    \"status\" : \"collected\", \n    \"tickMin\" : \"5\", \n    \"tickMax\" : \"9542\" \n  }, \n  { \n    \"datafile\" : \"/tmp/arangosh_6TZ2Oh/tmp-2088-4136787427/data/journals/logfile-23.db\", \n    \"status\" : \"collected\", \n    \"tickMin\" : \"9549\", \n    \"tickMax\" : \"9602\" \n  }, \n  { \n    \"datafile\" : \"/tmp/arangosh_6TZ2Oh/tmp-2088-4136787427/data/journals/logfile-48.db\", \n    \"status\" : \"collected\", \n    \"tickMin\" : \"9608\", \n    \"tickMax\" : \"10533\" \n  }, \n  { \n    \"datafile\" : \"/tmp/arangosh_6TZ2Oh/tmp-2088-4136787427/data/journals/logfile-9545.db\", \n    \"status\" : \"collected\", \n    \"tickMin\" : \"10541\", \n    \"tickMax\" : \"10543\" \n  }, \n  { \n    \"datafile\" : \"/tmp/arangosh_6TZ2Oh/tmp-2088-4136787427/data/journals/logfile-9614.db\", \n    \"status\" : \"open\", \n    \"tickMin\" : \"10547\", \n    \"tickMax\" : \"10598\" \n  } \n]\n
\n\n\n\n\n", "parameters": [], "responses": { "200": { "description": "is returned if the tick ranges could be determined successfully.\n\n" }, "405": { "description": "is returned when an invalid HTTP method is used.\n\n" }, "500": { "description": "is returned if the logger state could not be determined.\n\n" }, "501": { "description": "is returned when this operation is called on a coordinator in a cluster.\n\n" } }, "summary": " Return the tick ranges available in the WAL logfiles", "tags": [ "Replication" ], "x-examples": [], "x-filename": "Replication - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_delete_batch_replication.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_applier_state.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_cluster_inventory.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_dump.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_logger_first_tick.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_logger_returns.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_logger_return_state.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_logger_tick_ranges.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_post_batch_replication.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_applier.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_applier_adjust.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_applier_start.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_applier_stop.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_inventory.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_makeSlave.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_serverID.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_synchronize.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_batch_replication.md" } }, "/_api/replication/make-slave": { "put": { "description": "\n**A json post document with these Properties is required:**\n\n - **username**: an optional ArangoDB username to use when connecting to the master.\n - **includeSystem**: whether or not system collection operations will be applied\n - **endpoint**: the master endpoint to connect to (e.g. \"tcp://192.168.173.13:8529\").\n - **verbose**: if set to *true*, then a log line will be emitted for all operations\n performed by the replication applier. This should be used for debugging\n replication\n problems only.\n - **connectTimeout**: the timeout (in seconds) when attempting to connect to the\n endpoint. This value is used for each connection attempt.\n - **autoResync**: whether or not the slave should perform an automatic resynchronization with\n the master in case the master cannot serve log data requested by the slave,\n or when the replication is started and no tick value can be found.\n - **database**: the database name on the master (if not specified, defaults to the\n name of the local current database).\n - **idleMinWaitTime**: the minimum wait time (in seconds) that the applier will intentionally idle\n before fetching more log data from the master in case the master has\n already sent all its log data. This wait time can be used to control the\n frequency with which the replication applier sends HTTP log fetch requests\n to the master in case there is no write activity on the master.\n This value will be ignored if set to *0*.\n - **requestTimeout**: the timeout (in seconds) for individual requests to the endpoint.\n - **restrictType**: an optional string value for collection filtering. When\n specified, the allowed values are *include* or *exclude*.\n - **idleMaxWaitTime**: the maximum wait time (in seconds) that the applier will intentionally idle\n before fetching more log data from the master in case the master has\n already sent all its log data and there have been previous log fetch attempts\n that resulted in no more log data. This wait time can be used to control the\n maximum frequency with which the replication applier sends HTTP log fetch\n requests to the master in case there is no write activity on the master for\n longer periods. This configuration value will only be used if the option\n *adaptivePolling* is set to *true*.\n This value will be ignored if set to *0*.\n - **initialSyncMaxWaitTime**: the maximum wait time (in seconds) that the initial synchronization will\n wait for a response from the master when fetching initial collection data.\n This wait time can be used to control after what time the initial synchronization\n will give up waiting for a response and fail. This value is relevant even\n for continuous replication when *autoResync* is set to *true* because this\n may re-start the initial synchronization when the master cannot provide\n log data the slave requires.\n This value will be ignored if set to *0*.\n - **restrictCollections** (string): an optional array of collections for use with *restrictType*.\n If *restrictType* is *include*, only the specified collections\n will be sychronised. If *restrictType* is *exclude*, all but the specified\n collections will be synchronized.\n - **requireFromPresent**: if set to *true*, then the replication applier will check\n at start of its continuous replication if the start tick from the dump phase\n is 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\n appropriate error message. If set to *false*, then the replication applier will\n still start, and ignore the data loss.\n - **adaptivePolling**: whether or not the replication applier will use adaptive polling.\n - **maxConnectRetries**: the maximum number of connection attempts the applier\n will make in a row. If the applier cannot establish a connection to the\n endpoint in this number of attempts, it will stop itself.\n - **password**: the password to use when connecting to the master.\n - **connectionRetryWaitTime**: the time (in seconds) that the applier will intentionally idle before\n it retries connecting to the master in case of connection problems.\n This value will be ignored if set to *0*.\n - **autoResyncRetries**: number of resynchronization retries that will be performed in a row when\n automatic resynchronization is enabled and kicks in. Setting this to *0* will\n effectively disable *autoResync*. Setting it to some other value will limit\n the number of retries that are performed. This helps preventing endless retries\n in case resynchronizations always fail.\n - **chunkSize**: the requested maximum size for log transfer packets that\n is used when the endpoint is contacted.\n\n\n\n\nStarts a full data synchronization from a remote endpoint into the local ArangoDB\ndatabase and afterwards starts the continuous replication.\nThe operation works on a per-database level.\n\nAll local database data will be removed prior to the synchronization.\n\nIn case of success, the body of the response is a JSON object with the following\nattributes:\n\n- *state*: a JSON object with the following sub-attributes:\n\n - *running*: whether or not the applier is active and running\n\n - *lastAppliedContinuousTick*: the last tick value from the continuous\n replication log the applier has applied.\n\n - *lastProcessedContinuousTick*: the last tick value from the continuous\n replication log the applier has processed.\n\n Regularly, the last applied and last processed tick values should be\n identical. For transactional operations, the replication applier will first\n process incoming log events before applying them, so the processed tick\n value might be higher than the applied tick value. This will be the case\n until the applier encounters the *transaction commit* log event for the\n transaction.\n\n - *lastAvailableContinuousTick*: the last tick value the logger server can\n provide.\n\n - *time*: the time on the applier server.\n\n - *totalRequests*: the total number of requests the applier has made to the\n endpoint.\n\n - *totalFailedConnects*: the total number of failed connection attempts the\n applier has made.\n\n - *totalEvents*: the total number of log events the applier has processed.\n\n - *totalOperationsExcluded*: the total number of log events excluded because\n of *restrictCollections*.\n\n - *progress*: a JSON object with details about the replication applier progress.\n It contains the following sub-attributes if there is progress to report:\n\n - *message*: a textual description of the progress\n\n - *time*: the date and time the progress was logged\n\n - *failedConnects*: the current number of failed connection attempts\n\n - *lastError*: a JSON object with details about the last error that happened on\n the applier. It contains the following sub-attributes if there was an error:\n\n - *errorNum*: a numerical error code\n\n - *errorMessage*: a textual error description\n\n - *time*: the date and time the error occurred\n\n In case no error has occurred, *lastError* will be empty.\n\n- *server*: a JSON object with the following sub-attributes:\n\n - *version*: the applier server's version\n\n - *serverId*: the applier server's id\n\n- *endpoint*: the endpoint the applier is connected to (if applier is\n active) or will connect to (if applier is currently inactive)\n\n- *database*: the name of the database the applier is connected to (if applier is\n active) or will connect to (if applier is currently inactive)\n\nWARNING: calling this method will sychronize data from the collections found\non the remote master to the local ArangoDB database. All data in the local\ncollections will be purged and replaced with data from the master.\n\nUse with caution!\n\nPlease also keep in mind that this command may take a long time to complete\nand return. This is because it will first do a full data synchronization with\nthe master, which will take time roughly proportional to the amount of data.\n\n**Note**: this method is not supported on a coordinator in a cluster.\n\n", "parameters": [ { "in": "body", "name": "Json Request Body", "required": true, "schema": { "$ref": "#/definitions/JSF_put_api_replication_makeSlave" }, "x-description-offset": 61 } ], "responses": { "200": { "description": "is returned if the request was executed successfully.\n\n" }, "400": { "description": "is returned if the configuration is incomplete or malformed.\n\n" }, "405": { "description": "is returned when an invalid HTTP method is used.\n\n" }, "500": { "description": "is returned if an error occurred during sychronization or when starting the\ncontinuous replication.\n\n" }, "501": { "description": "is returned when this operation is called on a coordinator in a cluster.\n\n\n" } }, "summary": " Turn the server into a slave of another", "tags": [ "Replication" ], "x-examples": [], "x-filename": "Replication - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_delete_batch_replication.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_applier_state.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_cluster_inventory.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_dump.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_logger_first_tick.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_logger_returns.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_logger_return_state.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_logger_tick_ranges.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_post_batch_replication.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_applier.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_applier_adjust.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_applier_start.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_applier_stop.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_inventory.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_makeSlave.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_serverID.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_synchronize.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_batch_replication.md" } }, "/_api/replication/server-id": { "get": { "description": "\n\nReturns the servers id. The id is also returned by other replication API\nmethods, and this method is an easy means of determining a server's id.\n\nThe body of the response is a JSON object with the attribute *serverId*. The\nserver id is returned as a string.\n\n\n\n\n#Example:\n \n\n
shell> curl --dump - http://localhost:8529/_api/replication/server-id\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"serverId\" : \"49888925541999\" \n}\n
\n\n\n\n\n", "parameters": [], "responses": { "200": { "description": "is returned if the request was executed successfully.\n\n" }, "405": { "description": "is returned when an invalid HTTP method is used.\n\n" }, "500": { "description": "is returned if an error occurred while assembling the response.\n\n" } }, "summary": " Return server id", "tags": [ "Replication" ], "x-examples": [], "x-filename": "Replication - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_delete_batch_replication.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_applier_state.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_cluster_inventory.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_dump.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_logger_first_tick.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_logger_returns.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_logger_return_state.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_logger_tick_ranges.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_post_batch_replication.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_applier.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_applier_adjust.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_applier_start.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_applier_stop.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_inventory.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_makeSlave.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_serverID.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_synchronize.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_batch_replication.md" } }, "/_api/replication/sync": { "put": { "description": "\n**A json post document with these Properties is required:**\n\n - **username**: an optional ArangoDB username to use when connecting to the endpoint.\n - **includeSystem**: whether or not system collection operations will be applied\n - **endpoint**: the master endpoint to connect to (e.g. \"tcp://192.168.173.13:8529\").\n - **initialSyncMaxWaitTime**: the maximum wait time (in seconds) that the initial synchronization will\n wait for a response from the master when fetching initial collection data.\n This wait time can be used to control after what time the initial synchronization\n will give up waiting for a response and fail.\n This value will be ignored if set to *0*.\n - **database**: the database name on the master (if not specified, defaults to the\n name of the local current database).\n - **restrictType**: an optional string value for collection filtering. When\n specified, the allowed values are *include* or *exclude*.\n - **incremental**: if set to *true*, then an incremental synchronization method will be used\n for synchronizing data in collections. This method is useful when\n collections already exist locally, and only the remaining differences need\n to be transferred from the remote endpoint. In this case, the incremental\n synchronization can be faster than a full synchronization.\n The default value is *false*, meaning that the complete data from the remote\n collection will be transferred.\n - **restrictCollections** (string): an optional array of collections for use with\n *restrictType*. If *restrictType* is *include*, only the specified collections\n will be sychronised. If *restrictType* is *exclude*, all but the specified\n collections will be synchronized.\n - **password**: the password to use when connecting to the endpoint.\n\n\n\n\nStarts a full data synchronization from a remote endpoint into the local\nArangoDB database.\n\nThe *sync* method can be used by replication clients to connect an ArangoDB database\nto a remote endpoint, fetch the remote list of collections and indexes, and collection\ndata. It will thus create a local backup of the state of data at the remote ArangoDB\ndatabase. *sync* works on a per-database level.\n\n*sync* will first fetch the list of collections and indexes from the remote endpoint.\nIt does so by calling the *inventory* API of the remote database. It will then purge\ndata in the local ArangoDB database, and after start will transfer collection data\nfrom the remote database to the local ArangoDB database. It will extract data from the\nremote database by calling the remote database's *dump* API until all data are fetched.\n\nIn case of success, the body of the response is a JSON object with the following\nattributes:\n\n- *collections*: an array of collections that were transferred from the endpoint\n\n- *lastLogTick*: the last log tick on the endpoint at the time the transfer\n was started. Use this value as the *from* value when starting the continuous\n synchronization later.\n\nWARNING: calling this method will sychronize data from the collections found\non the remote endpoint to the local ArangoDB database. All data in the local\ncollections will be purged and replaced with data from the endpoint.\n\nUse with caution!\n\n**Note**: this method is not supported on a coordinator in a cluster.\n\n", "parameters": [ { "in": "body", "name": "Json Request Body", "required": true, "schema": { "$ref": "#/definitions/JSF_put_api_replication_synchronize" }, "x-description-offset": 61 } ], "responses": { "200": { "description": "is returned if the request was executed successfully.\n\n" }, "400": { "description": "is returned if the configuration is incomplete or malformed.\n\n" }, "405": { "description": "is returned when an invalid HTTP method is used.\n\n" }, "500": { "description": "is returned if an error occurred during sychronization.\n\n" }, "501": { "description": "is returned when this operation is called on a coordinator in a cluster.\n\n\n" } }, "summary": " Synchronize data from a remote endpoint", "tags": [ "Replication" ], "x-examples": [], "x-filename": "Replication - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_delete_batch_replication.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_applier_state.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_cluster_inventory.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_dump.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_logger_first_tick.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_logger_returns.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_logger_return_state.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_get_api_replication_logger_tick_ranges.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_post_batch_replication.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_applier.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_applier_adjust.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_applier_start.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_applier_stop.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_inventory.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_makeSlave.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_serverID.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_api_replication_synchronize.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Replication\\JSF_put_batch_replication.md" } }, "/_api/simple/all": { "put": { "description": "\n\n\nReturns all documents of a collections. The call expects a JSON object\nas body with the following attributes:\n\n- *collection*: The name of the collection to query.\n\n- *skip*: The number of documents to skip in the query (optional).\n\n- *limit*: The maximal amount of documents to return. The *skip*\n is applied before the *limit* restriction. (optional)\n\nReturns a cursor containing the result, see [Http Cursor](../AqlQueryCursor/README.md) for details.\n\n\n\n\n#Example:\n Limit the amount of documents using *limit*\n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/simple/all <<EOF\n{ \"collection\": \"products\", \"skip\": 2, \"limit\" : 2 }\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"result\" : [ \n    { \n      \"_key\" : \"10636\", \n      \"_id\" : \"products/10636\", \n      \"_rev\" : \"_V_qEJvm--_\", \n      \"Hello5\" : \"World5\" \n    }, \n    { \n      \"_key\" : \"10623\", \n      \"_id\" : \"products/10623\", \n      \"_rev\" : \"_V_qEJvi---\", \n      \"Hello1\" : \"World1\" \n    } \n  ], \n  \"hasMore\" : false, \n  \"count\" : 2, \n  \"cached\" : false, \n  \"extra\" : { \n    \"stats\" : { \n      \"writesExecuted\" : 0, \n      \"writesIgnored\" : 0, \n      \"scannedFull\" : 4, \n      \"scannedIndex\" : 0, \n      \"filtered\" : 0, \n      \"httpRequests\" : 0, \n      \"executionTime\" : 0.00027108192443847656 \n    }, \n    \"warnings\" : [ ] \n  }, \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n#Example:\n Using a *batchSize* value\n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/simple/all <<EOF\n{ \"collection\": \"products\", \"batchSize\" : 3 }\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"error\" : false, \n  \"code\" : 201, \n  \"result\" : [ \n    { \n      \"_key\" : \"10612\", \n      \"_id\" : \"products/10612\", \n      \"_rev\" : \"_V_qEJlq--_\", \n      \"Hello4\" : \"World4\" \n    }, \n    { \n      \"_key\" : \"10609\", \n      \"_id\" : \"products/10609\", \n      \"_rev\" : \"_V_qEJlq---\", \n      \"Hello3\" : \"World3\" \n    }, \n    { \n      \"_key\" : \"10602\", \n      \"_id\" : \"products/10602\", \n      \"_rev\" : \"_V_qEJlm---\", \n      \"Hello1\" : \"World1\" \n    } \n  ], \n  \"hasMore\" : true, \n  \"id\" : \"10618\", \n  \"count\" : 5, \n  \"extra\" : { \n    \"stats\" : { \n      \"writesExecuted\" : 0, \n      \"writesIgnored\" : 0, \n      \"scannedFull\" : 5, \n      \"scannedIndex\" : 0, \n      \"filtered\" : 0, \n      \"httpRequests\" : 0, \n      \"executionTime\" : 0.00026679039001464844 \n    }, \n    \"warnings\" : [ ] \n  }, \n  \"cached\" : false \n}\n
\n\n\n\n\n", "parameters": [ { "description": "Contains the query.\n\n", "in": "body", "name": "Json Request Body", "required": true, "schema": { "additionalProperties": {}, "type": "object" }, "x-description-offset": 0 } ], "responses": { "201": { "description": "is returned if the query was executed successfully.\n\n" }, "400": { "description": "is returned if the body does not contain a valid JSON representation of a\nquery. The response body contains an error document in this case.\n\n" }, "404": { "description": "is returned if the collection specified by *collection* is unknown. The\nresponse body contains an error document in this case.\n\n" } }, "summary": " Return all documents", "tags": [ "Simple Queries" ], "x-examples": [], "x-filename": "Simple Queries - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_all.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_any.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_first_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_fulltext.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_near.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_range.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_remove_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_replace_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_update_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_within.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_within_rectangle.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\RestLookupByKeys.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\RestRemoveByKeys.md" } }, "/_api/simple/all-keys": { "put": { "description": "\n**A json post document with these Properties is required:**\n\n - **type**: The type of the result. The following values are allowed:\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 - **collection**: The name of the collection. This is only for backward compatibility.\n In ArangoDB versions < 3.0, the URL path was */_api/document* and\n this was passed in via the query parameter \"collection\".\n This combination was removed.\n\n\n\n\nReturns an array of all keys, ids, or URI paths for all documents in the\ncollection identified by *collection*. The type of the result array is\ndetermined by the *type* attribute.\n\nNote that the results have no defined order and thus the order should\nnot be relied on.\n\n\n\n\n#Example:\n Return all document paths\n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/simple/all-keys <<EOF\n{ \n  \"collection\" : \"products\" \n}\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"result\" : [ \n    \"/_db/_system/_api/document/products/10008\", \n    \"/_db/_system/_api/document/products/10015\", \n    \"/_db/_system/_api/document/products/10012\" \n  ], \n  \"hasMore\" : false, \n  \"cached\" : false, \n  \"extra\" : { \n    \"stats\" : { \n      \"writesExecuted\" : 0, \n      \"writesIgnored\" : 0, \n      \"scannedFull\" : 3, \n      \"scannedIndex\" : 0, \n      \"filtered\" : 0, \n      \"httpRequests\" : 0, \n      \"executionTime\" : 0.0004329681396484375 \n    }, \n    \"warnings\" : [ ] \n  }, \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n#Example:\n Return all document keys\n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/simple/all-keys <<EOF\n{ \n  \"collection\" : \"products\", \n  \"type\" : \"id\" \n}\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"result\" : [ \n    \"products/10001\", \n    \"products/9994\", \n    \"products/9998\" \n  ], \n  \"hasMore\" : false, \n  \"cached\" : false, \n  \"extra\" : { \n    \"stats\" : { \n      \"writesExecuted\" : 0, \n      \"writesIgnored\" : 0, \n      \"scannedFull\" : 3, \n      \"scannedIndex\" : 0, \n      \"filtered\" : 0, \n      \"httpRequests\" : 0, \n      \"executionTime\" : 0.00021195411682128906 \n    }, \n    \"warnings\" : [ ] \n  }, \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n#Example:\n Collection does not exist\n\n
shell> curl --dump - http://localhost:8529/_api/document/doesnotexist\n\nHTTP/1.1 404 Not Found\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"error\" : true, \n  \"errorMessage\" : \"expecting GET /_api/document/<document-handle>\", \n  \"code\" : 404, \n  \"errorNum\" : 1203 \n}\n
\n\n\n\n\n", "parameters": [ { "in": "body", "name": "Json Request Body", "required": true, "schema": { "$ref": "#/definitions/REST_DOCUMENT_READ_ALL" }, "x-description-offset": 61 } ], "responses": { "201": { "description": "All went well.\n\n" }, "404": { "description": "The collection does not exist.\n\n" } }, "summary": " Read all documents", "tags": [ "Documents" ], "x-examples": [], "x-filename": "Documents - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_CREATE.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_DELETE.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_DELETE_MULTI.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_READ.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_READ_ALL.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_READ_HEAD.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_REPLACE.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_REPLACE_MULTI.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_UPDATE.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Documents\\REST_DOCUMENT_UPDATE_MULTI.md" } }, "/_api/simple/any": { "put": { "description": "\n\n\nReturns a random document from a collection. The call expects a JSON object\nas body with the following attributes:\n\n\n**A json post document with these Properties is required:**\n\n - **collection**: The identifier or name of the collection to query.\n Returns a JSON object with the document stored in the attribute\n *document* if the collection contains at least one document. If\n the collection is empty, the *document* attrbute contains null.\n\n\n\n\n\n#Example:\n \n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/simple/any <<EOF\n{ \n  \"collection\" : \"products\" \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"document\" : { \n    \"_key\" : \"10653\", \n    \"_id\" : \"products/10653\", \n    \"_rev\" : \"_V_qEJ6C--_\", \n    \"Hello4\" : \"World4\" \n  }, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n", "parameters": [ { "in": "body", "name": "Json Request Body", "required": true, "schema": { "$ref": "#/definitions/JSA_put_api_simple_any" }, "x-description-offset": 180 } ], "responses": { "200": { "description": "is returned if the query was executed successfully.\n\n" }, "400": { "description": "is returned if the body does not contain a valid JSON representation of a\nquery. The response body contains an error document in this case.\n\n" }, "404": { "description": "is returned if the collection specified by *collection* is unknown. The\nresponse body contains an error document in this case.\n\n" } }, "summary": " Return a random document", "tags": [ "Simple Queries" ], "x-examples": [], "x-filename": "Simple Queries - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_all.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_any.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_first_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_fulltext.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_near.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_range.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_remove_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_replace_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_update_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_within.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_within_rectangle.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\RestLookupByKeys.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\RestRemoveByKeys.md" } }, "/_api/simple/by-example": { "put": { "description": "\n**A json post document with these Properties is required:**\n\n - **skip**: The number of documents to skip in the query (optional).\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 - **limit**: The maximal amount of documents to return. The *skip*\n is applied before the *limit* restriction. (optional)\n - **example**: The example document.\n - **collection**: The name of the collection to query.\n\n\n\n\n\nThis will find all documents matching a given example.\n\nReturns a cursor containing the result, see [Http Cursor](../AqlQueryCursor/README.md) for details.\n\n\n\n\n#Example:\n Matching an attribute\n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/simple/by-example <<EOF\n{ \n  \"collection\" : \"products\", \n  \"example\" : { \n    \"i\" : 1 \n  } \n}\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"result\" : [ \n    { \n      \"_key\" : \"10670\", \n      \"_id\" : \"products/10670\", \n      \"_rev\" : \"_V_qEKC2--_\", \n      \"i\" : 1 \n    }, \n    { \n      \"_key\" : \"10663\", \n      \"_id\" : \"products/10663\", \n      \"_rev\" : \"_V_qEKCy---\", \n      \"a\" : { \n        \"k\" : 1, \n        \"j\" : 1 \n      }, \n      \"i\" : 1 \n    }, \n    { \n      \"_key\" : \"10673\", \n      \"_id\" : \"products/10673\", \n      \"_rev\" : \"_V_qEKC6---\", \n      \"a\" : { \n        \"k\" : 2, \n        \"j\" : 2 \n      }, \n      \"i\" : 1 \n    }, \n    { \n      \"_key\" : \"10667\", \n      \"_id\" : \"products/10667\", \n      \"_rev\" : \"_V_qEKC2---\", \n      \"a\" : { \n        \"j\" : 1 \n      }, \n      \"i\" : 1 \n    } \n  ], \n  \"hasMore\" : false, \n  \"count\" : 4, \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n#Example:\n Matching an attribute which is a sub-document\n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/simple/by-example <<EOF\n{ \n  \"collection\" : \"products\", \n  \"example\" : { \n    \"a.j\" : 1 \n  } \n}\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"result\" : [ \n    { \n      \"_key\" : \"10685\", \n      \"_id\" : \"products/10685\", \n      \"_rev\" : \"_V_qEKLq--_\", \n      \"a\" : { \n        \"j\" : 1 \n      }, \n      \"i\" : 1 \n    }, \n    { \n      \"_key\" : \"10681\", \n      \"_id\" : \"products/10681\", \n      \"_rev\" : \"_V_qEKLq---\", \n      \"a\" : { \n        \"k\" : 1, \n        \"j\" : 1 \n      }, \n      \"i\" : 1 \n    } \n  ], \n  \"hasMore\" : false, \n  \"count\" : 2, \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n#Example:\n Matching an attribute within a sub-document\n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/simple/by-example <<EOF\n{ \n  \"collection\" : \"products\", \n  \"example\" : { \n    \"a\" : { \n      \"j\" : 1 \n    } \n  } \n}\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"result\" : [ \n    { \n      \"_key\" : \"10703\", \n      \"_id\" : \"products/10703\", \n      \"_rev\" : \"_V_qEKUC---\", \n      \"a\" : { \n        \"j\" : 1 \n      }, \n      \"i\" : 1 \n    } \n  ], \n  \"hasMore\" : false, \n  \"count\" : 1, \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n", "parameters": [ { "in": "body", "name": "Json Request Body", "required": true, "schema": { "$ref": "#/definitions/JSA_put_api_simple_by_example" }, "x-description-offset": 61 } ], "responses": { "201": { "description": "is returned if the query was executed successfully.\n\n" }, "400": { "description": "is returned if the body does not contain a valid JSON representation of a\nquery. The response body contains an error document in this case.\n\n" }, "404": { "description": "is returned if the collection specified by *collection* is unknown. The\nresponse body contains an error document in this case.\n\n" } }, "summary": " Simple query by-example", "tags": [ "Simple Queries" ], "x-examples": [], "x-filename": "Simple Queries - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_all.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_any.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_first_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_fulltext.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_near.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_range.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_remove_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_replace_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_update_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_within.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_within_rectangle.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\RestLookupByKeys.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\RestRemoveByKeys.md" } }, "/_api/simple/first-example": { "put": { "description": "\n**A json post document with these Properties is required:**\n\n - **example**: The example document.\n - **collection**: The name of the collection to query.\n\n\n\n\n\nThis will return the first document matching a given example.\n\nReturns a result containing the document or *HTTP 404* if no\ndocument matched the example.\n\nIf more than one document in the collection matches the specified example, only\none of these documents will be returned, and it is undefined which of the matching\ndocuments is returned.\n\n\n\n\n#Example:\n If a matching document was found\n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/simple/first-example <<EOF\n{ \n  \"collection\" : \"products\", \n  \"example\" : { \n    \"i\" : 1 \n  } \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"document\" : { \n    \"_key\" : \"10717\", \n    \"_id\" : \"products/10717\", \n    \"_rev\" : \"_V_qEKd6---\", \n    \"a\" : { \n      \"k\" : 1, \n      \"j\" : 1 \n    }, \n    \"i\" : 1 \n  }, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n#Example:\n If no document was found\n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/simple/first-example <<EOF\n{ \n  \"collection\" : \"products\", \n  \"example\" : { \n    \"l\" : 1 \n  } \n}\nEOF\n\nHTTP/1.1 404 Not Found\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"error\" : true, \n  \"code\" : 404, \n  \"errorNum\" : 404, \n  \"errorMessage\" : \"no match\" \n}\n
\n\n\n\n\n", "parameters": [ { "in": "body", "name": "Json Request Body", "required": true, "schema": { "$ref": "#/definitions/JSA_put_api_simple_first_example" }, "x-description-offset": 61 } ], "responses": { "200": { "description": "is returned when the query was successfully executed.\n\n" }, "400": { "description": "is returned if the body does not contain a valid JSON representation of a\nquery. The response body contains an error document in this case.\n\n" }, "404": { "description": "is returned if the collection specified by *collection* is unknown. The\nresponse body contains an error document in this case.\n\n" } }, "summary": " Find documents matching an example", "tags": [ "Simple Queries" ], "x-examples": [], "x-filename": "Simple Queries - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_all.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_any.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_first_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_fulltext.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_near.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_range.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_remove_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_replace_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_update_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_within.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_within_rectangle.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\RestLookupByKeys.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\RestRemoveByKeys.md" } }, "/_api/simple/fulltext": { "put": { "description": "\n**A json post document with these Properties is required:**\n\n - **index**: The identifier of the fulltext-index to use.\n - **attribute**: The attribute that contains the texts.\n - **collection**: The name of the collection to query.\n - **limit**: The maximal amount of documents to return. The *skip*\n is applied before the *limit* restriction. (optional)\n - **skip**: The number of documents to skip in the query (optional).\n - **query**: The fulltext query. Please refer to [Fulltext queries](../../Manual/Appendix/Deprecated/SimpleQueries/FulltextQueries.html)\n for details.\n\n\n\n\n\nThis will find all documents from the collection that match the fulltext\nquery specified in *query*.\n\nIn order to use the *fulltext* operator, a fulltext index must be defined\nfor the collection and the specified attribute.\n\nReturns a cursor containing the result, see [Http Cursor](../AqlQueryCursor/README.md) for details.\n\nNote: the *fulltext* simple query is **deprecated** as of ArangoDB 2.6. \nThis API may be removed in future versions of ArangoDB. The preferred\nway for retrieving documents from a collection using the near operator is\nto issue an AQL query using the *FULLTEXT* [AQL function](../../AQL/Functions/Fulltext.html) \nas follows:\n\n\n FOR doc IN FULLTEXT(@@collection, @attributeName, @queryString, @limit) \n RETURN doc\n\n\n\n\n#Example:\n \n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/simple/fulltext <<EOF\n{ \n  \"collection\" : \"products\", \n  \"attribute\" : \"text\", \n  \"query\" : \"word\" \n}\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"result\" : [ \n    { \n      \"_key\" : \"10755\", \n      \"_id\" : \"products/10755\", \n      \"_rev\" : \"_V_qEKwK---\", \n      \"text\" : \"this text also has a word\" \n    }, \n    { \n      \"_key\" : \"10751\", \n      \"_id\" : \"products/10751\", \n      \"_rev\" : \"_V_qEKwG---\", \n      \"text\" : \"this text contains word\" \n    } \n  ], \n  \"hasMore\" : false, \n  \"count\" : 2, \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n", "parameters": [ { "in": "body", "name": "Json Request Body", "required": true, "schema": { "$ref": "#/definitions/JSA_put_api_simple_fulltext" }, "x-description-offset": 61 } ], "responses": { "201": { "description": "is returned if the query was executed successfully.\n\n" }, "400": { "description": "is returned if the body does not contain a valid JSON representation of a\nquery. The response body contains an error document in this case.\n\n" }, "404": { "description": "is returned if the collection specified by *collection* is unknown. The\nresponse body contains an error document in this case.\n\n" } }, "summary": " Fulltext index query", "tags": [ "Simple Queries" ], "x-examples": [], "x-filename": "Simple Queries - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_all.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_any.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_first_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_fulltext.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_near.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_range.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_remove_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_replace_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_update_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_within.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_within_rectangle.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\RestLookupByKeys.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\RestRemoveByKeys.md" } }, "/_api/simple/lookup-by-keys": { "put": { "description": "\n**A json post document with these Properties is required:**\n\n - **keys** (string): array with the _keys of documents to remove.\n - **collection**: The name of the collection to look in for the documents\n\n\n\n\nLooks up the documents in the specified collection\nusing the array of keys provided. All documents for which a matching\nkey was specified in the *keys* array and that exist in the collection\nwill be returned. Keys for which no document can be found in the\nunderlying collection are ignored, and no exception will be thrown for\nthem.\n\nThe body of the response contains a JSON object with a *documents*\nattribute. The *documents* attribute is an array containing the\nmatching documents. The order in which matching documents are present\nin the result array is unspecified.\n\n\n\n\n#Example:\n Looking up existing documents\n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/simple/lookup-by-keys <<EOF\n{ \n  \"keys\" : [ \n    \"test0\", \n    \"test1\", \n    \"test2\", \n    \"test3\", \n    \"test4\", \n    \"test5\", \n    \"test6\", \n    \"test7\", \n    \"test8\", \n    \"test9\" \n  ], \n  \"collection\" : \"test\" \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"documents\" : [ \n    { \n      \"_key\" : \"test0\", \n      \"_id\" : \"test/test0\", \n      \"_rev\" : \"_V_qELC2---\", \n      \"value\" : 0 \n    }, \n    { \n      \"_key\" : \"test1\", \n      \"_id\" : \"test/test1\", \n      \"_rev\" : \"_V_qELC6---\", \n      \"value\" : 1 \n    }, \n    { \n      \"_key\" : \"test2\", \n      \"_id\" : \"test/test2\", \n      \"_rev\" : \"_V_qELD----\", \n      \"value\" : 2 \n    }, \n    { \n      \"_key\" : \"test3\", \n      \"_id\" : \"test/test3\", \n      \"_rev\" : \"_V_qELD---_\", \n      \"value\" : 3 \n    }, \n    { \n      \"_key\" : \"test4\", \n      \"_id\" : \"test/test4\", \n      \"_rev\" : \"_V_qELDC---\", \n      \"value\" : 4 \n    }, \n    { \n      \"_key\" : \"test5\", \n      \"_id\" : \"test/test5\", \n      \"_rev\" : \"_V_qELDC--_\", \n      \"value\" : 5 \n    }, \n    { \n      \"_key\" : \"test6\", \n      \"_id\" : \"test/test6\", \n      \"_rev\" : \"_V_qELDG---\", \n      \"value\" : 6 \n    }, \n    { \n      \"_key\" : \"test7\", \n      \"_id\" : \"test/test7\", \n      \"_rev\" : \"_V_qELDG--_\", \n      \"value\" : 7 \n    }, \n    { \n      \"_key\" : \"test8\", \n      \"_id\" : \"test/test8\", \n      \"_rev\" : \"_V_qELDG--A\", \n      \"value\" : 8 \n    }, \n    { \n      \"_key\" : \"test9\", \n      \"_id\" : \"test/test9\", \n      \"_rev\" : \"_V_qELDK---\", \n      \"value\" : 9 \n    } \n  ], \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n#Example:\n Looking up non-existing documents\n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/simple/lookup-by-keys <<EOF\n{ \n  \"keys\" : [ \n    \"foo\", \n    \"bar\", \n    \"baz\" \n  ], \n  \"collection\" : \"test\" \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"documents\" : [ ], \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n\n", "parameters": [ { "in": "body", "name": "Json Request Body", "required": true, "schema": { "$ref": "#/definitions/RestLookupByKeys" }, "x-description-offset": 61 } ], "responses": { "200": { "description": "is returned if the operation was carried out successfully.\n\n" }, "404": { "description": "is returned if the collection was not found. The response body\ncontains an error document in this case.\n\n" }, "405": { "description": "is returned if the operation was called with a different HTTP METHOD than PUT.\n\n" } }, "summary": " Find documents by their keys", "tags": [ "Simple Queries" ], "x-examples": [], "x-filename": "Simple Queries - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_all.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_any.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_first_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_fulltext.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_near.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_range.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_remove_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_replace_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_update_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_within.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_within_rectangle.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\RestLookupByKeys.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\RestRemoveByKeys.md" } }, "/_api/simple/near": { "put": { "description": "\n**A json post document with these Properties is required:**\n\n - **distance**: If given, the attribute key used to return the distance to\n the given coordinate. (optional). If specified, distances are returned in meters.\n - **skip**: The number of documents to skip in the query. (optional)\n - **longitude**: The longitude of the coordinate.\n - **limit**: The maximal amount of documents to return. The *skip* is\n applied before the *limit* restriction. The default is 100. (optional)\n - **collection**: The name of the collection to query.\n - **latitude**: The latitude of the coordinate.\n - **geo**: If given, the identifier of the geo-index to use. (optional)\n\n\n\n\n\nThe default will find at most 100 documents near the given coordinate. The\nreturned array is sorted according to the distance, with the nearest document\nbeing first in the return array. If there are near documents of equal distance, documents\nare chosen randomly from this set until the limit is reached.\n\nIn order to use the *near* operator, a geo index must be defined for the\ncollection. This index also defines which attribute holds the coordinates\nfor the document. If you have more than one geo-spatial index, you can use\nthe *geo* field to select a particular index.\n\n\nReturns a cursor containing the result, see [Http Cursor](../AqlQueryCursor/README.md) for details.\n\nNote: the *near* simple query is **deprecated** as of ArangoDB 2.6. \nThis API may be removed in future versions of ArangoDB. The preferred\nway for retrieving documents from a collection using the near operator is\nto issue an [AQL query](../../AQL/Functions/Geo.html) using the *NEAR* function as follows: \n\n\n FOR doc IN NEAR(@@collection, @latitude, @longitude, @limit)\n RETURN doc`\n\n\n\n\n#Example:\n Without distance\n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/simple/near <<EOF\n{ \n  \"collection\" : \"products\", \n  \"latitude\" : 0, \n  \"longitude\" : 0, \n  \"skip\" : 1, \n  \"limit\" : 2 \n}\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"result\" : [ \n    { \n      \"_key\" : \"10842\", \n      \"_id\" : \"products/10842\", \n      \"_rev\" : \"_V_qELda---\", \n      \"name\" : \"Name/0.002/\", \n      \"loc\" : [ \n        0.002, \n        0 \n      ] \n    }, \n    { \n      \"_key\" : \"10836\", \n      \"_id\" : \"products/10836\", \n      \"_rev\" : \"_V_qELdW--_\", \n      \"name\" : \"Name/-0.002/\", \n      \"loc\" : [ \n        -0.002, \n        0 \n      ] \n    } \n  ], \n  \"hasMore\" : false, \n  \"count\" : 2, \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n#Example:\n With distance\n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/simple/near <<EOF\n{ \n  \"collection\" : \"products\", \n  \"latitude\" : 0, \n  \"longitude\" : 0, \n  \"skip\" : 1, \n  \"limit\" : 3, \n  \"distance\" : \"distance\" \n}\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"result\" : [ \n    { \n      \"distance\" : 222.38985328911744, \n      \"_id\" : \"products/10879\", \n      \"_key\" : \"10879\", \n      \"_rev\" : \"_V_qELri---\", \n      \"loc\" : [ \n        -0.002, \n        0 \n      ], \n      \"name\" : \"Name/-0.002/\" \n    }, \n    { \n      \"distance\" : 222.38985328911744, \n      \"_id\" : \"products/10885\", \n      \"_key\" : \"10885\", \n      \"_rev\" : \"_V_qELrm---\", \n      \"loc\" : [ \n        0.002, \n        0 \n      ], \n      \"name\" : \"Name/0.002/\" \n    }, \n    { \n      \"distance\" : 444.779706578235, \n      \"_id\" : \"products/10876\", \n      \"_key\" : \"10876\", \n      \"_rev\" : \"_V_qELre--_\", \n      \"loc\" : [ \n        -0.004, \n        0 \n      ], \n      \"name\" : \"Name/-0.004/\" \n    } \n  ], \n  \"hasMore\" : false, \n  \"count\" : 3, \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n", "parameters": [ { "in": "body", "name": "Json Request Body", "required": true, "schema": { "$ref": "#/definitions/JSA_put_api_simple_near" }, "x-description-offset": 61 } ], "responses": { "201": { "description": "is returned if the query was executed successfully.\n\n" }, "400": { "description": "is returned if the body does not contain a valid JSON representation of a\nquery. The response body contains an error document in this case.\n\n" }, "404": { "description": "is returned if the collection specified by *collection* is unknown. The\nresponse body contains an error document in this case.\n\n" } }, "summary": " Returns documents near a coordinate", "tags": [ "Simple Queries" ], "x-examples": [], "x-filename": "Simple Queries - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_all.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_any.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_first_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_fulltext.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_near.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_range.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_remove_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_replace_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_update_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_within.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_within_rectangle.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\RestLookupByKeys.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\RestRemoveByKeys.md" } }, "/_api/simple/range": { "put": { "description": "\n**A json post document with these Properties is required:**\n\n - **right**: The upper bound.\n - **attribute**: The attribute path to check.\n - **collection**: The name of the collection to query.\n - **limit**: The maximal amount of documents to return. The *skip*\n is applied before the *limit* restriction. (optional)\n - **closed**: If *true*, use interval including *left* and *right*,\n otherwise exclude *right*, but include *left*.\n - **skip**: The number of documents to skip in the query (optional).\n - **left**: The lower bound.\n\n\n\n\n\nThis will find all documents within a given range. In order to execute a\nrange query, a skip-list index on the queried attribute must be present.\n\nReturns a cursor containing the result, see [Http Cursor](../AqlQueryCursor/README.md) for details.\n\nNote: the *range* simple query is **deprecated** as of ArangoDB 2.6. \nThe function may be removed in future versions of ArangoDB. The preferred\nway for retrieving documents from a collection within a specific range\nis to use an AQL query as follows: \n\n\n FOR doc IN @@collection \n FILTER doc.value >= @left && doc.value < @right \n LIMIT @skip, @limit \n RETURN doc`\n\n\n\n\n#Example:\n \n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/simple/range <<EOF\n{ \n  \"collection\" : \"products\", \n  \"attribute\" : \"i\", \n  \"left\" : 2, \n  \"right\" : 4 \n}\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"result\" : [ \n    { \n      \"_key\" : \"10913\", \n      \"_id\" : \"products/10913\", \n      \"_rev\" : \"_V_qEL8u--_\", \n      \"i\" : 2 \n    }, \n    { \n      \"_key\" : \"10916\", \n      \"_id\" : \"products/10916\", \n      \"_rev\" : \"_V_qEL8u--A\", \n      \"i\" : 3 \n    } \n  ], \n  \"hasMore\" : false, \n  \"count\" : 2, \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n", "parameters": [ { "in": "body", "name": "Json Request Body", "required": true, "schema": { "$ref": "#/definitions/JSA_put_api_simple_range" }, "x-description-offset": 61 } ], "responses": { "201": { "description": "is returned if the query was executed successfully.\n\n" }, "400": { "description": "is returned if the body does not contain a valid JSON representation of a\nquery. The response body contains an error document in this case.\n\n" }, "404": { "description": "is returned if the collection specified by *collection* is unknown or no\nsuitable index for the range query is present. The response body contains \nan error document in this case.\n\n" } }, "summary": " Simple range query", "tags": [ "Simple Queries" ], "x-examples": [], "x-filename": "Simple Queries - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_all.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_any.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_first_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_fulltext.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_near.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_range.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_remove_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_replace_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_update_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_within.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_within_rectangle.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\RestLookupByKeys.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\RestRemoveByKeys.md" } }, "/_api/simple/remove-by-example": { "put": { "description": "\n**A json post document with these Properties is required:**\n\n - **example**: An example document that all collection documents are compared against.\n - **collection**: The name of the collection to remove from.\n - **options**:\n - **limit**: an optional value that determines how many documents to\n delete at most. If *limit* is specified but is less than the number\n of documents in the collection, it is undefined which of the documents\n will be deleted.\n - **waitForSync**: 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\n\n\n\nThis will find all documents in the collection that match the specified\nexample object.\n\nNote: the *limit* attribute is not supported on sharded collections.\nUsing it will result in an error.\n\nReturns the number of documents that were deleted.\n\n\n\n\n#Example:\n \n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/simple/remove-by-example <<EOF\n{ \n  \"collection\" : \"products\", \n  \"example\" : { \n    \"a\" : { \n      \"j\" : 1 \n    } \n  } \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"deleted\" : 1, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n#Example:\n Using Parameter: waitForSync and limit\n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/simple/remove-by-example <<EOF\n{ \n  \"collection\" : \"products\", \n  \"example\" : { \n    \"a\" : { \n      \"j\" : 1 \n    } \n  }, \n  \"waitForSync\" : true, \n  \"limit\" : 2 \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"deleted\" : 1, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n#Example:\n Using Parameter: waitForSync and limit with new signature\n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/simple/remove-by-example <<EOF\n{ \n  \"collection\" : \"products\", \n  \"example\" : { \n    \"a\" : { \n      \"j\" : 1 \n    } \n  }, \n  \"options\" : { \n    \"waitForSync\" : true, \n    \"limit\" : 2 \n  } \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"deleted\" : 1, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n", "parameters": [ { "in": "body", "name": "Json Request Body", "required": true, "schema": { "$ref": "#/definitions/JSA_put_api_simple_remove_by_example" }, "x-description-offset": 61 } ], "responses": { "200": { "description": "is returned if the query was executed successfully.\n\n" }, "400": { "description": "is returned if the body does not contain a valid JSON representation of a\nquery. The response body contains an error document in this case.\n\n" }, "404": { "description": "is returned if the collection specified by *collection* is unknown. The\nresponse body contains an error document in this case.\n\n" } }, "summary": " Remove documents by example", "tags": [ "Simple Queries" ], "x-examples": [], "x-filename": "Simple Queries - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_all.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_any.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_first_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_fulltext.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_near.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_range.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_remove_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_replace_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_update_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_within.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_within_rectangle.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\RestLookupByKeys.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\RestRemoveByKeys.md" } }, "/_api/simple/remove-by-keys": { "put": { "description": "\n**A json post document with these Properties is required:**\n\n - **keys** (string): array with the _keys of documents to remove.\n - **options**:\n - **returnOld**: if set to *true* and *silent* above is *false*, then the above\n information about the removed documents contains the complete\n removed documents.\n - **silent**: if set to *false*, then the result will contain an additional\n attribute *old* which contains an array with one entry for each\n removed document. By default, these entries will have the *_id*,\n *_key* and *_rev* attributes.\n - **waitForSync**: 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 - **collection**: The name of the collection to look in for the documents to remove\n\n\n\n\nLooks up the documents in the specified collection using the array of keys\nprovided, and removes all documents from the collection whose keys are\ncontained in the *keys* array. Keys for which no document can be found in\nthe underlying collection are ignored, and no exception will be thrown for\nthem.\n\nThe body of the response contains a JSON object with information how many\ndocuments were removed (and how many were not). The *removed* attribute will\ncontain the number of actually removed documents. The *ignored* attribute \nwill contain the number of keys in the request for which no matching document\ncould be found.\n\n\n\n\n#Example:\n \n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/simple/remove-by-keys <<EOF\n{ \n  \"keys\" : [ \n    \"test0\", \n    \"test1\", \n    \"test2\", \n    \"test3\", \n    \"test4\", \n    \"test5\", \n    \"test6\", \n    \"test7\", \n    \"test8\", \n    \"test9\" \n  ], \n  \"collection\" : \"test\" \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"removed\" : 10, \n  \"ignored\" : 0, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n#Example:\n \n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/simple/remove-by-keys <<EOF\n{ \n  \"keys\" : [ \n    \"foo\", \n    \"bar\", \n    \"baz\" \n  ], \n  \"collection\" : \"test\" \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"removed\" : 0, \n  \"ignored\" : 3, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n\n", "parameters": [ { "in": "body", "name": "Json Request Body", "required": true, "schema": { "$ref": "#/definitions/RestRemoveByKeys" }, "x-description-offset": 61 } ], "responses": { "200": { "description": "is returned if the operation was carried out successfully. The number of removed\ndocuments may still be 0 in this case if none of the specified document keys\nwere found in the collection.\n\n" }, "404": { "description": "is returned if the collection was not found.\nThe response body contains an error document in this case.\n\n" }, "405": { "description": "is returned if the operation was called with a different HTTP METHOD than PUT.\n\n" } }, "summary": " Remove documents by their keys", "tags": [ "Simple Queries" ], "x-examples": [], "x-filename": "Simple Queries - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_all.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_any.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_first_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_fulltext.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_near.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_range.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_remove_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_replace_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_update_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_within.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_within_rectangle.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\RestLookupByKeys.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\RestRemoveByKeys.md" } }, "/_api/simple/replace-by-example": { "put": { "description": "\n**A json post document with these Properties is required:**\n\n - **options**:\n - **limit**: an optional value that determines how many documents to\n replace at most. If *limit* is specified but is less than the number\n of documents in the collection, it is undefined which of the documents\n will be replaced.\n - **waitForSync**: 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 - **example**: An example document that all collection documents are compared against.\n - **collection**: The name of the collection to replace within.\n - **newValue**: The replacement document that will get inserted in place\n of the \"old\" documents.\n\n\n\n\n\nThis will find all documents in the collection that match the specified\nexample object, and replace the entire document body with the new value\nspecified. Note that document meta-attributes such as *_id*, *_key*,\n*_from*, *_to* etc. cannot be replaced.\n\nNote: the *limit* attribute is not supported on sharded collections.\nUsing it will result in an error.\n\nReturns the number of documents that were replaced.\n\n\n\n\n#Example:\n \n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/simple/replace-by-example <<EOF\n{ \n  \"collection\" : \"products\", \n  \"example\" : { \n    \"a\" : { \n      \"j\" : 1 \n    } \n  }, \n  \"newValue\" : { \n    \"foo\" : \"bar\" \n  }, \n  \"limit\" : 3 \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"replaced\" : 1, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n#Example:\n Using new Signature for attributes WaitForSync and limit\n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/simple/replace-by-example <<EOF\n{ \n  \"collection\" : \"products\", \n  \"example\" : { \n    \"a\" : { \n      \"j\" : 1 \n    } \n  }, \n  \"newValue\" : { \n    \"foo\" : \"bar\" \n  }, \n  \"options\" : { \n    \"limit\" : 3, \n    \"waitForSync\" : true \n  } \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"replaced\" : 1, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n", "parameters": [ { "in": "body", "name": "Json Request Body", "required": true, "schema": { "$ref": "#/definitions/JSA_put_api_simple_replace_by_example" }, "x-description-offset": 61 } ], "responses": { "200": { "description": "is returned if the query was executed successfully.\n\n" }, "400": { "description": "is returned if the body does not contain a valid JSON representation of a\nquery. The response body contains an error document in this case.\n\n" }, "404": { "description": "is returned if the collection specified by *collection* is unknown. The\nresponse body contains an error document in this case.\n\n" } }, "summary": " Replace documents by example", "tags": [ "Simple Queries" ], "x-examples": [], "x-filename": "Simple Queries - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_all.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_any.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_first_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_fulltext.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_near.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_range.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_remove_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_replace_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_update_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_within.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_within_rectangle.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\RestLookupByKeys.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\RestRemoveByKeys.md" } }, "/_api/simple/update-by-example": { "put": { "description": "\n**A json post document with these Properties is required:**\n\n - **options**:\n - **keepNull**: This parameter can be used to modify the behavior when\n handling *null* values. Normally, *null* values are stored in the\n database. By setting the *keepNull* parameter to *false*, this\n behavior can be changed so that all attributes in *data* with *null*\n values will be removed from the updated document.\n - **mergeObjects**: Controls whether objects (not arrays) will be merged if present in both the\n existing and the patch document. If set to false, the value in the\n patch document will overwrite the existing document's value. If set to\n true, objects will be merged. The default is true.\n - **limit**: an optional value that determines how many documents to\n update at most. If *limit* is specified but is less than the number\n of documents in the collection, it is undefined which of the documents\n will be updated.\n - **waitForSync**: 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 - **example**: An example document that all collection documents are compared against.\n - **collection**: The name of the collection to update within.\n - **newValue**: A document containing all the attributes to update in the found documents.\n\n\n\n\n\nThis will find all documents in the collection that match the specified\nexample object, and partially update the document body with the new value\nspecified. Note that document meta-attributes such as *_id*, *_key*,\n*_from*, *_to* etc. cannot be replaced.\n\nNote: the *limit* attribute is not supported on sharded collections.\nUsing it will result in an error.\n\nReturns the number of documents that were updated.\n\n\n\n\n\n#Example:\n using old syntax for options\n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/simple/update-by-example <<EOF\n{ \n  \"collection\" : \"products\", \n  \"example\" : { \n    \"a\" : { \n      \"j\" : 1 \n    } \n  }, \n  \"newValue\" : { \n    \"a\" : { \n      \"j\" : 22 \n    } \n  }, \n  \"limit\" : 3 \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"updated\" : 1, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n#Example:\n using new signature for options\n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/simple/update-by-example <<EOF\n{ \n  \"collection\" : \"products\", \n  \"example\" : { \n    \"a\" : { \n      \"j\" : 1 \n    } \n  }, \n  \"newValue\" : { \n    \"a\" : { \n      \"j\" : 22 \n    } \n  }, \n  \"options\" : { \n    \"limit\" : 3, \n    \"waitForSync\" : true \n  } \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"updated\" : 1, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n", "parameters": [ { "in": "body", "name": "Json Request Body", "required": true, "schema": { "$ref": "#/definitions/JSA_put_api_simple_update_by_example" }, "x-description-offset": 61 } ], "responses": { "200": { "description": "is returned if the collection was updated successfully and *waitForSync* was\n*true*.\n\n" }, "400": { "description": "is returned if the body does not contain a valid JSON representation of a\nquery. The response body contains an error document in this case.\n\n" }, "404": { "description": "is returned if the collection specified by *collection* is unknown. The\nresponse body contains an error document in this case.\n\n" } }, "summary": " Update documents by example", "tags": [ "Simple Queries" ], "x-examples": [], "x-filename": "Simple Queries - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_all.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_any.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_first_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_fulltext.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_near.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_range.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_remove_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_replace_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_update_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_within.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_within_rectangle.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\RestLookupByKeys.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\RestRemoveByKeys.md" } }, "/_api/simple/within": { "put": { "description": "\n**A json post document with these Properties is required:**\n\n - **distance**: If given, the attribute key used to return the distance to\n the given coordinate. (optional). If specified, distances are returned in meters.\n - **skip**: The number of documents to skip in the query. (optional)\n - **longitude**: The longitude of the coordinate.\n - **radius**: The maximal radius (in meters).\n - **collection**: The name of the collection to query.\n - **latitude**: The latitude of the coordinate.\n - **limit**: The maximal amount of documents to return. The *skip* is\n applied before the *limit* restriction. The default is 100. (optional)\n - **geo**: If given, the identifier of the geo-index to use. (optional)\n\n\n\n\n\nThis will find all documents within a given radius around the coordinate\n(*latitude*, *longitude*). The returned list is sorted by distance.\n\nIn order to use the *within* operator, a geo index must be defined for\nthe collection. This index also defines which attribute holds the\ncoordinates for the document. If you have more than one geo-spatial index,\nyou can use the *geo* field to select a particular index.\n\n\nReturns a cursor containing the result, see [Http Cursor](../AqlQueryCursor/README.md) for details.\n\nNote: the *within* simple query is **deprecated** as of ArangoDB 2.6. \nThis API may be removed in future versions of ArangoDB. The preferred\nway for retrieving documents from a collection using the near operator is\nto issue an [AQL query](../../AQL/Functions/Geo.html) using the *WITHIN* function as follows: \n\n\n FOR doc IN WITHIN(@@collection, @latitude, @longitude, @radius, @distanceAttributeName)\n RETURN doc\n\n\n\n\n#Example:\n Without distance\n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/simple/near <<EOF\n{ \n  \"collection\" : \"products\", \n  \"latitude\" : 0, \n  \"longitude\" : 0, \n  \"skip\" : 1, \n  \"limit\" : 2, \n  \"radius\" : 500 \n}\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"result\" : [ \n    { \n      \"_key\" : \"11159\", \n      \"_id\" : \"products/11159\", \n      \"_rev\" : \"_V_qENjK---\", \n      \"name\" : \"Name/0.002/\", \n      \"loc\" : [ \n        0.002, \n        0 \n      ] \n    }, \n    { \n      \"_key\" : \"11153\", \n      \"_id\" : \"products/11153\", \n      \"_rev\" : \"_V_qENjG---\", \n      \"name\" : \"Name/-0.002/\", \n      \"loc\" : [ \n        -0.002, \n        0 \n      ] \n    } \n  ], \n  \"hasMore\" : false, \n  \"count\" : 2, \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n#Example:\n With distance\n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/simple/near <<EOF\n{ \n  \"collection\" : \"products\", \n  \"latitude\" : 0, \n  \"longitude\" : 0, \n  \"skip\" : 1, \n  \"limit\" : 3, \n  \"distance\" : \"distance\", \n  \"radius\" : 300 \n}\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"result\" : [ \n    { \n      \"distance\" : 222.38985328911744, \n      \"_id\" : \"products/11196\", \n      \"_key\" : \"11196\", \n      \"_rev\" : \"_V_qEN0W---\", \n      \"loc\" : [ \n        -0.002, \n        0 \n      ], \n      \"name\" : \"Name/-0.002/\" \n    }, \n    { \n      \"distance\" : 222.38985328911744, \n      \"_id\" : \"products/11202\", \n      \"_key\" : \"11202\", \n      \"_rev\" : \"_V_qEN0a---\", \n      \"loc\" : [ \n        0.002, \n        0 \n      ], \n      \"name\" : \"Name/0.002/\" \n    }, \n    { \n      \"distance\" : 444.779706578235, \n      \"_id\" : \"products/11193\", \n      \"_key\" : \"11193\", \n      \"_rev\" : \"_V_qEN0S--_\", \n      \"loc\" : [ \n        -0.004, \n        0 \n      ], \n      \"name\" : \"Name/-0.004/\" \n    } \n  ], \n  \"hasMore\" : false, \n  \"count\" : 3, \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n", "parameters": [ { "in": "body", "name": "Json Request Body", "required": true, "schema": { "$ref": "#/definitions/JSA_put_api_simple_within" }, "x-description-offset": 61 } ], "responses": { "201": { "description": "is returned if the query was executed successfully.\n\n" }, "400": { "description": "is returned if the body does not contain a valid JSON representation of a\nquery. The response body contains an error document in this case.\n\n" }, "404": { "description": "is returned if the collection specified by *collection* is unknown. The\nresponse body contains an error document in this case.\n\n" } }, "summary": " Find documents within a radius around a coordinate", "tags": [ "Simple Queries" ], "x-examples": [], "x-filename": "Simple Queries - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_all.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_any.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_first_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_fulltext.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_near.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_range.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_remove_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_replace_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_update_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_within.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_within_rectangle.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\RestLookupByKeys.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\RestRemoveByKeys.md" } }, "/_api/simple/within-rectangle": { "put": { "description": "\n**A json post document with these Properties is required:**\n\n - **latitude1**: The latitude of the first rectangle coordinate.\n - **skip**: The number of documents to skip in the query. (optional)\n - **latitude2**: The latitude of the second rectangle coordinate.\n - **longitude2**: The longitude of the second rectangle coordinate.\n - **longitude1**: The longitude of the first rectangle coordinate.\n - **limit**: The maximal amount of documents to return. The *skip* is\n applied before the *limit* restriction. The default is 100. (optional)\n - **collection**: The name of the collection to query.\n - **geo**: If given, the identifier of the geo-index to use. (optional)\n\n\n\n\n\nThis will find all documents within the specified rectangle (determined by\nthe given coordinates (*latitude1*, *longitude1*, *latitude2*, *longitude2*). \n\nIn order to use the *within-rectangle* query, a geo index must be defined for\nthe collection. This index also defines which attribute holds the\ncoordinates for the document. If you have more than one geo-spatial index,\nyou can use the *geo* field to select a particular index.\n\nReturns a cursor containing the result, see [Http Cursor](../AqlQueryCursor/README.md) for details.\n\n\n\n\n#Example:\n \n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/simple/within-rectangle <<EOF\n{ \n  \"collection\" : \"products\", \n  \"latitude1\" : 0, \n  \"longitude1\" : 0, \n  \"latitude2\" : 0.2, \n  \"longitude2\" : 0.2, \n  \"skip\" : 1, \n  \"limit\" : 2 \n}\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"result\" : [ \n    { \n      \"_key\" : \"11254\", \n      \"_id\" : \"products/11254\", \n      \"_rev\" : \"_V_qEODO---\", \n      \"name\" : \"Name/0.008/\", \n      \"loc\" : [ \n        0.008, \n        0 \n      ] \n    }, \n    { \n      \"_key\" : \"11251\", \n      \"_id\" : \"products/11251\", \n      \"_rev\" : \"_V_qEODK--_\", \n      \"name\" : \"Name/0.006/\", \n      \"loc\" : [ \n        0.006, \n        0 \n      ] \n    } \n  ], \n  \"hasMore\" : false, \n  \"count\" : 2, \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n", "parameters": [ { "in": "body", "name": "Json Request Body", "required": true, "schema": { "$ref": "#/definitions/JSA_put_api_simple_within_rectangle" }, "x-description-offset": 61 } ], "responses": { "201": { "description": "is returned if the query was executed successfully.\n\n" }, "400": { "description": "is returned if the body does not contain a valid JSON representation of a\nquery. The response body contains an error document in this case.\n\n" }, "404": { "description": "is returned if the collection specified by *collection* is unknown. The\nresponse body contains an error document in this case.\n\n" } }, "summary": " Within rectangle query", "tags": [ "Simple Queries" ], "x-examples": [], "x-filename": "Simple Queries - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_all.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_any.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_first_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_fulltext.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_near.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_range.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_remove_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_replace_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_update_by_example.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_within.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\JSA_put_api_simple_within_rectangle.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\RestLookupByKeys.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Simple Queries\\RestRemoveByKeys.md" } }, "/_api/tasks": { "post": { "description": "\n**A json post document with these Properties is required:**\n\n - **params**: The parameters to be passed into command\n - **offset**: Number of seconds initial delay \n - **command**: The JavaScript code to be executed\n - **name**: The name of the task\n - **period**: number of seconds between the executions\n\n\n\n\ncreates a new task with a generated id\n\n\n\n\n#Example:\n \n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/tasks/ <<EOF\n{ \n  \"name\" : \"SampleTask\", \n  \"command\" : \"(function(params) { require('@arangodb').print(params); })(params)\", \n  \"params\" : { \n    \"foo\" : \"bar\", \n    \"bar\" : \"foo\" \n  }, \n  \"period\" : 2 \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"id\" : \"11265\", \n  \"name\" : \"SampleTask\", \n  \"created\" : 1495102013.598057, \n  \"type\" : \"periodic\", \n  \"period\" : 2, \n  \"offset\" : 0, \n  \"command\" : \"(function (params) { (function(params) { require('@arangodb').print(params); })(params) } )(params);\", \n  \"database\" : \"_system\", \n  \"error\" : false, \n  \"code\" : 200 \n}\nshell> curl -X DELETE --dump - http://localhost:8529/_api/tasks/11265\n\n
\n\n\n\n\n", "parameters": [ { "in": "body", "name": "Json Request Body", "required": true, "schema": { "$ref": "#/definitions/JSF_post_api_new_tasks" }, "x-description-offset": 61 } ], "responses": { "400": { "description": "If the post body is not accurate, a *HTTP 400* is returned.\n\n" } }, "summary": " creates a task", "tags": [ "Administration" ], "x-examples": [], "x-filename": "Administration - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_delete_api_tasks.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_database_version.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_echo.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_long_echo.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_modules_flush.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_routing_reloads.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_server_id.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_server_role.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_sleep.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_statistics.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_statistics_description.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_time.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_cluster_endpoints.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_endpoint.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_initiate.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_return.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_tasks.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_tasks_all.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_engine.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_post_admin_execute.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_post_admin_test.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_post_api_new_tasks.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_put_api_new_tasks.md" } }, "/_api/tasks/": { "get": { "description": "\n\nfetches all existing tasks on the server\n\n\n\n\n#Example:\n Fetching all tasks\n\n
shell> curl --dump - http://localhost:8529/_api/tasks\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n[ \n  { \n    \"id\" : \"statistics-gc\", \n    \"name\" : \"statistics-gc\", \n    \"created\" : 1495101934.622188, \n    \"type\" : \"periodic\", \n    \"period\" : 450, \n    \"offset\" : 310.474142, \n    \"command\" : \"(function (params) { require('@arangodb/statistics').garbageCollector(); } )(params);\", \n    \"database\" : \"_system\" \n  }, \n  { \n    \"id\" : \"statistics-average-collector\", \n    \"name\" : \"statistics-average-collector\", \n    \"created\" : 1495101934.621944, \n    \"type\" : \"periodic\", \n    \"period\" : 900, \n    \"offset\" : 20, \n    \"command\" : \"(function (params) { require('@arangodb/statistics').historianAverage(); } )(params);\", \n    \"database\" : \"_system\" \n  }, \n  { \n    \"id\" : \"statistics-collector\", \n    \"name\" : \"statistics-collector\", \n    \"created\" : 1495101934.621666, \n    \"type\" : \"periodic\", \n    \"period\" : 10, \n    \"offset\" : 1, \n    \"command\" : \"(function (params) { require('@arangodb/statistics').historian(); } )(params);\", \n    \"database\" : \"_system\" \n  }, \n  { \n    \"id\" : \"88\", \n    \"name\" : \"user-defined task\", \n    \"created\" : 1495101925.030978, \n    \"type\" : \"periodic\", \n    \"period\" : 1, \n    \"offset\" : 0.000001, \n    \"command\" : \"(function (params) { (function () {\\n        require('@arangodb/foxx/queues/manager').manage();\\n      })(params) } )(params);\", \n    \"database\" : \"_system\" \n  } \n]\n
\n\n\n\n\n", "parameters": [], "responses": { "200": { "description": "The list of tasks\n\n" } }, "summary": " Fetch all tasks or one task", "tags": [ "Administration" ], "x-examples": [], "x-filename": "Administration - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_delete_api_tasks.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_database_version.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_echo.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_long_echo.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_modules_flush.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_routing_reloads.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_server_id.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_server_role.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_sleep.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_statistics.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_statistics_description.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_time.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_cluster_endpoints.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_endpoint.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_initiate.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_return.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_tasks.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_tasks_all.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_engine.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_post_admin_execute.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_post_admin_test.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_post_api_new_tasks.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_put_api_new_tasks.md" } }, "/_api/tasks/{id}": { "delete": { "description": "\n\nDeletes the task identified by *id* on the server. \n\n\n\n\n#Example:\n trying to delete non existing task\n\n
shell> curl -X DELETE --dump - http://localhost:8529/_api/tasks/NoTaskWithThatName\n\nHTTP/1.1 404 Not Found\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"error\" : true, \n  \"code\" : 404, \n  \"errorNum\" : 1852, \n  \"errorMessage\" : \"task not found\" \n}\n
\n\n\n\n\n#Example:\n Remove existing Task\n\n
shell> curl -X DELETE --dump - http://localhost:8529/_api/tasks/SampleTask\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n", "parameters": [ { "description": "The id of the task to delete.\n\n", "format": "string", "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "404": { "description": "If the task *id* is unknown, then an *HTTP 404* is returned.\n\n" } }, "summary": " deletes the task with id", "tags": [ "Administration" ], "x-examples": [], "x-filename": "Administration - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_delete_api_tasks.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_database_version.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_echo.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_long_echo.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_modules_flush.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_routing_reloads.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_server_id.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_server_role.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_sleep.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_statistics.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_statistics_description.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_time.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_cluster_endpoints.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_endpoint.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_initiate.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_return.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_tasks.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_tasks_all.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_engine.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_post_admin_execute.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_post_admin_test.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_post_api_new_tasks.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_put_api_new_tasks.md" }, "get": { "description": "\n\nfetches one existing tasks on the server specified by *id*\n\n\n\n\n#Example:\n Fetching a single task by its id\n\n
shell> curl --dump - http://localhost:8529/_api/tasks/statistics-average-collector\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"id\" : \"statistics-average-collector\", \n  \"name\" : \"statistics-average-collector\", \n  \"created\" : 1495101934.621944, \n  \"type\" : \"periodic\", \n  \"period\" : 900, \n  \"offset\" : 20, \n  \"command\" : \"(function (params) { require('@arangodb/statistics').historianAverage(); } )(params);\", \n  \"database\" : \"_system\", \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n#Example:\n trying to fetch a non-existing task\n\n
shell> curl --dump - http://localhost:8529/_api/tasks/non-existing-task\n\nHTTP/1.1 404 Not Found\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"error\" : true, \n  \"code\" : 404, \n  \"errorNum\" : 1852, \n  \"errorMessage\" : \"task not found\" \n}\n
\n\n\n\n\n", "parameters": [ { "description": "The id of the task to fetch.\n\n", "format": "string", "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "200": { "description": "The requested task\n\n" } }, "summary": " Fetch one task with id", "tags": [ "Administration" ], "x-examples": [], "x-filename": "Administration - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_delete_api_tasks.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_database_version.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_echo.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_long_echo.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_modules_flush.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_routing_reloads.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_server_id.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_server_role.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_sleep.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_statistics.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_statistics_description.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_time.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_cluster_endpoints.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_endpoint.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_initiate.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_return.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_tasks.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_tasks_all.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_engine.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_post_admin_execute.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_post_admin_test.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_post_api_new_tasks.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_put_api_new_tasks.md" }, "put": { "description": "\n**A json post document with these Properties is required:**\n\n - **params**: The parameters to be passed into command\n - **offset**: Number of seconds initial delay \n - **command**: The JavaScript code to be executed\n - **name**: The name of the task\n - **period**: number of seconds between the executions\n\n\n\n\nregisters a new task with the specified id\n\n\n\n\n#Example:\n \n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/tasks/sampleTask <<EOF\n{ \n  \"id\" : \"SampleTask\", \n  \"name\" : \"SampleTask\", \n  \"command\" : \"(function(params) { require('@arangodb').print(params); })(params)\", \n  \"params\" : { \n    \"foo\" : \"bar\", \n    \"bar\" : \"foo\" \n  }, \n  \"period\" : 2 \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"id\" : \"sampleTask\", \n  \"name\" : \"SampleTask\", \n  \"created\" : 1495102013.635841, \n  \"type\" : \"periodic\", \n  \"period\" : 2, \n  \"offset\" : 0, \n  \"command\" : \"(function (params) { (function(params) { require('@arangodb').print(params); })(params) } )(params);\", \n  \"database\" : \"_system\", \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n", "parameters": [ { "description": "The id of the task to create\n\n", "format": "string", "in": "path", "name": "id", "required": true, "type": "string" }, { "in": "body", "name": "Json Request Body", "required": true, "schema": { "$ref": "#/definitions/JSF_put_api_new_tasks" }, "x-description-offset": 61 } ], "responses": { "400": { "description": "If the task *id* already exists or the rest body is not accurate, *HTTP 400* is returned.\n\n" } }, "summary": " creates a task with id", "tags": [ "Administration" ], "x-examples": [], "x-filename": "Administration - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_delete_api_tasks.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_database_version.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_echo.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_long_echo.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_modules_flush.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_routing_reloads.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_server_id.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_server_role.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_sleep.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_statistics.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_statistics_description.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_time.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_cluster_endpoints.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_endpoint.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_initiate.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_return.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_tasks.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_tasks_all.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_engine.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_post_admin_execute.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_post_admin_test.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_post_api_new_tasks.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_put_api_new_tasks.md" } }, "/_api/transaction": { "post": { "description": "\n**A json post document with these Properties is required:**\n\n - **action**: the actual transaction operations to be executed, in the\n form of stringified JavaScript code. The code will be executed on server\n side, with late binding. It is thus critical that the code specified in\n *action* properly sets up all the variables it needs.\n If the code specified in *action* ends with a return statement, the\n value returned will also be returned by the REST API in the *result*\n attribute if the transaction committed successfully.\n - **params**: optional arguments passed to *action*.\n - **collections**: *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\n collection name as string. Collections that will be written to in the\n transaction must be declared with the *write* attribute or it will fail,\n whereas non-declared collections from which is solely read will be added lazily.\n The optional sub-attribute *allowImplicit* can be set to *false* to let\n transactions fail in case of undeclared collections for reading. Collections\n for reading should be fully declared if possible, to avoid deadlocks.\n - **lockTimeout**: an optional numeric value that can be used to set a\n timeout for waiting on collection locks. If not specified, a default\n value will be used. Setting *lockTimeout* to *0* will make ArangoDB\n not time out waiting for a lock.\n - **waitForSync**: an optional boolean flag that, if set, will force the\n transaction to write all data to disk before returning.\n\n\n\n\n\nContains the *collections* and *action*.\n\nThe transaction description must be passed in the body of the POST request.\n\nIf the transaction is fully executed and committed on the server,\n*HTTP 200* will be returned. Additionally, the return value of the\ncode defined in *action* will be returned in the *result* attribute.\n\nFor successfully committed transactions, the returned JSON object has the\nfollowing properties:\n\n- *error*: boolean flag to indicate if an error occurred (*false*\n in this case)\n\n- *code*: the HTTP status code\n\n- *result*: the return value of the transaction\n\nIf the transaction specification is either missing or malformed, the server\nwill respond with *HTTP 400*.\n\nThe body of the response will then 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\nIf a transaction fails to commit, either by an exception thrown in the\n*action* code, or by an internal error, the server will respond with\nan error.\nAny other errors will be returned with any of the return codes\n*HTTP 400*, *HTTP 409*, or *HTTP 500*.\n\n\n\n\n#Example:\n Executing a transaction on a single collection\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/transaction <<EOF\n{ \n  \"collections\" : { \n    \"write\" : \"products\" \n  }, \n  \"action\" : \"function () { var db = require('@arangodb').db; db.products.save({});  return db.products.count(); }\" \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"result\" : 1, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n#Example:\n Executing a transaction using multiple collections\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/transaction <<EOF\n{ \n  \"collections\" : { \n    \"write\" : [ \n      \"products\", \n      \"materials\" \n    ] \n  }, \n  \"action\" : \"function () {var db = require('@arangodb').db;db.products.save({});db.materials.save({});return 'worked!';}\" \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"result\" : \"worked!\", \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n#Example:\n Aborting a transaction due to an internal error\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/transaction <<EOF\n{ \n  \"collections\" : { \n    \"write\" : \"products\" \n  }, \n  \"action\" : \"function () {var db = require('@arangodb').db;db.products.save({ _key: 'abc'});db.products.save({ _key: 'abc'});}\" \n}\nEOF\n\nHTTP/1.1 400 Bad Request\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"exception\" : \"ArangoError 1210: unique constraint violated\", \n  \"stacktrace\" : [ \n    \"ArangoError: unique constraint violated\", \n    \"    at eval (eval at post_api_transaction (/local/home/willi/src/devel/js/actions/api-transaction.js:48:16), <anonymous>:3:100)\", \n    \"    at eval (eval at post_api_transaction (/local/home/willi/src/devel/js/actions/api-transaction.js:48:16), <anonymous>:3:123)\", \n    \"    at post_api_transaction (/local/home/willi/src/devel/js/actions/api-transaction.js:48:16)\", \n    \"    at Function.callback (/local/home/willi/src/devel/js/actions/api-transaction.js:64:11)\" \n  ], \n  \"message\" : \"unique constraint violated\", \n  \"error\" : true, \n  \"code\" : 400, \n  \"errorNum\" : 1210, \n  \"errorMessage\" : \"unique constraint violated\" \n}\n
\n\n\n\n\n#Example:\n Aborting a transaction by explicitly throwing an exception\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/transaction <<EOF\n{ \n  \"collections\" : { \n    \"read\" : \"products\" \n  }, \n  \"action\" : \"function () { throw 'doh!'; }\" \n}\nEOF\n\nHTTP/1.1 500 Internal Server Error\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"exception\" : \"doh!\", \n  \"error\" : true, \n  \"code\" : 500, \n  \"errorNum\" : 500, \n  \"errorMessage\" : \"internal server error\" \n}\n
\n\n\n\n\n#Example:\n Referring to a non-existing collection\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/transaction <<EOF\n{ \n  \"collections\" : { \n    \"read\" : \"products\" \n  }, \n  \"action\" : \"function () { return true; }\" \n}\nEOF\n\nHTTP/1.1 404 Not Found\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"exception\" : \"ArangoError 1203: collection not found: products\", \n  \"stacktrace\" : [ \n    \"ArangoError: collection not found: products\", \n    \"    at post_api_transaction (/local/home/willi/src/devel/js/actions/api-transaction.js:48:16)\", \n    \"    at Function.callback (/local/home/willi/src/devel/js/actions/api-transaction.js:64:11)\" \n  ], \n  \"message\" : \"collection not found: products\", \n  \"error\" : true, \n  \"code\" : 404, \n  \"errorNum\" : 1203, \n  \"errorMessage\" : \"collection not found: products\" \n}\n
\n\n\n\n\n", "parameters": [ { "in": "body", "name": "Json Request Body", "required": true, "schema": { "$ref": "#/definitions/JSF_post_api_transaction" }, "x-description-offset": 61 } ], "responses": { "200": { "description": "If the transaction is fully executed and committed on the server,\n*HTTP 200* will be returned.\n\n" }, "400": { "description": "If the transaction specification is either missing or malformed, the server\nwill respond with *HTTP 400*.\n\n" }, "404": { "description": "If the transaction specification contains an unknown collection, the server\nwill respond with *HTTP 404*.\n\n" }, "500": { "description": "Exceptions thrown by users will make the server respond with a return code of\n*HTTP 500*\n\n" } }, "summary": " Execute transaction", "tags": [ "Transactions" ], "x-examples": [], "x-filename": "Transactions - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Transactions\\JSF_post_api_transaction.md" } }, "/_api/traversal": { "post": { "description": "\n\nStarts a traversal starting from a given vertex and following.\nedges contained in a given edgeCollection. The request must\ncontain the following attributes.\n\n\n**A json post document with these Properties is required:**\n\n - **sort**: body (JavaScript) code of a custom comparison function\n for the edges. The signature of this function is\n *(l, r) -> integer* (where l and r are edges) and must\n return -1 if l is smaller than, +1 if l is greater than,\n and 0 if l and r are equal. The reason for this is the\n following: The order of edges returned for a certain\n vertex is undefined. This is because there is no natural\n order of edges for a vertex with multiple connected edges.\n To explicitly define the order in which edges on the\n vertex are followed, you can specify an edge comparator\n function with this attribute. Note that the value here has\n to be a string to conform to the JSON standard, which in\n turn is parsed as function body on the server side. Furthermore\n note that this attribute is only used for the standard\n expanders. If you use your custom expander you have to\n do the sorting yourself within the expander code.\n - **direction**: direction for traversal\n - *if set*, must be either *\"outbound\"*, *\"inbound\"*, or *\"any\"*\n - *if not set*, the *expander* attribute must be specified\n - **minDepth**: ANDed with any existing filters):\n visits only nodes in at least the given depth\n - **startVertex**: id of the startVertex, e.g. *\"users/foo\"*.\n - **visitor**: body (JavaScript) code of custom visitor function\n function signature: *(config, result, vertex, path, connected) -> void*\n The visitor function can do anything, but its return value is ignored. To\n populate a result, use the *result* variable by reference. Note that the\n *connected* argument is only populated when the *order* attribute is set\n to *\"preorder-expander\"*.\n - **itemOrder**: item iteration order can be *\"forward\"* or *\"backward\"*\n - **strategy**: traversal strategy can be *\"depthfirst\"* or *\"breadthfirst\"*\n - **filter**: default is to include all nodes:\n body (JavaScript code) of custom filter function\n function signature: *(config, vertex, path) -> mixed*\n can 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 it's 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 - **init**: body (JavaScript) code of custom result initialization function\n function signature: *(config, result) -> void*\n initialize any values in result with what is required\n - **maxIterations**: Maximum number of iterations in each traversal. This number can be\n set to prevent endless loops in traversal of cyclic graphs. When a traversal performs\n as many iterations as the *maxIterations* value, the traversal will abort with an\n error. If *maxIterations* is not set, a server-defined value may be used.\n - **maxDepth**: ANDed with any existing filters visits only nodes in at most the given depth\n - **uniqueness**: specifies uniqueness for vertices and edges visited.\n If set, must be an object like this:\n `\"uniqueness\": {\"vertices\": \"none\"|\"global\"|\"path\", \"edges\": \"none\"|\"global\"|\"path\"}`\n - **order**: traversal order can be *\"preorder\"*, *\"postorder\"* or *\"preorder-expander\"*\n - **graphName**: name of the graph that contains the edges.\n Either *edgeCollection* or *graphName* has to be given.\n In case both values are set the *graphName* is prefered.\n - **expander**: body (JavaScript) code of custom expander function\n *must* be set if *direction* attribute is **not** set\n function signature: *(config, vertex, path) -> array*\n expander must return an array of the connections for *vertex*\n each connection is an object with the attributes *edge* and *vertex*\n - **edgeCollection**: name of the collection that contains the edges.\n\n\n\n\n\nIf the Traversal is successfully executed *HTTP 200* will be returned.\nAdditionally the *result* object will be returned by the traversal.\n\nFor successful traversals, the returned JSON object has the\nfollowing properties:\n\n- *error*: boolean flag to indicate if an error occurred (*false*\n in this case)\n\n- *code*: the HTTP status code\n\n- *result*: the return value of the traversal\n\nIf the traversal specification is either missing or malformed, the server\nwill respond with *HTTP 400*.\n\nThe body of the response will then 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\n\n\n\n#Example:\n In the following examples the underlying graph will contain five persons\n*Alice*, *Bob*, *Charlie*, *Dave* and *Eve*.\nWe will have the following directed relations:\n\n- *Alice* knows *Bob*\n- *Bob* knows *Charlie*\n- *Bob* knows *Dave*\n- *Eve* knows *Alice*\n- *Eve* knows *Bob*\n\nThe starting vertex will always be Alice.\n\nFollow only outbound edges\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF\n{ \n  \"startVertex\" : \"persons/alice\", \n  \"graphName\" : \"knows_graph\", \n  \"direction\" : \"outbound\" \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"result\" : { \n    \"visited\" : { \n      \"vertices\" : [ \n        { \n          \"_key\" : \"alice\", \n          \"_id\" : \"persons/alice\", \n          \"_rev\" : \"_V_qER5C---\", \n          \"name\" : \"Alice\" \n        }, \n        { \n          \"_key\" : \"bob\", \n          \"_id\" : \"persons/bob\", \n          \"_rev\" : \"_V_qER5G---\", \n          \"name\" : \"Bob\" \n        }, \n        { \n          \"_key\" : \"charlie\", \n          \"_id\" : \"persons/charlie\", \n          \"_rev\" : \"_V_qER5G--_\", \n          \"name\" : \"Charlie\" \n        }, \n        { \n          \"_key\" : \"dave\", \n          \"_id\" : \"persons/dave\", \n          \"_rev\" : \"_V_qER5G--A\", \n          \"name\" : \"Dave\" \n        } \n      ], \n      \"paths\" : [ \n        { \n          \"edges\" : [ ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_V_qER5C---\", \n              \"name\" : \"Alice\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"12038\", \n              \"_id\" : \"knows/12038\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_V_qER5K--_\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_V_qER5C---\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"_V_qER5G---\", \n              \"name\" : \"Bob\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"12038\", \n              \"_id\" : \"knows/12038\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_V_qER5K--_\" \n            }, \n            { \n              \"_key\" : \"12042\", \n              \"_id\" : \"knows/12042\", \n              \"_from\" : \"persons/bob\", \n              \"_to\" : \"persons/charlie\", \n              \"_rev\" : \"_V_qER5K--A\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_V_qER5C---\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"_V_qER5G---\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"charlie\", \n              \"_id\" : \"persons/charlie\", \n              \"_rev\" : \"_V_qER5G--_\", \n              \"name\" : \"Charlie\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"12038\", \n              \"_id\" : \"knows/12038\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_V_qER5K--_\" \n            }, \n            { \n              \"_key\" : \"12045\", \n              \"_id\" : \"knows/12045\", \n              \"_from\" : \"persons/bob\", \n              \"_to\" : \"persons/dave\", \n              \"_rev\" : \"_V_qER5O---\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_V_qER5C---\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"_V_qER5G---\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"dave\", \n              \"_id\" : \"persons/dave\", \n              \"_rev\" : \"_V_qER5G--A\", \n              \"name\" : \"Dave\" \n            } \n          ] \n        } \n      ] \n    } \n  }, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n#Example:\n Follow only inbound edges\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF\n{ \n  \"startVertex\" : \"persons/alice\", \n  \"graphName\" : \"knows_graph\", \n  \"direction\" : \"inbound\" \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"result\" : { \n    \"visited\" : { \n      \"vertices\" : [ \n        { \n          \"_key\" : \"alice\", \n          \"_id\" : \"persons/alice\", \n          \"_rev\" : \"_V_qEQvG---\", \n          \"name\" : \"Alice\" \n        }, \n        { \n          \"_key\" : \"eve\", \n          \"_id\" : \"persons/eve\", \n          \"_rev\" : \"_V_qEQvO--_\", \n          \"name\" : \"Eve\" \n        } \n      ], \n      \"paths\" : [ \n        { \n          \"edges\" : [ ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_V_qEQvG---\", \n              \"name\" : \"Alice\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11775\", \n              \"_id\" : \"knows/11775\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/alice\", \n              \"_rev\" : \"_V_qEQva---\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_V_qEQvG---\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"eve\", \n              \"_id\" : \"persons/eve\", \n              \"_rev\" : \"_V_qEQvO--_\", \n              \"name\" : \"Eve\" \n            } \n          ] \n        } \n      ] \n    } \n  }, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n#Example:\n Follow any direction of edges\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF\n{ \n  \"startVertex\" : \"persons/alice\", \n  \"graphName\" : \"knows_graph\", \n  \"direction\" : \"any\", \n  \"uniqueness\" : { \n    \"vertices\" : \"none\", \n    \"edges\" : \"global\" \n  } \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"result\" : { \n    \"visited\" : { \n      \"vertices\" : [ \n        { \n          \"_key\" : \"alice\", \n          \"_id\" : \"persons/alice\", \n          \"_rev\" : \"_V_qEPCC---\", \n          \"name\" : \"Alice\" \n        }, \n        { \n          \"_key\" : \"bob\", \n          \"_id\" : \"persons/bob\", \n          \"_rev\" : \"_V_qEPCC--_\", \n          \"name\" : \"Bob\" \n        }, \n        { \n          \"_key\" : \"charlie\", \n          \"_id\" : \"persons/charlie\", \n          \"_rev\" : \"_V_qEPCG---\", \n          \"name\" : \"Charlie\" \n        }, \n        { \n          \"_key\" : \"dave\", \n          \"_id\" : \"persons/dave\", \n          \"_rev\" : \"_V_qEPCG--_\", \n          \"name\" : \"Dave\" \n        }, \n        { \n          \"_key\" : \"eve\", \n          \"_id\" : \"persons/eve\", \n          \"_rev\" : \"_V_qEPCG--A\", \n          \"name\" : \"Eve\" \n        }, \n        { \n          \"_key\" : \"alice\", \n          \"_id\" : \"persons/alice\", \n          \"_rev\" : \"_V_qEPCC---\", \n          \"name\" : \"Alice\" \n        } \n      ], \n      \"paths\" : [ \n        { \n          \"edges\" : [ ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_V_qEPCC---\", \n              \"name\" : \"Alice\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11336\", \n              \"_id\" : \"knows/11336\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_V_qEPCK---\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_V_qEPCC---\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"_V_qEPCC--_\", \n              \"name\" : \"Bob\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11336\", \n              \"_id\" : \"knows/11336\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_V_qEPCK---\" \n            }, \n            { \n              \"_key\" : \"11340\", \n              \"_id\" : \"knows/11340\", \n              \"_from\" : \"persons/bob\", \n              \"_to\" : \"persons/charlie\", \n              \"_rev\" : \"_V_qEPCO---\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_V_qEPCC---\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"_V_qEPCC--_\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"charlie\", \n              \"_id\" : \"persons/charlie\", \n              \"_rev\" : \"_V_qEPCG---\", \n              \"name\" : \"Charlie\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11336\", \n              \"_id\" : \"knows/11336\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_V_qEPCK---\" \n            }, \n            { \n              \"_key\" : \"11343\", \n              \"_id\" : \"knows/11343\", \n              \"_from\" : \"persons/bob\", \n              \"_to\" : \"persons/dave\", \n              \"_rev\" : \"_V_qEPCO--_\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_V_qEPCC---\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"_V_qEPCC--_\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"dave\", \n              \"_id\" : \"persons/dave\", \n              \"_rev\" : \"_V_qEPCG--_\", \n              \"name\" : \"Dave\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11336\", \n              \"_id\" : \"knows/11336\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_V_qEPCK---\" \n            }, \n            { \n              \"_key\" : \"11349\", \n              \"_id\" : \"knows/11349\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_V_qEPCS--_\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_V_qEPCC---\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"_V_qEPCC--_\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"eve\", \n              \"_id\" : \"persons/eve\", \n              \"_rev\" : \"_V_qEPCG--A\", \n              \"name\" : \"Eve\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11336\", \n              \"_id\" : \"knows/11336\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_V_qEPCK---\" \n            }, \n            { \n              \"_key\" : \"11349\", \n              \"_id\" : \"knows/11349\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_V_qEPCS--_\" \n            }, \n            { \n              \"_key\" : \"11346\", \n              \"_id\" : \"knows/11346\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/alice\", \n              \"_rev\" : \"_V_qEPCS---\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_V_qEPCC---\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"_V_qEPCC--_\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"eve\", \n              \"_id\" : \"persons/eve\", \n              \"_rev\" : \"_V_qEPCG--A\", \n              \"name\" : \"Eve\" \n            }, \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_V_qEPCC---\", \n              \"name\" : \"Alice\" \n            } \n          ] \n        } \n      ] \n    } \n  }, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n#Example:\n Excluding *Charlie* and *Bob*\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF\n{ \n  \"startVertex\" : \"persons/alice\", \n  \"graphName\" : \"knows_graph\", \n  \"direction\" : \"outbound\", \n  \"filter\" : \"if (vertex.name === \\\"Bob\\\" ||     vertex.name === \\\"Charlie\\\") {  return \\\"exclude\\\";}return;\" \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"result\" : { \n    \"visited\" : { \n      \"vertices\" : [ \n        { \n          \"_key\" : \"alice\", \n          \"_id\" : \"persons/alice\", \n          \"_rev\" : \"_V_qEQLa---\", \n          \"name\" : \"Alice\" \n        }, \n        { \n          \"_key\" : \"dave\", \n          \"_id\" : \"persons/dave\", \n          \"_rev\" : \"_V_qEQLe--_\", \n          \"name\" : \"Dave\" \n        } \n      ], \n      \"paths\" : [ \n        { \n          \"edges\" : [ ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_V_qEQLa---\", \n              \"name\" : \"Alice\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11650\", \n              \"_id\" : \"knows/11650\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_V_qEQLi--_\" \n            }, \n            { \n              \"_key\" : \"11657\", \n              \"_id\" : \"knows/11657\", \n              \"_from\" : \"persons/bob\", \n              \"_to\" : \"persons/dave\", \n              \"_rev\" : \"_V_qEQLm--_\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_V_qEQLa---\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"_V_qEQLa--_\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"dave\", \n              \"_id\" : \"persons/dave\", \n              \"_rev\" : \"_V_qEQLe--_\", \n              \"name\" : \"Dave\" \n            } \n          ] \n        } \n      ] \n    } \n  }, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n#Example:\n Do not follow edges from *Bob*\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF\n{ \n  \"startVertex\" : \"persons/alice\", \n  \"graphName\" : \"knows_graph\", \n  \"direction\" : \"outbound\", \n  \"filter\" : \"if (vertex.name === \\\"Bob\\\") {return \\\"prune\\\";}return;\" \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"result\" : { \n    \"visited\" : { \n      \"vertices\" : [ \n        { \n          \"_key\" : \"alice\", \n          \"_id\" : \"persons/alice\", \n          \"_rev\" : \"_V_qEQcu---\", \n          \"name\" : \"Alice\" \n        }, \n        { \n          \"_key\" : \"bob\", \n          \"_id\" : \"persons/bob\", \n          \"_rev\" : \"_V_qEQcy---\", \n          \"name\" : \"Bob\" \n        } \n      ], \n      \"paths\" : [ \n        { \n          \"edges\" : [ ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_V_qEQcu---\", \n              \"name\" : \"Alice\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11710\", \n              \"_id\" : \"knows/11710\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_V_qEQc6---\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_V_qEQcu---\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"_V_qEQcy---\", \n              \"name\" : \"Bob\" \n            } \n          ] \n        } \n      ] \n    } \n  }, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n#Example:\n Visit only nodes in a depth of at least 2\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF\n{ \n  \"startVertex\" : \"persons/alice\", \n  \"graphName\" : \"knows_graph\", \n  \"direction\" : \"outbound\", \n  \"minDepth\" : 2 \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"result\" : { \n    \"visited\" : { \n      \"vertices\" : [ \n        { \n          \"_key\" : \"charlie\", \n          \"_id\" : \"persons/charlie\", \n          \"_rev\" : \"_V_qERnS---\", \n          \"name\" : \"Charlie\" \n        }, \n        { \n          \"_key\" : \"dave\", \n          \"_id\" : \"persons/dave\", \n          \"_rev\" : \"_V_qERnS--_\", \n          \"name\" : \"Dave\" \n        } \n      ], \n      \"paths\" : [ \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11978\", \n              \"_id\" : \"knows/11978\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_V_qERnW--_\" \n            }, \n            { \n              \"_key\" : \"11982\", \n              \"_id\" : \"knows/11982\", \n              \"_from\" : \"persons/bob\", \n              \"_to\" : \"persons/charlie\", \n              \"_rev\" : \"_V_qERna---\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_V_qERnO---\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"_V_qERnO--_\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"charlie\", \n              \"_id\" : \"persons/charlie\", \n              \"_rev\" : \"_V_qERnS---\", \n              \"name\" : \"Charlie\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11978\", \n              \"_id\" : \"knows/11978\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_V_qERnW--_\" \n            }, \n            { \n              \"_key\" : \"11985\", \n              \"_id\" : \"knows/11985\", \n              \"_from\" : \"persons/bob\", \n              \"_to\" : \"persons/dave\", \n              \"_rev\" : \"_V_qERna--_\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_V_qERnO---\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"_V_qERnO--_\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"dave\", \n              \"_id\" : \"persons/dave\", \n              \"_rev\" : \"_V_qERnS--_\", \n              \"name\" : \"Dave\" \n            } \n          ] \n        } \n      ] \n    } \n  }, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n#Example:\n Visit only nodes in a depth of at most 1\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF\n{ \n  \"startVertex\" : \"persons/alice\", \n  \"graphName\" : \"knows_graph\", \n  \"direction\" : \"outbound\", \n  \"maxDepth\" : 1 \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"result\" : { \n    \"visited\" : { \n      \"vertices\" : [ \n        { \n          \"_key\" : \"alice\", \n          \"_id\" : \"persons/alice\", \n          \"_rev\" : \"_V_qERDG---\", \n          \"name\" : \"Alice\" \n        }, \n        { \n          \"_key\" : \"bob\", \n          \"_id\" : \"persons/bob\", \n          \"_rev\" : \"_V_qERDG--_\", \n          \"name\" : \"Bob\" \n        } \n      ], \n      \"paths\" : [ \n        { \n          \"edges\" : [ ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_V_qERDG---\", \n              \"name\" : \"Alice\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11821\", \n              \"_id\" : \"knows/11821\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_V_qERDO---\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_V_qERDG---\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"_V_qERDG--_\", \n              \"name\" : \"Bob\" \n            } \n          ] \n        } \n      ] \n    } \n  }, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n#Example:\n Using a visitor function to return vertex ids only\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF\n{ \n  \"startVertex\" : \"persons/alice\", \n  \"graphName\" : \"knows_graph\", \n  \"direction\" : \"outbound\", \n  \"visitor\" : \"result.visited.vertices.push(vertex._id);\" \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"result\" : { \n    \"visited\" : { \n      \"vertices\" : [ \n        \"persons/alice\", \n        \"persons/bob\", \n        \"persons/charlie\", \n        \"persons/dave\" \n      ], \n      \"paths\" : [ ] \n    } \n  }, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n#Example:\n Count all visited nodes and return a list of nodes only\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF\n{ \n  \"startVertex\" : \"persons/alice\", \n  \"graphName\" : \"knows_graph\", \n  \"direction\" : \"outbound\", \n  \"init\" : \"result.visited = 0; result.myVertices = [ ];\", \n  \"visitor\" : \"result.visited++; result.myVertices.push(vertex);\" \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"result\" : { \n    \"visited\" : 4, \n    \"myVertices\" : [ \n      { \n        \"_key\" : \"alice\", \n        \"_id\" : \"persons/alice\", \n        \"_rev\" : \"_V_qESbu---\", \n        \"name\" : \"Alice\" \n      }, \n      { \n        \"_key\" : \"bob\", \n        \"_id\" : \"persons/bob\", \n        \"_rev\" : \"_V_qESby---\", \n        \"name\" : \"Bob\" \n      }, \n      { \n        \"_key\" : \"charlie\", \n        \"_id\" : \"persons/charlie\", \n        \"_rev\" : \"_V_qESby--_\", \n        \"name\" : \"Charlie\" \n      }, \n      { \n        \"_key\" : \"dave\", \n        \"_id\" : \"persons/dave\", \n        \"_rev\" : \"_V_qESby--A\", \n        \"name\" : \"Dave\" \n      } \n    ] \n  }, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n#Example:\n Expand only inbound edges of *Alice* and outbound edges of *Eve*\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF\n{ \n  \"startVertex\" : \"persons/alice\", \n  \"graphName\" : \"knows_graph\", \n  \"expander\" : \"var connections = [ ];if (vertex.name === \\\"Alice\\\") {config.datasource.getInEdges(vertex).forEach(function (e) {connections.push({ vertex: require(\\\"internal\\\").db._document(e._from), edge: e});});}if (vertex.name === \\\"Eve\\\") {config.datasource.getOutEdges(vertex).forEach(function (e) {connections.push({vertex: require(\\\"internal\\\").db._document(e._to), edge: e});});}return connections;\" \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"result\" : { \n    \"visited\" : { \n      \"vertices\" : [ \n        { \n          \"_key\" : \"alice\", \n          \"_id\" : \"persons/alice\", \n          \"_rev\" : \"_V_qESr----\", \n          \"name\" : \"Alice\" \n        }, \n        { \n          \"_key\" : \"eve\", \n          \"_id\" : \"persons/eve\", \n          \"_rev\" : \"_V_qESrG---\", \n          \"name\" : \"Eve\" \n        }, \n        { \n          \"_key\" : \"bob\", \n          \"_id\" : \"persons/bob\", \n          \"_rev\" : \"_V_qESr---_\", \n          \"name\" : \"Bob\" \n        } \n      ], \n      \"paths\" : [ \n        { \n          \"edges\" : [ ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_V_qESr----\", \n              \"name\" : \"Alice\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"12254\", \n              \"_id\" : \"knows/12254\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/alice\", \n              \"_rev\" : \"_V_qESrO---\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_V_qESr----\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"eve\", \n              \"_id\" : \"persons/eve\", \n              \"_rev\" : \"_V_qESrG---\", \n              \"name\" : \"Eve\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"12254\", \n              \"_id\" : \"knows/12254\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/alice\", \n              \"_rev\" : \"_V_qESrO---\" \n            }, \n            { \n              \"_key\" : \"12257\", \n              \"_id\" : \"knows/12257\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_V_qESrO--_\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_V_qESr----\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"eve\", \n              \"_id\" : \"persons/eve\", \n              \"_rev\" : \"_V_qESrG---\", \n              \"name\" : \"Eve\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"_V_qESr---_\", \n              \"name\" : \"Bob\" \n            } \n          ] \n        } \n      ] \n    } \n  }, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n#Example:\n Follow the *depthfirst* strategy\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF\n{ \n  \"startVertex\" : \"persons/alice\", \n  \"graphName\" : \"knows_graph\", \n  \"direction\" : \"any\", \n  \"strategy\" : \"depthfirst\" \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"result\" : { \n    \"visited\" : { \n      \"vertices\" : [ \n        { \n          \"_key\" : \"alice\", \n          \"_id\" : \"persons/alice\", \n          \"_rev\" : \"_V_qEPnu---\", \n          \"name\" : \"Alice\" \n        }, \n        { \n          \"_key\" : \"bob\", \n          \"_id\" : \"persons/bob\", \n          \"_rev\" : \"_V_qEPny---\", \n          \"name\" : \"Bob\" \n        }, \n        { \n          \"_key\" : \"charlie\", \n          \"_id\" : \"persons/charlie\", \n          \"_rev\" : \"_V_qEPny--_\", \n          \"name\" : \"Charlie\" \n        }, \n        { \n          \"_key\" : \"dave\", \n          \"_id\" : \"persons/dave\", \n          \"_rev\" : \"_V_qEPny--A\", \n          \"name\" : \"Dave\" \n        }, \n        { \n          \"_key\" : \"eve\", \n          \"_id\" : \"persons/eve\", \n          \"_rev\" : \"_V_qEPn2---\", \n          \"name\" : \"Eve\" \n        }, \n        { \n          \"_key\" : \"alice\", \n          \"_id\" : \"persons/alice\", \n          \"_rev\" : \"_V_qEPnu---\", \n          \"name\" : \"Alice\" \n        }, \n        { \n          \"_key\" : \"eve\", \n          \"_id\" : \"persons/eve\", \n          \"_rev\" : \"_V_qEPn2---\", \n          \"name\" : \"Eve\" \n        }, \n        { \n          \"_key\" : \"bob\", \n          \"_id\" : \"persons/bob\", \n          \"_rev\" : \"_V_qEPny---\", \n          \"name\" : \"Bob\" \n        }, \n        { \n          \"_key\" : \"charlie\", \n          \"_id\" : \"persons/charlie\", \n          \"_rev\" : \"_V_qEPny--_\", \n          \"name\" : \"Charlie\" \n        }, \n        { \n          \"_key\" : \"dave\", \n          \"_id\" : \"persons/dave\", \n          \"_rev\" : \"_V_qEPny--A\", \n          \"name\" : \"Dave\" \n        }, \n        { \n          \"_key\" : \"alice\", \n          \"_id\" : \"persons/alice\", \n          \"_rev\" : \"_V_qEPnu---\", \n          \"name\" : \"Alice\" \n        } \n      ], \n      \"paths\" : [ \n        { \n          \"edges\" : [ ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_V_qEPnu---\", \n              \"name\" : \"Alice\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11493\", \n              \"_id\" : \"knows/11493\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_V_qEPn6---\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_V_qEPnu---\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"_V_qEPny---\", \n              \"name\" : \"Bob\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11493\", \n              \"_id\" : \"knows/11493\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_V_qEPn6---\" \n            }, \n            { \n              \"_key\" : \"11497\", \n              \"_id\" : \"knows/11497\", \n              \"_from\" : \"persons/bob\", \n              \"_to\" : \"persons/charlie\", \n              \"_rev\" : \"_V_qEPn6--_\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_V_qEPnu---\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"_V_qEPny---\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"charlie\", \n              \"_id\" : \"persons/charlie\", \n              \"_rev\" : \"_V_qEPny--_\", \n              \"name\" : \"Charlie\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11493\", \n              \"_id\" : \"knows/11493\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_V_qEPn6---\" \n            }, \n            { \n              \"_key\" : \"11500\", \n              \"_id\" : \"knows/11500\", \n              \"_from\" : \"persons/bob\", \n              \"_to\" : \"persons/dave\", \n              \"_rev\" : \"_V_qEPn6--A\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_V_qEPnu---\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"_V_qEPny---\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"dave\", \n              \"_id\" : \"persons/dave\", \n              \"_rev\" : \"_V_qEPny--A\", \n              \"name\" : \"Dave\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11493\", \n              \"_id\" : \"knows/11493\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_V_qEPn6---\" \n            }, \n            { \n              \"_key\" : \"11506\", \n              \"_id\" : \"knows/11506\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_V_qEPo---_\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_V_qEPnu---\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"_V_qEPny---\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"eve\", \n              \"_id\" : \"persons/eve\", \n              \"_rev\" : \"_V_qEPn2---\", \n              \"name\" : \"Eve\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11493\", \n              \"_id\" : \"knows/11493\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_V_qEPn6---\" \n            }, \n            { \n              \"_key\" : \"11506\", \n              \"_id\" : \"knows/11506\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_V_qEPo---_\" \n            }, \n            { \n              \"_key\" : \"11503\", \n              \"_id\" : \"knows/11503\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/alice\", \n              \"_rev\" : \"_V_qEPo----\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_V_qEPnu---\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"_V_qEPny---\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"eve\", \n              \"_id\" : \"persons/eve\", \n              \"_rev\" : \"_V_qEPn2---\", \n              \"name\" : \"Eve\" \n            }, \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_V_qEPnu---\", \n              \"name\" : \"Alice\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11503\", \n              \"_id\" : \"knows/11503\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/alice\", \n              \"_rev\" : \"_V_qEPo----\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_V_qEPnu---\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"eve\", \n              \"_id\" : \"persons/eve\", \n              \"_rev\" : \"_V_qEPn2---\", \n              \"name\" : \"Eve\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11503\", \n              \"_id\" : \"knows/11503\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/alice\", \n              \"_rev\" : \"_V_qEPo----\" \n            }, \n            { \n              \"_key\" : \"11506\", \n              \"_id\" : \"knows/11506\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_V_qEPo---_\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_V_qEPnu---\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"eve\", \n              \"_id\" : \"persons/eve\", \n              \"_rev\" : \"_V_qEPn2---\", \n              \"name\" : \"Eve\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"_V_qEPny---\", \n              \"name\" : \"Bob\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11503\", \n              \"_id\" : \"knows/11503\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/alice\", \n              \"_rev\" : \"_V_qEPo----\" \n            }, \n            { \n              \"_key\" : \"11506\", \n              \"_id\" : \"knows/11506\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_V_qEPo---_\" \n            }, \n            { \n              \"_key\" : \"11497\", \n              \"_id\" : \"knows/11497\", \n              \"_from\" : \"persons/bob\", \n              \"_to\" : \"persons/charlie\", \n              \"_rev\" : \"_V_qEPn6--_\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_V_qEPnu---\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"eve\", \n              \"_id\" : \"persons/eve\", \n              \"_rev\" : \"_V_qEPn2---\", \n              \"name\" : \"Eve\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"_V_qEPny---\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"charlie\", \n              \"_id\" : \"persons/charlie\", \n              \"_rev\" : \"_V_qEPny--_\", \n              \"name\" : \"Charlie\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11503\", \n              \"_id\" : \"knows/11503\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/alice\", \n              \"_rev\" : \"_V_qEPo----\" \n            }, \n            { \n              \"_key\" : \"11506\", \n              \"_id\" : \"knows/11506\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_V_qEPo---_\" \n            }, \n            { \n              \"_key\" : \"11500\", \n              \"_id\" : \"knows/11500\", \n              \"_from\" : \"persons/bob\", \n              \"_to\" : \"persons/dave\", \n              \"_rev\" : \"_V_qEPn6--A\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_V_qEPnu---\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"eve\", \n              \"_id\" : \"persons/eve\", \n              \"_rev\" : \"_V_qEPn2---\", \n              \"name\" : \"Eve\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"_V_qEPny---\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"dave\", \n              \"_id\" : \"persons/dave\", \n              \"_rev\" : \"_V_qEPny--A\", \n              \"name\" : \"Dave\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11503\", \n              \"_id\" : \"knows/11503\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/alice\", \n              \"_rev\" : \"_V_qEPo----\" \n            }, \n            { \n              \"_key\" : \"11506\", \n              \"_id\" : \"knows/11506\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_V_qEPo---_\" \n            }, \n            { \n              \"_key\" : \"11493\", \n              \"_id\" : \"knows/11493\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_V_qEPn6---\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_V_qEPnu---\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"eve\", \n              \"_id\" : \"persons/eve\", \n              \"_rev\" : \"_V_qEPn2---\", \n              \"name\" : \"Eve\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"_V_qEPny---\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_V_qEPnu---\", \n              \"name\" : \"Alice\" \n            } \n          ] \n        } \n      ] \n    } \n  }, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n#Example:\n Using *postorder* ordering\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF\n{ \n  \"startVertex\" : \"persons/alice\", \n  \"graphName\" : \"knows_graph\", \n  \"direction\" : \"any\", \n  \"order\" : \"postorder\" \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"result\" : { \n    \"visited\" : { \n      \"vertices\" : [ \n        { \n          \"_key\" : \"charlie\", \n          \"_id\" : \"persons/charlie\", \n          \"_rev\" : \"_V_qESJa--A\", \n          \"name\" : \"Charlie\" \n        }, \n        { \n          \"_key\" : \"dave\", \n          \"_id\" : \"persons/dave\", \n          \"_rev\" : \"_V_qESJe---\", \n          \"name\" : \"Dave\" \n        }, \n        { \n          \"_key\" : \"alice\", \n          \"_id\" : \"persons/alice\", \n          \"_rev\" : \"_V_qESJa---\", \n          \"name\" : \"Alice\" \n        }, \n        { \n          \"_key\" : \"eve\", \n          \"_id\" : \"persons/eve\", \n          \"_rev\" : \"_V_qESJe--_\", \n          \"name\" : \"Eve\" \n        }, \n        { \n          \"_key\" : \"bob\", \n          \"_id\" : \"persons/bob\", \n          \"_rev\" : \"_V_qESJa--_\", \n          \"name\" : \"Bob\" \n        }, \n        { \n          \"_key\" : \"charlie\", \n          \"_id\" : \"persons/charlie\", \n          \"_rev\" : \"_V_qESJa--A\", \n          \"name\" : \"Charlie\" \n        }, \n        { \n          \"_key\" : \"dave\", \n          \"_id\" : \"persons/dave\", \n          \"_rev\" : \"_V_qESJe---\", \n          \"name\" : \"Dave\" \n        }, \n        { \n          \"_key\" : \"alice\", \n          \"_id\" : \"persons/alice\", \n          \"_rev\" : \"_V_qESJa---\", \n          \"name\" : \"Alice\" \n        }, \n        { \n          \"_key\" : \"bob\", \n          \"_id\" : \"persons/bob\", \n          \"_rev\" : \"_V_qESJa--_\", \n          \"name\" : \"Bob\" \n        }, \n        { \n          \"_key\" : \"eve\", \n          \"_id\" : \"persons/eve\", \n          \"_rev\" : \"_V_qESJe--_\", \n          \"name\" : \"Eve\" \n        }, \n        { \n          \"_key\" : \"alice\", \n          \"_id\" : \"persons/alice\", \n          \"_rev\" : \"_V_qESJa---\", \n          \"name\" : \"Alice\" \n        } \n      ], \n      \"paths\" : [ \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"12098\", \n              \"_id\" : \"knows/12098\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_V_qESJi---\" \n            }, \n            { \n              \"_key\" : \"12102\", \n              \"_id\" : \"knows/12102\", \n              \"_from\" : \"persons/bob\", \n              \"_to\" : \"persons/charlie\", \n              \"_rev\" : \"_V_qESJi--_\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_V_qESJa---\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"_V_qESJa--_\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"charlie\", \n              \"_id\" : \"persons/charlie\", \n              \"_rev\" : \"_V_qESJa--A\", \n              \"name\" : \"Charlie\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"12098\", \n              \"_id\" : \"knows/12098\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_V_qESJi---\" \n            }, \n            { \n              \"_key\" : \"12105\", \n              \"_id\" : \"knows/12105\", \n              \"_from\" : \"persons/bob\", \n              \"_to\" : \"persons/dave\", \n              \"_rev\" : \"_V_qESJm---\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_V_qESJa---\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"_V_qESJa--_\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"dave\", \n              \"_id\" : \"persons/dave\", \n              \"_rev\" : \"_V_qESJe---\", \n              \"name\" : \"Dave\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"12098\", \n              \"_id\" : \"knows/12098\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_V_qESJi---\" \n            }, \n            { \n              \"_key\" : \"12111\", \n              \"_id\" : \"knows/12111\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_V_qESJq---\" \n            }, \n            { \n              \"_key\" : \"12108\", \n              \"_id\" : \"knows/12108\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/alice\", \n              \"_rev\" : \"_V_qESJm--_\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_V_qESJa---\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"_V_qESJa--_\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"eve\", \n              \"_id\" : \"persons/eve\", \n              \"_rev\" : \"_V_qESJe--_\", \n              \"name\" : \"Eve\" \n            }, \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_V_qESJa---\", \n              \"name\" : \"Alice\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"12098\", \n              \"_id\" : \"knows/12098\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_V_qESJi---\" \n            }, \n            { \n              \"_key\" : \"12111\", \n              \"_id\" : \"knows/12111\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_V_qESJq---\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_V_qESJa---\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"_V_qESJa--_\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"eve\", \n              \"_id\" : \"persons/eve\", \n              \"_rev\" : \"_V_qESJe--_\", \n              \"name\" : \"Eve\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"12098\", \n              \"_id\" : \"knows/12098\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_V_qESJi---\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_V_qESJa---\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"_V_qESJa--_\", \n              \"name\" : \"Bob\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"12108\", \n              \"_id\" : \"knows/12108\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/alice\", \n              \"_rev\" : \"_V_qESJm--_\" \n            }, \n            { \n              \"_key\" : \"12111\", \n              \"_id\" : \"knows/12111\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_V_qESJq---\" \n            }, \n            { \n              \"_key\" : \"12102\", \n              \"_id\" : \"knows/12102\", \n              \"_from\" : \"persons/bob\", \n              \"_to\" : \"persons/charlie\", \n              \"_rev\" : \"_V_qESJi--_\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_V_qESJa---\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"eve\", \n              \"_id\" : \"persons/eve\", \n              \"_rev\" : \"_V_qESJe--_\", \n              \"name\" : \"Eve\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"_V_qESJa--_\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"charlie\", \n              \"_id\" : \"persons/charlie\", \n              \"_rev\" : \"_V_qESJa--A\", \n              \"name\" : \"Charlie\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"12108\", \n              \"_id\" : \"knows/12108\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/alice\", \n              \"_rev\" : \"_V_qESJm--_\" \n            }, \n            { \n              \"_key\" : \"12111\", \n              \"_id\" : \"knows/12111\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_V_qESJq---\" \n            }, \n            { \n              \"_key\" : \"12105\", \n              \"_id\" : \"knows/12105\", \n              \"_from\" : \"persons/bob\", \n              \"_to\" : \"persons/dave\", \n              \"_rev\" : \"_V_qESJm---\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_V_qESJa---\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"eve\", \n              \"_id\" : \"persons/eve\", \n              \"_rev\" : \"_V_qESJe--_\", \n              \"name\" : \"Eve\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"_V_qESJa--_\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"dave\", \n              \"_id\" : \"persons/dave\", \n              \"_rev\" : \"_V_qESJe---\", \n              \"name\" : \"Dave\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"12108\", \n              \"_id\" : \"knows/12108\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/alice\", \n              \"_rev\" : \"_V_qESJm--_\" \n            }, \n            { \n              \"_key\" : \"12111\", \n              \"_id\" : \"knows/12111\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_V_qESJq---\" \n            }, \n            { \n              \"_key\" : \"12098\", \n              \"_id\" : \"knows/12098\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_V_qESJi---\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_V_qESJa---\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"eve\", \n              \"_id\" : \"persons/eve\", \n              \"_rev\" : \"_V_qESJe--_\", \n              \"name\" : \"Eve\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"_V_qESJa--_\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_V_qESJa---\", \n              \"name\" : \"Alice\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"12108\", \n              \"_id\" : \"knows/12108\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/alice\", \n              \"_rev\" : \"_V_qESJm--_\" \n            }, \n            { \n              \"_key\" : \"12111\", \n              \"_id\" : \"knows/12111\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_V_qESJq---\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_V_qESJa---\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"eve\", \n              \"_id\" : \"persons/eve\", \n              \"_rev\" : \"_V_qESJe--_\", \n              \"name\" : \"Eve\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"_V_qESJa--_\", \n              \"name\" : \"Bob\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"12108\", \n              \"_id\" : \"knows/12108\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/alice\", \n              \"_rev\" : \"_V_qESJm--_\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_V_qESJa---\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"eve\", \n              \"_id\" : \"persons/eve\", \n              \"_rev\" : \"_V_qESJe--_\", \n              \"name\" : \"Eve\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_V_qESJa---\", \n              \"name\" : \"Alice\" \n            } \n          ] \n        } \n      ] \n    } \n  }, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n#Example:\n Using *backward* item-ordering:\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF\n{ \n  \"startVertex\" : \"persons/alice\", \n  \"graphName\" : \"knows_graph\", \n  \"direction\" : \"any\", \n  \"itemOrder\" : \"backward\" \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"result\" : { \n    \"visited\" : { \n      \"vertices\" : [ \n        { \n          \"_key\" : \"alice\", \n          \"_id\" : \"persons/alice\", \n          \"_rev\" : \"_V_qEPSK--_\", \n          \"name\" : \"Alice\" \n        }, \n        { \n          \"_key\" : \"eve\", \n          \"_id\" : \"persons/eve\", \n          \"_rev\" : \"_V_qEPSS---\", \n          \"name\" : \"Eve\" \n        }, \n        { \n          \"_key\" : \"bob\", \n          \"_id\" : \"persons/bob\", \n          \"_rev\" : \"_V_qEPSO---\", \n          \"name\" : \"Bob\" \n        }, \n        { \n          \"_key\" : \"alice\", \n          \"_id\" : \"persons/alice\", \n          \"_rev\" : \"_V_qEPSK--_\", \n          \"name\" : \"Alice\" \n        }, \n        { \n          \"_key\" : \"dave\", \n          \"_id\" : \"persons/dave\", \n          \"_rev\" : \"_V_qEPSO--A\", \n          \"name\" : \"Dave\" \n        }, \n        { \n          \"_key\" : \"charlie\", \n          \"_id\" : \"persons/charlie\", \n          \"_rev\" : \"_V_qEPSO--_\", \n          \"name\" : \"Charlie\" \n        }, \n        { \n          \"_key\" : \"bob\", \n          \"_id\" : \"persons/bob\", \n          \"_rev\" : \"_V_qEPSO---\", \n          \"name\" : \"Bob\" \n        }, \n        { \n          \"_key\" : \"eve\", \n          \"_id\" : \"persons/eve\", \n          \"_rev\" : \"_V_qEPSS---\", \n          \"name\" : \"Eve\" \n        }, \n        { \n          \"_key\" : \"alice\", \n          \"_id\" : \"persons/alice\", \n          \"_rev\" : \"_V_qEPSK--_\", \n          \"name\" : \"Alice\" \n        }, \n        { \n          \"_key\" : \"dave\", \n          \"_id\" : \"persons/dave\", \n          \"_rev\" : \"_V_qEPSO--A\", \n          \"name\" : \"Dave\" \n        }, \n        { \n          \"_key\" : \"charlie\", \n          \"_id\" : \"persons/charlie\", \n          \"_rev\" : \"_V_qEPSO--_\", \n          \"name\" : \"Charlie\" \n        } \n      ], \n      \"paths\" : [ \n        { \n          \"edges\" : [ ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_V_qEPSK--_\", \n              \"name\" : \"Alice\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11417\", \n              \"_id\" : \"knows/11417\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/alice\", \n              \"_rev\" : \"_V_qEPSa---\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_V_qEPSK--_\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"eve\", \n              \"_id\" : \"persons/eve\", \n              \"_rev\" : \"_V_qEPSS---\", \n              \"name\" : \"Eve\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11417\", \n              \"_id\" : \"knows/11417\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/alice\", \n              \"_rev\" : \"_V_qEPSa---\" \n            }, \n            { \n              \"_key\" : \"11420\", \n              \"_id\" : \"knows/11420\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_V_qEPSa--_\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_V_qEPSK--_\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"eve\", \n              \"_id\" : \"persons/eve\", \n              \"_rev\" : \"_V_qEPSS---\", \n              \"name\" : \"Eve\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"_V_qEPSO---\", \n              \"name\" : \"Bob\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11417\", \n              \"_id\" : \"knows/11417\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/alice\", \n              \"_rev\" : \"_V_qEPSa---\" \n            }, \n            { \n              \"_key\" : \"11420\", \n              \"_id\" : \"knows/11420\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_V_qEPSa--_\" \n            }, \n            { \n              \"_key\" : \"11407\", \n              \"_id\" : \"knows/11407\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_V_qEPSS--_\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_V_qEPSK--_\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"eve\", \n              \"_id\" : \"persons/eve\", \n              \"_rev\" : \"_V_qEPSS---\", \n              \"name\" : \"Eve\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"_V_qEPSO---\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_V_qEPSK--_\", \n              \"name\" : \"Alice\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11417\", \n              \"_id\" : \"knows/11417\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/alice\", \n              \"_rev\" : \"_V_qEPSa---\" \n            }, \n            { \n              \"_key\" : \"11420\", \n              \"_id\" : \"knows/11420\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_V_qEPSa--_\" \n            }, \n            { \n              \"_key\" : \"11414\", \n              \"_id\" : \"knows/11414\", \n              \"_from\" : \"persons/bob\", \n              \"_to\" : \"persons/dave\", \n              \"_rev\" : \"_V_qEPSW--_\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_V_qEPSK--_\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"eve\", \n              \"_id\" : \"persons/eve\", \n              \"_rev\" : \"_V_qEPSS---\", \n              \"name\" : \"Eve\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"_V_qEPSO---\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"dave\", \n              \"_id\" : \"persons/dave\", \n              \"_rev\" : \"_V_qEPSO--A\", \n              \"name\" : \"Dave\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11417\", \n              \"_id\" : \"knows/11417\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/alice\", \n              \"_rev\" : \"_V_qEPSa---\" \n            }, \n            { \n              \"_key\" : \"11420\", \n              \"_id\" : \"knows/11420\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_V_qEPSa--_\" \n            }, \n            { \n              \"_key\" : \"11411\", \n              \"_id\" : \"knows/11411\", \n              \"_from\" : \"persons/bob\", \n              \"_to\" : \"persons/charlie\", \n              \"_rev\" : \"_V_qEPSW---\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_V_qEPSK--_\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"eve\", \n              \"_id\" : \"persons/eve\", \n              \"_rev\" : \"_V_qEPSS---\", \n              \"name\" : \"Eve\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"_V_qEPSO---\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"charlie\", \n              \"_id\" : \"persons/charlie\", \n              \"_rev\" : \"_V_qEPSO--_\", \n              \"name\" : \"Charlie\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11407\", \n              \"_id\" : \"knows/11407\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_V_qEPSS--_\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_V_qEPSK--_\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"_V_qEPSO---\", \n              \"name\" : \"Bob\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11407\", \n              \"_id\" : \"knows/11407\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_V_qEPSS--_\" \n            }, \n            { \n              \"_key\" : \"11420\", \n              \"_id\" : \"knows/11420\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_V_qEPSa--_\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_V_qEPSK--_\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"_V_qEPSO---\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"eve\", \n              \"_id\" : \"persons/eve\", \n              \"_rev\" : \"_V_qEPSS---\", \n              \"name\" : \"Eve\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11407\", \n              \"_id\" : \"knows/11407\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_V_qEPSS--_\" \n            }, \n            { \n              \"_key\" : \"11420\", \n              \"_id\" : \"knows/11420\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_V_qEPSa--_\" \n            }, \n            { \n              \"_key\" : \"11417\", \n              \"_id\" : \"knows/11417\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/alice\", \n              \"_rev\" : \"_V_qEPSa---\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_V_qEPSK--_\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"_V_qEPSO---\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"eve\", \n              \"_id\" : \"persons/eve\", \n              \"_rev\" : \"_V_qEPSS---\", \n              \"name\" : \"Eve\" \n            }, \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_V_qEPSK--_\", \n              \"name\" : \"Alice\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11407\", \n              \"_id\" : \"knows/11407\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_V_qEPSS--_\" \n            }, \n            { \n              \"_key\" : \"11414\", \n              \"_id\" : \"knows/11414\", \n              \"_from\" : \"persons/bob\", \n              \"_to\" : \"persons/dave\", \n              \"_rev\" : \"_V_qEPSW--_\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_V_qEPSK--_\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"_V_qEPSO---\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"dave\", \n              \"_id\" : \"persons/dave\", \n              \"_rev\" : \"_V_qEPSO--A\", \n              \"name\" : \"Dave\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11407\", \n              \"_id\" : \"knows/11407\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_V_qEPSS--_\" \n            }, \n            { \n              \"_key\" : \"11411\", \n              \"_id\" : \"knows/11411\", \n              \"_from\" : \"persons/bob\", \n              \"_to\" : \"persons/charlie\", \n              \"_rev\" : \"_V_qEPSW---\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_V_qEPSK--_\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"_V_qEPSO---\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"charlie\", \n              \"_id\" : \"persons/charlie\", \n              \"_rev\" : \"_V_qEPSO--_\", \n              \"name\" : \"Charlie\" \n            } \n          ] \n        } \n      ] \n    } \n  }, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n#Example:\n Edges should only be included once globally,\nbut nodes are included every time they are visited\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF\n{ \n  \"startVertex\" : \"persons/alice\", \n  \"graphName\" : \"knows_graph\", \n  \"direction\" : \"any\", \n  \"uniqueness\" : { \n    \"vertices\" : \"none\", \n    \"edges\" : \"global\" \n  } \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"result\" : { \n    \"visited\" : { \n      \"vertices\" : [ \n        { \n          \"_key\" : \"alice\", \n          \"_id\" : \"persons/alice\", \n          \"_rev\" : \"_V_qEP6G---\", \n          \"name\" : \"Alice\" \n        }, \n        { \n          \"_key\" : \"bob\", \n          \"_id\" : \"persons/bob\", \n          \"_rev\" : \"_V_qEP6G--_\", \n          \"name\" : \"Bob\" \n        }, \n        { \n          \"_key\" : \"charlie\", \n          \"_id\" : \"persons/charlie\", \n          \"_rev\" : \"_V_qEP6K---\", \n          \"name\" : \"Charlie\" \n        }, \n        { \n          \"_key\" : \"dave\", \n          \"_id\" : \"persons/dave\", \n          \"_rev\" : \"_V_qEP6K--_\", \n          \"name\" : \"Dave\" \n        }, \n        { \n          \"_key\" : \"eve\", \n          \"_id\" : \"persons/eve\", \n          \"_rev\" : \"_V_qEP6O---\", \n          \"name\" : \"Eve\" \n        }, \n        { \n          \"_key\" : \"alice\", \n          \"_id\" : \"persons/alice\", \n          \"_rev\" : \"_V_qEP6G---\", \n          \"name\" : \"Alice\" \n        } \n      ], \n      \"paths\" : [ \n        { \n          \"edges\" : [ ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_V_qEP6G---\", \n              \"name\" : \"Alice\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11579\", \n              \"_id\" : \"knows/11579\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_V_qEP6O--_\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_V_qEP6G---\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"_V_qEP6G--_\", \n              \"name\" : \"Bob\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11579\", \n              \"_id\" : \"knows/11579\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_V_qEP6O--_\" \n            }, \n            { \n              \"_key\" : \"11583\", \n              \"_id\" : \"knows/11583\", \n              \"_from\" : \"persons/bob\", \n              \"_to\" : \"persons/charlie\", \n              \"_rev\" : \"_V_qEP6O--A\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_V_qEP6G---\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"_V_qEP6G--_\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"charlie\", \n              \"_id\" : \"persons/charlie\", \n              \"_rev\" : \"_V_qEP6K---\", \n              \"name\" : \"Charlie\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11579\", \n              \"_id\" : \"knows/11579\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_V_qEP6O--_\" \n            }, \n            { \n              \"_key\" : \"11586\", \n              \"_id\" : \"knows/11586\", \n              \"_from\" : \"persons/bob\", \n              \"_to\" : \"persons/dave\", \n              \"_rev\" : \"_V_qEP6S---\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_V_qEP6G---\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"_V_qEP6G--_\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"dave\", \n              \"_id\" : \"persons/dave\", \n              \"_rev\" : \"_V_qEP6K--_\", \n              \"name\" : \"Dave\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11579\", \n              \"_id\" : \"knows/11579\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_V_qEP6O--_\" \n            }, \n            { \n              \"_key\" : \"11592\", \n              \"_id\" : \"knows/11592\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_V_qEP6W---\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_V_qEP6G---\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"_V_qEP6G--_\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"eve\", \n              \"_id\" : \"persons/eve\", \n              \"_rev\" : \"_V_qEP6O---\", \n              \"name\" : \"Eve\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11579\", \n              \"_id\" : \"knows/11579\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_V_qEP6O--_\" \n            }, \n            { \n              \"_key\" : \"11592\", \n              \"_id\" : \"knows/11592\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_V_qEP6W---\" \n            }, \n            { \n              \"_key\" : \"11589\", \n              \"_id\" : \"knows/11589\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/alice\", \n              \"_rev\" : \"_V_qEP6S--_\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_V_qEP6G---\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"_V_qEP6G--_\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"eve\", \n              \"_id\" : \"persons/eve\", \n              \"_rev\" : \"_V_qEP6O---\", \n              \"name\" : \"Eve\" \n            }, \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_V_qEP6G---\", \n              \"name\" : \"Alice\" \n            } \n          ] \n        } \n      ] \n    } \n  }, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n#Example:\n If the underlying graph is cyclic, *maxIterations* should be set\n\nThe underlying graph has two vertices *Alice* and *Bob*.\nWith the directed edges:\n\n- *Alice* knows *Bob*\n- *Bob* knows *Alice*\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF\n{ \n  \"startVertex\" : \"persons/alice\", \n  \"graphName\" : \"knows_graph\", \n  \"direction\" : \"any\", \n  \"uniqueness\" : { \n    \"vertices\" : \"none\", \n    \"edges\" : \"none\" \n  }, \n  \"maxIterations\" : 5 \n}\nEOF\n\nHTTP/1.1 500 Internal Server Error\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"error\" : true, \n  \"code\" : 500, \n  \"errorNum\" : 1909, \n  \"errorMessage\" : \"too many iterations - try increasing the value of 'maxIterations'\" \n}\n
\n\n\n\n\n\n", "parameters": [ { "in": "body", "name": "Json Request Body", "required": true, "schema": { "$ref": "#/definitions/JSF_HTTP_API_TRAVERSAL" }, "x-description-offset": 221 } ], "responses": { "200": { "description": "If the traversal is fully executed\n*HTTP 200* will be returned.\n\n" }, "400": { "description": "If the traversal specification is either missing or malformed, the server\nwill respond with *HTTP 400*.\n\n" }, "404": { "description": "The server will responded with *HTTP 404* if the specified edge collection\ndoes not exist, or the specified start vertex cannot be found.\n\n" }, "500": { "description": "The server will responded with *HTTP 500* when an error occurs inside the\ntraversal or if a traversal performs more than *maxIterations* iterations.\n\n" } }, "summary": "executes a traversal", "tags": [ "Graph Traversal" ], "x-examples": [], "x-filename": "Graph Traversal - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Graph Traversal\\JSF_HTTP_API_TRAVERSAL.md" } }, "/_api/user": { "post": { "description": "\n**A json post document with these Properties is required:**\n\n - **passwd**: The user password as a string. If no password is specified, the empty\n string will be used. If you pass the special value\n *ARANGODB_DEFAULT_ROOT_PASSWORD*, the password will be set the value\n stored in the environment variable\n `ARANGODB_DEFAULT_ROOT_PASSWORD`. This can be used to pass an instance\n variable into ArangoDB. For example, the instance identifier from\n Amazon.\n - **active**: An optional flag that specifies whether the user is active. If not\n specified, this will default to true\n - **user**: The name of the user as a string. This is mandatory.\n - **extra**: An optional JSON object with arbitrary extra data about the user.\n\n\n\n\n\nCreate a new user. This user will not have access to any database. You\nneed permission to the *_system* database in order to execute this\nREST call.\n\n\n\n\n#Example:\n \n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/user <<EOF\n{ \n  \"user\" : \"admin@example\", \n  \"passwd\" : \"secure\" \n}\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"user\" : \"admin@example\", \n  \"active\" : true, \n  \"extra\" : { \n  }, \n  \"changePassword\" : false, \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n\n\n\n", "parameters": [ { "in": "body", "name": "Json Request Body", "required": true, "schema": { "$ref": "#/definitions/UserHandling_create" }, "x-description-offset": 61 } ], "responses": { "201": { "description": "Returned if the user can be added by the server\n\n" }, "400": { "description": "If the JSON representation is malformed or mandatory data is missing\nfrom the request.\n\n" }, "409": { "description": "Returned if a user with the same name already exists.\n\n" } }, "summary": " Create User", "tags": [ "User Management" ], "x-examples": [], "x-filename": "User Management - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\User Management\\README.md" } }, "/_api/user/": { "get": { "description": "\n\n\nFetches data about all users. You can only execute this call if you\nhave access to the *_system* database. Otherwise, you will only\nget information about yourself.\n\nThe call will return a JSON object with at least the following\nattributes on success:\n\n- *user*: The name of the user as a string.\n- *active*: An optional flag that specifies whether the user is active.\n- *extra*: An optional JSON object with arbitrary extra data about the user.\n- *changePassword*: An optional flag that specifies whether the user must\n change the password or not.\n\n\n\n\n#Example:\n \n\n
shell> curl --dump - http://localhost:8529/_api/user\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"result\" : [ \n    { \n      \"user\" : \"tester\", \n      \"active\" : false, \n      \"extra\" : { \n      }, \n      \"changePassword\" : false \n    }, \n    { \n      \"user\" : \"root\", \n      \"active\" : true, \n      \"extra\" : { \n      }, \n      \"changePassword\" : false \n    }, \n    { \n      \"user\" : \"admin\", \n      \"active\" : true, \n      \"extra\" : { \n      }, \n      \"changePassword\" : false \n    } \n  ], \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n", "parameters": [], "responses": { "200": { "description": "The users that were found.\n\n" } }, "summary": " List available Users", "tags": [ "User Management" ], "x-examples": [], "x-filename": "User Management - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\User Management\\README.md" } }, "/_api/user/{user}": { "delete": { "description": "\n\n\nRemoves an existing user, identified by *user*. You need access to the\n*_system* database.\n\n\n\n\n#Example:\n \n\n
shell> curl -X DELETE --data-binary @- --dump - http://localhost:8529/_api/user/userToDelete@myapp <<EOF\n{ \n}\nEOF\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"error\" : false, \n  \"code\" : 202 \n}\n
\n\n\n\n\n\n\n\n", "parameters": [ { "description": "The name of the user\n\n", "format": "string", "in": "path", "name": "user", "required": true, "type": "string" } ], "responses": { "202": { "description": "Is returned if the user was removed by the server\n\n" }, "404": { "description": "The specified user does not exist\n\n" } }, "summary": " Remove User", "tags": [ "User Management" ], "x-examples": [], "x-filename": "User Management - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\User Management\\README.md" }, "get": { "description": "\n\n\nFetches data about the specified user. You can fetch information about yourself\nor you need permission to the *_system* database in order to execute this\nREST call.\n\n\n\n\n#Example:\n \n\n
shell> curl --dump - http://localhost:8529/_api/user/admin@myapp\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"user\" : \"admin@myapp\", \n  \"active\" : true, \n  \"extra\" : { \n  }, \n  \"changePassword\" : false, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n\n\n\n", "parameters": [ { "description": "The name of the user\n\n", "format": "string", "in": "path", "name": "user", "required": true, "type": "string" } ], "responses": { "200": { "description": "The user was found.\n\n" }, "404": { "description": "The user with the specified name does not exist.\n\n" } }, "summary": " Fetch User", "tags": [ "User Management" ], "x-examples": [], "x-filename": "User Management - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\User Management\\README.md" }, "patch": { "description": "\n**A json post document with these Properties is required:**\n\n - **passwd**: The user password as a string. Specifying a password is mandatory, but\n the empty string is allowed for passwords\n - **active**: An optional flag that specifies whether the user is active. If not\n specified, this will default to true\n - **extra**: An optional JSON object with arbitrary extra data about the user.\n\n\n\n\n\nPartially updates the data of an existing user. The name of an existing\nuser must be specified in *user*. When authentication is turned on in the\nserver, only users that have read and write permissions for the *_system*\ndatabase can change other users' data. Additionally, a user can change \nhis/her own data.\n\n\n\n\n#Example:\n \n\n
shell> curl -X PATCH --data-binary @- --dump - http://localhost:8529/_api/user/admin@myapp <<EOF\n{ \n  \"passwd\" : \"secure\" \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"user\" : \"admin@myapp\", \n  \"active\" : true, \n  \"extra\" : { \n  }, \n  \"changePassword\" : false, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n\n\n\n\n\n", "parameters": [ { "description": "The name of the user\n\n", "format": "string", "in": "path", "name": "user", "required": true, "type": "string" }, { "in": "body", "name": "Json Request Body", "required": true, "schema": { "$ref": "#/definitions/UserHandling_modify" }, "x-description-offset": 61 } ], "responses": { "200": { "description": "Is returned if the user data can be replaced by the server\n\n" }, "400": { "description": "The JSON representation is malformed or mandatory data is missing from the request\n\n" }, "404": { "description": "The specified user does not exist\n\n" } }, "summary": " Update User", "tags": [ "User Management" ], "x-examples": [], "x-filename": "User Management - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\User Management\\README.md" }, "put": { "description": "\n**A json post document with these Properties is required:**\n\n - **passwd**: The user password as a string. Specifying a password is mandatory, but\n the empty string is allowed for passwords\n - **active**: An optional flag that specifies whether the user is active. If not\n specified, this will default to true\n - **extra**: An optional JSON object with arbitrary extra data about the user.\n\n\n\n\n\nReplaces the data of an existing user. The name of an existing user\nmust be specified in *user*. When authentication is turned on in the\nserver, only users that have read and write permissions for the *_system*\ndatabase can change other users' data. Additionally, a user can change \nhis/her own data.\n\n\n\n\n#Example:\n \n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/user/admin@myapp <<EOF\n{ \n  \"passwd\" : \"secure\" \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"user\" : \"admin@myapp\", \n  \"active\" : true, \n  \"extra\" : { \n  }, \n  \"changePassword\" : false, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n\n\n\n", "parameters": [ { "description": "The name of the user\n\n", "format": "string", "in": "path", "name": "user", "required": true, "type": "string" }, { "in": "body", "name": "Json Request Body", "required": true, "schema": { "$ref": "#/definitions/UserHandling_replace" }, "x-description-offset": 61 } ], "responses": { "200": { "description": "Is returned if the user data can be replaced by the server\n\n" }, "400": { "description": "The JSON representation is malformed or mandatory data is missing from the request\n\n" }, "404": { "description": "The specified user does not exist\n\n" } }, "summary": " Replace User", "tags": [ "User Management" ], "x-examples": [], "x-filename": "User Management - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\User Management\\README.md" } }, "/_api/user/{user}/database/": { "get": { "description": "\n\n\nFetch the list of databases available to the specified *user*. You\nneed permission to the *_system* database in order to execute this\nREST call.\n\nThe call will return a JSON object with the per-database access\nprivileges for the specified user. The *result* object will contain\nthe databases names as object keys, and the associated privileges\nfor the database as values.\n\n\n\n\n#Example:\n \n\n
shell> curl --dump - http://localhost:8529/_api/user/anotherAdmin@secapp/database/\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"result\" : { \n    \"_system\" : \"rw\" \n  }, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n\n\n\n", "parameters": [ { "description": "The name of the user for which you want to query the databases.\n\n", "format": "string", "in": "path", "name": "user", "required": true, "type": "string" } ], "responses": { "200": { "description": "Returned if the list of available databases can be returned.\n\n" }, "400": { "description": "If the access privileges are not right etc.\n\n" } }, "summary": " List the databases available to a User", "tags": [ "User Management" ], "x-examples": [], "x-filename": "User Management - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\User Management\\README.md" } }, "/_api/user/{user}/database/{dbname}": { "put": { "description": "\n**A json post document with these Properties is required:**\n\n - **grant**: Use \"rw\" to grant read and write access rights, or \"ro\" to\n grant read-only access right. To revoke access rights, use \"none\".\n\n\n\n\n\nGrants or revokes access to the database *dbname* for user *user*. You\nneed permission to the *_system* database in order to execute this\nREST call.\n\n\n\n\n#Example:\n \n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/user/admin@myapp/database/_system <<EOF\n{ \n  \"grant\" : \"rw\" \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"_system\" : \"rw\", \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n\n\n\n", "parameters": [ { "in": "body", "name": "Json Request Body", "required": true, "schema": { "$ref": "#/definitions/UserHandling_grantDatabase" }, "x-description-offset": 61 }, { "description": "The name of the user.\n\n", "format": "string", "in": "path", "name": "user", "required": true, "type": "string" }, { "description": "The name of the database.\n\n", "format": "string", "in": "path", "name": "dbname", "required": true, "type": "string" } ], "responses": { "200": { "description": "Returned if the access permissions were changed successfully.\n\n" }, "400": { "description": "If the JSON representation is malformed or mandatory data is missing\nfrom the request.\n\n" } }, "summary": " Grant or revoke database access", "tags": [ "User Management" ], "x-examples": [], "x-filename": "User Management - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\User Management\\README.md" } }, "/_api/version": { "get": { "description": "\n\nReturns the server name and version number. The response is a JSON object\nwith the following attributes:\n\n**A json document with these Properties is returned:**\n\n##HTTP 200\nis returned in all cases.\n\n- **version**: 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- **details**: an optional JSON object with additional details. This is\nreturned only if the *details* query parameter is set to *true* in the\nrequest.\n- **server**: will always contain *arango*\n\n\n\n\n#Example:\n Return the version information\n\n
shell> curl --dump - http://localhost:8529/_api/version\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"server\" : \"arango\", \n  \"version\" : \"3.2.devel\", \n  \"license\" : \"community\" \n}\n
\n\n\n\n\n#Example:\n Return the version information with details\n\n
shell> curl --dump - http://localhost:8529/_api/version?details=true\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"server\" : \"arango\", \n  \"version\" : \"3.2.devel\", \n  \"license\" : \"community\", \n  \"details\" : { \n    \"architecture\" : \"64bit\", \n    \"arm\" : \"false\", \n    \"asan\" : \"false\", \n    \"asm-crc32\" : \"true\", \n    \"assertions\" : \"false\", \n    \"boost-version\" : \"1.62.0\", \n    \"build-date\" : \"2017-05-16 14:45:08\", \n    \"build-repository\" : \"heads/devel-0-g5477e64a35-dirty\", \n    \"compiler\" : \"gcc [4.9.3]\", \n    \"cplusplus\" : \"201103\", \n    \"debug\" : \"false\", \n    \"endianness\" : \"little\", \n    \"failure-tests\" : \"false\", \n    \"fd-client-event-handler\" : \"poll\", \n    \"fd-setsize\" : \"1024\", \n    \"full-version-string\" : \"ArangoDB 3.2.devel [linux] 64bit, using VPack 0.1.30, RocksDB 5.1.4, ICU 58.1, V8 5.7.0.0, OpenSSL 1.0.2k  26 Jan 2017\", \n    \"icu-version\" : \"58.1\", \n    \"jemalloc\" : \"true\", \n    \"maintainer-mode\" : \"false\", \n    \"openssl-version\" : \"OpenSSL 1.0.2k  26 Jan 2017\", \n    \"platform\" : \"linux\", \n    \"reactor-type\" : \"epoll\", \n    \"rocksdb-version\" : \"5.1.4\", \n    \"server-version\" : \"3.2.devel\", \n    \"sizeof int\" : \"4\", \n    \"sizeof void*\" : \"8\", \n    \"sse42\" : \"false\", \n    \"unaligned-access\" : \"true\", \n    \"v8-version\" : \"5.7.0.0\", \n    \"vpack-version\" : \"0.1.30\", \n    \"zlib-version\" : \"1.2.11\", \n    \"mode\" : \"server\" \n  } \n}\n
\n\n\n\n\n", "parameters": [ { "description": "If set to *true*, the response will contain a *details* attribute with\nadditional information about included components and their versions. The\nattribute names and internals of the *details* object may vary depending on\nplatform and ArangoDB version.\n\n", "in": "query", "name": "details", "required": false, "type": "boolean" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "is returned in all cases.\n\n", "schema": { "$ref": "#/definitions/JSF_get_api_return_rc_200" }, "x-description-offset": 163 } }, "summary": " Return server version", "tags": [ "Administration" ], "x-examples": [], "x-filename": "Administration - C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_delete_api_tasks.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_database_version.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_echo.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_long_echo.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_modules_flush.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_routing_reloads.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_server_id.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_server_role.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_sleep.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_statistics.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_statistics_description.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_admin_time.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_cluster_endpoints.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_endpoint.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_initiate.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_return.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_tasks.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_api_tasks_all.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_get_engine.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_post_admin_execute.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_post_admin_test.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_post_api_new_tasks.md, C:/Users/User/arangodb/Documentation/DocuBlocks/Rest\\Administration\\JSF_put_api_new_tasks.md" } } }, "schemes": [ "http" ], "swagger": "2.0" }