Versions Compared

Key

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

...


Request example

Section

Add custom application

Delete one or more connectors from Aspire, this endpoint need the OPERATOR role to be executed.

Panel
borderColorblack
bgColor#fafafb

PUT /aspire/_api/resources/:type/:cmpSpecresourceType/addCustom


Path Parameters

NameTypeRequiredDescription
typeresourceTypestringRequired

The type of resource

  • "connector"
  • "application"
  • "publisher"
  • "service"
  • "framework"
  • "other"
cmpSpecstringRequiredthe full Maven coordinates of the component - e.g. 
com.accenture.aspire:aspire-customFilesystem-source:5.0

Query Parameters

NameTypeRequiredDescription
cmpNamestringRequired

The name of the component. 

Code Block
languagejs
PUT /aspire/_api/resources/connector/addCustom
{
   "name" : "customFileSystem",
   "mvnCoordinates" : "com.accenture.aspire:aspire-customFilesystem-source:5.0/addCustom?cmpName=customFileSystem"
}

Status: 200, 400, 409

Section

Delete custom application

Delete the custom application, this endpoint need the OPERATOR role to be executed.

Panel
borderColorblack
bgColor#fafafb

DELETE /aspire/_api/resources/:type/:cmpName/deleteCustom


Path Parameters

NameTypeRequiredDescription
typestringRequired

The type of resource

  • "connector"
  • "application"
  • "publisher"
  • "service"
  • "framework"
  • "other"
cmpNamestringRequireda component to be deleted


Request example

Code Block
languagejs
DELETE /aspire/_api/resources/connector/customFileSystem/deleteCustom

Status: 200, 404