Skip to main content

How to delete app or resource (subindex) orphans in VS Search

Updated

The article addresses "orphan" search resources or apps in VS Search not linked to any VS Web App, caused by map updates, app replacements, unsaved changes, failed copies, or multi-environment deployments. To resolve, first try deleting via the Delete button. If blocked, use the VS Search API to delete orphaned apps or resources by copying their UUIDs and executing DELETE requests in Swagger UI, confirming success with HTTP 200 status.

Problem

There is a search resource configuration (Type: VertiGIS Studio Web) in VS Search that does not appear in any VS Web App—a so-called "orphan" search resource.

Similarly, there may be a search app configuration (Type: VertiGIS Studio Web) in VS Search that is not associated with any VS Web App—a so-called "orphan" search app.

This could occur in several scenarios:

  • A layer field is updated in the Web Map (for example, renamed or deleted), while the corresponding VS Search configuration is not removed beforehand (that is, not reverted to the Standard Esri search configuration).
  • The Web Map is replaced in a VS Web App, but the associated VS Search configurations are not deleted beforehand.
  • VS Search is configured for a feature layer in a VS Web App, but the changes are not saved before the page is reloaded or closed.
  • A copy of a VS Web App is created using Save As, but the copy operation fails for any reason.
  • A VS Web App is deployed across multiple environments (for example, following a development → test → staging → production workflow), resulting in search configurations that are no longer associated with an existing app.

Solution

If you have an orphaned configured resource (subindex) or orphaned search app in VS Search, first try to remove it using the Delete button (recycle bin icon). If the deletion is successful, no further action is required.
If there is no VS Web app associated with the given VS Search app, it should work out of the box.
If one still exists, you will typically see the following message when attempting to delete the search using the recycle bin:
"App of type 'VertiGIS Studio Web' can only be deleted from within VertiGIS Studio Web Designer."
In this case, you should attempt to delete the orphaned app using the relevant VS Search API endpoint - either for the VS Search App [A] or Resource (subindex) [B].

[A] How to delete orphaned apps using the VS Search API

  1. Copy VS Search App identifier (UUID) to the clipboard:

  2. Open the VS Search API. You can access it via: 
    Search Designer → Info → Engine Settings → “Explore the API” (Swagger UI).
  3. In Swagger UI:
    • Expand the apps section (1)
    • Expand the endpoint DELETE /api/apps/{appUuid} (2)
    • Click Try it out
    • Paste the previously copied app identifier into the appUuid field, then click Execute (3)
    • Check the response to confirm that the app was successfully deleted (HTTP status code 200)

[B] How to delete orphaned resources (subindices) using the VS Search API

  1. Copy (or note) the VS Search resource identifier (UUID) to the clipboard.
    You can also find the identifier in the internal Resource Config Viewer (press Ctrl + Shift + E on the resource configuration page):
  2. Open the VS Search API. You can access it via: 
    Search Designer → Info → Engine Settings → “Explore the API” (Swagger UI).
  3. In Swagger UI:
    • Expand the subindices - delete section (1)
    • Expand the endpoint DELETE /api/subindices/{subindexUuid} (2)
    • Click Try it out
    • Paste the previously copied resource (subindex) identifier into the subindexUuid field, then click Execute (3)
    • Check the response to confirm that the resource (subindex) was successfully deleted (HTTP status code 200)


       

Related to

Related articles

Comments

0 comments

Please sign in to leave a comment.