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
Get all servers
Lists all the servers configured in the Aspire
GET /aspire/_api/servers
Query String Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| xx | string | Optional | xx |
Response
{
"server": [
{
"id": "191283d9-183e-4820-8932-32b1fa07d2d5",
.....
},
{
"id": "5d0b35d5-c946-44e7-9be5-97c9ad9036a3",
.....
}
]
}
Status
| Response code | Description |
|---|---|
| 200 | Success |
Get a single server
Get information about a single server configured in Aspire
GET /aspire/_api/servers/:id
Path Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| id | string | Required | The id of the server to return |
Response
{
"server": {
"id": "191283d9-183e-4820-8932-32b1fa07d2d5",
},
"message": "optional response message"
}
Status
| Response code | Description |
|---|---|
| 200 | Success |
| 404 | The given server id was not found |
Add servers
Add one or more servers to Aspire
POST /aspire/_api/servers
Request Body Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| xx | string | Required | xx |
| xx | string | Optional | An optional xx of the server |
Examples
Add a single server
POST /aspire/_api/servers
{
"server": "c:\\testdata\\2500",
"type": "filesystem"
}
Add multiple servers
POST /aspire/_api/servers
[{
"server": "c:\\testdata\\2500",
"type": "filesystem"
},
{
"server": "c:\\testdata\\250000",
"connector": "connector_1",
"description": "250,000 files",
"credential": "cred_1",
"policy": "policy_1",
"workflow": ["workflow_1","workflow_99"]
}]
Response
{
"server": [{
"id": "5d0b35d5-c946-44e7-9be5-97c9ad9036a3",
},
{
"id": "5d0b35d5-c946-44e7-9be5-97c9ad9036a3",
}]
}
Status
| Response code | Description |
|---|---|
| 201 | Created |
| 406 | Not acceptable - there was an issue validating the input |
Update servers
Update one or more servers in Aspire. Updates will be treated as partial updates rather than overwrites. If a field is not present in the input, any previous value will remain after the update. If you wish to "delete" a value, pass a value of null
PUT /aspire/_api/servers/:id
PUT /aspire/_api/servers
Request Body Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| id | string | Required | The identifier of the server to update |
| xx | string | Required | xx |
| xx | string | Optional | An optional xx of the server |
Examples
Update a single server
PUT /aspire/_api/servers/AAABcID5GBc%3D
{
"id": "AAABcID5GBc=",
"server": "c:\\testdata\\2500",
"type": "filesystem"
}
Update multiple servers
PUT /aspire/_api/servers
{
"AAABcID5GBc=": {
"id": "AAABcID5GBc=",
"server": "c:\\testdata\\2500",
"type": "filesystem"
},
"AAABcIueWUc=": {
"id": "AAABcIueWUc=",
"server": "c:\\testdata\\250000",
"connector": "connector_1",
"description": "250,000 files",
"credential": "cred_1",
"policy": "policy_1",
"workflow": ["workflow_1","workflow_99"]
}
}
Response
{
"server": [{
"id": "AAABcID5GBc=",
},
{
"id": "AAABcIueWUc=",
}]
}
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 |
Delete servers
Delete one or more servers from Aspire.
DELETE /aspire/_api/servers/:id
DELETE /aspire/_api/servers
Path and Query String Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| id | string | Required | The identifier(s) of the server(s) to delete |
Examples
Delete a single server
DELETE /aspire/_api/servers/AAABcID5GBc%3D
Delete multiple servers
DELETE /aspire/_api/servers?id=AAABcID5GBc%3D&id=AAABcIueWUc%3D
Response
{
"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 |
Overview
Content Tools
Copyright © 2024 Accenture
