API Documentation
Master collection ¶
This section describes data that marked as master
Master collection ¶
Master collectionGET/*{?alt}
Represent the master collection
Example URI
- alt
string
(optional) Default: htmlAlternative representation type.
- $query
object
(required)Query filter serialize by MQS see MongoDB documentation syntax
- $orderby
object
(required)Sort on specific fields serialize by MQS see MongoDB documentation syntax
- $limit
object
(required)Limit the number of results serialize by MQS see MongoDB documentation syntax
- $offset
object
(required)Skipping results serialize by MQS see MongoDB documentation syntax
200
Headers
Content-Type: text/html
Body
<html>HTML representation</html>
One document of the master collection ¶
One document of the master collectionGET/=/*{?alt}
…
Example URI
- alt
string
(optional) Default: htmlAlternative representation type.
200
Headers
Content-Type: text/html
Body
<html>HTML representation</html>
Apply an operator documents on the master collection ¶
Apply an operator documents on the master collectionGET/${?alt}
Applique une opération de map/reduce sur les documents sélectionnés de la colelction princiaple.
Example URI
- alt
string
(optional) Default: dryAlternative representation type.
- $query
object
(required)Query filter serialize by MQS see MongoDB documentation syntax
- $orderby
object
(required)Sort on specific fields serialize by MQS see MongoDB documentation syntax
- $limit
object
(required)Limit the number of results serialize by MQS see MongoDB documentation syntax
- $offset
object
(required)Skipping results serialize by MQS see MongoDB documentation syntax
200
Headers
Content-Type: application/json
Body
{
"_id": "abc123",
"value": "This is a label",
}
Schema
{
"type": "object",
"properties": {
"_id": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
Temporary collection ¶
Documents of a temporary collection ¶
Documents of a temporary collectionGET/*{?alt}
Affichage des documents sélectionnés d’une collection dans un format JSON minimal si le paramètre alt= n’est pas spécifié.
Example URI
- alt
string
(optional) Default: dryAlternative representation type.
- $query
object
(required)Query filter serialize by MQS see MongoDB documentation syntax
- $orderby
object
(required)Sort on specific fields serialize by MQS see MongoDB documentation syntax
- $limit
object
(required)Limit the number of results serialize by MQS see MongoDB documentation syntax
- $offset
object
(required)Skipping results serialize by MQS see MongoDB documentation syntax
200
Headers
Content-Type: application/json
Body
{
"_id": "abc123",
"value": "This is a label",
}
Schema
{
"type": "object",
"properties": {
"_id": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
One document of a temporary collection ¶
One document of a temporary collectionGET/*{?alt}
Affichage des champs d’un document d’une collection dans un format JSON minimal si le paramètre alt= n’est pas spécifié.
Example URI
- alt
string
(optional) Default: dryAlternative representation type.
200
Headers
Content-Type: application/json
Body
{
"_id": "abc123",
"value": "This is a label",
}
Schema
{
"type": "object",
"properties": {
"_id": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
Apply an operator documents of a temporary collection ¶
Apply an operator documents of a temporary collectionGET/${?alt}
Applique l’opération de “labelization” sur les documents sélectionnés d’une collection dans un format JSON minimal si le paramètre alt= n’est pas spécifié.
Example URI
- alt
string
(optional) Default: dryAlternative representation type.
- $query
object
(required)Query filter serialize by MQS see MongoDB documentation syntax
- $orderby
object
(required)Sort on specific fields serialize by MQS see MongoDB documentation syntax
- $limit
object
(required)Limit the number of results serialize by MQS see MongoDB documentation syntax
- $offset
object
(required)Skipping results serialize by MQS see MongoDB documentation syntax
200
Headers
Content-Type: application/json
Body
{
"_id": "abc123",
"value": "This is a label",
}
Schema
{
"type": "object",
"properties": {
"_id": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
Field of document of temporary collection ¶
Field of document of temporary collectionGET/?fieldID
Affichage de la valeur d’un champ spécifique pour un document d’une collection dans un format JSON minimal si le paramètre alt= n’est pas spécifié.
Example URI
- alt
string
(optional) Default: dryAlternative representation type.
200
Headers
Content-Type: application/json
Body
{
"_id": "abc123",
"title": "This is a label"
}
Schema
{
"type": "object",
"properties": {
"_id": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
CRUD operations ¶
…
Fill a temporary collection ¶
Fill a temporary collectionPOST/
To load data to temporary collection.
Example URI
- typ
string
(required)Alternative input mode.
Choices:
file
uri
fork
Headers
Content-Type: application/json
Body
{
"file": "token d’un fichier précédent uploadé sur le serveur voir la route /-/upload",
"uri": "URL du contenu",
"fork": "collectionID de la collection à dupliquer"
}
201