Add entities to a program, task, or request

Adds entities (tasks, requests, or content items) to another entity (program, task, or request), making them part of the entity and visible within its UI. Associations enable organizational hierarchy and workflow management, and ensure relevant entities appear within the program interface for better organization and accessibility.

Key Features:

  • Supports bulk addition of multiple entities in a single request
  • Validates all entity references exist and are accessible before processing
  • Automatically sanitizes input data for security and consistency
  • Returns complete entity information including generated metadata
  • Maintains hierarchical relationships and prevents circular dependencies
  • Supports special subType 'brief' for content associations that serve as the program's brief/description

Authorization Logic:

  1. User must have a valid JWT token with appropriate scopes
  2. User must have permission to manage the target entity (program, task, or request)
  3. User must have access to all entities being added to the association

Usage Example:

Add tasks and content to a program to create a structured workflow with all necessary components. Use subType 'brief' when associating content that should serve as the program's brief or detailed description.

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 add entities to. This entity must exist within the specified space and be accessible to the authenticated user. The entity will include the new entities within its interface.

Body Params

Request body containing an array of entities to add to the program structure. Each entity must include spaceId, nodeId, and nodeType fields. Supported nodeTypes include task, request, and content. Optionally set subType to 'brief' for content associations to designate them as the program's brief/description. The system will validate all entities before adding them and may sanitize input data for security.

associations
array of objects

List of association objects

associations
Responses

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