Get all linked entities with relationship information · Atomicwork API Preview

Atomicwork API Preview

Home API Reference

GETList available apps GETList available entitlements POSTCreate an entitlement POSTCreate a grant for a user POSTList grants with filters PUTUpdate a grant GETGet grant history POSTRevoke a grant POSTCreate a policy

GETGet workspace agent groups GETGet workspace agent group members POSTAdd workspace agent group member DELDelete workspace agent group member

POSTCreate Asset GETGet List of all Asset attributes POSTAsset List with views, and filters.GETGet Form Fields of an AssetType GETGet List of Assets for a user GETGet Asset Details PUTUpdate Asset DELDelete Asset GETGet Asset Activities

GETGet all audit logs POSTExport audit logs to CSV POSTList audit logs with filters

GETRetrieve Business Hour Configurations GETRetrieve Business Hour Configurations

GETRetrieve all the templates a logged in user can raise changes from (scoped to the workspaces the user is a member of); when for_user_id is supplied the list is curated for that profile user POSTCreate Change in workspace POSTCreate Change with File Uploads GETGet Change by display ID PATCHPatch Change by display ID GETGet Change Notes and activities GETGet notes for change by display ID POSTCreate note for change by display ID POSTGet changes by filter

GETList custom objects POSTCreate a custom object instance GETGet custom object details by numeric id PUTUpdate a custom object instance PATCHPartial update a custom object instance (single-field edits)DELSoft delete a custom object instance GETGet only the relationship fields of a custom object GETGet filter fields for custom object list view GETGet CO field picker values (dropdown/multi-dropdown/relationship options)POSTList custom objects with filtering and sorting POSTExport custom objects to CSV (async, emailed)

GETGet all linked entities with relationship information POSTLink multiple entities at once

GETGet change fields applicable (visible) to current user GETGet request fields applicable (visible) to current user GETGet request fields applicable (visible) to current user GETGet list of options for the field identified by reference_key GETGet list of options for the field identified by reference_key

POSTCreate problem request GETRetrieve Problem Request Assessment Form POSTUpdate Problem Request Assessment Form GETRetrieve Problem Request Tasks POSTCreate task for problem request GETRetrieve Problem Request Task PUTUpdate Problem Request Task

POSTCreate request POSTBulk action on requests POSTCreate service request for item POSTGet requests by filter POSTCreate major incident request GETGet Request PATCHPatch request GETGet Request PATCHPatch request GETGet Request Notes and activities PATCHAdd Followers to a Request GETGet Followers of a Request PUTAdd or Remove Followers POSTMove Request GETGet Request Notes POSTCreate request notes PUTTrash Request GETRetrieve Service Request Items POSTAdd service item instance to service request GETRetrieve Service Request PATCHPatch Service Request GETList Impact Options POSTGet requests by filter

GETGet catalogue item fields POSTBulk create catalogue item fields GETGet category POSTCreate category GETGet catalogue item POSTCreate catalogue item GETRetrieve catalogue Item PATCHPatch catalogue item GETGet Service Items List GETRetrieve Service Item

GETGet tags POSTCreate Tag Option GETGet tag PUTUpdate Tag Option DELDelete Tag Option

GETGet users POSTCreate user POSTInvite Users GETGet paginated users list POSTUser workspace invite GETGet a user by email PATCHRestore user in organization GETGet paginated users list in a segment GETRetrieve User PUTUpdate User PATCHPatch a user DELDelete user from organization POSTPatch a user PATCHRestore a user

POSTClone a Request automations of a Workspace GETGet request automation definitions GETGet actions for request automations GETGet placeholders, adhoc query conditions for request automation GETGet Request automation Definition of a Workspace GETGet output fields for action GETGet output fields for action GETGet placeholder fields GETGet previous actions with output fields GETGet details of a request field GETList request automations with pagination GETList versions of a request automation GETGenerate description for the difference in workflows of the versions GETGet specific version of a request automation

GETGet list of workspaces GETGet workspace details GETGet workspace members

Get all linked entities with relationship information

GET https://{tenant}.atomicwork.com/api/v1/entities/{entity_type}/{display_id}/links

Authorization

X-Api-Keyheaderstringrequired

Headers

X-Workspace-Idheaderstring

Path Parameters

entity_typepathenum (string)required

The entity type (e.g. REQUEST, CHANGE)

display_idpathstringrequired

The display ID of the source entity (e.g. REQ-123, CHG-456)

Query Parameters

reference_keyquerystring

Reference key of the implicit relationship field definition

pagequeryinteger

Page number for pagination

per_pagequeryinteger

Number of items per page

search_keyquerystring

Search keyword to filter linked entities by display ID or subject

Response

200application/json

Successful response

cURL

cURL

curl -X GET 'https://{tenant}.atomicwork.com/api/v1/entities/{entity_type}/{display_id}/links' \
  -H 'X-Api-Key: <api-key>'