Remove entities from a program, task, or request

Removes entities (tasks, requests, or content items) from another entity (program, task, or request) so they are no longer part of the entity or visible within its UI. This operation excludes entities without affecting the actual entities themselves. Use this endpoint when you need to remove tasks, requests, or content from programs while preserving the entities for other uses.

Key Features:

  • Supports bulk removal of multiple entities in a single request
  • Validates entity identification before processing removal operations
  • Gracefully handles cases where entities are not currently associated
  • Operation is atomic - either all specified entities are removed or none
  • Preserves original entities while removing them from program structure

Authorization Logic:

  1. User must have a valid JWT token with appropriate scopes
  2. Token is valid for this operation
  3. User must have permission to manage the target entity (program, task, or request)
  4. User must have access to all entities being removed from the association

Usage Example:

Remove completed tasks from a program to clean up the active workflow view.

Path Params
string
required
length between 7 and 22

The unique identifier of the space containing the target entity. This determines the scope of entity queries and ensures proper access control. The space must be accessible to the authenticated user with appropriate permissions. It can be the unique identifier (GUID) of the space or the word "default" to indicate the default programs space. Common values include "default" and "rkr83lapKkyCJuLLWqLqzB".

string
required

The unique identifier of the entity (program, task, or request) to remove entities from. This entity must exist within
the specified space and be accessible to the authenticated user. Entities will be excluded from this structure.

Body Params

Request body containing an array of entities to remove from the program structure. Each entity must include sufficient identification information (spaceId, nodeId, nodeType) to uniquely identify the entity to be excluded. Supported nodeTypes include task, request, and content. Only the specified entities will be affected.

associations
array of objects

List of association objects

associations
Responses
204

Entities removed successfully. No response body is returned for successful removal operations.

Language
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json