\n\n\n\n\n",
+ "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
\n\n\n\n\n",
"parameters": [],
"responses": {
"200": {
@@ -3095,7 +3095,7 @@
},
"/_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
\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
\n\n\n\n\n",
+ "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
\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
\n\n\n\n\n",
"parameters": [
{
"description": "The multipart batch request, consisting of the envelope and the individual\nbatch parts.\n\n",
@@ -3277,7 +3277,7 @@
},
"/_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
\n\n\n\n\n",
+ "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
\n\n\n\n\n",
"parameters": [
{
"description": "The name of the collection.\n\n",
@@ -3320,7 +3320,7 @@
},
"/_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
\n\n\n\n\n",
+ "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
\n\n\n\n\n",
"parameters": [
{
"description": "The name of the collection.\n\n",
@@ -3349,7 +3349,7 @@
},
"/_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
\n\n\n\n\n",
+ "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
\n\n\n\n\n",
"parameters": [
{
"description": "The name of the collection.\n\n",
@@ -3388,7 +3388,7 @@
},
"/_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
\n\n\n\n\n",
+ "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
\n\n\n\n\n",
"parameters": [
{
"description": "The name of the collection.\n\n",
@@ -3449,7 +3449,7 @@
},
"/_api/collection/{collection-name}/properties": {
"get": {
- "description": "\n\nIn addition to the above, the result will always contain the\n*waitForSync* attribute, and the *doCompact*, *journalSize*, \nand *isVolatile* attributes for the MMFiles storage engine.\nThis is achieved by forcing a load of the underlying collection.\n\n- *waitForSync*: If *true* then creating, changing or removing\n documents will wait until the data has been synchronized to disk.\n\n- *doCompact*: Whether or not the collection will be compacted.\n This option is only present for the MMFiles storage engine.\n\n- *journalSize*: The maximal size setting for journals / datafiles\n in bytes.\n This option is only present for the MMFiles storage engine.\n\n- *keyOptions*: JSON object which contains key generation options:\n - *type*: specifies the type of the key generator. The currently\n available generators are *traditional* and *autoincrement*.\n - *allowUserKeys*: if set to *true*, then it is allowed to supply\n own key values in the *_key* attribute of a document. If set to\n *false*, then the key generator is solely responsible for\n generating keys and supplying own key values in the *_key* attribute\n of documents is considered an error.\n\n- *isVolatile*: If *true* then the collection data will be\n kept in memory only and ArangoDB will not write or sync the data\n to disk.\n This option is only present for the MMFiles storage engine.\n\nIn a cluster setup, the result will also contain the following attributes:\n- *numberOfShards*: the number of shards of the collection.\n\n- *shardKeys*: contains the names of document attributes that are used to\n determine the target shard for documents.\n\n- *replicationFactor*: contains how many copies of each shard are kept on different DBServers.\n\n\n\n\n#Example:\n Using an identifier:\n\n
\n\n\n\n\n",
+ "description": "\n\nIn addition to the above, the result will always contain the\n*waitForSync* attribute, and the *doCompact*, *journalSize*, \nand *isVolatile* attributes for the MMFiles storage engine.\nThis is achieved by forcing a load of the underlying collection.\n\n- *waitForSync*: If *true* then creating, changing or removing\n documents will wait until the data has been synchronized to disk.\n\n- *doCompact*: Whether or not the collection will be compacted.\n This option is only present for the MMFiles storage engine.\n\n- *journalSize*: The maximal size setting for journals / datafiles\n in bytes.\n This option is only present for the MMFiles storage engine.\n\n- *keyOptions*: JSON object which contains key generation options:\n - *type*: specifies the type of the key generator. The currently\n available generators are *traditional* and *autoincrement*.\n - *allowUserKeys*: if set to *true*, then it is allowed to supply\n own key values in the *_key* attribute of a document. If set to\n *false*, then the key generator is solely responsible for\n generating keys and supplying own key values in the *_key* attribute\n of documents is considered an error.\n\n- *isVolatile*: If *true* then the collection data will be\n kept in memory only and ArangoDB will not write or sync the data\n to disk.\n This option is only present for the MMFiles storage engine.\n\nIn a cluster setup, the result will also contain the following attributes:\n- *numberOfShards*: the number of shards of the collection.\n\n- *shardKeys*: contains the names of document attributes that are used to\n determine the target shard for documents.\n\n- *replicationFactor*: contains how many copies of each shard are kept on different DBServers.\n\n\n\n\n#Example:\n Using an identifier:\n\n
\n\n\n\n\n",
"parameters": [
{
"description": "The name of the collection.\n\n",
@@ -3476,7 +3476,7 @@
"x-filename": "Collections - /arangodb33/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /arangodb33/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /arangodb33/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /arangodb33/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /arangodb33/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /arangodb33/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /arangodb33/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /arangodb33/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md, /arangodb33/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /arangodb33/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /arangodb33/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load_indexes_in_memory.md, /arangodb33/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /arangodb33/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /arangodb33/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md, /arangodb33/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /arangodb33/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
\n\n\n\n\n",
+ "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
\n\n\n\n\n",
"parameters": [
{
"description": "The name of the collection.\n\n",
@@ -3505,7 +3505,7 @@
},
"/_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
\n\n\n\n\n",
+ "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
\n\n\n\n\n",
"parameters": [
{
"description": "The name of the collection to rename.\n\n",
@@ -3534,7 +3534,7 @@
},
"/_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
\n\n\n\n\n",
+ "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
\n\n\n\n\n",
"parameters": [
{
"description": "The name of the collection.\n\n",
@@ -3592,7 +3592,7 @@
},
"/_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
\n\n\n\n\n",
"parameters": [
{
"description": "The name of the collection.\n\n",
@@ -3621,7 +3621,7 @@
},
"/_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
\n\n\n\n\n",
+ "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
\n\n\n\n\n",
"parameters": [
{
"description": "\n",
@@ -3650,7 +3650,7 @@
},
"/_api/cursor": {
"post": {
- "description": "\n**A JSON object with these properties is required:**\n\n - **count**: indicates whether the number of documents in the result set should be returned in\n the \"count\" attribute of the result.\n Calculating the \"count\" attribute might have a performance impact for some queries\n in the future so this option is turned off by default, and \"count\"\n is only returned when requested.\n - **batchSize**: maximum number of result documents to be transferred from\n the server to the client in one roundtrip. If this attribute is\n not set, a server-controlled default value will be used. A *batchSize* value of\n *0* is disallowed.\n - **cache**: flag to determine whether the AQL query cache\n shall be used. If set to *false*, then any query cache lookup will be skipped\n for the query. If set to *true*, it will lead to the query cache being checked\n for the query if the query cache mode is either *on* or *demand*.\n - **memoryLimit**: the maximum number of memory (measured in bytes) that the query is allowed to \n use. If set, then the query will fail with error \"resource limit exceeded\" in\n case it allocates too much memory. A value of *0* indicates that there is no\n memory limit.\n - **ttl**: The time-to-live for the cursor (in seconds). The cursor will be\n removed on the server automatically after the specified amount of time. This\n is useful to ensure garbage collection of cursors that are not fully fetched\n by clients. If not set, a server-defined value will be used.\n - **query**: contains the query string to be executed\n - **bindVars** (object): key/value pairs representing the bind parameters.\n - **options**:\n - **failOnWarning**: When set to *true*, the query will throw an exception and abort instead of producing\n a warning. This option should be used during development to catch potential issues\n early. When the attribute is set to *false*, warnings will not be propagated to \n exceptions and will be returned with the query result.\n There is also a server configuration option `--query.fail-on-warning` for setting the\n default value for *failOnWarning* so it does not need to be set on a per-query level.\n - **profile**: If set to *true*, then the additional query profiling information will be returned\n in the sub-attribute *profile* of the *extra* return attribute if the query result\n is not served from the query cache.\n - **maxTransactionSize**: Transaction size limit in bytes. Honored by the RocksDB storage engine only.\n - **maxWarningCount**: Limits the maximum number of warnings a query will return. The number of warnings\n a query will return is limited to 10 by default, but that number can be increased\n or decreased by setting this attribute.\n - **intermediateCommitCount**: Maximum number of operations after which an intermediate commit is performed \n automatically. Honored by the RocksDB storage engine only.\n - **satelliteSyncWait**: This *enterprise* parameter allows to configure how long a DBServer will have time\n to bring the satellite collections involved in the query into sync.\n The default value is *60.0* (seconds). When the max time has been reached the query\n will be stopped.\n - **fullCount**: if set to *true* and the query contains a *LIMIT* clause, then the\n result will have an *extra* attribute with the sub-attributes *stats*\n and *fullCount*, `{ ... , \"extra\": { \"stats\": { \"fullCount\": 123 } } }`.\n The *fullCount* attribute will contain the number of documents in the result before the\n last LIMIT in the query was applied. It can be used to count the number of documents that\n match certain filter criteria, but only return a subset of them, in one go.\n It is thus similar to MySQL's *SQL_CALC_FOUND_ROWS* hint. Note that setting the option\n will disable a few LIMIT optimizations and may lead to more documents being processed,\n and thus make queries run longer. Note that the *fullCount* attribute will only\n be present in the result if the query has a LIMIT clause and the LIMIT clause is\n actually used in the query.\n - **intermediateCommitSize**: Maximum total size of operations after which an intermediate commit is performed \n automatically. Honored by the RocksDB storage engine only.\n - **optimizer.rules** (string): A list of to-be-included or to-be-excluded optimizer rules\n can be put into this attribute, telling the optimizer to include or exclude\n specific rules. To disable a rule, prefix its name with a `-`, to enable a rule, prefix it\n with a `+`. There is also a pseudo-rule `all`, which will match all optimizer rules.\n - **maxPlans**: Limits the maximum number of plans that are created by the AQL query optimizer.\n\n\n\n\nThe query details include the query string plus optional query options and\nbind parameters. These values need to be passed in a JSON representation in\nthe body of the POST request.\n\n**A json document with these Properties is returned:**\n\n##HTTP 201\nis returned if the result set can be created by the server.\n\n- **count**: the total number of result documents available (only\navailable if the query was executed with the *count* attribute set)\n- **code**: the HTTP status code\n- **extra**: an optional JSON object with extra information about the query result\ncontained in its *stats* sub-attribute. For data-modification queries, the \n*extra.stats* sub-attribute will contain the number of modified documents and \nthe number of documents that could not be modified\ndue to an error (if *ignoreErrors* query option is specified)\n- **cached**: a boolean flag indicating whether the query result was served \nfrom the query cache or not. If the query result is served from the query\ncache, the *extra* return attribute will not contain any *stats* sub-attribute\nand no *profile* sub-attribute.\n- **hasMore**: A boolean indicator whether there are more results\navailable for the cursor on the server\n- **result** (anonymous json object): an array of result documents (might be empty if query has no results)\n- **error**: A flag to indicate that an error occurred (*false* in this case)\n- **id**: id of temporary cursor created on the server (optional, see above)\n\n**A json document with these Properties is returned:**\n\n##HTTP 400\nis returned if the JSON representation is malformed or the query specification is\nmissing from the request.\nIf the JSON representation is malformed or the query specification is\nmissing from the request, the server will respond with *HTTP 400*.\nThe body of the response will contain a JSON object with additional error\ndetails. The object has the following attributes:\n\n- **errorMessage**: a descriptive error message\nIf the query specification is complete, the server will process the query. If an\nerror occurs during query processing, the server will respond with *HTTP 400*.\nAgain, the body of the response will contain details about the error.\nA [list of query errors can be found here](../../Manual/Appendix/ErrorCodes.html).\n- **errorNum**: the server error number\n- **code**: the HTTP status code\n- **error**: boolean flag to indicate that an error occurred (*true* in this case)\n\n\n\n\n#Example:\n Execute a query and extract the result in a single go\n\n
\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.1404 Not Found\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n \"error\" : true, \n \"errorMessage\" : \"AQL: document not found (while executing)\", \n \"code\" : 404, \n \"errorNum\" : 1202 \n}\n
\n\n\n\n\n\n",
+ "description": "\n**A JSON object with these properties is required:**\n\n - **count**: indicates whether the number of documents in the result set should be returned in\n the \"count\" attribute of the result.\n Calculating the \"count\" attribute might have a performance impact for some queries\n in the future so this option is turned off by default, and \"count\"\n is only returned when requested.\n - **batchSize**: maximum number of result documents to be transferred from\n the server to the client in one roundtrip. If this attribute is\n not set, a server-controlled default value will be used. A *batchSize* value of\n *0* is disallowed.\n - **cache**: flag to determine whether the AQL query cache\n shall be used. If set to *false*, then any query cache lookup will be skipped\n for the query. If set to *true*, it will lead to the query cache being checked\n for the query if the query cache mode is either *on* or *demand*.\n - **memoryLimit**: the maximum number of memory (measured in bytes) that the query is allowed to \n use. If set, then the query will fail with error \"resource limit exceeded\" in\n case it allocates too much memory. A value of *0* indicates that there is no\n memory limit.\n - **ttl**: The time-to-live for the cursor (in seconds). The cursor will be\n removed on the server automatically after the specified amount of time. This\n is useful to ensure garbage collection of cursors that are not fully fetched\n by clients. If not set, a server-defined value will be used.\n - **query**: contains the query string to be executed\n - **bindVars** (object): key/value pairs representing the bind parameters.\n - **options**:\n - **failOnWarning**: When set to *true*, the query will throw an exception and abort instead of producing\n a warning. This option should be used during development to catch potential issues\n early. When the attribute is set to *false*, warnings will not be propagated to \n exceptions and will be returned with the query result.\n There is also a server configuration option `--query.fail-on-warning` for setting the\n default value for *failOnWarning* so it does not need to be set on a per-query level.\n - **profile**: If set to *true*, then the additional query profiling information will be returned\n in the sub-attribute *profile* of the *extra* return attribute if the query result\n is not served from the query cache.\n - **maxTransactionSize**: Transaction size limit in bytes. Honored by the RocksDB storage engine only.\n - **maxWarningCount**: Limits the maximum number of warnings a query will return. The number of warnings\n a query will return is limited to 10 by default, but that number can be increased\n or decreased by setting this attribute.\n - **intermediateCommitCount**: Maximum number of operations after which an intermediate commit is performed \n automatically. Honored by the RocksDB storage engine only.\n - **satelliteSyncWait**: This *enterprise* parameter allows to configure how long a DBServer will have time\n to bring the satellite collections involved in the query into sync.\n The default value is *60.0* (seconds). When the max time has been reached the query\n will be stopped.\n - **fullCount**: if set to *true* and the query contains a *LIMIT* clause, then the\n result will have an *extra* attribute with the sub-attributes *stats*\n and *fullCount*, `{ ... , \"extra\": { \"stats\": { \"fullCount\": 123 } } }`.\n The *fullCount* attribute will contain the number of documents in the result before the\n last LIMIT in the query was applied. It can be used to count the number of documents that\n match certain filter criteria, but only return a subset of them, in one go.\n It is thus similar to MySQL's *SQL_CALC_FOUND_ROWS* hint. Note that setting the option\n will disable a few LIMIT optimizations and may lead to more documents being processed,\n and thus make queries run longer. Note that the *fullCount* attribute will only\n be present in the result if the query has a LIMIT clause and the LIMIT clause is\n actually used in the query.\n - **intermediateCommitSize**: Maximum total size of operations after which an intermediate commit is performed \n automatically. Honored by the RocksDB storage engine only.\n - **optimizer.rules** (string): A list of to-be-included or to-be-excluded optimizer rules\n can be put into this attribute, telling the optimizer to include or exclude\n specific rules. To disable a rule, prefix its name with a `-`, to enable a rule, prefix it\n with a `+`. There is also a pseudo-rule `all`, which will match all optimizer rules.\n - **maxPlans**: Limits the maximum number of plans that are created by the AQL query optimizer.\n\n\n\n\nThe query details include the query string plus optional query options and\nbind parameters. These values need to be passed in a JSON representation in\nthe body of the POST request.\n\n**A json document with these Properties is returned:**\n\n##HTTP 201\nis returned if the result set can be created by the server.\n\n- **count**: the total number of result documents available (only\navailable if the query was executed with the *count* attribute set)\n- **code**: the HTTP status code\n- **extra**: an optional JSON object with extra information about the query result\ncontained in its *stats* sub-attribute. For data-modification queries, the \n*extra.stats* sub-attribute will contain the number of modified documents and \nthe number of documents that could not be modified\ndue to an error (if *ignoreErrors* query option is specified)\n- **cached**: a boolean flag indicating whether the query result was served \nfrom the query cache or not. If the query result is served from the query\ncache, the *extra* return attribute will not contain any *stats* sub-attribute\nand no *profile* sub-attribute.\n- **hasMore**: A boolean indicator whether there are more results\navailable for the cursor on the server\n- **result** (anonymous json object): an array of result documents (might be empty if query has no results)\n- **error**: A flag to indicate that an error occurred (*false* in this case)\n- **id**: id of temporary cursor created on the server (optional, see above)\n\n**A json document with these Properties is returned:**\n\n##HTTP 400\nis returned if the JSON representation is malformed or the query specification is\nmissing from the request.\nIf the JSON representation is malformed or the query specification is\nmissing from the request, the server will respond with *HTTP 400*.\nThe body of the response will contain a JSON object with additional error\ndetails. The object has the following attributes:\n\n- **errorMessage**: a descriptive error message\nIf the query specification is complete, the server will process the query. If an\nerror occurs during query processing, the server will respond with *HTTP 400*.\nAgain, the body of the response will contain details about the error.\nA [list of query errors can be found here](../../Manual/Appendix/ErrorCodes.html).\n- **errorNum**: the server error number\n- **code**: the HTTP status code\n- **error**: boolean flag to indicate that an error occurred (*true* in this case)\n\n\n\n\n#Example:\n Execute a query and extract the result in a single go\n\n
\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.1404 Not Found\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n \"error\" : true, \n \"errorMessage\" : \"AQL: document not found (while executing)\", \n \"code\" : 404, \n \"errorNum\" : 1202 \n}\n
\n\n\n\n\n\n",
"parameters": [
{
"in": "body",
@@ -3697,7 +3697,7 @@
},
"/_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
\n\n\n\n\n",
+ "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
\n\n\n\n\n",
"parameters": [
{
"description": "The id of the cursor\n\n",
@@ -3724,7 +3724,7 @@
"x-filename": "Cursors - /arangodb33/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor.md, /arangodb33/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor_delete.md, /arangodb33/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
\n\n\n\n\n",
+ "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
\n\n\n\n\n",
"parameters": [
{
"description": "The name of the cursor\n\n",
@@ -3813,7 +3813,7 @@
},
"/_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
\n\n\n\n\n",
+ "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
\n\n\n\n\n",
"parameters": [],
"responses": {
"200": {
@@ -3891,7 +3891,7 @@
},
"/_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
\n\n\n\n",
+ "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
\n\n\n\n",
"parameters": [
{
"description": "A JSON array of strings or documents.\n\n",
@@ -4039,7 +4039,7 @@
"x-filename": "Documents - /arangodb33/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_CREATE.md, /arangodb33/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE.md, /arangodb33/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE_MULTI.md, /arangodb33/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ.md, /arangodb33/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_ALL.md, /arangodb33/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_HEAD.md, /arangodb33/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE.md, /arangodb33/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE_MULTI.md, /arangodb33/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE.md, /arangodb33/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
\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
\n\n\n\n\n",
+ "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
\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
\n\n\n\n\n",
"parameters": [
{
"description": "The *collection* in which the collection is to be created.\n\n",
@@ -4188,7 +4188,7 @@
},
"/_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
\n\n\n\n",
+ "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
\n\n\n\n",
"parameters": [
{
"description": "Removes the document identified by *document-handle*.\n\n",
@@ -4248,7 +4248,7 @@
"x-filename": "Documents - /arangodb33/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_CREATE.md, /arangodb33/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE.md, /arangodb33/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE_MULTI.md, /arangodb33/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ.md, /arangodb33/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_ALL.md, /arangodb33/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_HEAD.md, /arangodb33/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE.md, /arangodb33/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE_MULTI.md, /arangodb33/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE.md, /arangodb33/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
\n\n\n\n\n",
+ "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
\n\n\n\n\n",
"parameters": [
{
"description": "The handle of the document.\n\n",
@@ -4259,13 +4259,13 @@
"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",
+ "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",
+ "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"
@@ -4293,7 +4293,7 @@
"x-filename": "Documents - /arangodb33/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_CREATE.md, /arangodb33/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE.md, /arangodb33/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE_MULTI.md, /arangodb33/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ.md, /arangodb33/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_ALL.md, /arangodb33/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_HEAD.md, /arangodb33/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE.md, /arangodb33/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE_MULTI.md, /arangodb33/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE.md, /arangodb33/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/11091\n\n
\n\n\n\n\n\n",
+ "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/11094\n\n
\n\n\n\n\n\n",
"parameters": [
{
"description": "The handle of the document.\n\n",
@@ -4304,13 +4304,13 @@
"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",
+ "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",
+ "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"
@@ -4327,7 +4327,7 @@
"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"
+ "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",
@@ -4338,7 +4338,7 @@
"x-filename": "Documents - /arangodb33/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_CREATE.md, /arangodb33/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE.md, /arangodb33/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE_MULTI.md, /arangodb33/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ.md, /arangodb33/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_ALL.md, /arangodb33/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_HEAD.md, /arangodb33/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE.md, /arangodb33/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE_MULTI.md, /arangodb33/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE.md, /arangodb33/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
\n\n\n\n\n",
+ "description": "\n\nPartially updates the document identified by *document-handle*.\nThe body of the request must contain a JSON document with the\nattributes to patch (the patch document). All attributes from the\npatch document will be added to the existing document if they do not\nyet exist, and overwritten in the existing document if they do exist\nthere.\n\nSetting an attribute value to *null* in the patch document will cause a\nvalue of *null* to be saved for the attribute by default.\n\nIf the *If-Match* header is specified and the revision of the\ndocument in the database is unequal to the given revision, the\nprecondition is violated.\n\nIf *If-Match* is not given and *ignoreRevs* is *false* and there\nis a *_rev* attribute in the body and its value does not match\nthe revision of the document in the database, the precondition is\nviolated.\n\nIf a precondition is violated, an *HTTP 412* is returned.\n\nIf the document exists and can be updated, then an *HTTP 201* or\nan *HTTP 202* is returned (depending on *waitForSync*, see below),\nthe *Etag* header field contains the new revision of the document\n(in double quotes) and the *Location* header contains a complete URL\nunder which the document can be queried.\n\nOptionally, the query parameter *waitForSync* can be used to force\nsynchronization of the updated document operation to disk even in case\nthat the *waitForSync* flag had been disabled for the entire collection.\nThus, the *waitForSync* query parameter can be used to force synchronization\nof just specific operations. To use this, set the *waitForSync* parameter\nto *true*. If the *waitForSync* parameter is not specified or set to\n*false*, then the collection's default *waitForSync* behavior is\napplied. The *waitForSync* query parameter cannot be used to disable\nsynchronization for collections that have a default *waitForSync* value\nof *true*.\n\nIf *silent* is not set to *true*, the body of the response contains a JSON \nobject with the information about the handle and the revision. The attribute \n*_id* contains the known *document-handle* of the updated document, *_key* \ncontains the key which uniquely identifies a document in a given collection, \nand the attribute *_rev* contains the new document revision.\n\nIf the query parameter *returnOld* is *true*, then\nthe complete previous revision of the document\nis returned under the *old* attribute in the result.\n\nIf the query parameter *returnNew* is *true*, then\nthe complete new document is returned under\nthe *new* attribute in the result.\n\nIf the document does not exist, then a *HTTP 404* is returned and the\nbody of the response contains an error document.\n\n\n\n\n#Example:\n Patches an existing document with new content.\n\n
\n\n\n\n\n",
"parameters": [
{
"description": "A JSON representation of a document update as an object.\n\n",
@@ -4440,7 +4440,7 @@
"x-filename": "Documents - /arangodb33/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_CREATE.md, /arangodb33/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE.md, /arangodb33/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE_MULTI.md, /arangodb33/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ.md, /arangodb33/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_ALL.md, /arangodb33/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_HEAD.md, /arangodb33/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE.md, /arangodb33/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE_MULTI.md, /arangodb33/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE.md, /arangodb33/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
\n\n\n\n\n",
+ "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
\n\n\n\n\n",
"parameters": [
{
"description": "A JSON representation of a single document.\n\n",
@@ -4530,7 +4530,7 @@
},
"/_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
\n\n\n\n\n",
+ "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
\n\n\n\n\n",
"parameters": [
{
"description": "The id of the collection.\n\n",
@@ -4576,7 +4576,7 @@
},
"/_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
\n\n\n\n\n",
+ "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
\n\n\n\n\n",
"parameters": [],
"responses": {
"200": {
@@ -4623,7 +4623,7 @@
},
"/_api/explain": {
"post": {
- "description": "\n**A JSON object with these properties is required:**\n\n - **query**: the query which you want explained; If the query references any bind variables,\n these must also be passed in the attribute *bindVars*. Additional\n options for the query can be passed in the *options* attribute.\n - **options**:\n - **optimizer.rules** (string): an array of to-be-included or to-be-excluded optimizer rules\n can be put into this attribute, telling the optimizer to include or exclude\n specific rules. To disable a rule, prefix its name with a `-`, to enable a rule, prefix it\n with a `+`. There is also a pseudo-rule `all`, which will match all optimizer rules.\n - **maxNumberOfPlans**: an optional maximum number of plans that the optimizer is \n allowed to generate. Setting this attribute to a low value allows to put a\n cap on the amount of work the optimizer does.\n - **allPlans**: if set to *true*, all possible execution plans will be returned.\n The default is *false*, meaning only the optimal plan will be returned.\n - **bindVars** (object): key/value pairs representing the bind parameters.\n\n\n\n\n\nTo explain how an AQL query would be executed on the server, the query string\ncan be sent to the server via an HTTP POST request. The server will then validate\nthe query and create an execution plan for it. The execution plan will be\nreturned, but the query will not be executed.\n\nThe execution plan that is returned by the server can be used to estimate the\nprobable performance of the query. Though the actual performance will depend\non many different factors, the execution plan normally can provide some rough\nestimates on the amount of work the server needs to do in order to actually run \nthe query.\n\nBy default, the explain operation will return the optimal plan as chosen by\nthe query optimizer The optimal plan is the plan with the lowest total estimated\ncost. The plan will be returned in the attribute *plan* of the response object.\nIf the option *allPlans* is specified in the request, the result will contain \nall plans created by the optimizer. The plans will then be returned in the \nattribute *plans*.\n\nThe result will also contain an attribute *warnings*, which is an array of \nwarnings that occurred during optimization or execution plan creation. Additionally,\na *stats* attribute is contained in the result with some optimizer statistics.\nIf *allPlans* is set to *false*, the result will contain an attribute *cacheable* \nthat states whether the query results can be cached on the server if the query\nresult cache were used. The *cacheable* attribute is not present when *allPlans*\nis set to *true*.\n\nEach plan in the result is a JSON object with the following attributes:\n- *nodes*: the array of execution nodes of the plan. The array of available node types\n can be found [here](../../AQL/ExecutionAndPerformance/Optimizer.html)\n\n- *estimatedCost*: the total estimated cost for the plan. If there are multiple\n plans, the optimizer will choose the plan with the lowest total cost.\n\n- *collections*: an array of collections used in the query\n\n- *rules*: an array of rules the optimizer applied. An overview of the\n available rules can be found [here](../../AQL/ExecutionAndPerformance/Optimizer.html)\n\n- *variables*: array of variables used in the query (note: this may contain\n internal variables created by the optimizer)\n\n\n\n\n#Example:\n Valid query\n\n
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.1400 Bad Request\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n \"error\" : true, \n \"errorMessage\" : \"no value specified for declared bind parameter 'id' (while parsing)\", \n \"code\" : 400, \n \"errorNum\" : 1551 \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
\n\n\n\n\n",
+ "description": "\n**A JSON object with these properties is required:**\n\n - **query**: the query which you want explained; If the query references any bind variables,\n these must also be passed in the attribute *bindVars*. Additional\n options for the query can be passed in the *options* attribute.\n - **options**:\n - **optimizer.rules** (string): an array of to-be-included or to-be-excluded optimizer rules\n can be put into this attribute, telling the optimizer to include or exclude\n specific rules. To disable a rule, prefix its name with a `-`, to enable a rule, prefix it\n with a `+`. There is also a pseudo-rule `all`, which will match all optimizer rules.\n - **maxNumberOfPlans**: an optional maximum number of plans that the optimizer is \n allowed to generate. Setting this attribute to a low value allows to put a\n cap on the amount of work the optimizer does.\n - **allPlans**: if set to *true*, all possible execution plans will be returned.\n The default is *false*, meaning only the optimal plan will be returned.\n - **bindVars** (object): key/value pairs representing the bind parameters.\n\n\n\n\n\nTo explain how an AQL query would be executed on the server, the query string\ncan be sent to the server via an HTTP POST request. The server will then validate\nthe query and create an execution plan for it. The execution plan will be\nreturned, but the query will not be executed.\n\nThe execution plan that is returned by the server can be used to estimate the\nprobable performance of the query. Though the actual performance will depend\non many different factors, the execution plan normally can provide some rough\nestimates on the amount of work the server needs to do in order to actually run \nthe query.\n\nBy default, the explain operation will return the optimal plan as chosen by\nthe query optimizer The optimal plan is the plan with the lowest total estimated\ncost. The plan will be returned in the attribute *plan* of the response object.\nIf the option *allPlans* is specified in the request, the result will contain \nall plans created by the optimizer. The plans will then be returned in the \nattribute *plans*.\n\nThe result will also contain an attribute *warnings*, which is an array of \nwarnings that occurred during optimization or execution plan creation. Additionally,\na *stats* attribute is contained in the result with some optimizer statistics.\nIf *allPlans* is set to *false*, the result will contain an attribute *cacheable* \nthat states whether the query results can be cached on the server if the query\nresult cache were used. The *cacheable* attribute is not present when *allPlans*\nis set to *true*.\n\nEach plan in the result is a JSON object with the following attributes:\n- *nodes*: the array of execution nodes of the plan. The array of available node types\n can be found [here](../../AQL/ExecutionAndPerformance/Optimizer.html)\n\n- *estimatedCost*: the total estimated cost for the plan. If there are multiple\n plans, the optimizer will choose the plan with the lowest total cost.\n\n- *collections*: an array of collections used in the query\n\n- *rules*: an array of rules the optimizer applied. An overview of the\n available rules can be found [here](../../AQL/ExecutionAndPerformance/Optimizer.html)\n\n- *variables*: array of variables used in the query (note: this may contain\n internal variables created by the optimizer)\n\n\n\n\n#Example:\n Valid query\n\n
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.1400 Bad Request\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n \"error\" : true, \n \"errorMessage\" : \"no value specified for declared bind parameter 'id' (while parsing)\", \n \"code\" : 400, \n \"errorNum\" : 1551 \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
\n\n\n\n\n",
"parameters": [],
"responses": {
"200": {
@@ -5344,7 +5344,7 @@
"x-filename": "Graph - /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /arangodb33/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 object with these properties is required:**\n\n - **orphanCollections**: An array of additional vertex collections.\n - **edgeDefinitions**: An array of definitions for the edge\n - **name**: Name of the graph.\n - **isSmart**: Define if the created graph should be smart.\n This only has effect in Enterprise version.\n - **options**:\n - **smartGraphAttribute**: The attribute name that is used to smartly shard the vertices of a graph.\n Every vertex in this Graph has to have this attribute.\n Cannot be modified later.\n - **numberOfShards**: The number of shards that is used for every collection within this graph.\n Cannot be modified later.\n\n\n\n\n\n#Example:\n \n\n
\n\n\n\n\n",
+ "description": "\n\nThe creation of a graph requires the name of the graph and a\ndefinition of its edges.\n[See also edge definitions](../../Manual/Graphs/GeneralGraphs/Management.html#edge-definitions).\n\n\n**A JSON object with these properties is required:**\n\n - **orphanCollections**: An array of additional vertex collections.\n - **edgeDefinitions**: An array of definitions for the edge\n - **name**: Name of the graph.\n - **isSmart**: Define if the created graph should be smart.\n This only has effect in Enterprise version.\n - **options**:\n - **smartGraphAttribute**: The attribute name that is used to smartly shard the vertices of a graph.\n Every vertex in this Graph has to have this attribute.\n Cannot be modified later.\n - **numberOfShards**: The number of shards that is used for every collection within this graph.\n Cannot be modified later.\n\n\n\n\n\n#Example:\n \n\n
\n\n\n\n\n",
+ "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
\n\n\n\n\n",
"parameters": [],
"responses": {
"200": {
@@ -5436,7 +5436,7 @@
"x-filename": "Graph - /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /arangodb33/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 object with these properties is required:**\n\n - **to** (string): One or many vertex collections that can contain target vertices.\n - **from** (string): One or many vertex collections that can contain source vertices.\n - **collection**: The name of the edge collection to be used.\n\n\n\n\n\n#Example:\n \n\n
\n\n\n\n",
+ "description": "\n\nAdds an additional edge definition to the graph.\n\nThis edge definition has to contain a *collection* and an array of\neach *from* and *to* vertex collections. An edge definition can only\nbe added if this definition is either not used in any other graph, or\nit is used with exactly the same definition. It is not possible to\nstore a definition \"e\" from \"v1\" to \"v2\" in the one graph, and \"e\"\nfrom \"v2\" to \"v1\" in the other graph.\n\n\n**A JSON object with these properties is required:**\n\n - **to** (string): One or many vertex collections that can contain target vertices.\n - **from** (string): One or many vertex collections that can contain source vertices.\n - **collection**: The name of the edge collection to be used.\n\n\n\n\n\n#Example:\n \n\n
\n\n\n\n",
"parameters": [
{
"in": "body",
@@ -5472,7 +5472,7 @@
},
"/_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
\n\n\n\n\n",
+ "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
\n\n\n\n\n",
"parameters": [
{
"description": "The body has to be the JSON object to be stored.\n\n",
@@ -5531,7 +5531,7 @@
"x-filename": "Graph - /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /arangodb33/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
\n\n\n\n\n",
"parameters": [
{
"description": "The body has to be a JSON object containing the attributes to be updated.\n\n",
@@ -5585,7 +5585,7 @@
"x-filename": "Graph - /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /arangodb33/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
\n\n\n\n",
"parameters": [
{
"description": "The body has to be the JSON object to be stored.\n\n",
@@ -5623,7 +5623,7 @@
},
"/_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
\n\n\n\n",
+ "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
\n\n\n\n",
"parameters": [],
"responses": {
"201": {
@@ -5647,7 +5647,7 @@
"x-filename": "Graph - /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /arangodb33/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 object with these properties is required:**\n\n - **to** (string): One or many vertex collections that can contain target vertices.\n - **from** (string): One or many vertex collections that can contain source vertices.\n - **collection**: The name of the edge collection to be used.\n\n\n\n\n\n#Example:\n \n\n
\n\n\n\n",
+ "description": "\n\nChange one specific edge definition.\nThis will modify all occurrences of this definition in all graphs known to your database.\n\n\n**A JSON object with these properties is required:**\n\n - **to** (string): One or many vertex collections that can contain target vertices.\n - **from** (string): One or many vertex collections that can contain source vertices.\n - **collection**: The name of the edge collection to be used.\n\n\n\n\n\n#Example:\n \n\n
\n\n\n\n",
+ "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
\n\n\n\n",
"parameters": [],
"responses": {
"201": {
@@ -5724,7 +5724,7 @@
},
"/_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
\n\n\n\n\n",
+ "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
\n\n\n\n\n",
"parameters": [
{
"description": "The body has to be the JSON object to be stored.\n\n",
@@ -5807,7 +5807,7 @@
"x-filename": "Graph - /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /arangodb33/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
\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",
@@ -5864,7 +5864,7 @@
"x-filename": "Graph - /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /arangodb33/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /arangodb33/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
\n\n\n\n\n",
"parameters": [
{
"description": "The body has to be the JSON object to be stored.\n\n",
@@ -6103,7 +6103,7 @@
},
"/_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
\n\n\n\n\n",
+ "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
\n\n\n\n\n",
"parameters": [
{
"description": "The collection name.\n\n",
@@ -6128,7 +6128,7 @@
},
"/_api/index#fulltext": {
"post": {
- "description": "\n**A JSON object 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
\n\n\n\n\n",
+ "description": "\n**A JSON object 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
\n\n\n\n\n",
"parameters": [
{
"description": "The collection name.\n\n",
@@ -6213,7 +6213,7 @@
},
"/_api/index#geo": {
"post": {
- "description": "\n**A JSON object 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
\n\n\n\n\n",
+ "description": "\n**A JSON object 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
\n\n\n\n\n",
"parameters": [
{
"description": "The collection name.\n\n\n",
@@ -6253,7 +6253,7 @@
},
"/_api/index#hash": {
"post": {
- "description": "\n**A JSON object 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 - **deduplicate**: if *false*, the deduplication of array values is turned off.\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
\n\n\n\n\n",
+ "description": "\n**A JSON object 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 - **deduplicate**: if *false*, the deduplication of array values is turned off.\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
\n\n\n\n\n",
"parameters": [
{
"description": "The collection name.\n\n",
@@ -6296,7 +6296,7 @@
},
"/_api/index#persistent": {
"post": {
- "description": "\n**A JSON object 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
\n\n\n\n\n",
+ "description": "\n**A JSON object 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
\n\n\n\n\n",
"parameters": [
{
"description": "The collection name.\n\n",
@@ -6339,7 +6339,7 @@
},
"/_api/index#skiplist": {
"post": {
- "description": "\n**A JSON object 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 - **deduplicate**: if *false*, the deduplication of array values is turned off.\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
\n\n\n\n\n",
+ "description": "\n**A JSON object 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 - **deduplicate**: if *false*, the deduplication of array values is turned off.\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
\n\n\n\n\n",
"parameters": [
{
"description": "The index handle.\n\n",
@@ -6438,7 +6438,7 @@
},
"/_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
\n\n\n\n\n",
+ "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
\n\n\n\n\n",
"parameters": [
{
"description": "The async job id.\n\n",
@@ -6468,7 +6468,7 @@
"x-filename": "job - /arangodb33/Documentation/DocuBlocks/Rest/job/JSF_job_cancel.md, /arangodb33/Documentation/DocuBlocks/Rest/job/JSF_job_delete.md, /arangodb33/Documentation/DocuBlocks/Rest/job/JSF_job_fetch_result.md, /arangodb33/Documentation/DocuBlocks/Rest/job/JSF_job_getByType.md, /arangodb33/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
\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: 151152750087081\nx-content-type-options: nosniff\n\nshell> curl -X PUT --dump - http://localhost:8529/_api/job/151152750087081\n\nHTTP/1.1400 Bad Request\ncontent-type: application/json; charset=utf-8\nx-arango-async-id: 151152750087081\nx-content-type-options: nosniff\n\n{ \n \"error\" : true, \n \"errorMessage\" : \"expected PUT /_api/collection/<collection-name>/<action>\", \n \"code\" : 400, \n \"errorNum\" : 400 \n}\n
\n\n\n\n\n",
+ "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
\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: 151188720791647\nx-content-type-options: nosniff\n\nshell> curl -X PUT --dump - http://localhost:8529/_api/job/151188720791647\n\nHTTP/1.1400 Bad Request\ncontent-type: application/json; charset=utf-8\nx-arango-async-id: 151188720791647\nx-content-type-options: nosniff\n\n{ \n \"error\" : true, \n \"errorMessage\" : \"expected PUT /_api/collection/<collection-name>/<action>\", \n \"code\" : 400, \n \"errorNum\" : 400 \n}\n
\n\n\n\n\n",
"parameters": [
{
"description": "The async job id.\n\n",
@@ -6500,7 +6500,7 @@
},
"/_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: 151152750087039\nx-content-type-options: nosniff\n\nshell> curl --dump - http://localhost:8529/_api/job/pending\n\nHTTP/1.1200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n[ \n \"151152750087039\" \n]\nshell> curl -X PUT --dump - http://localhost:8529/_api/job/151152750087039/cancel\n\nHTTP/1.1200 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.1200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n[ \n \"151152750087039\" \n]\n
\n\n\n\n\n",
+ "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: 151188720791605\nx-content-type-options: nosniff\n\nshell> curl --dump - http://localhost:8529/_api/job/pending\n\nHTTP/1.1200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n[ \n \"151188720791605\" \n]\nshell> curl -X PUT --dump - http://localhost:8529/_api/job/151188720791605/cancel\n\nHTTP/1.1200 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.1200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n[ \n \"151188720791605\" \n]\n
\n\n\n\n\n",
"parameters": [
{
"description": "The async job id.\n\n",
@@ -6532,7 +6532,7 @@
},
"/_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
\n\n\n\n\n",
+ "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
\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",
@@ -6562,7 +6562,7 @@
"x-filename": "job - /arangodb33/Documentation/DocuBlocks/Rest/job/JSF_job_cancel.md, /arangodb33/Documentation/DocuBlocks/Rest/job/JSF_job_delete.md, /arangodb33/Documentation/DocuBlocks/Rest/job/JSF_job_fetch_result.md, /arangodb33/Documentation/DocuBlocks/Rest/job/JSF_job_getByType.md, /arangodb33/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
\n\n\n\n\n",
+ "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
\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",
@@ -6884,7 +6884,7 @@
},
"/_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
\n\n\n\n\n",
+ "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
\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",
@@ -6918,7 +6918,7 @@
},
"/_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
\n\n\n\n\n",
+ "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
\n\n\n\n\n",
+ "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
\n\n\n\n\n",
"parameters": [],
"responses": {
"200": {
@@ -7099,7 +7099,7 @@
},
"/_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
\n\n\n\n\n",
+ "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
\n\n\n\n\n",
"parameters": [
{
"description": "The name or id of the collection to dump.\n\n",
@@ -7188,7 +7188,7 @@
},
"/_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 an array of collections with the following sub-attributes:\n\n- *parameters*: the collection properties\n\n- *indexes*: an array of the indexes of a the collection. Primary indexes and edge 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
\n\n\n\n\n",
+ "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 an array of collections with the following sub-attributes:\n\n- *parameters*: the collection properties\n\n- *indexes*: an array of the indexes of a the collection. Primary indexes and edge 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
\n\n\n\n\n",
"parameters": [
{
"description": "Include system collections in the result. The default value is *true*.\n\n",
@@ -7245,7 +7245,7 @@
},
"/_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
\n\n\n\n\n",
+ "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
\n\n\n\n\n",
"parameters": [
{
"description": "Lower bound tick value for results.\n\n",
@@ -7306,7 +7306,7 @@
},
"/_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
\n\n\n\n\n",
+ "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
\n\n\n\n\n",
"parameters": [],
"responses": {
"200": {
@@ -7329,7 +7329,7 @@
},
"/_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
\n\n\n\n\n",
+ "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
\n\n\n\n\n",
"parameters": [],
"responses": {
"200": {
@@ -7394,7 +7394,7 @@
},
"/_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
\n\n\n\n\n",
+ "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
\n\n\n\n\n",
"parameters": [],
"responses": {
"200": {
@@ -7456,7 +7456,7 @@
},
"/_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
\n\n\n\n\n",
+ "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
\n\n\n\n\n",
"parameters": [
{
"description": "Contains the query.\n\n",
@@ -7491,7 +7491,7 @@
},
"/_api/simple/all-keys": {
"put": {
- "description": "\n**A JSON object 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
\n\n\n\n\n",
+ "description": "\n**A JSON object 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
\n\n\n\n\n",
"parameters": [
{
"in": "body",
@@ -7521,7 +7521,7 @@
},
"/_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 object 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
\n\n\n\n\n",
+ "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 object 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
\n\n\n\n\n",
"parameters": [
{
"in": "body",
@@ -7554,7 +7554,7 @@
},
"/_api/simple/by-example": {
"put": {
- "description": "\n**A JSON object 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
\n\n\n\n\n",
+ "description": "\n**A JSON object 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
\n\n\n\n\n",
"parameters": [
{
"in": "body",
@@ -7587,7 +7587,7 @@
},
"/_api/simple/first-example": {
"put": {
- "description": "\n**A JSON object 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
\n\n\n\n\n",
+ "description": "\n**A JSON object 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
\n\n\n\n\n",
"parameters": [
{
"in": "body",
@@ -7620,7 +7620,7 @@
},
"/_api/simple/fulltext": {
"put": {
- "description": "\n**A JSON object 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
\n\n\n\n\n",
+ "description": "\n**A JSON object 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
\n\n\n\n\n",
"parameters": [
{
"in": "body",
@@ -7653,7 +7653,7 @@
},
"/_api/simple/lookup-by-keys": {
"put": {
- "description": "\n**A JSON object 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
\n\n\n\n\n\n",
+ "description": "\n**A JSON object 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
\n\n\n\n\n\n",
"parameters": [
{
"in": "body",
@@ -7686,7 +7686,7 @@
},
"/_api/simple/near": {
"put": {
- "description": "\n**A JSON object 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
\n\n\n\n\n",
+ "description": "\n**A JSON object 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
\n\n\n\n\n",
"parameters": [
{
"in": "body",
@@ -7719,7 +7719,7 @@
},
"/_api/simple/range": {
"put": {
- "description": "\n**A JSON object 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
\n\n\n\n\n",
+ "description": "\n**A JSON object 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
\n\n\n\n\n",
"parameters": [
{
"in": "body",
@@ -7884,7 +7884,7 @@
},
"/_api/simple/within": {
"put": {
- "description": "\n**A JSON object 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
\n\n\n\n\n",
+ "description": "\n**A JSON object 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
\n\n\n\n\n",
"parameters": [
{
"in": "body",
@@ -7917,7 +7917,7 @@
},
"/_api/simple/within-rectangle": {
"put": {
- "description": "\n**A JSON object 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
\n\n\n\n\n",
+ "description": "\n**A JSON object 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
\n\n\n\n\n",
"parameters": [
{
"in": "body",
@@ -7950,7 +7950,7 @@
},
"/_api/tasks": {
"post": {
- "description": "\n**A JSON object 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
\n\n\n\n\n",
+ "description": "\n**A JSON object 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
\n\n\n\n\n",
+ "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
\n\n\n\n\n",
"parameters": [
{
"description": "The id of the task to fetch.\n\n",
@@ -8042,7 +8042,7 @@
"x-filename": "Administration - /arangodb33/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /arangodb33/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /arangodb33/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /arangodb33/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /arangodb33/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /arangodb33/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /arangodb33/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md, /arangodb33/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /arangodb33/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /arangodb33/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /arangodb33/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /arangodb33/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_cluster_endpoints.md, /arangodb33/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /arangodb33/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /arangodb33/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /arangodb33/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /arangodb33/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /arangodb33/Documentation/DocuBlocks/Rest/Administration/JSF_get_engine.md, /arangodb33/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /arangodb33/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /arangodb33/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /arangodb33/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md"
},
"put": {
- "description": "\n**A JSON object 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
\n\n\n\n\n",
+ "description": "\n**A JSON object 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
\n\n\n\n\n",
"parameters": [
{
"description": "The id of the task to create\n\n",
@@ -8113,7 +8113,7 @@
},
"/_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 object 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
\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
\n\n\n\n\n\n",
+ "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 object 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
\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
\n\n\n\n\n\n",
"parameters": [
{
"in": "body",
@@ -8695,7 +8695,7 @@
},
"/_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
\n\n\n\n\n",
+ "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
\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",
diff --git a/js/apps/system/_admin/aardvark/APP/frontend/build/app.min.js.gz b/js/apps/system/_admin/aardvark/APP/frontend/build/app.min.js.gz
index b84d54de78..49590141b1 100644
Binary files a/js/apps/system/_admin/aardvark/APP/frontend/build/app.min.js.gz and b/js/apps/system/_admin/aardvark/APP/frontend/build/app.min.js.gz differ
diff --git a/js/apps/system/_admin/aardvark/APP/frontend/build/index-min.html b/js/apps/system/_admin/aardvark/APP/frontend/build/index-min.html
index 0519a697fa..a1c78207a6 100644
--- a/js/apps/system/_admin/aardvark/APP/frontend/build/index-min.html
+++ b/js/apps/system/_admin/aardvark/APP/frontend/build/index-min.html
@@ -2912,4 +2912,4 @@ var cutByResolution = function (str) {
-
Loading...
You have been disconnected from the server
The connection to the server has been lost. The server may be under heavy load.