API de recherche

Mis à jour le 21 Nov 2024
11 Minutes à lire
Contributeurs

Impression
Partager
Sombre
Clair
PDF

Résumé de l’article

Avez-vous trouvé ce résumé utile ?

Merci pour vos commentaires

API de Recherche Générale

Cette API répond aux besoins suivants:

Permettre d’effectuer des recherches avancées et d’utiliser les mêmes mécaniques que la recherche avancée de Constellio via les APIs
Avoir un API optimisé pour la recherche avancée

Autorisations

Voir l'article OAuth2 pour générer le token.

Requête HTTP

POST  beta/records/search

En-tête de la requête

Paramètre	Description
authentication	Bearer {token}. Obligatoire.

Corps de la requête

Paramètres	Type	Description
query	String	La requête de la recherche en json

Dans le paramètre query nous avons les propriétés décrites dans le tableau ci-dessous:

Propriétés	Type	Description	Statut
searchTerms	String	Recherche par un texte simple	Facultatif
collection	String	La collection sur laquelle la recherche est faite	Obligatoire
schemaType	String	Le type de schéma	Obligatoire
filter	Objet (Voir section Filter)	Le filtre avec des operateurs logiques AND, OR ou NOT sur les métadonnées	Facultatif
searchParams	Objet (Voir section SearchParams)	Le paramétrage des résultats de recherche	Facultatif
sorting	List (Voir section Sorting)	Le tri des résultats sur les métadonnées	Facultatif

Filter

Permet de définir une condition simple sur une métadonnée, d'imbriquer des conditions avec les opérateurs OR, AND. Les opérateurs de comparaison supportés sont les suivants :

Opérateur	Exemple d'utilisation	Description
eq	{ "metadata": "title", "eq": "guide" }	L'opérateur d'égalité. Teste si la métadonnée est égale à la valeur fournie
bt	{ "metadata": "openingDate", "bt": { "min": "2000-10-03", "max": "2023-11-05" } }	L'opérateur beetween. Teste si la métadonnée est comprise dans l'intervalle fourni.
ct	{ "metadata": "numberMetadata", "ct": [ 88, 90 ] }	L'opérateur Contains. Teste si la métadonnée contient les valeurs fournies. Cet opérateur est utilisé sur des métadonnées à valeur multiple dont le type est diffèrent de string.
ctText	{ "metadata": "title", "ctText": "Abeille" }	L'opérateur Contains text. Teste si la métadonnée contient le texte fourni.
gt	{ "metadata": "openingDate", "gt": "2000-11-08" }	L'opérateur Greater than. Teste si la valeur de la métadonnée est supérieure à la valeur fournie.
lt	{ "metadata": "openingDate", "lt": "2000-11-08" }	L'opérateur Lower than. Teste si la valeur de la métadonnée est inferieure à la valeur fournie.
startsWith	{ "metadata": "title", "startsWith": "Abeille" }	L'opérateur Starts with. Teste si la valeur de la métadonnée commence avec la valeur fournie.
endsWith	{ "metadata": "title", "endsWith": "Abeille" }	L'opérateur Ends with. Teste si la valeur de la métadonnée se termine avec la valeur fournie.
nct	{ "metadata": "numberMetadata", "nct": [ 88, 90 ] }	L'opérateur NOT contains. Teste si la métadonnée ne contient pas les valeurs fournies. Cet operateur est utilisé sur des métadonnée à valeur multiple dont le type est diffèrent de string.
nctText	{ "metadata": "title", "nctText": "Abeille" }	L'opérateur NOT contains text. Teste si la métadonnée ne contient pas le texte fourni.
isTrue	{ "isTrue": "hasContent" }	L'opérateur is true. Teste si la valeur de la métadonnée est égale à true.
isFalse	{ "isFalse": "hasContent" }	L'opérateur is False. Teste si la valeur de la métadonnée est égale à false.
isNull	{ "isNull": "actualDestructionDate" }	L'opérateur is null. Teste si la valeur de la métadonnée est null.
isNotNull	{ "isNotNull": "actualDestructionDate" }	L'opérateur is not null. Teste si la valeur de la métadonnée n'est pas null.

SearchParams

Elle permet de gérer la paramétrisation des résultats de la recherche en définissant le nombre de résultats à retourner, à partir de quel index, les métadonnées à retourner, faire du highlighthing, calculer ou appliquer des facettes.

Propriétés	Type	Descriptions	Statut
resultCount	int	Le nombre de resultats a afficher	Facultatif
startIndex	int	Le début de l’index pour afficher les résultats. Par defaut	Facultatif
hl	List<String> ou enum avec les valeurs DEFAULT, SUMMARY	Pour faire du highlighting(mise en évidence)	Facultatif
metadatas	List<String> ou enum avec les valeurs ALL, RESULTS, SUMMARY	On peut définir dans une liste les metadonnées à retourner ou choisir l’une des mode ALL, RESULTS ou SUMMARY	Facultatif
facets	Object de type Facet (voir la section Facet)	Pour calculer ou appliquer les facettes	Facultatif
corrector	boolean	Pour activer la suggestion	Facultatif
showOnlyWriteAccess	boolean	Pour afficher seulement les enregistrements dont on a les droits en écriture	Facultatif

Facet

Propriétés	Type	Descriptions	Statut
computeFacet	boolean	pour calculer les facettes	Facultatif
facetMode	Enum avec les valeurs NONE, CONSTELLIO, SPECIFIC	NONE les facettes ne sont pas calculer CONSTELLIO Les facettes sont calculer SPECIFIC on applique les facettes definies dans la propriété selectedFacet ( Il faudra dans ce cas renseigner selectedFacet)	Facultatif
selectedFacet	List	La liste des facettes à appliquer. Dans chacune des facettes, on renseigne la métadonnée et les valeurs. comme ici : "selectedFacets": [{"metadata": "copyStatus", "values": ["P"]}]	Facultatif

Sorting

Propriétés	Type	Descriptions	Statut
metadata	String	la métadonnée	Obligatoire
ascending	boolean	Le type de tri ascendant ou descendant	Obligatoire

Avant d'interagir avec l'API, assurez-vous de respecter le schéma JSON de requête suivant :

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Constellio Search Expression",
  "type": "object",
  "properties": {
    "searchTerms": {
      "type": "string",
      "nullable": true
    },
    "collection": {
      "type": "string",
      "nullable": false
    },
    "schemaType": {
      "type": "string",
      "nullable": false
    },
    "filter": {
      "$ref": "#/definitions/filterCondition"
    },
    "searchParams": {
      "$ref": "#/definitions/searchParamsDefinition"
    },
    "sorting": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "metadata": {
            "type": "string"
          },
          "ascending": {
            "type": "boolean"
          }
        }
      }
    }
  },
  "definitions": {
    "arrayOfString": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "returnedMetadatasMode": {
      "type": "string",
      "enum": [
        "ALL",
        "RESULTS",
        "SUMMARY"
      ]
    },
    "highlightingMode": {
      "type": "string",
      "enum": [
        "DEFAULT",
        "SUMMARY"
      ]
    },
    "searchParamsDefinition": {
      "type": "object",
      "properties": {
        "resultCount": {
          "type": "integer"
        },
        "startIndex": {
          "type": "integer"
        },
        "hl": {
          "description": "highlighting on a set of metadata or choose the highlighting mode(DEFAULT, SUMMARY)",
          "oneOf": [
            {
              "$ref": "#/definitions/highlightingMode"
            },
            {
              "$ref": "#/definitions/arrayOfString"
            }
          ]
        },
        "metadatas": {
          "description": "returned metadatas. You can define the list of metadata to return or choose the mode(ALL,CACHED,RESULTS)",
          "oneOf": [
            {
              "$ref": "#/definitions/returnedMetadatasMode"
            },
            {
              "$ref": "#/definitions/arrayOfString"
            }
          ]
        },
        "facets": {
          "$ref": "#/definitions/facetsDefintion"
        },
        "corrector": {
          "type": "boolean"
        },
        "showOnlyWriteAccess": {
          "type": "boolean"
        }
      }
    },
    "facetsDefintion": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "computeFacets": {
          "type": "boolean"
        },
        "facetMode": {
          "type": "string",
          "enum": [
            "NONE",
            "CONSTELLIO",
            "SPECIFIC"
          ]
        },
        "selectedFacet": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/selectedFacetItem"
          }
        }
      },
      "required": [
        "computeFacets"
      ]
    },
    "selectedFacetItem": {
      "type": "object",
      "properties": {
        "metadata": {
          "type": "string"
        },
        "values": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "additionalProperties": false
    },
    "metadataDefinition": {
      "type": "string"
    },
    "eqOperator": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "metadata": {
          "$ref": "#/definitions/metadataDefinition"
        },
        "eq": {
          "type": "string"
        }
      },
      "required": [
        "metadata",
        "eq"
      ]
    },
    "betweenOperator": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "metadata": {
          "$ref": "#/definitions/metadataDefinition"
        },
        "bt": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "min": {
              "type": "string"
            },
            "max": {
              "type": "string"
            },
            "rangeIsIncluded": {
              "type": "boolean"
            }
          },
          "required": [
            "min",
            "max"
          ]
        }
      },
      "required": [
        "metadata",
        "bt"
      ]
    },
    "gtOperator": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "metadata": {
          "$ref": "#/definitions/metadataDefinition"
        },
        "gt": {
          "type": "string"
        }
      },
      "required": [
        "metadata",
        "gt"
      ]
    },
    "ltOperator": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "metadata": {
          "$ref": "#/definitions/metadataDefinition"
        },
        "lt": {
          "type": "string"
        }
      },
      "required": [
        "metadata",
        "lt"
      ]
    },
    "startsWithOperator": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "metadata": {
          "$ref": "#/definitions/metadataDefinition"
        },
        "startsWith": {
          "type": "string"
        }
      },
      "required": [
        "metadata",
        "startsWith"
      ]
    },
    "endsWithOperator": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "metadata": {
          "$ref": "#/definitions/metadataDefinition"
        },
        "endsWith": {
          "type": "string"
        }
      },
      "required": [
        "metadata",
        "endsWith"
      ]
    },
    "containsOperator": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "metadata": {
          "$ref": "#/definitions/metadataDefinition"
        },
        "ct": {
          "type": "string"
        }
      },
      "required": [
        "metadata",
        "ct"
      ]
    },
    "notContainsOperator": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "metadata": {
          "$ref": "#/definitions/metadataDefinition"
        },
        "nct": {
          "type": "string"
        }
      },
      "required": [
        "metadata",
        "nct"
      ]
    },
    "isTrueOperator": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "isTrue": {
          "type": "string"
        }
      },
      "required": [
        "isTrue"
      ]
    },
    "isFalseOperator": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "isFalse": {
          "type": "string"
        }
      },
      "required": [
        "isFalse"
      ]
    },
    "isNullOperator": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "isNull": {
          "type": "string"
        }
      },
      "required": [
        "isNull"
      ]
    },
    "isNotNullOperator": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "isNotNull": {
          "type": "string"
        }
      },
      "required": [
        "isNotNull"
      ]
    },
    "metadataCondition": {
      "type": "object",
      "anyOf": [
        {
          "$ref": "#/definitions/betweenOperator"
        },
        {
          "$ref": "#/definitions/eqOperator"
        },
        {
          "$ref": "#/definitions/gtOperator"
        },
        {
          "$ref": "#/definitions/ltOperator"
        },
        {
          "$ref": "#/definitions/startsWithOperator"
        },
        {
          "$ref": "#/definitions/endsWithOperator"
        },
        {
          "$ref": "#/definitions/containsOperator"
        },
        {
          "$ref": "#/definitions/notContainsOperator"
        },
        {
          "$ref": "#/definitions/isTrueOperator"
        },
        {
          "$ref": "#/definitions/isFalseOperator"
        },
        {
          "$ref": "#/definitions/isNullOperator"
        },
        {
          "$ref": "#/definitions/isNotNullOperator"
        }
      ]
    },
    "filterConditionList": {
      "type": "array",
      "items": {
        "$ref": "#/definitions/filterCondition"
      }
    },
    "andLogicalOperator": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "and": {
          "$ref": "#/definitions/filterConditionList"
        }
      },
      "required": [
        "and"
      ]
    },
    "orLogicalOperator": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "or": {
          "$ref": "#/definitions/filterConditionList"
        }
      },
      "required": [
        "or"
      ]
    },
    "notLogicalOperator": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "not": {
          "$ref": "#/definitions/filterConditionList"
        }
      },
      "required": [
        "not"
      ]
    },
    "filterCondition": {
      "oneOf": [
        {
          "$ref": "#/definitions/andLogicalOperator"
        },
        {
          "$ref": "#/definitions/orLogicalOperator"
        },
        {
          "$ref": "#/definitions/metadataCondition"
        },
        {
          "$ref": "#/definitions/notLogicalOperator"
        }
      ]
    }
  }
}

Exemples

Ceci équivaut à faire la requête suivante:
Chercher tous les documents de la collection zeCollection dont les critères suivants sont respectés:

(L'unité administrative est unitId_10 OU le document a du contenu OU le titre contient le texte "guide")
ET
(La date d'ouverture est entre 2000-10-03 et 2000-11-05)
ET
(La date d'ouverture est plus grande que 2000-11-08 OU le titre commence par Crocodile OU la date de destruction n'est pas vide)

{
  "searchTerms": "",
  "collection": "zeCollection",
  "schemaType": "document",
  "filter": {
    "and": [
      {
        "or": [
          {
            "metadata": "administrativeUnit",
            "eq": "unitId_10"
          },
          {
            "isTrue": "hasContent"
          },
          {
            "metadata": "title",
            "ctText": "guide"
          }
        ]
      },
      {
        "metadata": "openingDate",
        "bt": {
          "min": "2000-10-03",
          "max": "2000-11-05"
        }
      },
      {
        "or": [
          {
            "metadata": "openingDate",
            "gt": "2000-11-08"
          },
          {
            "metadata": "title",
            "startsWith": "Crocodile"
          },
          {
            "isNotNull": "actualDestructionDate"
          }
        ]
      }
    ]
  },
  "searchParams": {
    "resultCount": 15,
    "startIndex": 0,
    "metadatas": "SUMMARY",
    "facets": {
      "computeFacets": true,
      "facetMode": "SPECIFIC",
      "selectedFacets": [
        {
          "metadata": "copyStatus",
          "values": [
            "P"
          ]
        }
      ]
    }
  },
  "sorting": [
    {
      "metadata": "title",
      "ascending": true
    }
  ]
}

Réponse

{
  "totalRowCount": 15,
  "startRow": 0,
  "endRow": 2,
  "page": 1,
  "totalPages": 5,
  "suggestions": [],
  "recordsResult": {
    "records": [
      {
        "id": "00000200221",
        "schemaType": "document",
        "metadatas": {
          "sameSemiActiveFateAsFolder": [
            "true"
          ],
          "visibleInTrees": [
            "false"
          ],
          "caption": [
            "Avocat / Avocat - Petit guide"
          ],
          "type": [
            "documentTypeId_3"
          ],
          "title": [
            "Avocat - Petit guide"
          ],
          "createdOn": [
            "2023-09-27T13:07:40.972"
          ],
          "principalpath": [
            "/admUnits/unitId_10/unitId_12/unitId_12b/B52/00000200221"
          ],
          "modifiedOn": [
            "2023-09-27T13:07:40.972"
          ],
          "estimatedSize": [
            "2750"
          ],
          "archivisticStatus": [
            "INACTIVE_DESTROYED"
          ],
          "currentContentSize": [
            "0.0"
          ],
          "copyStatus": [
            "PRINCIPAL"
          ],
          "principalAncestorsIntIds": [
            "-128",
            "-69",
            "-48",
            "-4"
          ],
          "borrowed": [
            "false"
          ],
          "contentVersionsCount": [
            "0"
          ],
          "confidential": [
            "false"
          ],
          "inheritedRetentionRule": [
            "ruleId_1"
          ],
          "contentVersionsSize": [
            "0.0"
          ],
          "hasContent": [
            "false"
          ],
          "attachedPrincipalAncestorsIntIds": [
            "-128",
            "-69",
            "-48",
            "-4",
            "200221"
          ],
          "secondaryConceptsIntIds": [
            "-155",
            "-85"
          ],
          "sameInactiveFateAsFolder": [
            "true"
          ],
          "published": [
            "false"
          ],
          "collection": [
            "zeCollection"
          ],
          "administrativeUnit": [
            "unitId_12b"
          ],
          "isCheckoutAlertSent": [
            "false"
          ],
          "folder": [
            "B52"
          ],
          "principalConceptsIntIds": [
            "-128",
            "-48",
            "-4"
          ],
          "category": [
            "categoryId_X100"
          ],
          "retentionRule": [
            "ruleId_1"
          ],
          "essential": [
            "false"
          ]
        },
        "contentMetadatas": null
      },
      {
        "id": "A42_numericContractWithDifferentCopy",
        "schemaType": "document",
        "metadatas": {
          "sameSemiActiveFateAsFolder": [
            "true"
          ],
          "caption": [
            "Crocodile / Crocodile - Document contrat numérique avec un autre exemplaire"
          ],
          "visibleInTrees": [
            "false"
          ],
          "title": [
            "Crocodile - Document contrat numérique avec un autre exemplaire"
          ],
          "type": [
            "documentTypeId_9"
          ],
          "createdOn": [
            "2023-09-27T13:07:43.975"
          ],
          "content": [
            "com.constellio.model.services.contents.ContentImpl@2c9ea756[checkoutDateTime=<null>,checkoutSource=0,checkoutUserId=<null>,currentCheckedOutVersion=<null>,currentVersion=com.constellio.model.entities.records.ContentVersion@2d7a6503[comment=<null>,contentVersionDataSummary=ContentVersionDataSummary{hash=GRVIJHXC4UR3Z6VNEJIJAG4RJZ7KVQYD, mimetype=application/vnd.openxmlformats-officedocument.wordprocessingml.document, length=37455},filename=contrat.docx,lastModificationDateTime=2023-09-27T13:07:43.551,lastModifiedBy=00000000006,version=0.1],dirty=false,emptyVersion=false,history=<null>,id=00000200310,lazyHistory=com.constellio.model.services.contents.ContentFactory$2@42ef282a]"
          ],
          "principalpath": [
            "/admUnits/unitId_10/unitId_10a/A42/A42_numericContractWithDifferentCopy"
          ],
          "modifiedOn": [
            "2023-09-27T13:07:43.975"
          ],
          "estimatedSize": [
            "4594"
          ],
          "archivisticStatus": [
            "SEMI_ACTIVE"
          ],
          "currentContentSize": [
            "37455.0"
          ],
          "copyStatus": [
            "PRINCIPAL"
          ],
          "principalAncestorsIntIds": [
            "-164",
            "-74",
            "-4"
          ],
          "borrowed": [
            "false"
          ],
          "contentVersionsCount": [
            "1"
          ],
          "confidential": [
            "false"
          ],
          "inheritedRetentionRule": [
            "ruleId_2"
          ],
          "contentVersionsSize": [
            "37455.0"
          ],
          "secondaryConceptsIntIds": [
            "-155",
            "-108",
            "-85"
          ],
          "attachedPrincipalAncestorsIntIds": [
            "-636",
            "-164",
            "-74",
            "-4"
          ],
          "hasContent": [
            "true"
          ],
          "sameInactiveFateAsFolder": [
            "true"
          ],
          "published": [
            "false"
          ],
          "collection": [
            "zeCollection"
          ],
          "administrativeUnit": [
            "unitId_10a"
          ],
          "isCheckoutAlertSent": [
            "false"
          ],
          "filename": [
            "contrat.docx"
          ],
          "folder": [
            "A42"
          ],
          "mimetype": [
            "Microsoft Word"
          ],
          "category": [
            "categoryId_X110"
          ],
          "principalConceptsIntIds": [
            "-164",
            "-4"
          ],
          "retentionRule": [
            "ruleId_2"
          ],
          "essential": [
            "false"
          ]
        },
        "contentMetadatas": null
      },
      {
        "id": "A42_numericDocumentWithSameCopy",
        "schemaType": "document",
        "metadatas": {
          "sameSemiActiveFateAsFolder": [
            "true"
          ],
          "visibleInTrees": [
            "false"
          ],
          "caption": [
            "Crocodile / Crocodile - Document numérique avec le même exemplaire"
          ],
          "title": [
            "Crocodile - Document numérique avec le même exemplaire"
          ],
          "createdOn": [
            "2023-09-27T13:07:43.976"
          ],
          "content": [
            "com.constellio.model.services.contents.ContentImpl@1b129336[checkoutDateTime=<null>,checkoutSource=0,checkoutUserId=<null>,currentCheckedOutVersion=<null>,currentVersion=com.constellio.model.entities.records.ContentVersion@653ebf2a[comment=<null>,contentVersionDataSummary=ContentVersionDataSummary{hash=ADIMNNRL566Z6IL7KKIPN2BBKOVN7BA3, mimetype=application/vnd.openxmlformats-officedocument.wordprocessingml.document, length=31777},filename=proces.docx,lastModificationDateTime=2023-09-27T13:07:43.573,lastModifiedBy=00000000006,version=0.1],dirty=false,emptyVersion=false,history=<null>,id=00000200311,lazyHistory=com.constellio.model.services.contents.ContentFactory$2@33f1e48a]"
          ],
          "principalpath": [
            "/admUnits/unitId_10/unitId_10a/A42/A42_numericDocumentWithSameCopy"
          ],
          "modifiedOn": [
            "2023-09-27T13:07:43.976"
          ],
          "estimatedSize": [
            "4260"
          ],
          "archivisticStatus": [
            "SEMI_ACTIVE"
          ],
          "currentContentSize": [
            "31777.0"
          ],
          "copyStatus": [
            "PRINCIPAL"
          ],
          "principalAncestorsIntIds": [
            "-164",
            "-74",
            "-4"
          ],
          "borrowed": [
            "false"
          ],
          "contentVersionsCount": [
            "1"
          ],
          "confidential": [
            "false"
          ],
          "inheritedRetentionRule": [
            "ruleId_2"
          ],
          "contentVersionsSize": [
            "31777.0"
          ],
          "secondaryConceptsIntIds": [
            "-155",
            "-108",
            "-85"
          ],
          "attachedPrincipalAncestorsIntIds": [
            "-492",
            "-164",
            "-74",
            "-4"
          ],
          "hasContent": [
            "true"
          ],
          "sameInactiveFateAsFolder": [
            "true"
          ],
          "published": [
            "false"
          ],
          "collection": [
            "zeCollection"
          ],
          "administrativeUnit": [
            "unitId_10a"
          ],
          "isCheckoutAlertSent": [
            "false"
          ],
          "filename": [
            "proces.docx"
          ],
          "folder": [
            "A42"
          ],
          "mimetype": [
            "Microsoft Word"
          ],
          "category": [
            "categoryId_X110"
          ],
          "principalConceptsIntIds": [
            "-164",
            "-4"
          ],
          "retentionRule": [
            "ruleId_2"
          ],
          "essential": [
            "false"
          ]
        },
        "contentMetadatas": null
      }
    ],
    "facets": [
      {
        "facetId": "copyStatus_s",
        "facetName": "Statut d'exemplaire",
        "values": [
          {
            "id": "copyStatus_s:P",
            "name": "Principal",
            "count": 15
          },
          {
            "id": "copyStatus_s:S",
            "name": "Secondaire",
            "count": 15
          }
        ]
      },
      {
        "facetId": "administrativeUnitId_s",
        "facetName": "Unités administratives",
        "values": [
          {
            "id": "administrativeUnitId_s:unitId_10a",
            "name": " 10A - Unité 10-A",
            "count": 14
          },
          {
            "id": "administrativeUnitId_s:unitId_12b",
            "name": " 12B - Unité 12-B",
            "count": 1
          }
        ]
      },
      {
        "facetId": "schema_s",
        "facetName": "Type",
        "values": [
          {
            "id": "schema_s:document_default",
            "name": "Document",
            "count": 15
          }
        ]
      },
      {
        "facetId": "categoryId_s",
        "facetName": "Catégories",
        "values": [
          {
            "id": "categoryId_s:categoryId_X110",
            "name": " X110 - X110",
            "count": 8
          },
          {
            "id": "categoryId_s:categoryId_Z120",
            "name": " Z120 - Z120",
            "count": 6
          },
          {
            "id": "categoryId_s:categoryId_X100",
            "name": " X100 - X100",
            "count": 1
          }
        ]
      },
      {
        "facetId": "archivisticStatus_s",
        "facetName": "Statut archivistique",
        "values": [
          {
            "id": "archivisticStatus_s:d",
            "name": "Détruit",
            "count": 11
          },
          {
            "id": "archivisticStatus_s:s",
            "name": "Semi-actif",
            "count": 4
          }
        ]
      }
    ],
    "references": [
      {
        "id": "B52",
        "schemaType": "folder",
        "code": null,
        "title": "Avocat",
        "description": null
      },
      {
        "id": "unitId_12b",
        "schemaType": "administrativeUnit",
        "code": "12B",
        "title": "Unité 12-B",
        "description": "Ze ultimate unit 12B"
      },
      {
        "id": "categoryId_X100",
        "schemaType": "category",
        "code": "X100",
        "title": "X100",
        "description": "Ze category X100"
      },
      {
        "id": "ruleId_1",
        "schemaType": "retentionRule",
        "code": "1",
        "title": "Règle de conservation #1",
        "description": "Description Rule 1"
      },
      {
        "id": "documentTypeId_3",
        "schemaType": "ddvDocumentType",
        "code": "3",
        "title": "Petit guide",
        "description": null
      },
      {
        "id": "A42",
        "schemaType": "folder",
        "code": null,
        "title": "Crocodile",
        "description": null
      },
      {
        "id": "unitId_10a",
        "schemaType": "administrativeUnit",
        "code": "10A",
        "title": "Unité 10-A",
        "description": "Ze ultimate unit 10A"
      },
      {
        "id": "categoryId_X110",
        "schemaType": "category",
        "code": "X110",
        "title": "X110",
        "description": "Ze category X110"
      },
      {
        "id": "ruleId_2",
        "schemaType": "retentionRule",
        "code": "2",
        "title": "Règle de conservation #2",
        "description": null
      },
      {
        "id": "documentTypeId_9",
        "schemaType": "ddvDocumentType",
        "code": "9",
        "title": "Contrat",
        "description": null
      }
    ]
  },
  "highlights": null,
  "nextRequest": {
    "rows": 15,
    "start": 3,
    "end": 5,
    "query": {
      "searchTerms": "",
      "collection": "zeCollection",
      "schemaType": "document",
      "filter": {
        "and": [
          {
            "or": [
              {
                "metadata": "administrativeUnit",
                "eq": "unitId_10"
              },
              {
                "isTrue": "hasContent"
              },
              {
                "metadata": "title",
                "ctText": "guide"
              }
            ]
          },
          {
            "metadata": "openingDate",
            "bt": {
              "min": "2000-10-03",
              "max": "2000-11-05"
            }
          },
          {
            "or": [
              {
                "metadata": "openingDate",
                "gt": "2000-11-08"
              },
              {
                "metadata": "title",
                "startsWith": "Crocodile"
              },
              {
                "isNotNull": "actualDestructionDate"
              }
            ]
          }
        ]
      },
      "searchParams": {
        "resultCount": 3,
        "startIndex": 3,
        "hl": null,
        "metadatas": "SUMMARY",
        "facets": {
          "computeFacets": true,
          "facetMode": "SPECIFIC",
          "selectedFacets": [
            {
              "metadata": "copyStatus",
              "values": [
                "P"
              ]
            }
          ]
        },
        "corrector": false,
        "showOnlyWriteAccess": false
      },
      "sorting": [
        {
          "metadata": "title",
          "ascending": true
        }
      ]
    }
  }
}

Cet article vous a-t-il été utile ?

What's Next

Rest API v2

Table des matières

API de Recherche Générale
Autorisations
Requête HTTP
En-tête de la requête
Corps de la requête
Exemples
Réponse