Page in development
This page is in development and as such, its contents may be incorrect
Lists resources configured in the Aspire, this endpoint needs the at least the OPERATOR role to be executed.
GET /aspire/_api/resources/:type
Path Parameters
Name | Type | Required | Description |
---|---|---|---|
type | string | Required | The type of resource
|
Response
GET /aspire/_api/resources/connector { "resource": [ { "available": true, "mavenCoordinates": "com.accenture.aspire:aspire-sharepointonline-source", "type": "sharepoint-online", "displayName": "sharepoint-online", "versions": [ "5.0-SNAPSHOT" ], "currentVersion": "5.0-SNAPSHOT", "properties": { "connector.framework.feature.hierarchy": "false", "connector.framework.feature.contentCrawling": "true", "checkSnapshotAfterProcess": "false", "mvnCoordinates": "com.accenture.aspire:aspire-sharepointonline-source", "component.default.dxf": "dxf/contentSource.xml", "component.appbundle.maven.coordinates": "app-rap-connector", "connector.framework.isRAP": "true", "connector.framework.feature.identityCrawling": "false" } }, { "available": true, "mavenCoordinates": "com.accenture.aspire:aspire-filesystem-source", "type": "filesystem", "displayName": "filesystem", "versions": [ "5.0-SNAPSHOT" ], "currentVersion": "5.0-SNAPSHOT", "properties": { "connector.framework.feature.hierarchy": "true", "connector.framework.feature.contentCrawling": "true", "checkSnapshotAfterProcess": "false", "mvnCoordinates": "com.accenture.aspire:aspire-filesystem-source", "component.default.dxf": "dxf/contentSource.xml", "useCredentials": "false", "component.appbundle.maven.coordinates": "app-rap-connector", "connector.framework.isRAP": "true", "connector.framework.feature.groupExpansion": "false", "connector.framework.feature.identityCrawling": "false" } } ] }
Status: 200, 400
Gets properties for the component, this endpoint needs the at least the OPERATOR role to be executed.
GET /aspire/_api/resources/:type/:appType/properties
Path Parameters
Name | Type | Required | Description |
---|---|---|---|
type | string | Required | The type of resource
|
appType | string | Required | the component we require properties for |
Response
/aspire/_api/resources/connector/sharepoint-online/properties { "properties": { "connector.framework.feature.hierarchy": "false", "connector.framework.feature.contentCrawling": "true", "checkSnapshotAfterProcess": "false", "mvnCoordinates": "com.accenture.aspire:aspire-sharepointonline-source", "component.default.dxf": "dxf/contentSource.xml", "component.appbundle.maven.coordinates": "app-rap-connector", "connector.framework.isRAP": "true", "connector.framework.feature.identityCrawling": "false" } }
Status: 200, 400
Gets the icon for the component, this endpoint needs the at least the OPERATOR role to be executed.
GET /aspire/_api/resources/:type/:appType/icon
Path Parameters
Name | Type | Required | Description |
---|---|---|---|
type | string | Required | The type of resource
|
appType | string | Required | the component we require properties for |
Query Parameters
Name | Type | Required | Description |
---|---|---|---|
thumbnail | boolean | Optional | We want the thumbnail from the icon |
Response
/aspire/_api/resources/connector/sharepoint-online/icon?thumbnail=true [the image]
Status: 200, 400
Delete one or more connectors from Aspire, this endpoint need the OPERATOR role to be executed.
DELETE /aspire/_api/resources/:type/:appType/deleteCustom
Path Parameters
Name | Type | Required | Description |
---|---|---|---|
type | string | Required | |
appType |
Examples
DELETE /aspire/_api/connectors/AAABcID5GBc
Response
{ "message": "delete result response message" }
Status: 200, 404, 406