The Resource Manager API endpoints live in the manager nodes only. They are responsible for serving component resources such as properties, icons and DXF (for UI configuration).
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
|
Request and Response example
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/:cmpName/properties
Path Parameters
Name | Type | Required | Description |
---|---|---|---|
type | string | Required | The type of resource
|
cmpName | string | Required | a component we require properties for. It can be used with or without the version. When used with the version use this syntax: cmpName:version |
Request and Response example
/aspire/_api/resources/connector/sharepoint-online/properties /aspire/_api/resources/connector/sharepoint-online:5.0-SNAPSHOT/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, 404
Gets the icon for the component, this endpoint needs the at least the OPERATOR role to be executed.
GET /aspire/_api/resources/:type/:cmpName/icon
Path Parameters
Name | Type | Required | Description |
---|---|---|---|
type | string | Required | The type of resource
|
cmpName | string | Required | a component we require icon for. It can be used with or without the version. When used with the version use this syntax: cmpName:version |
Query Parameters
Name | Type | Required | Description |
---|---|---|---|
thumbnail | boolean | Optional | We want the thumbnail from the icon |
Request and Response example
/aspire/_api/resources/connector/sharepoint-online/icon?thumbnail=true [the image]
Status: 200, 400, 404
Gets the icon for the component, this endpoint needs the at least the OPERATOR role to be executed.
GET /aspire/_api/resources/:type/:cmpName/dxf
Path Parameters
Name | Type | Required | Description |
---|---|---|---|
type | string | Required | The type of resource
|
cmpName | string | Required | a component we require the DXF for. It can be used with or without the version. When used with the version use this syntax: cmpName:version |
Query Parameters
Name | Type | Required | Description |
---|---|---|---|
file | string | Required | The DXF file name |
Request and Response example
/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/:resourceType/addCustom
Path Parameters
Name | Type | Required | Description |
---|---|---|---|
resourceType | string | Required | The type of resource
|
Request example
PUT /aspire/_api/resources/connector/addCustom { "name" : "customFileSystem", "mvnCoordinates" : "com.accenture.aspire:aspire-customFilesystem-source:5.0" }
Status: 200, 400, 409
Delete the custom application, this endpoint need the OPERATOR role to be executed.
DELETE /aspire/_api/resources/:type/:cmpName/deleteCustom
Path Parameters
Name | Type | Required | Description |
---|---|---|---|
type | string | Required | The type of resource
|
cmpName | string | Required | a component to be deleted |
Request example
DELETE /aspire/_api/resources/connector/customFileSystem/deleteCustom
Status: 200, 404
Determine if there are dashboards properties enabled
Get the URL to the Main Dashboard
GET /aspire/_api/resources/dashboard/main
Status: 200
Response example
{ "url" : "https://kibana_host:5601/...." }
Get the URL to the Metrics Dashboard for a list of given crawls
POST /aspire/_api/resources/dashboard/metrics
Request example
POST /aspire/_api/resources/dashboard/metrics [ { "seed" : "e11dac6b-0083-4d9a-ac3b-0e1bca4f0872", "crawlId" : "1623652817" }, { "seed" : "98d65d8b-a7eb-4349-9f51-4139cf8a6404", "crawlId" : "1623642813" } ]
Status: 200
Response example
{ "e11dac6b-0083-4d9a-ac3b-0e1bca4f0872" : { "url" : "https://kibana_host:5601/....." }, "98d65d8b-a7eb-4349-9f51-4139cf8a6404" : { "url" : "https://kibana_host:5601/....." } }
Uploads a file to the Aspire resources repository, this endpoint needs the at least the OPERATOR role to be executed.
POST /aspire/_api/resources/file?description=:description
Body Form
Name | Type | Required | Description |
---|---|---|---|
file | file | Required | The file to be uploaded |
Query Parameters
Name | Type | Required | Description |
---|---|---|---|
description | string | Required | The file description |
Request example
POST /aspire/_api/resources/file?description=groovy --form 'file=@"/C:/Directory/file.groovy"'
Status: 200
Response example
{ "id" : "517f161623ea3f43cc567a33914b96c31cbaa2c63d2594174d2b6230b1912ae1" "name" : "file.groovy", "description" : "groovy", "checksum" : "12565092083235" }
Downloads a file from the Aspire resources repository, this endpoint needs the at least the OPERATOR role to be executed.
GET /aspire/_api/resources/file/:id
Path Parameters
Name | Type | Required | Description |
---|---|---|---|
id | string | Required | The id of the file to download |
Request example
GET /aspire/_api/resources/file/517f161623ea3f43cc567a33914b96c31cbaa2c63d2594174d2b6230b1912ae1
Status: 200
Response example
[the file]
Updates the description from a file to the Aspire resources repository, this endpoint needs the at least the OPERATOR role to be executed.
POST /aspire/_api/resources/file/:id?description=:description
Path Parameters
Name | Type | Required | Description |
---|---|---|---|
id | string | Required | The id of the file to update |
Query Parameters
Name | Type | Required | Description |
---|---|---|---|
description | string | Required | The file description |
Request example
POST/aspire/_api/resources/file/517f161623ea3f43cc567a33914b96c31cbaa2c63d2594174d2b6230b1912ae1?description=new_description
Status: 200
Response example
{ "id" : "517f161623ea3f43cc567a33914b96c31cbaa2c63d2594174d2b6230b1912ae1" }
Deletes a file from the Aspire resources repository, this endpoint needs the at least the OPERATOR role to be executed.
DELETE /aspire/_api/resources/file/:id
Path Parameters
Name | Type | Required | Description |
---|---|---|---|
id | string | Required | The id of the file to delete |
Request example
DELETE /aspire/_api/resources/file/517f161623ea3f43cc567a33914b96c31cbaa2c63d2594174d2b6230b1912ae1
Status: 200
Response example
{ "id" : "517f161623ea3f43cc567a33914b96c31cbaa2c63d2594174d2b6230b1912ae1" }
Gets the list of files in the Aspire resources repository, this endpoint needs the at least the OPERATOR role to be executed.
GET /aspire/_api/resources/file?from=:from&size=:size
Query Parameters
Name | Type | Required | Description |
---|---|---|---|
from | integer | Optional | The offset for the results page |
size | integer | Optional | The page size |
Request example
GET /aspire/_api/resources/file
Status: 200
Response example
{ "count": { "totalItems": 1 }, "resource": [ { "id" : "517f161623ea3f43cc567a33914b96c31cbaa2c63d2594174d2b6230b1912ae1" "name" : "file.groovy", "description" : "groovy", "checksum" : "12565092083235" } ] }