The connectors API provides functionality that allows a administrator or operator to perform actions such as adding and configuring connectors.
Easy Heading Free | ||||
---|---|---|---|---|
| ||||
Section | |||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get all connectorsLists all the connectors configured in the Aspire, this endpoint need the at least the OPERATOR role to be executed.
Pagination query string parameters Sorting query string parameter
Response
Status | |||||||||||||||||||||||
Response code | Description | ||||||||||||||||||||||
200 | Success |
"100",
....
},
"checksum": "2f29393b0fb89ab1d70c0df85c698214def4952467488c3df03d37baeab5d39e"
},
{
"id": "16e901a5-75c7-4969-90d2-70ad299916f3",
"artifact": "com.accenture.aspire:aspire-filesystem-source",
"type": "filesystem",
"description": "FS_Demo",
"properties": {
"enableFetcher": "true",
"enableFetchUrl": "true",
"infoCacheSize": "100",
....
},
"checksum": "0d5130e07c1e6123bcfa6c6e81850693a2e2e3d03d896c7725dd3cb536c86b62"
}
]
} |
Status: 200
Section | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get a single connectorGet information about a single connector configured in Aspire, this endpoint need the at least the OPERATOR role to be executed.
Path Parameters
Response
| ||||||||||||||||||||||
Section |
Panel | ||||
---|---|---|---|---|
| ||||
|
Path Parameters
Response
Code Block | ||
---|---|---|
| ||
{
"connector": {
"id": "AAABcID5GBc=",
"type": "filesystem"
"description": "NetApp connector",
"created": 1596707252548,
"updated": 1596707252548,
"properties": { This will be a dynamic JSON object }
}
} |
Status
Add connectors to Aspire
Panel | ||||
---|---|---|---|---|
| ||||
POST /aspire/_api/connectors |
Body Parameters
Example
Code Block | ||
---|---|---|
| ||
POST /aspire/_api/connectors [ { "type": "filesystem", "description": "FS Demo", "artifact": "com.accenture.aspire:aspire-filesystem-source", "properties": { "enableFetcher": "true", ..... } }, { "type": "filesystem", "description": "FS Demo1", "artifact": "com.accenture.aspire:aspire-filesystem-source", "properties": { "enableFetcherid": "true948a9d99-5b71-4023-976e-14dcdc82f231", "enableFetchUrlartifact": "truecom.accenture.aspire:aspire-ldap-cache-source", .... } } ] |
Response
Code Block | ||
---|---|---|
| ||
{ "connector": [{ "type": "ldap", "iddescription": "AAABcID5GBc=LDAP", "typeproperties": "filesystem",{ "description": "FS Demo", "artifactenableFetcher": "com.accenture.aspire:aspire-filesystem-sourcetrue", "properties": { "enableFetcherenableFetchUrl": "true", ..... } }, { "infoCacheSize": "100", ............. "id": "BAABcID5GBc=" }, "type": "filesystem", "descriptionchecksum": "FS Demo12f29393b0fb89ab1d70c0df85c698214def4952467488c3df03d37baeab5d39e", "artifact": "com.accenture.aspire:aspire-filesystem-source", "properties": { "enableFetcher": "true} } |
Status: 200, 404
Section | ||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Add connector(s)Add connectors to Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed.
Body Parameters
Example
See Response Body for details regarding the response body returned where multiple items are affected with some (or all) returning errors Status | ||||||||||||||||||||||||||||||||||
Response code | Description | |||||||||||||||||||||||||||||||||
201 | Created | |||||||||||||||||||||||||||||||||
406 | Not acceptable - there was an issue validating the input | |||||||||||||||||||||||||||||||||
Section | ||||||||||||||||||||||||||||||||||
Update connector(s)Updates connectors in Aspire.
Path Parameters | ||||||||||||||||||||||||||||||||||
Name | Type | Required | Description | |||||||||||||||||||||||||||||||
id | string | Required | The identifier of the connector to update | |||||||||||||||||||||||||||||||
Name | Type | Required | Description | |||||||||||||||||||||||||||||||
id | string | Required | The identifier of the connector to update | other parameters mentioned in the above "Add" section |
Code Block |
---|
PUT /aspire/_api/connectors/600f70ef-7a90-4364-bdb9-7a9b5f81f6fe { "id": "600f70ef-7a90-4364-bdb9-7a9b5f81f6fe", "FS Demo Test 1", "artifact": "com.accenture.aspire:aspire-filesystem-source", "properties": { "enableFetcher": "true", "enableFetchUrl": "true", "infoCacheSize": "100", "deleteCheckAfterErrors": "NEVER", ..... } }, { "type": "filesystem", "description": "NetAppFS -Demo First-Test UPDATE2", "artifact": "blacom.accenture.aspire:aspire-filesystem-source", ..... } |
Example - update more connectors
Code Block | ||
---|---|---|
| ||
PUT /aspire/_api/connectors { "AAABcID5GBc=": { "properties": { "idenableFetcher": "AAABcID5GBc=true", "description": "Net App", "typeenableFetchUrl": "filesystemtrue", ..... }, "AAABcID5GBd=": { "idinfoCacheSize": "AAABcID5GBd=100", "description": "Sharepoint online", "typedeleteCheckAfterErrors": "sharepointNEVER" , ................. } } ] |
Response
Code Block | ||||
---|---|---|---|---|
| ||||
{ "connector": [ { "id": "AAABcID5GBc=8e971436-b78a-4c6d-bafb-e16f1433c6f6", "description": "Net App", "typeartifact": "com.accenture.aspire:aspire-filesystem-source", .... }, { "idtype": "AAABcID5GBd=filesystem", "description": "Sharepoint onlineFS_Demo_Test_1", "typeproperties": "sharepoint",{ ...... }] } |
See Response Body for details regarding the response body returned where multiple items are affected with some (or all) returning errors
Status
Update connectors configured in the Aspire, filtered by a specified criteria
Panel | ||||
---|---|---|---|---|
| ||||
|
Response
Code Block | ||
---|---|---|
| ||
{
"message": "update result response message"
} |
Delete multiple connectors from Aspire, filtered by a specified criteria
Panel | ||||
---|---|---|---|---|
| ||||
|
Response
Code Block | ||
---|---|---|
| ||
{
"message": "delete result response message"
} |
Status
Delete one or more connectors from Aspire.
Panel | ||||
---|---|---|---|---|
| ||||
|
Path Parameters and Query parameters
Body Parameter
Examples
Code Block | ||
---|---|---|
| ||
DELETE /aspire/_api/connectors/AAABcID5GBc
DELETE /aspire/_api/connectors?id=AAABcID5GBc&id=AAABcID5GBd
POST /aspire/_api/connectors
{
"ids":["AAABcID5GBc","AAABcID5GBd"]
}
|
Response
Code Block | ||
---|---|---|
| ||
{
"message": "delete result response message"
} |
See Response Body for details regrading the response body returned where multiple items are affected with some (or all) returning errors
Status
"enableFetcher": "true",
"enableFetchUrl": "true",
"infoCacheSize": "100",
..........
},
"checksum": "c27b11a3996c4dc6f3a03b79397679fa68256241a865faeef7f06271b558bb46"
},
{
"id": "9ad25f3b-ae34-4cff-85e1-6884e5b8f070",
"artifact": "com.accenture.aspire:aspire-filesystem-source",
"type": "filesystem",
"description": "FS_Demo_Test_2",
"properties": {
"enableFetcher": "true",
"enableFetchUrl": "true",
"infoCacheSize": "100",
.............
},
"checksum": "19a1ce2e3bb658c4831bbc706a13393874822bf03e1bac31a4f197770410afbb"
}
]
} |
See Response Body for details regarding the response body returned where multiple items are affected with some (or all) returning errors
Status: 201, 406
Section | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Update connector(s)Updates connectors in Aspire, this endpoint need the ADMINISTRATOR role to be executed.
Path Parameters
Body Parameters
x - at least one field must be present
Example - update more connectors
Response
Status: 200, 404, 406
|
Section | |||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Delete connector(s)Delete one or more connectors from Aspire, this endpoint need the ADMINISTRATOR role to be executed.
Path Parameters and Query parameters
Body Parameter
Examples
Response
Status: 200, 404, 406
|
Section | |||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Export connector(s)Export one or more connector from Aspire, this endpoint needs at least the OPERATOR role to be executed.
Path Parameters and Query parameters
Body Parameter
Examples
Response
Status: 200, 404, 406
| |||||||||||||||||||||||||||||||||||||||||||||
Section | |||||||||||||||||||||||||||||||||||||||||||||
Get connectors types (TODO)Lists all available connectors types
Status | |||||||||||||||||||||||||||||||||||||||||||||
Response code | Description | ||||||||||||||||||||||||||||||||||||||||||||
200 | Success | ||||||||||||||||||||||||||||||||||||||||||||
Section |
Panel | ||||
---|---|---|---|---|
| ||||
GET /aspire/_api/connectors/:id/type |
Path Parameters
Status: 200 |
Section |
---|
ImportThe import usage can be found here |
Section | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Filters
Connector filter:
| |||||||||||||
Name | Type | Required | Description | ||||||||||
id | string | Required | The identifier of the type to retrieve |
Code Block | ||
---|---|---|
| ||
{
"type": [{
"id": "filesystem",
"description": "Filesytem Connector",
"coordinates": "com.accenture.aspire:aspire-filesystem-source"
}
]
} |
Status
Returns the dxf for a specific connector type
Panel | ||||
---|---|---|---|---|
| ||||
GET /aspire/_api/connectors/type/:typeId/dxf |
Path Parameters
Response
Code Block | ||
---|---|---|
| ||
{
"dxf": {...}
"message": "optional response message"
} |
Status