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 | a 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 | a component we require the icon 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
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 | a component we require the icon 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
Gets the icon for the component, this endpoint needs the at least the OPERATOR role to be executed.
GET /aspire/_api/resources/:type/:appType/dxf
Path Parameters
Name | Type | Required | Description |
---|---|---|---|
type | string | Required | The type of resource
|
appType | string | Required | a component we require the dxf for |
Query Parameters
Name | Type | Required | Description |
---|---|---|---|
file | string | Required | The DXF file name |
Response
/aspire/_api/resources/connector/filesystem/dxf?file=server { "General": [ { "type": "text", "key": "url", "display": "Base Path", "placeholder": "C:\\", "tooltip": "All the seeds will be prefixed with this value to form the full path", "validations": [ "required", "path" ] }, { "type": "boolean", "key": "ignoreSymLinks", "display": "Ignore Symbolic Links", "default": false, "tooltip": "If selected, symbolic links will not be processed and links in the root items will cause error." }, { "type": "boolean", "key": "ignoreScanErrors", "display": "Ignore Scan Errors", "default": false, "tooltip": "If selected, the scanning errors won't stop the crawl from continuing, but they are still going to be logged." } ], "Security": [ { "type": "fieldset", "display": "Static ACLs", "tooltip": "These ACLs will be added to all of the documents.", "body": [ { "type": "multiple", "key": "staticAcl", "body": [ { "type": "text", "key": "name", "display": "Name", "placeholder": "john.doe", "validations": [ "required" ], "tooltip": "Name of the ACL." }, { "type": "text", "display": "Domain", "key": "domain", "placeholder": "domain", "tooltip": "Domain to which the ACL belongs to." }, { "key": "entity", "type": "select", "display": "Entity", "tooltip": "Whether or not this ACL is for a group or a user.", "default": "user", "options": [ { "key": "group", "display": "Group" }, { "key": "user", "display": "User" } ] }, { "key": "access", "type": "select", "display": "Access", "tooltip": "Whether or not this ACL will have access to crawled files", "default": "allow", "options": [ { "key": "allow", "display": "Allow" }, { "key": "deny", "display": "Deny" } ] } ] } ] } ] }
Status: 200, 400, 404
Delete one or more connectors from Aspire, this endpoint need the OPERATOR role to be executed.
PUT /aspire/_api/resources/:type/:appType/addCustom
Path Parameters
Name | Type | Required | Description |
---|---|---|---|
type | string | Required | The type of resource
|
appType | string | Required | a component |
Query Parameters
Name | Type | Required | Description |
---|---|---|---|
name | string | Required | The name of the component |
Response
Status: 200, 400, 409
Delete the custom application, 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 | The type of resource
|
appType | string | Required | a component |
Response
Status: 200, 400, 404