Warning

title	Page in development

This page is in development and as such, its contents may be incorrect

The servers API provides functionality that allows a administrator to perform actions such as adding and configuring a server to crawl, or beginning or stopping a crawl

Table of Contents

List of fields to expand, * will expand everything

Pagination query string parameters

Common filter

Response

Section

Get all servers

Lists all the servers configured in the Aspire

Panel

borderColor	black
bgColor	#fafafb

GET /aspire/_api/servers

Query String Parameters

Name Type Required Description

from integer Optional Indicates the initial page to be retrieved

size integer Optional Specifies the size of results page

sortBy string Optional Field by which results are sorted

sortMode

string

Optional

Sort mode

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

expand string Optional

Code Block

language	js

{
  "server": [
    {
      "id": "5d0b35d5-c946-44e7-9be5-97c9ad9036a3",
      "type":   "filesystem",        
      "description": "Local Storage",
      "created": 1596707252548,
	  "updated": 1596707252548,
      "properties": { This is a dynamic JSON object}
    },
    {
      "id": "5d0b35d5-c946-44e7-9be5-97c9ad9036a4",
      "type": "smb",
      "description": "Remote Storage",
      "created": 1596707252548,
	  "updated": 1596707252548,
	  "credential": "cred_1",
      "properties": { This is a dynamic JSON object}
    }
  ],
  "from": 100,
  "size": 10,
  "sortBy": "id",
  "sortMode": "asc"
  "totalItems": 10000,
  "message": "optional response message"
}

Status

Response code	Description
200	Success

Body Parameters

Response

Section

Get all servers, filtered

Lists servers configured in the Aspire, filtered by a specified criteria

Panel

borderColor	black
bgColor	#fafafb

POST /aspire/_api/servers/getAll

Query String Parameters

Name Type Required Description

from integer Optional Indicates the initial page to be retrieved

size integer Optional Specifies the size of results page

sortBy string Optional Field by which results are sorted

sortMode

string

Optional

Sort mode

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

expand string Optional List of fields to expand, * will expand everything

Name Type Required Description

filter JSON Required Filters retrieved servers. Check the filter definition here

Code Block

language	js

{
  "server": [
    {
      "id": "5d0b35d5-c946-44e7-9be5-97c9ad9036a3",
      "type":   "filesystem",        
      "description": "Local Storage",
      "created": 1596707252548,
	  "updated": 1596707252548,
      "properties": { This is a dynamic JSON object}
    },
    {
      "id": "5d0b35d5-c946-44e7-9be5-97c9ad9036a4",
      "type": "smb",
      "description": "Remote Storage",
      "created": 1596707252548,
	  "updated": 1596707252548,
	  "credential": "cred_1",
      "properties": { This is a dynamic JSON object}
    }
  ],
  "from": 100,
  "size": 10,
  "sortBy": "id",
  "sortMode": "asc"
  "totalItems": 10000,
  "message": "optional response message"
}

Status

Response codeDescription200Success

Pagination query string parameters

Common filter

Section

Get a single server

Get information about a single server configured in Aspire

Panel

borderColor	black
bgColor	#fafafb

GET /aspire/_api/servers/:id

Path Parameters

Name	Type	Required	Description
id	string	Required	The id of the server to return

Query String Parameters

List of fields to expand, * will expand everything

Name	Type	Required	Description
expand	string	Optional

Response

Code Block

language	js

{
  "server": {
      "id": "5d0b35d5-c946-44e7-9be5-97c9ad9036a4",
      "type": "smb",
      "description": "Remote Storage",
      "created": 1596707252548,
	  "updated": 1596707252548,
	  "credential": "cred_1",
      "properties": { This is a dynamic JSON object}
    },
  "message": "optional response message"
}

Status

Response code	Description
200	Success
404	The given server id was not found

Section

Add servers

Add servers to Aspire

Panel

borderColor	black
bgColor	#fafafb

POST /aspire/_api/servers

Body Parameters

Name	Type	Required	Description
type	string	Required	The type of server to add
description	string	Required	An optional description of the server
credentials	string	Optional	Credentials can be specified for the server
properties	JSON	Required	Dynamic JSON object with server properties (from dxf)

Example

Code Block

language	js

POST /aspire/_api/servers
[{
   "type": "filesystem",
   "description": "Local storage",
   "properties": { This will be a dynamic JSON object }
 },
 {
   "type": "filesystem",
   "description": "Remote Storage",
   "credential": "cred_1",
   "properties": { This will be a dynamic JSON object }
}]

Response

Code Block

language	js

{
  "server": [
    {
      "id": "5d0b35d5-c946-44e7-9be5-97c9ad9036a3",
      "type":   "filesystem",        
      "description": "Local Storage",
      "created": 1596707252548,
	  "updated": 1596707252548,
      "properties": { This is a dynamic JSON object}
    },
    {
      "id": "5d0b35d5-c946-44e7-9be5-97c9ad9036a4",
      "type": "smb",
      "description": "Remote Storage",
      "created": 1596707252548,
	  "updated": 1596707252548,
	  "credential": "cred_1",
      "properties": { This is a dynamic JSON object}
    }
  ]
}

Status

Response code	Description
201	Created
406	Not acceptable - there was an issue validating the input

Section

Update servers

Update servers in Aspire.

Panel

borderColor	black
bgColor	#fafafb

PUT /aspire/_api/servers

Body Parameters

Name	Type	Required	Description
id	string	Required	The identifier of the server to update
type	string	Optional	The type of server to add
description	string	Optional	An optional description of the server
credentials	string	Optional	Credentials can be specified for the server
properties	JSON	Optional	Dynamic JSON object with server properties (from dxf)

Example

Code Block

language	js

PUT /aspire/_api/servers
{
  "AAABcID5GBc=": {
    "id": "AAABcID5GBc=",
    "description": "Local Storage",
    "type": "filesystem"
  },
  "AAABcIueWUc=": {
    "id": "AAABcIueWUc=",
    "description": "Remote Storage",
    "credential": "cred_2"
  }
}

Response

Code Block

language	js

{
  "server": [
    {
      "id": "AAABcID5GBc",
      "type":   "filesystem",        
      "description": "Local Storage",
      "created": 1596707252548,
	  "updated": 1596707252548,
      "properties": { This is a dynamic JSON object}
    },
    {
      "id": "  "AAABcIueWUc=",
      "type": "smb",
      "description": "Remote Storage",
      "created": 1596707252548,
	  "updated": 1596707252548,
	  "credential": "cred_1",
      "properties": { This is a dynamic JSON object}
    }
  ]
}

Status

Response code	Description
201	Created
404	Not found - a given server identifier was not found
406	Not acceptable - there was an issue validating the input

Section

Delete multiple servers, filtered

Delete multiple servers from Aspire, filtered by a specified criteria

Panel

borderColor	black
bgColor	#fafafb

POST /aspire/_api/servers/deleteAll

Body Parameters

Name	Type	Required	Description
filter	JSON	Required	Filters retrieved servers. Check the filter definition here

Response

Code Block

language	js

{
  "message": "optional response message"
}

See Response Body for details regrading the response body returned where multiple items are affected with some (or all) returning errors

Status

Response code	Description
200	Success
404	Not found - a given credential identifier was not found
406	Not acceptable - there was an issue validating the input

Section

Delete single server

Delete a single server from Aspire.

Panel

borderColor	black
bgColor	#fafafb

DELETE /aspire/_api/servers/:id

Path Parameters

Name	Type	Required	Description
id	string	Required	The identifier of the server to delete

Example

Code Block

language	js

DELETE /aspire/_api/servers/AAABcID5GBc%3D

Response

Code Block

language	js

{
  "message": "optional response message"
}

Status

Response code	Description
200	Success
404	Not found - a given server identifier was not found
406	Not acceptable - there was an issue validating the input

Some endpoint queries require a filter. A filter is basically a JSON object with the following format:

Credentials filter:

Section

Get server type dxf (TODO)

Returns the dxf for a specific server type

Panel

borderColor	black
bgColor	#fafafb

GET /aspire/_api/servers/type/:typeId/dxf

Path Parameters

Name	Type	Required	Description
typeId	string	Required	The id of the type for which dxf is going to be retrieved

Response

Code Block

language	js

{
  "dxf": {...}
  "message": "optional response message"
}

Status

Response code	Description
200	Success
404	Not found - a given service identifier was not found

Section

Filters

Anchor

FiltersAnchor FiltersAnchor

Code Block

language	js

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

NoteWhen using endpoints that use this filter, the filter cannot be empty: at least one field of the filter must be specified.

Page tree

Versions Compared

Old Version 11

New Version 12

Key

Get all servers

Get all servers, filtered

Get a single server

Add servers

Update servers

Delete multiple servers, filtered

Delete single server

Get server type dxf (TODO)

Page tree

Page History

Versions Compared

Old Version 11

New Version 12

Key

Get all servers

Get all servers, filtered

Get a single server

Add servers

Update servers

Delete multiple servers, filtered

Delete single server

Get server type dxf (TODO)