You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 7 Next »

Page in development

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

Get available resources

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

NameTypeRequiredDescription
typestringRequired

The type of resource

  • "connector"
  • "application"
  • "publisher"
  • "service"
  • "framework"
  • "other"


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

Get properties for the component

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

NameTypeRequiredDescription
typestringRequired

The type of resource

  • "connector"
  • "application"
  • "publisher"
  • "service"
  • "framework"
  • "other"
appTypestringRequiredthe 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

Delete resource

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

NameTypeRequiredDescription
typestringRequired
appType



Examples

DELETE /aspire/_api/connectors/AAABcID5GBc



Response

{
  "message": "delete result response message"
}

Status: 200, 404, 406

  • No labels