relationship-settings_skill

Overview

This skill exposes Meegle OpenAPI endpoints to manage work item relationship settings: list, create, update, and delete relationships within a space. It requires a plugin access token and user headers (see megsle-api-users for auth setup). Use it to configure and maintain cross-type or cross-space links used by work items and custom fields.

How this skill works

The skill calls four API endpoints: GET to list WorkItemRelation entries, POST to create a new relation, POST to overwrite/update an existing relation, and DELETE to remove a relation. Each relation record contains an id (UUID), name, relation_type, and relation_details that map source and target project_key and work_item_type_key. Permissions and space admin rights control create/update/delete actions.

When to use it

• List all configured work item relationships when building admin UIs or fetching relation ids for custom fields.
• Create a new relationship when linking work item types within the same space or across spaces.
• Update (overwrite) a relationship when changing its name or target relation_details.
• Delete a relationship when cleaning up or reconfiguring link definitions.
• Obtain relation_id and relation_type for use in custom fields (work_item_relation_uuid) or other APIs.

Best practices

• Always call Get the List of Work Item Relationships to retrieve current relation_id and avoid duplicates.
• Provide the full relation_details list on update since updates are overwrite operations.
• Ensure the relationship name is unique in the space to avoid 50006 name conflict errors.
• Perform create/update/delete actions with a space administrator account to prevent 10001 permission errors.
• Validate project_key and work_item_type_key values beforehand to reduce request errors.

Example use cases

• Populate an admin interface with available relationships and their relation_details for selection.
• Create a cross-space link (e.g., story in Space A -> task in Space B) and use the returned relation_id in a custom select field.
• Overwrite an existing relationship to change its targets after a project reorganization.
• Delete obsolete relationships before recreating a corrected configuration.