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).
Easy Heading Free | ||||
---|---|---|---|---|
|
Table of Contents |
---|
...
title | Page in development |
---|
...
Section | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get available resourcesLists resources configured in the Aspire, this endpoint needs the at least the OPERATOR role to be executed.
Path Parameters
Request and Response example
Status: 200, 400 |
Section | ||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get properties for the componentGets properties for the component, this endpoint needs the at least the OPERATOR role to be executed.
Path Parameters
Request and Response example
Status: 200, 400, 404 |
Section | ||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get the icon for the componentGets the icon for the component, this endpoint needs the at least the OPERATOR role to be executed.
Path Parameters
Query Parameters
Request and Response example
Status: 200, 400, 404 |
Section | ||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get theicondxf for the componentGets the icon for the component, this endpoint needs the at least the OPERATOR role to be executed.
Path Parameters
Query Parameters
Request and Response exampleResponse
Status: 200, 400 | ||||||||||||||||||||||||||||||||||||
Section | ||||||||||||||||||||||||||||||||||||
Get the dxf for the componentGets the icon for the component, this endpoint needs the at least the OPERATOR role to be executed.
Path Parameters | ||||||||||||||||||||||||||||||||||||
Name | Type | Required | Description | |||||||||||||||||||||||||||||||||
type | string | Required | The type of resource
| |||||||||||||||||||||||||||||||||
appType | string | Required | a component we require the dxf for | |||||||||||||||||||||||||||||||||
Name | Type | Required | Description | |||||||||||||||||||||||||||||||||
file | string | Required | The DXF file name |
Code Block | ||
---|---|---|
| ||
/aspire/_api/resources/connector/filesystem/dxf?file=server { "General": [ "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": [ "type": "textrequired", "key": "urlpath", ] "display": "Base Path", }, { "placeholdertype": "C:\\boolean", "tooltipkey": "All the seeds will be prefixed with this value to form the full pathignoreSymLinks", "display": "Ignore Symbolic Links", "validationsdefault": [false, "tooltip": "required", "path""If selected, symbolic links will not be processed and links in the root items will cause error." }, ] { }, { ""type": "boolean", "key": "ignoreSymLinksignoreScanErrors", "display": "Ignore SymbolicScan LinksErrors", "default": false, "tooltip": "If selected, the scanning symbolicerrors linkswon't willstop notthe becrawl processedfrom andcontinuing, linksbut inthey theare rootstill itemsgoing willto causebe errorlogged." } ], "Security": [ { "type": "booleanfieldset", "keydisplay": "ignoreScanErrorsStatic ACLs", "displaytooltip": "IgnoreThese Scan Errors", "default": falseACLs will be added to all of the documents.", "tooltipbody": "If selected, the scanning errors won't stop the crawl from continuing, but they are still going to be logged." [ { } ], "Securitytype": ["multiple", { "typekey": "fieldsetstaticAcl", "display": "Static ACLs", "tooltipbody": "These ACLs will be added to all of the documents.", [ "body": [ { { "type": "multipletext", "key": "staticAclname", "body "display": [ "Name", {"placeholder": "john.doe", "typevalidations": "text",[ "key": "namerequired", "display": "Name"], "placeholdertooltip": "john.doe",Name of the ACL." }, "validations": [ { "required" ]"type": "text", "tooltipdisplay": "Name of the ACL."Domain", }, {"key": "domain", "typeplaceholder": "textdomain", "displaytooltip": "Domain", to which the ACL belongs to." "key": "domain" }, "placeholder": "domain",{ "tooltipkey": "entity"Domain, to which the ACL belongs to." }"type": "select", { "display": "Entity", "keytooltip": "entityWhether or not this ACL is for a group or a user.", "typedefault": "selectuser", "displayoptions": "Entity",[ "tooltip": "Whether or not this{ ACL is for a group or a user.", "defaultkey": "usergroup", "options": [ "display": "Group" { }, "key": "group", { "displaykey": "Groupuser", }, "display": "User" {} ] "key": "user", }, "display": "User" { }"key": "access", ]"type": "select", }, "display": "Access", { "tooltip": "Whether or not this ACL will have access to "key": "access"crawled files", "typedefault": "selectallow", "displayoptions": "Access",[ "tooltip": "Whether or not this{ ACL will have access to crawled files", "defaultkey": "allow", "optionsdisplay": ["Allow" {}, "key": "allow",{ "displaykey": "Allowdeny", }, "display": "Deny" { } ] "key": "deny", } "display": "Deny" ] } ] } ] } ] } ] } ] } |
Status: 200, 400, 404
Section | |||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Add custom applicationDelete one or more connectors from Aspire, this endpoint need the OPERATOR role to be executed.
Path Parameters
Query Parameters | |||||||||||||||||||
Name | Type | Required | Description | ||||||||||||||||
name | string | Required | The name of the component | ||||||||||||||||
Code Block | |||||||||||||||||||
| |||||||||||||||||||
Section | |||||||||||||||||||
Request example
Delete resourceDelete the custom application, this endpoint need the OPERATOR role to be executed.
Path Parameters
Status: 200, 400, 409 |
Section | ||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Delete custom applicationDelete the custom application, this endpoint need the OPERATOR role to be executed.
Path Parameters
Request example
Status: 200, 404 |
Section | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Dashboards enabledDetermine if there are dashboards properties enabled
Status: 200 Response example
|
Section | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get Main DashboardGet the URL to the Main Dashboard
Status: 200 Response example
|
Section | |||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get Metrics DashboardGet the URL to the Metrics Dashboard for a list of given crawls
Request example
Status: 200 Response example
|
Section | |||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Upload FileUploads a file to the Aspire resources repository, this endpoint needs the at least the OPERATOR role to be executed.
Body Form
Query Parameters
Request example
Status: 200 Response example
|
Section | |||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Download FileDownloads a file from the Aspire resources repository, this endpoint needs the at least the OPERATOR role to be executed.
Path Parameters
Request example
Status: 200 Response example
|
Section | |||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Update File DescriptionUpdates the description from a file to the Aspire resources repository, this endpoint needs the at least the OPERATOR role to be executed.
Path Parameters
Query Parameters
Request example
Status: 200 Response example
|
Section | |||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Delete FileDeletes a file from the Aspire resources repository, this endpoint needs the at least the OPERATOR role to be executed.
Path Parameters
Request example
Status: 200 Response example
|
Section | |||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get File ListGets the list of files in the Aspire resources repository, this endpoint needs the at least the OPERATOR role to be executed.
Query Parameters
Request example
Status: 200 Response example
| |||||||||||||||||||||||||||||||||
Name | Type | Required | Description | ||||||||||||||||||||||||||||||
type | string | Required | The type of resource
| ||||||||||||||||||||||||||||||
appType | string | Required | a component | ||||||||||||||||||||||||||||||
Code Block | |||||||||||||||||||||||||||||||||
|