ElasticSearchView

This view creates an ElasticSearch index and stores the targeted Json resources into an ElasticSearch Document.

The documents created on each view are isolated from documents created on other views by using different ElasticSearch indices.

A default view gets automatically created when the project is created but other views can be created.

Processing pipeline

An asynchronous process gets triggered for every view. This process can be visualized as a pipeline with different stages.

The first stage is the input of the pipeline: a stream of events scoped for the project where the view was created.

The last stage takes the JSON document, generated through the pipeline steps, and stores it as a Document in the corresponding ElasticSearch index.

ElasticSearchView pipeline

Payload

{
  "@id": "{someid}",
  "@type": "ElasticSearchView",
  "resourceSchemas": [ "{resourceSchema}", ...],
  "resourceTypes": [ "{resourceType}", ...],
  "resourceTag": "{tag}",
  "sourceAsText": {sourceAsText},
  "includeMetadata": {includeMetadata},
  "includeDeprecated": {includeDeprecated},
  "mapping": _elasticsearch mapping_,
  "settings": _elasticsearch settings_,
  "permission": "{permission}"
}

where…

  • {resourceSchema}: Iri - Selects only resources that are validated against the provided schema Iri. This field is optional.
  • {resourceType}: Iri - Select only resources of the provided type Iri. This field is optional.
  • {tag}: String - Selects only resources with the provided tag. This field is optional.
  • _elasticsearch mapping_: Json object - Defines the value types for the Json keys, as stated at the ElasticSearch mapping documentation.
  • _elasticssearch settings_: Json object - defines Elasticsearch index settings for the underlying Elasticsearch index. Default settings are applied, if not specified.
  • {sourceAsText}: Boolean - If true, the resource’s payload will be stored in the ElasticSearch document as a single escaped string value under the key _original_source. If false, the resource’s payload will be stored normally in the ElasticSearch document. The default value is false.
  • {includeMetadata}: Boolean - If true, the resource’s nexus metadata (_constrainedBy, _deprecated, …) will be stored in the ElasticSearch document. Otherwise it won’t. The default value is false.
  • {includeDeprecated}: Boolean - If true, deprecated resources are also indexed. The default value is false.
  • {someid}: Iri - The @id value for this view.
  • {permission}: String - permission required to query this view. Defaults to views/query.

Example

The following example creates an ElasticSearch view that will index resources validated against the schema with id https://bluebrain.github.io/nexus/schemas/myschema. If a resource is deprecated, it won’t be selected for indexing.

The resulting ElasticSearch Documents fields will be indexed according to the provided mapping rules and they won’t include the resource metadata fields.

{
  "@id": "https://bluebrain.github.io/nexus/vocabulary/myview",
  "@type": [
    "ElasticSearchView"
  ],
  "mapping": {
    "dynamic": false,
    "properties": {
      "@id": {
        "type": "keyword"
      },
      "@type": {
        "type": "keyword"
      },
      "name": {
        "type": "keyword"
      },
      "number": {
        "type": "long"
      },
      "bool": {
        "type": "boolean"
      }
    }
  },
  "includeMetadata": false,
  "includeDeprecated": false,
  "sourceAsText": false,
  "resourceSchemas": [
    "https://bluebrain.github.io/nexus/schemas/myschema"
  ],
  "resourceTypes": []
}

Create using POST

POST /v1/views/{org_label}/{project_label}
  {...}

The json payload:

  • If the @id value is found on the payload, this @id will be used.
  • If the @id value is not found on the payload, an @id will be generated as follows: base:{UUID}. The base is the prefix defined on the resource’s project ({project_label}).

Example

Request
sourcecurl -XPOST \
  -H "Content-Type: application/json" \
  "http://localhost:8080/v1/views/myorg/myproj" -d \
'{
    "@type": "ElasticSearchView",
    "mapping": {
      "dynamic": false,
      "properties": {
        "@id": {
          "type": "keyword"
        },
        "@type": {
          "type": "keyword"
        },
        "name": {
          "type": "keyword"
        },
        "number": {
          "type": "long"
        },
        "bool": {
          "type": "boolean"
        }
      }
    },
    "includeMetadata": true,
    "includeDeprecated": true,
    "sourceAsText": true,
    "resourceSchemas": [],
    "resourceTypes": []
}'
Payload
source{
  "@type": [
    "ElasticSearchView"
  ],
  "mapping": {
    "dynamic": false,
    "properties": {
      "@id": {
        "type": "keyword"
      },
      "@type": {
        "type": "keyword"
      },
      "name": {
        "type": "keyword"
      },
      "number": {
        "type": "long"
      },
      "bool": {
        "type": "boolean"
      }
    }
  },
  "includeMetadata": true,
  "includeDeprecated": true,
  "sourceAsText": true,
  "resourceSchemas": [],
  "resourceTypes": []
}
Response
source{
  "@context": [
    "https://bluebrain.github.io/nexus/contexts/elasticsearch-metadata.json",
    "https://bluebrain.github.io/nexus/contexts/metadata.json"
  ],
  "@id": "http://localhost:8080/v1/resources/myorg/myproj/_/386a8c21-3acf-4f10-90ab-329466f5e04c",
  "@type": [
    "ElasticSearchView",
    "View"
  ],
  "_constrainedBy": "https://bluebrain.github.io/nexus/schemas/views.json",
  "_createdAt": "2021-05-12T09:44:35.609Z",
  "_createdBy": "http://localhost:8080/v1/anonymous",
  "_deprecated": false,
  "_incoming": "http://localhost:8080/v1/views/myorg/myproj/386a8c21-3acf-4f10-90ab-329466f5e04c/incoming",
  "_outgoing": "http://localhost:8080/v1/views/myorg/myproj/386a8c21-3acf-4f10-90ab-329466f5e04c/outgoing",
  "_project": "http://localhost:8080/v1/projects/myorg/myproj",
  "_rev": 1,
  "_self": "http://localhost:8080/v1/views/myorg/myproj/386a8c21-3acf-4f10-90ab-329466f5e04c",
  "_updatedAt": "2021-05-12T09:44:35.609Z",
  "_updatedBy": "http://localhost:8080/v1/anonymous",
  "_uuid": "ea4b3858-c1ac-4afb-ac94-13fdb1b53681"
}

Create using PUT

This alternative endpoint to create a view is useful in case the json payload does not contain an @id but you want to specify one. The @id will be specified in the last segment of the endpoint URI.

PUT /v1/views/{org_label}/{project_label}/{view_id}
  {...}

Note that if the payload contains an @id different from the {view_id}, the request will fail.

Example

Request
sourcecurl -XPUT \
  -H "Content-Type: application/json" \
  "http://localhost:8080/v1/views/myorg/myproj/myview" -d \
'{
    "@type": "ElasticSearchView",
    "mapping": {
      "dynamic": false,
      "properties": {
        "@id": {
          "type": "keyword"
        },
        "@type": {
          "type": "keyword"
        },
        "name": {
          "type": "keyword"
        },
        "number": {
          "type": "long"
        },
        "bool": {
          "type": "boolean"
        }
      }
    },
    "includeMetadata": true,
    "includeDeprecated": true,
    "sourceAsText": true,
    "resourceSchemas": [],
    "resourceTypes": []
}'
Payload
source{
  "@type": [
    "ElasticSearchView"
  ],
  "mapping": {
    "dynamic": false,
    "properties": {
      "@id": {
        "type": "keyword"
      },
      "@type": {
        "type": "keyword"
      },
      "name": {
        "type": "keyword"
      },
      "number": {
        "type": "long"
      },
      "bool": {
        "type": "boolean"
      }
    }
  },
  "includeMetadata": true,
  "includeDeprecated": true,
  "sourceAsText": true,
  "resourceSchemas": [],
  "resourceTypes": []
}
Response
source{
  "@context": [
    "https://bluebrain.github.io/nexus/contexts/elasticsearch-metadata.json",
    "https://bluebrain.github.io/nexus/contexts/metadata.json"
  ],
  "@id": "http://localhost:8080/v1/resources/myorg/myproj/_/myview",
  "@type": [
    "ElasticSearchView",
    "View"
  ],
  "_constrainedBy": "https://bluebrain.github.io/nexus/schemas/views.json",
  "_createdAt": "2021-05-12T09:54:28.171Z",
  "_createdBy": "http://localhost:8080/v1/anonymous",
  "_deprecated": false,
  "_incoming": "http://localhost:8080/v1/views/myorg/myproj/myview/incoming",
  "_outgoing": "http://localhost:8080/v1/views/myorg/myproj/myview/outgoing",
  "_project": "http://localhost:8080/v1/projects/myorg/myproj",
  "_rev": 1,
  "_self": "http://localhost:8080/v1/views/myorg/myproj/myview",
  "_updatedAt": "2021-05-12T09:54:28.171Z",
  "_updatedBy": "http://localhost:8080/v1/anonymous",
  "_uuid": "7e737b83-30a0-4ea3-b6c9-cd1ed481d743"
}

Update

This operation overrides the payload.

In order to ensure a client does not perform any changes to a resource without having had seen the previous revision of the view, the last revision needs to be passed as a query parameter.

PUT /v1/views/{org_label}/{project_label}/{view_id}?rev={previous_rev}
  {...}

… where {previous_rev} is the last known revision number for the view.

Note

Updating a view creates a new Elasticsearch index and deletes the existing one. The indexing process will start from the beginning.

Example

Request
sourcecurl -XPUT \
-H "Content-Type: application/json" \
"http://localhost:8080/v1/views/myorg/myproj/myview?rev=1" -d \
'{
    "@type": [
        "ElasticSearchView"
    ],
    "mapping": {
    "dynamic": false,
    "properties": {
      "@id": {
        "type": "keyword"
      },
      "@type": {
        "type": "keyword"
      },
      "name": {
        "type": "keyword"
      },
      "number": {
        "type": "long"
      },
      "bool": {
        "type": "boolean"
      }
    }
  },
    "includeMetadata": true,
    "includeDeprecated": true,
    "sourceAsText": true,
    "resourceSchemas": [],
    "resourceTypes": []
}'
Payload
source{
  "@type": [
    "ElasticSearchView"
  ],
  "mapping": {
    "dynamic": false,
    "properties": {
      "@id": {
        "type": "keyword"
      },
      "@type": {
        "type": "keyword"
      },
      "name": {
        "type": "keyword"
      },
      "number": {
        "type": "long"
      },
      "bool": {
        "type": "boolean"
      }
    }
  },
  "includeMetadata": true,
  "includeDeprecated": true,
  "sourceAsText": true,
  "resourceSchemas": [],
  "resourceTypes": []
}
Response
source{
  "@context": [
    "https://bluebrain.github.io/nexus/contexts/elasticsearch-metadata.json",
    "https://bluebrain.github.io/nexus/contexts/metadata.json"
  ],
  "@id": "http://localhost:8080/v1/resources/myorg/myproj/_/myview",
  "@type": [
    "ElasticSearchView",
    "View"
  ],
  "_constrainedBy": "https://bluebrain.github.io/nexus/schemas/views.json",
  "_createdAt": "2021-05-12T09:54:28.171Z",
  "_createdBy": "http://localhost:8080/v1/anonymous",
  "_deprecated": false,
  "_incoming": "http://localhost:8080/v1/views/myorg/myproj/myview/incoming",
  "_outgoing": "http://localhost:8080/v1/views/myorg/myproj/myview/outgoing",
  "_project": "http://localhost:8080/v1/projects/myorg/myproj",
  "_rev": 2,
  "_self": "http://localhost:8080/v1/views/myorg/myproj/myview",
  "_updatedAt": "2021-05-12T09:56:26.156Z",
  "_updatedBy": "http://localhost:8080/v1/anonymous",
  "_uuid": "7e737b83-30a0-4ea3-b6c9-cd1ed481d743"
}

Tag

Links a view revision to a specific name.

Tagging a view is considered to be an update as well.

POST /v1/views/{org_label}/{project_label}/{view_id}/tags?rev={previous_rev}
  {
    "tag": "{name}",
    "rev": {rev}
  }

… where

  • {previous_rev}: is the last known revision number for the resource.
  • {name}: String - label given to the view at specific revision.
  • {rev}: Number - the revision to link the provided {name}.

Example

Request
sourcecurl -X POST \
     -H "Content-Type: application/json" \
     "http://localhost:8080/v1/views/myorg/myproj/nxv:myview/tags?rev=2" \
     -d \
'{
  "tag": "mytag",
  "rev": 1
}'
Payload
source{
  "tag": "mytag",
  "rev": 1
}
Response
source{
  "@context": [
    "https://bluebrain.github.io/nexus/contexts/elasticsearch-metadata.json",
    "https://bluebrain.github.io/nexus/contexts/metadata.json"
  ],
  "@id": "http://localhost:8080/v1/resources/myorg/myproj/_/myview",
  "@type": [
    "ElasticSearchView",
    "View"
  ],
  "_constrainedBy": "https://bluebrain.github.io/nexus/schemas/views.json",
  "_createdAt": "2021-05-12T09:54:28.171Z",
  "_createdBy": "http://localhost:8080/v1/anonymous",
  "_deprecated": false,
  "_incoming": "http://localhost:8080/v1/views/myorg/myproj/myview/incoming",
  "_outgoing": "http://localhost:8080/v1/views/myorg/myproj/myview/outgoing",
  "_project": "http://localhost:8080/v1/projects/myorg/myproj",
  "_rev": 3,
  "_self": "http://localhost:8080/v1/views/myorg/myproj/myview",
  "_updatedAt": "2021-05-12T09:58:20.507Z",
  "_updatedBy": "http://localhost:8080/v1/anonymous",
  "_uuid": "7e737b83-30a0-4ea3-b6c9-cd1ed481d743"
}

Deprecate

Locks the view, so no further operations can be performed. It also stops indexing any more resources into it and deletes the underlying index.

Deprecating a view is considered to be an update as well.

Note

Deprecating a view deletes the view index, making the view not searchable.

DELETE /v1/views/{org_label}/{project_label}/{view_id}?rev={previous_rev}

… where {previous_rev} is the last known revision number for the view.

Example

Request
sourcecurl -XDELETE \
  "http://localhost:8080/v1/views/myorg/myproj/myview?rev=3"
Response
source{
  "@context": [
    "https://bluebrain.github.io/nexus/contexts/elasticsearch-metadata.json",
    "https://bluebrain.github.io/nexus/contexts/metadata.json"
  ],
  "@id": "http://localhost:8080/v1/resources/myorg/myproj/_/myview",
  "@type": [
    "ElasticSearchView",
    "View"
  ],
  "_constrainedBy": "https://bluebrain.github.io/nexus/schemas/views.json",
  "_createdAt": "2021-05-12T12:56:09.676Z",
  "_createdBy": "http://localhost:8080/v1/anonymous",
  "_deprecated": true,
  "_incoming": "http://localhost:8080/v1/views/myorg/myproj/myview/incoming",
  "_outgoing": "http://localhost:8080/v1/views/myorg/myproj/myview/outgoing",
  "_project": "http://localhost:8080/v1/projects/myorg/myproj",
  "_rev": 4,
  "_self": "http://localhost:8080/v1/views/myorg/myproj/myview",
  "_updatedAt": "2021-05-12T13:01:01.232Z",
  "_updatedBy": "http://localhost:8080/v1/anonymous",
  "_uuid": "7e737b83-30a0-4ea3-b6c9-cd1ed481d743"
}

Fetch

GET /v1/views/{org_label}/{project_label}/{view_id}?rev={rev}&tag={tag}

where …

  • {rev}: Number - the targeted revision to be fetched. This field is optional and defaults to the latest revision.
  • {tag}: String - the targeted tag to be fetched. This field is optional. {rev} and {tag} fields cannot be simultaneously present.

Example

Request
sourcecurl "http://localhost:8080/v1/views/myorg/myproj/myview"
Response
source{
  "@context": [
    "https://bluebrain.github.io/nexus/contexts/elasticsearch.json",
    "https://bluebrain.github.io/nexus/contexts/metadata.json"
  ],
  "@id": "http://localhost:8080/v1/resources/myorg/myproj/_/myview",
  "@type": [
    "ElasticSearchView",
    "View"
  ],
  "includeDeprecated": true,
  "includeMetadata": true,
  "mapping": {
    "dynamic": false,
    "properties": {
      "@id": {
        "type": "keyword"
      },
      "@type": {
        "type": "keyword"
      },
      "bool": {
        "type": "boolean"
      },
      "name": {
        "type": "keyword"
      },
      "number": {
        "type": "long"
      }
    }
  },
  "permission": "views/query",
  "resourceSchemas": [],
  "resourceTypes": [],
  "settings": {
    "analysis": {
      "analyzer": {
        "nexus": {
          "filter": [
            "trim",
            "word_delimiter_nexus",
            "lowercase"
          ],
          "tokenizer": "classic",
          "type": "custom"
        }
      },
      "filter": {
        "word_delimiter_nexus": {
          "split_on_numerics": false,
          "type": "word_delimiter_graph"
        }
      }
    },
    "index": {
      "number_of_shards": 1
    }
  },
  "sourceAsText": true,
  "_constrainedBy": "https://bluebrain.github.io/nexus/schemas/views.json",
  "_createdAt": "2021-05-12T09:54:28.171Z",
  "_createdBy": "http://localhost:8080/v1/anonymous",
  "_deprecated": false,
  "_incoming": "http://localhost:8080/v1/views/myorg/myproj/myview/incoming",
  "_outgoing": "http://localhost:8080/v1/views/myorg/myproj/myview/outgoing",
  "_project": "http://localhost:8080/v1/projects/myorg/myproj",
  "_rev": 3,
  "_self": "http://localhost:8080/v1/views/myorg/myproj/myview",
  "_updatedAt": "2021-05-12T09:58:20.507Z",
  "_updatedBy": "http://localhost:8080/v1/anonymous",
  "_uuid": "7e737b83-30a0-4ea3-b6c9-cd1ed481d743"
}

Fetch original payload

GET /v1/views/{org_label}/{project_label}/{view_id}/source?rev={rev}&tag={tag}

where …

  • {rev}: Number - the targeted revision to be fetched. This field is optional and defaults to the latest revision.
  • {tag}: String - the targeted tag to be fetched. This field is optional. {rev} and {tag} fields cannot be simultaneously present.

Example

Request
sourcecurl "http://localhost:8080/v1/views/myorg/myproj/myview/source"
Response
source{
  "@type": [
    "ElasticSearchView"
  ],
  "mapping": {
    "dynamic": false,
    "properties": {
      "@id": {
        "type": "keyword"
      },
      "@type": {
        "type": "keyword"
      },
      "name": {
        "type": "keyword"
      },
      "number": {
        "type": "long"
      },
      "bool": {
        "type": "boolean"
      }
    }
  },
  "includeMetadata": true,
  "includeDeprecated": true,
  "sourceAsText": true,
  "resourceSchemas": [],
  "resourceTypes": []
}

Search

POST /v1/views/{org_label}/{project_label}/{view_id}/_search
  {...}

The supported payload is defined on the ElasticSearch documentation

The string documents is used as a prefix of the default ElasticSearch view_id

Example

Request
sourcecurl -XPOST \
-H "Content-Type: application/json" \
"http://localhost:8080/v1/views/myorg/myproj/myview/_search" -d \
'{
  "query": {
    "term": {
      "@type": "https://bluebrain.github.io/nexus/vocabulary/ElasticSearchView"
    }
  }
}'
Payload
source{
  "query": {
    "term": {
      "@type": "https://bluebrain.github.io/nexus/vocabulary/ElasticSearchView"
    }
  }
}
Response
source{
  "hits": {
    "hits": [
      {
        "_id": "https://bluebrain.github.io/nexus/vocabulary/defaultElasticSearchIndex",
        "_index": "delta_7e737b83-30a0-4ea3-b6c9-cd1ed481d743_3",
        "_score": 0.8566987,
        "_source": {
          "@id": "https://bluebrain.github.io/nexus/vocabulary/defaultElasticSearchIndex",
          "@type": [
            "https://bluebrain.github.io/nexus/vocabulary/ElasticSearchView",
            "https://bluebrain.github.io/nexus/vocabulary/View"
          ],
          "_constrainedBy": "https://bluebrain.github.io/nexus/schemas/views.json",
          "_createdAt": "2021-05-12T09:44:22.259Z",
          "_createdBy": "http://localhost:8080/v1/realms/internal/users/delta",
          "_deprecated": false,
          "_incoming": "http://localhost:8080/v1/views/myorg/myproj/documents/incoming",
          "_original_source": "{\"resourceSchemas\":[],\"resourceTypes\":[],\"sourceAsText\":true,\"includeMetadata\":true,\"includeDeprecated\":true,\"permission\":\"views/query\",\"@type\":\"ElasticSearchView\",\"@id\":\"https://bluebrain.github.io/nexus/vocabulary/defaultElasticSearchIndex\"}",
          "_outgoing": "http://localhost:8080/v1/views/myorg/myproj/documents/outgoing",
          "_project": "http://localhost:8080/v1/projects/myorg/myproj",
          "_rev": 1,
          "_self": "http://localhost:8080/v1/views/myorg/myproj/documents",
          "_updatedAt": "2021-05-12T09:44:22.259Z",
          "_updatedBy": "http://localhost:8080/v1/realms/internal/users/delta",
          "_uuid": "a1147f0f-1650-49f2-8704-30ad97be8f31"
        },
        "_type": "_doc"
      },
      {
        "_id": "http://localhost:8080/v1/resources/myorg/myproj/_/386a8c21-3acf-4f10-90ab-329466f5e04c",
        "_index": "delta_7e737b83-30a0-4ea3-b6c9-cd1ed481d743_3",
        "_score": 0.8566987,
        "_source": {
          "@id": "http://localhost:8080/v1/resources/myorg/myproj/_/386a8c21-3acf-4f10-90ab-329466f5e04c",
          "@type": [
            "https://bluebrain.github.io/nexus/vocabulary/ElasticSearchView",
            "https://bluebrain.github.io/nexus/vocabulary/View"
          ],
          "_constrainedBy": "https://bluebrain.github.io/nexus/schemas/views.json",
          "_createdAt": "2021-05-12T09:44:35.609Z",
          "_createdBy": "http://localhost:8080/v1/anonymous",
          "_deprecated": false,
          "_incoming": "http://localhost:8080/v1/views/myorg/myproj/386a8c21-3acf-4f10-90ab-329466f5e04c/incoming",
          "_original_source": "{\"@type\":[\"ElasticSearchView\"],\"mapping\":{\"dynamic\":false,\"properties\":{\"@id\":{\"type\":\"keyword\"},\"@type\":{\"type\":\"keyword\"},\"name\":{\"type\":\"keyword\"},\"number\":{\"type\":\"long\"},\"bool\":{\"type\":\"boolean\"}}},\"includeMetadata\":true,\"includeDeprecated\":true,\"sourceAsText\":true,\"resourceSchemas\":[],\"resourceTypes\":[]}",
          "_outgoing": "http://localhost:8080/v1/views/myorg/myproj/386a8c21-3acf-4f10-90ab-329466f5e04c/outgoing",
          "_project": "http://localhost:8080/v1/projects/myorg/myproj",
          "_rev": 1,
          "_self": "http://localhost:8080/v1/views/myorg/myproj/386a8c21-3acf-4f10-90ab-329466f5e04c",
          "_updatedAt": "2021-05-12T09:44:35.609Z",
          "_updatedBy": "http://localhost:8080/v1/anonymous",
          "_uuid": "ea4b3858-c1ac-4afb-ac94-13fdb1b53681"
        },
        "_type": "_doc"
      },
      {
        "_id": "http://localhost:8080/v1/resources/myorg/myproj/_/indexing1",
        "_index": "delta_7e737b83-30a0-4ea3-b6c9-cd1ed481d743_3",
        "_score": 0.8566987,
        "_source": {
          "@id": "http://localhost:8080/v1/resources/myorg/myproj/_/indexing1",
          "@type": [
            "https://bluebrain.github.io/nexus/vocabulary/ElasticSearchView",
            "https://bluebrain.github.io/nexus/vocabulary/View"
          ],
          "_constrainedBy": "https://bluebrain.github.io/nexus/schemas/views.json",
          "_createdAt": "2021-05-12T09:53:32.704Z",
          "_createdBy": "http://localhost:8080/v1/anonymous",
          "_deprecated": false,
          "_incoming": "http://localhost:8080/v1/views/myorg/myproj/indexing1/incoming",
          "_original_source": "{\"@type\":[\"ElasticSearchView\"],\"mapping\":{\"dynamic\":false,\"properties\":{\"@id\":{\"type\":\"keyword\"},\"@type\":{\"type\":\"keyword\"},\"name\":{\"type\":\"keyword\"},\"number\":{\"type\":\"long\"},\"bool\":{\"type\":\"boolean\"}}},\"includeMetadata\":true,\"includeDeprecated\":true,\"sourceAsText\":true,\"resourceSchemas\":[],\"resourceTypes\":[]}",
          "_outgoing": "http://localhost:8080/v1/views/myorg/myproj/indexing1/outgoing",
          "_project": "http://localhost:8080/v1/projects/myorg/myproj",
          "_rev": 1,
          "_self": "http://localhost:8080/v1/views/myorg/myproj/indexing1",
          "_updatedAt": "2021-05-12T09:53:32.704Z",
          "_updatedBy": "http://localhost:8080/v1/anonymous",
          "_uuid": "ab97491a-0f30-4616-9906-28b92a8c0b79"
        },
        "_type": "_doc"
      },
      {
        "_id": "http://localhost:8080/v1/resources/myorg/myproj/_/myview",
        "_index": "delta_7e737b83-30a0-4ea3-b6c9-cd1ed481d743_3",
        "_score": 0.8566987,
        "_source": {
          "@id": "http://localhost:8080/v1/resources/myorg/myproj/_/myview",
          "@type": [
            "https://bluebrain.github.io/nexus/vocabulary/ElasticSearchView",
            "https://bluebrain.github.io/nexus/vocabulary/View"
          ],
          "_constrainedBy": "https://bluebrain.github.io/nexus/schemas/views.json",
          "_createdAt": "2021-05-12T09:54:28.171Z",
          "_createdBy": "http://localhost:8080/v1/anonymous",
          "_deprecated": false,
          "_incoming": "http://localhost:8080/v1/views/myorg/myproj/myview/incoming",
          "_original_source": "{\"@type\":[\"ElasticSearchView\"],\"mapping\":{\"dynamic\":false,\"properties\":{\"@id\":{\"type\":\"keyword\"},\"@type\":{\"type\":\"keyword\"},\"name\":{\"type\":\"keyword\"},\"number\":{\"type\":\"long\"},\"bool\":{\"type\":\"boolean\"}}},\"includeMetadata\":true,\"includeDeprecated\":true,\"sourceAsText\":true,\"resourceSchemas\":[],\"resourceTypes\":[]}",
          "_outgoing": "http://localhost:8080/v1/views/myorg/myproj/myview/outgoing",
          "_project": "http://localhost:8080/v1/projects/myorg/myproj",
          "_rev": 3,
          "_self": "http://localhost:8080/v1/views/myorg/myproj/myview",
          "_updatedAt": "2021-05-12T09:58:20.507Z",
          "_updatedBy": "http://localhost:8080/v1/anonymous",
          "_uuid": "7e737b83-30a0-4ea3-b6c9-cd1ed481d743"
        },
        "_type": "_doc"
      }
    ],
    "max_score": 0.8566987,
    "total": {
      "relation": "eq",
      "value": 4
    }
  },
  "timed_out": false,
  "took": 10,
  "_shards": {
    "failed": 0,
    "skipped": 0,
    "successful": 1,
    "total": 1
  }
}

Fetch tags

GET /v1/views/{org_label}/{project_label}/{view_id}/tags?rev={rev}&tag={tag}

where …

  • {rev}: Number - the targeted revision to be fetched. This field is optional and defaults to the latest revision.
  • {tag}: String - the targeted tag to be fetched. This field is optional.

{rev} and {tag} fields cannot be simultaneously present.

Example

Request
sourcecurl "http://localhost:8080/v1/views/myorg/myproj/myview/tags"
Response
source{
  "@context": "https://bluebrain.github.io/nexus/contexts/tags.json",
  "tags": [
    {
      "rev": 1,
      "tag": "mytag"
    }
  ]
}

Fetch statistics

GET /v1/views/{org_label}/{project_label}/{view_id}/statistics

Example

Request
sourcecurl "http://localhost:8080/v1/views/myorg/myproj/nxv:myview/statistics"
Response
source{
  "@context": "https://bluebrain.github.io/nexus/contexts/statistics.json",
  "@type": "ViewStatistics",
  "totalEvents": 3754,
  "processedEvents": 3754,
  "evaluatedEvents": 3754,
  "remainingEvents": 0,
  "discardedEvents": 0,
  "failedEvents": 0,
  "delayInSeconds": 0,
  "lastEventDateTime": "2021-04-30T15:04:44.021Z",
  "lastProcessedEventDateTime": "2021-04-30T15:04:44.021Z"
}

where…

  • totalEvents - total number of events in the project
  • processedEvents - number of events that have been considered by the view
  • remainingEvents - number of events that remain to be considered by the view
  • discardedEvents - number of events that have been discarded (were not evaluated due to filters, e.g. did not match schema, tag or type defined in the view)
  • evaluatedEvents - number of events that have been used to update an index
  • lastEventDateTime - timestamp of the last event in the project
  • lastProcessedEventDateTime - timestamp of the last event processed by the view
  • delayInSeconds - number of seconds between the last processed event timestamp and the last known event timestamp

Fetch indexing

GET /v1/views/{org_label}/{project_label}/{view_id}/offset

Example

Request
sourcecurl "http://localhost:8080/v1/views/myorg/myproj/myview/offset"
Response
source{
  "@context": "https://bluebrain.github.io/nexus/contexts/offset.json",
  "@type": "TimeBasedOffset",
  "instant": "2021-05-12T12:57:19.375Z",
  "value": "95d159f6-b321-11eb-a5f9-e5c0b5ea0976"
}

where…

  • instant - timestamp of the last event processed by the view
  • value - the value of the offset

Restart indexing

This endpoint restarts the view indexing process. It does not delete the created indices but it overrides the resource Document when going through the event log.

DELETE /v1/views/{org_label}/{project_label}/{view_id}/offset

Example

Request
sourcecurl -XDELETE "http://localhost:8080/v1/views/myorg/myproj/nxv:myview/offset"
Response
source{
  "@context": "https://bluebrain.github.io/nexus/contexts/offset.json",
  "@type": "ViewStatistics",
  "delayInSeconds": 0,
  "discardedEvents": 2,
  "evaluatedEvents": 8,
  "failedEvents": 0,
  "lastEventDateTime": "2021-05-12T09:58:20.507Z",
  "lastProcessedEventDateTime": "2021-05-12T09:58:20.507Z",
  "processedEvents": 10,
  "remainingEvents": 0,
  "totalEvents": 10
}