Skip to content

ARLAS Tagger APIs vAPI_VERSION

Scroll down for example requests and responses.

(Un)Tag fields of ARLAS collections

Base URLs:

Email: Gisaia Web: Gisaia License: Apache 2.0

write

Tagger API

Tag

POST /write/{collection}/_tag

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

Body parameter

{
  "partitionFilter": [
    {
      "f": [
        [
          {
            "field": "string",
            "op": "eq",
            "value": "string"
          }
        ]
      ],
      "q": [
        [
          "string"
        ]
      ],
      "dateformat": "string",
      "righthand": true
    }
  ],
  "filter": {
    "f": [
      [
        {
          "field": "string",
          "op": "eq",
          "value": "string"
        }
      ]
    ],
    "q": [
      [
        "string"
      ]
    ],
    "dateformat": "string",
    "righthand": true
  },
  "form": {
    "pretty": true,
    "flat": true
  },
  "search": {
    "partitionFilter": [
      {
        "f": [
          [
            {
              "field": "string",
              "op": "eq",
              "value": "string"
            }
          ]
        ],
        "q": [
          [
            "string"
          ]
        ],
        "dateformat": "string",
        "righthand": true
      }
    ],
    "filter": {
      "f": [
        [
          {
            "field": "string",
            "op": "eq",
            "value": "string"
          }
        ]
      ],
      "q": [
        [
          "string"
        ]
      ],
      "dateformat": "string",
      "righthand": true
    },
    "form": {
      "pretty": true,
      "flat": true
    },
    "page": {
      "size": 0,
      "from": 0,
      "sort": "string",
      "after": "string",
      "before": "string"
    },
    "projection": {
      "includes": "string",
      "excludes": "string"
    },
    "returned_geometries": "string"
  },
  "tag": {
    "path": "string",
    "value": {}
  },
  "propagation": {
    "field": "string",
    "filter": {
      "f": [
        [
          {
            "field": "string",
            "op": "eq",
            "value": "string"
          }
        ]
      ],
      "q": [
        [
          "string"
        ]
      ],
      "dateformat": "string",
      "righthand": true
    }
  },
  "label": "string"
}

Parameters

Name In Type Required Description
collection path string true collection
pretty query boolean false Pretty print
body body TagRequest false none

Example responses

200 Response

{
  "id": "string",
  "label": "string",
  "action": "ADD",
  "failures": [
    {
      "id": "string",
      "message": "string",
      "type": "string"
    }
  ],
  "failed": 0,
  "updated": 0,
  "progress": 0.1,
  "nbRequest": 0,
  "propagated": 0,
  "startTime": 0,
  "endTime": 0,
  "processingTimeMs": 0
}

Responses

Status Meaning Description Schema
200 OK Successful operation UpdateResponse
400 Bad Request Bad request. Error
500 Internal Server Error Arlas Server Error. Error

TagReplay

POST /write/{collection}/_tagreplay

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

Parameters

Name In Type Required Description
collection path string true collection
offset query integer(int64) true The offset from which the replay must be done.
pretty query boolean false Pretty print

Example responses

200 Response

0

Responses

Status Meaning Description Schema
200 OK Successful operation integer
400 Bad Request Bad request. Error
500 Internal Server Error Arlas Server Error. Error

Untag

POST /write/{collection}/_untag

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

Body parameter

{
  "partitionFilter": [
    {
      "f": [
        [
          {
            "field": "string",
            "op": "eq",
            "value": "string"
          }
        ]
      ],
      "q": [
        [
          "string"
        ]
      ],
      "dateformat": "string",
      "righthand": true
    }
  ],
  "filter": {
    "f": [
      [
        {
          "field": "string",
          "op": "eq",
          "value": "string"
        }
      ]
    ],
    "q": [
      [
        "string"
      ]
    ],
    "dateformat": "string",
    "righthand": true
  },
  "form": {
    "pretty": true,
    "flat": true
  },
  "search": {
    "partitionFilter": [
      {
        "f": [
          [
            {
              "field": "string",
              "op": "eq",
              "value": "string"
            }
          ]
        ],
        "q": [
          [
            "string"
          ]
        ],
        "dateformat": "string",
        "righthand": true
      }
    ],
    "filter": {
      "f": [
        [
          {
            "field": "string",
            "op": "eq",
            "value": "string"
          }
        ]
      ],
      "q": [
        [
          "string"
        ]
      ],
      "dateformat": "string",
      "righthand": true
    },
    "form": {
      "pretty": true,
      "flat": true
    },
    "page": {
      "size": 0,
      "from": 0,
      "sort": "string",
      "after": "string",
      "before": "string"
    },
    "projection": {
      "includes": "string",
      "excludes": "string"
    },
    "returned_geometries": "string"
  },
  "tag": {
    "path": "string",
    "value": {}
  },
  "propagation": {
    "field": "string",
    "filter": {
      "f": [
        [
          {
            "field": "string",
            "op": "eq",
            "value": "string"
          }
        ]
      ],
      "q": [
        [
          "string"
        ]
      ],
      "dateformat": "string",
      "righthand": true
    }
  },
  "label": "string"
}

Parameters

Name In Type Required Description
collection path string true collection
pretty query boolean false Pretty print
body body TagRequest false none

Example responses

200 Response

{
  "id": "string",
  "label": "string",
  "action": "ADD",
  "failures": [
    {
      "id": "string",
      "message": "string",
      "type": "string"
    }
  ],
  "failed": 0,
  "updated": 0,
  "progress": 0.1,
  "nbRequest": 0,
  "propagated": 0,
  "startTime": 0,
  "endTime": 0,
  "processingTimeMs": 0
}

Responses

Status Meaning Description Schema
200 OK Successful operation UpdateResponse
400 Bad Request Bad request. Error
500 Internal Server Error Arlas Server Error. Error

status

Tagger status API

TagStatus

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

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

Parameters

Name In Type Required Description
collection path string true collection
id path string true The id of a previously requested (un)tag operation.
pretty query boolean false Pretty print

Example responses

200 Response

{
  "id": "string",
  "label": "string",
  "action": "ADD",
  "failures": [
    {
      "id": "string",
      "message": "string",
      "type": "string"
    }
  ],
  "failed": 0,
  "updated": 0,
  "progress": 0.1,
  "nbRequest": 0,
  "propagated": 0,
  "startTime": 0,
  "endTime": 0,
  "processingTimeMs": 0
}

Responses

Status Meaning Description Schema
200 OK Successful operation UpdateResponse
400 Bad Request Bad request. Error
500 Internal Server Error Arlas Server Error. Error

TagList

GET /status/{collection}/_taglist

Get the list of previously submitted tag requests

Parameters

Name In Type Required Description
collection path string true collection
pretty query boolean false Pretty print

Example responses

200 Response

[
  {
    "partitionFilter": "string",
    "filter": {
      "f": [
        [
          {
            "field": "string",
            "op": "eq",
            "value": "string"
          }
        ]
      ],
      "q": [
        [
          "string"
        ]
      ],
      "dateformat": "string",
      "righthand": true
    },
    "form": {
      "pretty": true,
      "flat": true
    },
    "search": {
      "partitionFilter": [
        {
          "f": [
            [
              {
                "field": "string",
                "op": "eq",
                "value": "string"
              }
            ]
          ],
          "q": [
            [
              "string"
            ]
          ],
          "dateformat": "string",
          "righthand": true
        }
      ],
      "filter": {
        "f": [
          [
            {
              "field": "string",
              "op": "eq",
              "value": "string"
            }
          ]
        ],
        "q": [
          [
            "string"
          ]
        ],
        "dateformat": "string",
        "righthand": true
      },
      "form": {
        "pretty": true,
        "flat": true
      },
      "page": {
        "size": 0,
        "from": 0,
        "sort": "string",
        "after": "string",
        "before": "string"
      },
      "projection": {
        "includes": "string",
        "excludes": "string"
      },
      "returned_geometries": "string"
    },
    "tag": {
      "path": "string",
      "value": {}
    },
    "propagation": {
      "field": "string",
      "filter": {
        "f": [
          [
            {
              "field": "string",
              "op": "eq",
              "value": "string"
            }
          ]
        ],
        "q": [
          [
            "string"
          ]
        ],
        "dateformat": "string",
        "righthand": true
      }
    },
    "label": "string",
    "id": "string",
    "action": "ADD",
    "collection": "string",
    "propagated": 0,
    "creationTime": 0,
    "offset": 0
  }
]

Responses

Status Meaning Description Schema
200 OK Successful operation Inline
400 Bad Request Bad request. Error
500 Internal Server Error Arlas Server Error. Error

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [TagRefRequest] false none none
» partitionFilter string false none none
» filter Filter false none none
»» f [array] false none none
»»» field string false none none
»»» op string false none none
»»» value string false none none
»»» empty boolean false none none
q [array] false none none
» empty boolean false none none
dateformat string false none none
righthand boolean false none none
form Form false none none
» pretty boolean false none none
» flat boolean false none none
search Search false none none
» partitionFilter [Filter] false none none
» filter Filter false none none
» form Form false none none
» page Page false none none
»» size integer(int32) false none none
»» from integer(int32) false none none
»» sort string false none none
»» after string false none none
»» before string false none none
» projection Projection false none none
»» includes string false none none
»» excludes string false none none
» returned_geometries string false none none
tag Tag false none none
» path string false none none
» value object false none none
propagation Propagation false none none
» field string false none none
» filter Filter false none none
label string false none none
id string false none none
action string false none none
collection string false none none
propagated integer(int64) false none none
creationTime integer(int64) false none none
offset integer(int64) false none none

Enumerated Values

Property Value
op eq
op gte
op gt
op lte
op lt
op like
op ne
op range
op within
op notwithin
op intersects
op notintersects
action ADD
action REMOVE
action REMOVEALL

Schemas

Failure

{
  "id": "string",
  "message": "string",
  "type": "string"
}

Properties

Name Type Required Restrictions Description
id string false none none
message string false none none
type string false none none

UpdateResponse

{
  "id": "string",
  "label": "string",
  "action": "ADD",
  "failures": [
    {
      "id": "string",
      "message": "string",
      "type": "string"
    }
  ],
  "failed": 0,
  "updated": 0,
  "progress": 0.1,
  "nbRequest": 0,
  "propagated": 0,
  "startTime": 0,
  "endTime": 0,
  "processingTimeMs": 0
}

Properties

Name Type Required Restrictions Description
id string false none none
label string false none none
action string false none none
failures [Failure] false none none
failed integer(int64) false none none
updated integer(int64) false none none
progress number(float) false none none
nbRequest integer(int64) false none none
propagated integer(int64) false none none
startTime integer(int64) false none none
endTime integer(int64) false none none
processingTimeMs integer(int64) false none none

Enumerated Values

Property Value
action ADD
action REMOVE
action REMOVEALL

Error

{
  "status": 0,
  "message": "string",
  "error": "string"
}

Properties

Name Type Required Restrictions Description
status integer(int32) false none none
message string false none none
error string false none none

Expression

{
  "field": "string",
  "op": "eq",
  "value": "string"
}

Properties

Name Type Required Restrictions Description
field string false none none
op string false none none
value string false none none

Enumerated Values

Property Value
op eq
op gte
op gt
op lte
op lt
op like
op ne
op range
op within
op notwithin
op intersects
op notintersects

Filter

{
  "f": [
    [
      {
        "field": "string",
        "op": "eq",
        "value": "string"
      }
    ]
  ],
  "q": [
    [
      "string"
    ]
  ],
  "dateformat": "string",
  "righthand": true
}

Properties

Name Type Required Restrictions Description
f [array] false none none
» empty boolean false none none
q [array] false none none
» empty boolean false none none
dateformat string false none none
righthand boolean false none none

Form

{
  "pretty": true,
  "flat": true
}

Properties

Name Type Required Restrictions Description
pretty boolean false none none
flat boolean false none none

MultiValueFilterExpression

[
  {
    "field": "string",
    "op": "eq",
    "value": "string"
  }
]

Properties

Name Type Required Restrictions Description
anonymous [Expression] false none none
empty boolean false none none

MultiValueFilterString

[
  "string"
]

Properties

Name Type Required Restrictions Description
empty boolean false none none

Page

{
  "size": 0,
  "from": 0,
  "sort": "string",
  "after": "string",
  "before": "string"
}

Properties

Name Type Required Restrictions Description
size integer(int32) false none none
from integer(int32) false none none
sort string false none none
after string false none none
before string false none none

Projection

{
  "includes": "string",
  "excludes": "string"
}

Properties

Name Type Required Restrictions Description
includes string false none none
excludes string false none none

Propagation

{
  "field": "string",
  "filter": {
    "f": [
      [
        {
          "field": "string",
          "op": "eq",
          "value": "string"
        }
      ]
    ],
    "q": [
      [
        "string"
      ]
    ],
    "dateformat": "string",
    "righthand": true
  }
}

Properties

Name Type Required Restrictions Description
field string false none none
filter Filter false none none 

{
  "partitionFilter": [
    {
      "f": [
        [
          {
            "field": "string",
            "op": "eq",
            "value": "string"
          }
        ]
      ],
      "q": [
        [
          "string"
        ]
      ],
      "dateformat": "string",
      "righthand": true
    }
  ],
  "filter": {
    "f": [
      [
        {
          "field": "string",
          "op": "eq",
          "value": "string"
        }
      ]
    ],
    "q": [
      [
        "string"
      ]
    ],
    "dateformat": "string",
    "righthand": true
  },
  "form": {
    "pretty": true,
    "flat": true
  },
  "page": {
    "size": 0,
    "from": 0,
    "sort": "string",
    "after": "string",
    "before": "string"
  },
  "projection": {
    "includes": "string",
    "excludes": "string"
  },
  "returned_geometries": "string"
}

Properties

Name Type Required Restrictions Description
partitionFilter [Filter] false none none
filter Filter false none none
form Form false none none
page Page false none none
projection Projection false none none
returned_geometries string false none none

Tag

{
  "path": "string",
  "value": {}
}

Properties

Name Type Required Restrictions Description
path string false none none
value object false none none

TagRequest

{
  "partitionFilter": [
    {
      "f": [
        [
          {
            "field": "string",
            "op": "eq",
            "value": "string"
          }
        ]
      ],
      "q": [
        [
          "string"
        ]
      ],
      "dateformat": "string",
      "righthand": true
    }
  ],
  "filter": {
    "f": [
      [
        {
          "field": "string",
          "op": "eq",
          "value": "string"
        }
      ]
    ],
    "q": [
      [
        "string"
      ]
    ],
    "dateformat": "string",
    "righthand": true
  },
  "form": {
    "pretty": true,
    "flat": true
  },
  "search": {
    "partitionFilter": [
      {
        "f": [
          [
            {
              "field": "string",
              "op": "eq",
              "value": "string"
            }
          ]
        ],
        "q": [
          [
            "string"
          ]
        ],
        "dateformat": "string",
        "righthand": true
      }
    ],
    "filter": {
      "f": [
        [
          {
            "field": "string",
            "op": "eq",
            "value": "string"
          }
        ]
      ],
      "q": [
        [
          "string"
        ]
      ],
      "dateformat": "string",
      "righthand": true
    },
    "form": {
      "pretty": true,
      "flat": true
    },
    "page": {
      "size": 0,
      "from": 0,
      "sort": "string",
      "after": "string",
      "before": "string"
    },
    "projection": {
      "includes": "string",
      "excludes": "string"
    },
    "returned_geometries": "string"
  },
  "tag": {
    "path": "string",
    "value": {}
  },
  "propagation": {
    "field": "string",
    "filter": {
      "f": [
        [
          {
            "field": "string",
            "op": "eq",
            "value": "string"
          }
        ]
      ],
      "q": [
        [
          "string"
        ]
      ],
      "dateformat": "string",
      "righthand": true
    }
  },
  "label": "string"
}

Properties

Name Type Required Restrictions Description
partitionFilter [Filter] false none none
filter Filter false none none
form Form false none none
search Search false none none
tag Tag false none none
propagation Propagation false none none
label string false none none

TagRefRequest

{
  "partitionFilter": "string",
  "filter": {
    "f": [
      [
        {
          "field": "string",
          "op": "eq",
          "value": "string"
        }
      ]
    ],
    "q": [
      [
        "string"
      ]
    ],
    "dateformat": "string",
    "righthand": true
  },
  "form": {
    "pretty": true,
    "flat": true
  },
  "search": {
    "partitionFilter": [
      {
        "f": [
          [
            {
              "field": "string",
              "op": "eq",
              "value": "string"
            }
          ]
        ],
        "q": [
          [
            "string"
          ]
        ],
        "dateformat": "string",
        "righthand": true
      }
    ],
    "filter": {
      "f": [
        [
          {
            "field": "string",
            "op": "eq",
            "value": "string"
          }
        ]
      ],
      "q": [
        [
          "string"
        ]
      ],
      "dateformat": "string",
      "righthand": true
    },
    "form": {
      "pretty": true,
      "flat": true
    },
    "page": {
      "size": 0,
      "from": 0,
      "sort": "string",
      "after": "string",
      "before": "string"
    },
    "projection": {
      "includes": "string",
      "excludes": "string"
    },
    "returned_geometries": "string"
  },
  "tag": {
    "path": "string",
    "value": {}
  },
  "propagation": {
    "field": "string",
    "filter": {
      "f": [
        [
          {
            "field": "string",
            "op": "eq",
            "value": "string"
          }
        ]
      ],
      "q": [
        [
          "string"
        ]
      ],
      "dateformat": "string",
      "righthand": true
    }
  },
  "label": "string",
  "id": "string",
  "action": "ADD",
  "collection": "string",
  "propagated": 0,
  "creationTime": 0,
  "offset": 0
}

Properties

Name Type Required Restrictions Description
partitionFilter string false none none
filter Filter false none none
form Form false none none
search Search false none none
tag Tag false none none
propagation Propagation false none none
label string false none none
id string false none none
action string false none none
collection string false none none
propagated integer(int64) false none none
creationTime integer(int64) false none none
offset integer(int64) false none none

Enumerated Values

Property Value
action ADD
action REMOVE
action REMOVEALL