Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Section

Get the icon for the component

Gets the icon for the component, this endpoint needs the at least the OPERATOR role to be executed.

Panel
borderColorblack
bgColor#fafafb

GET /aspire/_api/resources/:type/:appType/icon


Path Parameters

NameTypeRequiredDescription
typestringRequired

The type of resource

  • "connector"
  • "application"
  • "publisher"
  • "service"
  • "framework"
  • "other"
appTypestringRequireda component we require the icon for


Query Parameters

NameTypeRequiredDescription
thumbnailbooleanOptional

We want the thumbnail from the icon


Response

Code Block
languagejs
/aspire/_api/resources/connector/sharepoint-online/icon?thumbnail=true

[the image]

Status: 200, 400

Query Parameters

Response

Section

Get the

icon for the component

Gets the icon for the component, this endpoint needs the at least the OPERATOR role to be executed.

Panel
borderColorblack
bgColor#fafafb

GET /aspire/_api/resources/:type/:appType/icon

Path Parameters

NameTypeRequiredDescription
typestringRequired

The type of resource

  • "connector"
  • "application"
  • "publisher"
  • "service"
  • "framework"
  • "other"
appTypestringRequireda component we require the icon for
NameTypeRequiredDescription
thumbnailbooleanOptional

We want the thumbnail from the icon

Code Block
languagejs
/aspire/_api/resources/connector/sharepoint-online/icon?thumbnail=true

[the image]

Status: 200, 400

Section

Get the dxf for the component

Gets the icon for the component, this endpoint needs the at least the OPERATOR role to be executed.

Panel
borderColorblack
bgColor#fafafb

GET /aspire/_api/resources/:type/:appType/dxf


Path Parameters

NameTypeRequiredDescription
typestringRequired

The type of resource

  • "connector"
  • "application"
  • "publisher"
  • "service"
  • "framework"
  • "other"
appTypestringRequireda component we require the dxf for


Query Parameters

NameTypeRequiredDescription
filestringRequired

The DXF file name


Response

Code Block
languagejs
/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

...