Page in development
This page is in development and as such, its contents may be incorrect
The connector API provides functionality that allows a administrator to perform actions such as adding and configuring connectors
List connectors
Lists all the connectors configured in the Aspire
GET /aspire_api/connector
Query String Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| type | string | Optional | Filter returned connectors to only those with the given type |
| description | string | Optional | Filter returned connectors to only those whose description matches the given expression |
Response
{
"connector": [{
"id": "AAABcID5GBc=",
"type": "filesystem",
"description": "NetApp connector",
},
{
"id": "AAABcIueWUc=",
"type": "shareoint-online",
"description": "SharePoint Online",
}],
"message": "optional response message"
}
Status
| Response code | Description |
|---|---|
| 200 | Success |
Get a single connector
Get information about a single connector configured in Aspire
GET /aspire_api/connector?id=:id
GET /aspire_api/connector/:id
Query String and Path Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| id | string | Required | The id of the connector to return |
Response
{
"connector": {
"id": "AAABcID5GBc=",
"connector": "c:\\testdata\\2500",
"type": "filesystem",
"description": "2,500 files",
"status": "S",
"start": 1584550193011,
"stop": 1584550267047
},
"message": "optional response message"
}
Status
| Response code | Description |
|---|---|
| 200 | Success |
| 404 | The given connector id was not found |
Add connector(s)
Add one or more connectors to Aspire
POST /aspire_api/connector
Request Body Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| connector | string | Required | The url/path indicating the content to crawl |
| type | string | Required | The type of connector to use for this connector (may be omitted if connector is specified) |
| connector | string | Required | The identifier of the connector configuration to use for this connector (may be omitted if type is specified) |
| description | string | Optional | An optional description of the connector |
| credential | string | Optional | An optional id of the credential to use for this connector |
| policy | string | Optional | An optional list of the policy identifiers to use for this connector |
| workflow | string | Optional | An optional list of the workflow identifiers to use for this connector |
Examples
Add a single connector
{
"connector": "c:\\testdata\\2500",
"type": "filesystem"
}
Add multiple connectors
[{
"connector": "c:\\testdata\\2500",
"type": "filesystem"
},
{
"connector": "c:\\testdata\\250000",
"connector": "connector_1",
"description": "250,000 files",
"credential": "cred_1",
"policy": "policy_1",
"workflow": ["workflow_1","workflow_99"]
}]
Response
{
"connector": [{
"id": "AAABcID5GBc=",
"connector": "c:\\testdata\\2500",
"type": "filesystem",
"status": "N"
},
{
"id": "AAABcIueWUc=",
"type": "filesystem",
"connector": "c:\\testdata\\250000",
"connector": "connector_1",
"description": "250,000 files",
"credential": "cred_1",
"policy": "policy_1",
"workflow": ["workflow_1","workflow_99"]
"status": "N"
}],
"message": "optional response message"
}
Status
| Response code | Description |
|---|---|
| 201 | Created |
| 406 | Not acceptable - there was an issue validating the input |
Update connector(s)
Update one or more connectors 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/connector
Request Body Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| id | string | Required | The identifier of the connector to update |
| connector | string | Required | The url/path indicating the content to crawl |
| type | string | Required | The type of connector to use for this connector (may be omitted if connector is specified) |
| connector | string | Required | The identifier of the connector configuration to use for this connector (may be omitted if type is specified) |
| description | string | Optional | An optional description of the connector |
| credential | string | Optional | An optional id of the credential to use for this connector |
| policy | string | Optional | An optional list of the policy identifiers to use for this connector |
| workflow | string | Optional | An optional list of the workflow identifiers to use for this connector |
Examples
Update a single connector
{
"id": "AAABcID5GBc=",
"connector": "c:\\testdata\\2500",
"type": "filesystem"
}
Update multiple connectors
[{
"id": "AAABcID5GBc=",
"connector": "c:\\testdata\\2500",
"type": "filesystem"
},
{
"id": "AAABcIueWUc=",
"connector": "c:\\testdata\\250000",
"connector": "connector_1",
"description": "250,000 files",
"credential": "cred_1",
"policy": "policy_1",
"workflow": ["workflow_1","workflow_99"]
}]
Response
{
"connector": [{
"id": "AAABcID5GBc=",
"connector": "c:\\testdata\\2500",
"type": "filesystem",
"status": "N"
},
{
"id": "AAABcIueWUc=",
"type": "filesystem",
"connector": "c:\\testdata\\250000",
"connector": "connector_1",
"description": "250,000 files",
"credential": "cred_1",
"policy": "policy_1",
"workflow": ["workflow_1","workflow_99"]
"status": "N"
}],
"message": "optional response message"
}
Status
| Response code | Description |
|---|---|
| 201 | Created |
| 404 | Not found - a given connector identifier was not found |
| 406 | Not acceptable - there was an issue validating the input |
Delete connector(s)
Delete one or more connectors from Aspire.
DELETE /aspire_api/connector?id=:id
DELETE /aspire_api/connector/:id
DELETE /aspire_api/connector
Query String, Path and Request Body Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| id | string | Required | The identifier(s) of the connector(s) to delete |
Examples
Delete a single connector
{
"id": "AAABcID5GBc="
}
Delete multiple connectors
[{
"id": "AAABcID5GBc="
},
{
"id": "AAABcIueWUc="
}]
Delete multiple connectors (alternative form)
{
"id": ["AAABcID5GBc=", "AAABcIueWUc="]
}
Response
{
"message": "optional response message"
}
Status
| Response code | Description |
|---|---|
| 200 | Success |
| 404 | Not found - a given connector identifier was not found |
| 406 | Not acceptable - there was an issue validating the input |
Overview
Content Tools
Copyright © 2024 Accenture
