ARLAS Tagger API

Overview

(Un)Tag fields of ARLAS collections

Version information

Version : 12.0.1

Contact information

Contact : Gisaia
Contact Email : contact@gisaia.com

License information

License : Apache 2.0
License URL : https://www.apache.org/licenses/LICENSE-2.0.html
Terms of service : null

URI scheme

BasePath : /arlas_tagger
Schemes : HTTP, HTTPS

Tags

  • status
  • write

Resources

Status

TagStatus

GET /status/{collection}/_tag/{id}
Description

Get the status of the (un)tagging operation, given the id of a previously requested operation

Parameters
Type Name Description Schema Default
Path collection
required
collection string
Path id
required
The id of a previously requested (un)tag operation. string
Query pretty
optional
Pretty print boolean "false"
Responses
HTTP Code Description Schema
200 Successful operation UpdateResponse
400 Bad request. Error
500 Arlas Server Error. Error
Consumes
  • application/json;charset=utf-8
Produces
  • application/json;charset=utf-8

TagList

GET /status/{collection}/_taglist
Description

Get the list of previously submitted tag requests

Parameters
Type Name Description Schema Default
Path collection
required
collection string
Query pretty
optional
Pretty print boolean "false"
Responses
HTTP Code Description Schema
200 Successful operation < TagRefRequest > array
400 Bad request. Error
500 Arlas Server Error. Error
Consumes
  • application/json;charset=utf-8
Produces
  • application/json;charset=utf-8

Write

Tag

POST /write/{collection}/_tag
Description

Search and tag the elements found in the collection, given the filters

Parameters
Type Name Description Schema Default
Path collection
required
collection string
Query pretty
optional
Pretty print boolean "false"
Body body
optional
TagRequest
Responses
HTTP Code Description Schema
200 Successful operation UpdateResponse
400 Bad request. Error
500 Arlas Server Error. Error
Consumes
  • application/json;charset=utf-8
Produces
  • application/json;charset=utf-8

TagReplay

POST /write/{collection}/_tagreplay
Description

Scan the tagref topic and replay tagging operations from the given offset

Parameters
Type Name Description Schema Default
Path collection
required
collection string
Query offset
required
The offset from which the replay must be done. integer (int64)
Query pretty
optional
Pretty print boolean "false"
Responses
HTTP Code Description Schema
200 Successful operation integer (int64)
400 Bad request. Error
500 Arlas Server Error. Error
Consumes
  • application/json;charset=utf-8
Produces
  • application/json;charset=utf-8

Untag

POST /write/{collection}/_untag
Description

Search and untag the elements found in the collection, given the filters

Parameters
Type Name Description Schema Default
Path collection
required
collection string
Query pretty
optional
Pretty print boolean "false"
Body body
optional
TagRequest
Responses
HTTP Code Description Schema
200 Successful operation UpdateResponse
400 Bad request. Error
500 Arlas Server Error. Error
Consumes
  • application/json;charset=utf-8
Produces
  • application/json;charset=utf-8

Definitions

Error

Name Schema
error
optional
string
message
optional
string
status
optional
integer (int32)

Expression

Name Schema
field
optional
string
op
optional
enum (eq, gte, gt, lte, lt, like, ne, range, within, notwithin, intersects, notintersects)
value
optional
string

Failure

Name Schema
id
optional
string
message
optional
string
type
optional
string

Filter

Name Schema
dateformat
optional
string
f
optional
< < Expression > array > array
q
optional
< < string > array > array

Form

Name Schema
flat
optional
boolean
pretty
optional
boolean

Page

Name Schema
after
optional
string
before
optional
string
from
optional
integer (int32)
size
optional
integer (int32)
sort
optional
string

Projection

Name Schema
excludes
optional
string
includes
optional
string

Propagation

Name Schema
field
optional
string
filter
optional
Filter

Name Schema
filter
optional
Filter
form
optional
Form
page
optional
Page
projection
optional
Projection
returned_geometries
optional
string

Tag

Name Schema
path
optional
string
value
optional
object

TagRefRequest

Name Schema
action
optional
enum (ADD, REMOVE, REMOVEALL)
collection
optional
string
creationTime
optional
integer (int64)
id
optional
string
label
optional
string
offset
optional
integer (int64)
partitionFilter
optional
string
propagated
optional
integer (int64)
propagation
optional
Propagation
search
optional
Search
tag
optional
Tag

TagRequest

Name Schema
label
optional
string
propagation
optional
Propagation
search
optional
Search
tag
optional
Tag

UpdateResponse

Name Schema
action
optional
enum (ADD, REMOVE, REMOVEALL)
endTime
optional
integer (int64)
failed
optional
integer (int64)
failures
optional
< Failure > array
id
optional
string
label
optional
string
nbRequest
optional
integer (int64)
processingTimeMs
optional
integer (int64)
progress
optional
number (float)
propagated
optional
integer (int64)
startTime
optional
integer (int64)
updated
optional
integer (int64)