Change Management

Create Change in workspace

POST https://{tenant}.atomicwork.com/api/v1/change-management/changes

Authorization

X-Api-Keyheaderstringrequired

API key authentication.

Headers

X-Workspace-Idheaderstring

Query Parameters

problem_display_idquerystring

Body

created_bybodyinteger

requesterbodyinteger

ownerbodyinteger

agent_groupbodyinteger

assigneebodyinteger

change_typebodystring

change_templatebodyintegerrequired

change_start_datebodystring

change_completion_datebodystring

planned_change_start_datebodystring

planned_change_completion_datebodystring

actual_change_start_datebodystring

actual_change_completion_datebodystring

subjectbodystringrequired

prioritybodystring

statusbodystring

impactbodystring

urgencybodystring

parent_change_idbodyinteger

parent_display_idbodystring

Formatted display ID of the parent (e.g. CHG-5 or REQ-123)

parent_request_typebodystring

Entity type of the parent (CHANGE or REQUEST)

descriptionbodystring

attachmentsbodyarray of integer

tagsbodyarray of integer

workspace_idbodyinteger

assetsbodyarray of integer

linked_requestsbodyarray of string

custom_fieldsbodyobject

template_fieldsbodyobject

notesbodyarray of object

properties

conversation_infobodyobject

properties

created_atbodystring

updated_atbodystring

external_idbodystring

external_sourcebodyenum (string)

Allowed valuesSAAS_GENIESNOWJSM_BRIDGE

external_system_entity_referencebodyobject

Response

200

Successful response

cURL

curl -X POST 'https://{tenant}.atomicwork.com/api/v1/change-management/changes' \
  -H 'X-Api-Key: <api-key>' \
  -H 'Content-Type: application/json' \
  -d '{"created_by": 0, "requester": 0, "owner": 0, "agent_group": 0, "assignee": 0, "change_type": "string", "change_template": 0, "change_start_date": "date-time", "change_completion_date": "date-time", "planned_change_start_date": "date-time", "planned_change_completion_date": "date-time", "actual_change_start_date": "date-time", "actual_change_completion_date": "date-time", "subject": "string", "priority": "string", "status": "string", "impact": "string", "urgency": "string", "parent_change_id": 0, "parent_display_id": "string", "parent_request_type": "string", "description": "string", "attachments": [0], "tags": [0], "workspace_id": 0, "assets": [0], "linked_requests": ["string"], "custom_fields": {}, "template_fields": {}, "notes": [{"user_id": 0, "description": "string", "mentions": ["\u2026"], "is_private": true, "source": "EMAIL", "type": "ESD_NOTE", "attachments": ["\u2026"]}], "conversation_info": {"channel_name": "string", "channel_id": "string", "start_timestamp": "unix-timestamp"}, "created_at": "date-time", "updated_at": "date-time", "external_id": "string", "external_source": "SAAS_GENIE", "external_system_entity_reference": {}}'