Skip to main content
Entity-to-entity relationship. Links connect items to other items (Subtask, Relates, Blocks, Duplicate), or items to external resources via the link-type collection. Links are directional — FromOwner / ToOwner capture which side is which.

​
Sample JSON

Copy, edit, paste. Server-set fields (id, created, tenantId, …) are omitted from the example — they’re populated by the server on response. 
{
  "fromOwner": "Item",
  "fromOwnerId": "item_01HITEM_LOGIN_BUG",
  "toOwner": "Item",
  "toOwnerId": "item_01HITEM_TIMEOUT_FIX",
  "linkType": "Blocks"
}

​
Fields

FieldTypeRequiredNotes
entitystring • nullableServer-setSet by the server. Read-only on writes.
linkTypestringRequiredRelationship label. Common values: Subtask, Relates, Blocks, Duplicate. Free-text — Jira link types come through verbatim during migration.
fromOwnerContentOwnerOptionalType of the entity at the from-side of the link.
fromOwnerIdstringRequiredId of the from-side entity.
toOwnerContentOwnerOptionalType of the entity at the to-side of the link.
toOwnerIdstringRequiredId of the to-side entity.
tenantIdstringServer-setSet by the server. Read-only on writes.
idstringServer-setSet by the server. Read-only on writes.
createdstring (date-time)Server-setSet by the server. Read-only on writes.
createdBystringServer-setSet by the server. Read-only on writes.
updatedstring (date-time)Server-setSet by the server. Read-only on writes.
updatedBystringServer-setSet by the server. Read-only on writes.
deletedbooleanServer-setSet by the server. Read-only on writes.

​
Used by

​
Request body

  • POST /api/link

​
Response body

  • POST /api/link

​
CLI

ekso link — see the command branches page for available verbs. Body for create / update verbs typically passed via --data @file.json matching the sample JSON above.