Introduction

The new Datafari API is trying to respect the principles of RESTFUL applications as much as possible and use json as the mean to exchange data. This means that everything returned by the API will be JSON, and any payload in POST and PUT requests made to the API will be in JSON too.

On GET and DELETE requests, some parameter may be passed through url parmeters (either as part of the URL or in the search parameter String - anything that is after the “?”)

Prefix

Every endpoint in this API are prefixed by /rest/VX.Y/ where X and Y are the major and minor versions of this API.

Do also remember to add the relevant path to your Datafari web app (https://datafaridomain/Datafari/rest/VX.Y/endpoint)

Response Structure

All responses are formatted using the following template:

{
  "status": "OK|ERROR",
  "content": {}
}

In the following, any object presented as the response is showing the format of the content key in the above template.

For errors, the content follows the following structure:

{
  "code": {int},
  "reason": {String},
  "extra": {Object}
}

1. code: an integer using the HTTP response code nomenclature

2. reason: a String in English giving some details if relevant to help solve the problem or give context

3. extra: a JSON object providing some extra information from the endpoint if relevant, can be null or empty

Do keep in mind that on some occasions the server might respond with an HTTP error code without any JSON payload, you must handle this case in your applications.

Endpoints

V2.0

GET /rest/v2.0/search/*

This is the endpoint to perform a search request. This endpoint expects a search handler to be provided as well as all the elements of a solr query as URL parameters. A simple example for a search query would be:

GET {DATAFARI_BASE_URL}/rest/v2.0/search/select?q=*:*

Note that {DATAFARI_BASE_URL} is by default of the following shape: [DATAFARI_DOMAIN_NAME]/Datafari

This endpoints allows the use of only a few selected search handlers for security reasons. The handlers that can be called are different depending on the value of the special “action” URL parameter.

The main handlers to keep in mind are /select and /suggest.

The /select handler is used to perform search queries while the /suggesthandler is used to get suggestions for autocomplete.

If you wonder how to format your queries (either for search or query), please refer to the Solr documentation as well as the rest of Datafari’s documentation for the fields available.

Response format

The response format of this endpoint does not follow the standard response format of this API.

The payload of the response is the response from solr (please refer to the Solr documentation to see what those response look like or experiment with the endpoint).
If solr encountered an error, the endpoint will most of the time respond with 200 status, the error being in the solr response itself.

If an error occurred while Datafari is querying Solr, the response may be a 500 or 5xx http response with possibly no JSON (and maybe an html page as a response body).

For each document in the response, they have two fields for the url:

1. doc.url : the original url of the document

2. doc.click_url : The url to use for the href link to send the user to the document (and will track user clicks to get statistics in the search engine)

GET /rest/v2.0/results/export?*

This is the endpoint to perform an export of the result of a provided query. Here are the parameters to provide:

• query: the main query to perform. ex:
  query=*:*

• facetQuery: An array containing all the facet queries. ex:
  facetQuery[]={!key=From%20100KB%20To%2010MB}original_file_size:[102400 TO 10485760]&facetQuery[]={!key=More%20Than%2010MB}original_file_size:[10485760 TO *]

• facetField: An array containing all the facet fields. ex:
  facetField[]=extension&facetField[]=language&facetField[]=source

• fq: An array containing all the active filter queries. ex:
  fq[]={!tag=query}original_file_size:[102400 TO 10485760]&fq[]={!tag=author}(author:"agence de l'eau artois picardie")

• sort: The sort method to apply to results, can be either "score desc", or "score asc". ex:
  sort=score desc

• fl: The list of fields that must be returned in the results. The fields must be separated by a coma. ex:
  fl=title,last_modified,url

• nbResults: The number of results that the export file must contain. ex:
  nbResults=500
  Be careful with this parameter, because the higher is the number, the more the query will take time and the export file will be big

• type: The type of the export file to generate. Currently (December 2022) the only supported type is “excel”:
  type=excel

Here is an example of a GET request to the export API:

/rest/v2.0/results/export?query=*:*&facetQuery[]=original_file_size:[102400 TO 10485760]&facetQuery[]=original_file_size:[10485760 TO *]&facetField[]=extension&facetField[]=language&fq[]=original_file_size:[102400 TO 10485760]&sort=score desc&fl=title,last_modified,url&nbResults=10&type=excel

The response of this endpoint is a bytes input stream of the generated export file. In a standard web browser like chrome, it will trigger a download process

V1.0

Bellow is a set of API endpoints that are implemented or in the roadmap. Endpoints that are not implemented are clearly identified by the “NOT IMPLEMENTED” string in the response column. Those endpoints return a 501 HTTP Response code when queried (which is the code for the NOT_IMPLEMENTED http error). For implemented endpoints, query body and format for the content object of the response in case of success are provided.

{
  "name":{String},
  "roles":[{Strings}],
  "lang": {String}
  "uiConfig": {Obj}
}

{
  "lang"?:{String}
  "uiConfig"?: {Obj}
}

{
  "name":{String},
  "roles":[{Strings}],
  "lang": {String}
  "uiConfig": {Obj}
}

{
  "uiConfig": {Obj}
}

{
  "uiConfig": {Obj}
}

{
  "uiConfig": {Obj}
}

{
  "activated":{boolean as String}
}

{
  "alerts":[
    {
      "_id":{String},
      "core":{String},
      "frequency":{String},
      "mail":{String},
      "subject":{String},
      "keyword":{String},
      "filters":{String - optional},
      "user": {String - username}
    },
    ...
  ]
}

{
  "core":{String - the solr core for the query},
  "frequency":{String - },
  "mail":{String},
  "subject":{String},
  "keyword":{String - optional, query keywords, defaults to *:*},
  "filters":{String - optional, for facets etc., defaults to null},
}

{
  "_id": {String},
  "core":{String},
  "frequency":{String - },
  "mail":{String},
  "subject":{String},
  "keyword":{String},
  "filters":{String},
}

{
  "core":{String - the solr core for the query},
  "frequency":{String - },
  "mail":{String},
  "subject":{String},
  "keyword":{String - optional, query keywords, defaults to *:*},
  "filters":{String - optional, for facets etc., defaults to null},
}

{
  "_id": {String},
  "core":{String - the solr core for the query},
  "frequency":{String - },
  "mail":{String},
  "subject":{String},
  "keyword":{String - optional, query keywords, defaults to *:*},
  "filters":{String - optional, for facets etc., defaults to null},
}

{
  "_id": {String},
  "core":{String - the solr core for the query},
  "frequency":{String - },
  "mail":{String},
  "subject":{String},
  "keyword":{String - optional, query keywords, defaults to *:*},
  "filters":{String - optional, for facets etc., defaults to null},
}

{
  "savedsearches":[
    {
      "name":{String},
      "search":{String},
    },
    ...
  ]
}

{
  "name":{String - the name},
  "search":{String - the query},
}

{
  "name":{String - the name},
  "search":{String - the query},
}

{
  "name":{String - the name},
  "search":{String - the query},
}

{
  "name":{String - the name},
  "search":{String - the query},
}

{
  "name":{String - the name},
  "search":{String - the query},
}

{
  "favorites":[
    {
      "id": {String},
      "title": {String}
    },
    ...
  ]
}

{
  "id":{String},
  "title":{String}
}

{
  "id":{String},
  "title":{String}
}

{
  "id":{String}
}

{
  "id":{String},
  "title":{String}
}

{
  "history":[str...],
}

{
  "fields":[
    {"indexed":true,"stored":false,"name":"artifact_assignees_search","type":"text_general","multiValued":true},
     ...
  ]
}

{
  "exactFieldsList":[
    {},
     ...
  ]
}

{
  autocompleteFields:{
    "solr_field_name":"suggester",
    ...
}

{
  mappingFieldNameValues:{
    "solr_field_name":"label",
    ...
}

{
  "exactFieldsList":{
    "fieldname":[{"value":"solr_field_value","label":"label_todisplay"}, "*", ...],
     ...
  }
}

{
  "htmlHelpContent":{html}
}

{
  "htmlPrivacyContent":{html}
}

{
  "type":{String},
  "contact": {String - email},
  "time": {String - valid | ending | overdue | expired},
  "files": {String - valid | ending | overdue | expired},
  "users": {String - valid | ending | overdue | expired}
}

{
  "aggregatorList": [
    {
      "label": str,
      ?selected: bool
    }
  ]
}

Keep in mind that for now, this API is meant to cover standard users actions only. Admin actions are out of the scope for the time being.

Details

Special cases

Auth

For use authentication, the browser must be redirected to the auth endpoint. Once Datafari has finished the authentication process, the user is redirected to the callback URL provided as a URL parameter.

The URL to redirect the user to is:

{DATAFARI_BASE_URL}/rest/v1.0/auth?callback=url

Provide any URL you need the user to be send back to as the value for the callback parameter.

GET /rest/v1.0/search/*

This is the endpoint to perform a search request. This endpoint expects a search handler to be provided as well as all the elements of a solr query as URL parameters. A simple example for a search query would be:

GET {DATAFARI_BASE_URL}/rest/v1.0/search/select?q=*:*

This endpoints allows the use of only a few selected search handlers for security reasons. The handlers that can be called are different depending on the value of the special “action” URL parameter.

The main handlers to keep in mind are /select and /suggest.

The /select handlers is used to perform search queries while the suggest handler is used to get suggestions for autocomplete.

For how to format you queries (either for search or query), please refer to the Solr documentation as well as the rest of Datafari’s documentation for the fields available.

Response format

The response format of this endpoint does not follow the standard response format of this API. The payload of the response is the response from solr unfiltered (please refer to the Solr documentation to see what those response look like or experiment with the endpoint).
If solr encountered an error, the endpoint will most of the time respond with 200 status, the error being in the solr response itself.

If an error occurred while Datafari is querying Solr, the response may be a 500 or 5xx http response with possibly no JSON (and maybe an html page as a response body).

Standard endpoints

GET /rest/v1.0/users/current

This endpoints returns the information about the currently connected user in the following form:

{
  "name": {username}
  "roles": [{roles list}]
  "lang": {locale}
}

Exemple request / response

Request:

curl "https://localhost/Datafari/rest/v1_0/current"

Response:

HTTP 200/OK
{
  "status": "OK",
  "content": {
    "name": "admin"
    "roles": ["SearchAdmin"]
    "lang": "en"
  }
}