Page tree
Skip to end of metadata
Go to start of metadata

The configuration and control API provides functionality that allows a administrator to perform actions such as adding a seed to crawl, or beginning or stopping a crawl. This API will provide the functionality required by the Aspire User interface and will be extensively used by it. The API will also be used by any external process (or script) that needs to control Aspire

Common parts

Those parts are described here once for all endpoints. They are referenced  from the specific chapters when needed.

Pagination query string parameters

To allow paging of responses that might return large amounts of data (typically "list" requests), requests will accept paging parameters as shown below

NameTypeRequiredDefaultDescription
fromlongOptional0

The offset in to the results list from which results should be returned

sizelongOptional25/unlimited

The (maximum) number of items to be returned in the results list

Note: The results list is only limited if the size parameter is set (even to 0). If size is not set, Aspire will assume you are trying to retrieve all items. TODO: the defaults not implemented

Where paging parameters are applied, Aspire will add a "count" to the returned object to inform the total number of objects that exists (the fields being from, size, totalItems)

Sorting query string parameters

NameTypeRequiredDescription
sortBystringOptionalField by which results are sorted. The fields are "description" or "type"
sortModestringOptional

Sort mode

  • "asc" for ascending sort,
  • "desc" for descending sort

Expand query string parameter

NameTypeRequiredDescription
$expandstringOptionalComma separated list of fields to expand, * will expand everything

Filter body parameter

Some endpoint queries support a filter. The common filter is basically a JSON object with the following format

{
  "filter" : {
    "ids" : ["ID1", "ID2", "ID3", ...],
    "type" : "TYPE",
    "description" : "DESCRIPTION"
  }
}

Update body parameter

Some update endpoint queries support an update  object which together with the filtering above allows for "update by query" functionality. The update  is basically a JSON object with the following format

{
  "update" : {
    "description" : "DESCRIPTION"
  }
}

Responses

Aspire's API will return both an HTTP response code and a JSON body indicating success or failure of all calls. The following status codes are used

Status

Response codeDescription
200

Success

Success with errors (batch mode)*

201 TODO: not implementedCreated
400Bad request
404Not found
406Not acceptable

* batch requests (those calls capable of creating, updating, deleting or controlling more than a single item/object at a time - update multiple connectors for example) will return a status of 200 for the call itself and other status inside the Json body.


Response Body

This is an example of the response to this GET request - - /aspire/_api/workflows?sparse=true&from=0&size=2

{
    "count": {
        "from": 0,
        "size": 2,
        "totalItems": 3
    },
    "workflow": [
        {
            "id": "f5daef4d-fd4b-4e01-bd7b-b00334601b73",
            "type": "connector",
            "description": "Publish to Elastic-1",
            "checksum": "b0bb8b191d7bba8a0c32b8db091937a617e14ad0e768da2c0a75e360aff45430"
        },
        {
            "id": "e33a890a-cea9-48c0-8db9-07533444820f",
            "type": "connector",
            "description": "Publish to Elastic-1",
            "checksum": "1d3e041ca4de48edcee85d46217d928846077277f39d07eac6e4206a2ce8966d"
        }
    ]
}


Where an API call causes a single item to be successful created , the body of the response will contain the item itself. The response shown below is an example of the body returned if a single connector was created or updated (response status 200 or 201)

{
  "connector": {
    "id": "AAABcID5GBc=",
    "type": "filesystem",
    "description": "NetApp connector",
    "created": 1596707252548,
    "updated": 1596707252548,
    "properties": { This will be a dynamic JSON object }
  }
}


Where multiple items/objects to be affected, an array will be returned in place of an object. The response shown below is an example of the body returned if two connectors were created  (response status 200)

{
  "connector": [{
    "id": "AAABcID5GBc=",
    "type": "filesystem",
    "description": "NetApp connector",
    "created": 1596707252548,
    "updated": 1596707252548,
    "properties": { This will be a dynamic JSON object }
  },
  {
    "id": "AAABcIueWUc=",
    "type": "sharepoint-online",
    "description": "SharePoint Online",
    "created": 1596707252548,
    "updated": 1596707252548,
    "properties": { This will be a dynamic JSON object } 
  }]
}

Should multiple items/objects to be affected and some (or all) result in errors, information about any unsuccessful call will be included in an error section for the response. The response shown below is an example of the body returned if four connectors submitted for create and two encountered and error (response status 200)

{
  "connector": [{
    "id": "AAABcID5GBc=",
    "type": "filesystem",
    "description": "NetApp connector",
    "created": 1596707252548,
    "updated": 1596707252548,
    "properties": { This will be a dynamic JSON object }
  },
  {
    "id": "AAABcIueWUc=",
    "type": "sharepoint-online",
    "description": "SharePoint Online",
    "created": 1596707252548,
    "updated": 1596707252548,
    "properties": { This will be a dynamic JSON object } 
  }],
  "error": {
    "connector": [{
        "id": "aaf15f20-c334-4f5f-a34f-f308360c2092",
        "status": 406,
        "message": "java.lang.RuntimeException: testing exception"
      },
      {
        "id": "dde02131-ce63-4639-afee-d72293eef5e0",
        "status": 406,
        "message": "java.lang.RuntimeException: another testing exception"
      }
    ]
  }
}



  • No labels