Infraon API Guide
Product DocsSchemaAuthentication
  • Welcome
    • Base URL
    • Authorization
    • Responses
  • Modules
    • Schema
    • Authentication
    • Announcement
    • API Registration
    • Async Tasks
    • BusinessRule
    • BusinessServiceConfiguration
    • Service Catalogue
    • CMDBBlacklistWhitelist
    • CMDBCategory
    • CMDBConsumables
    • Ux
    • CMDBSoftwareLicense
    • Cmdb
    • CMDBRelation
    • CMDBSoftware
    • ContractManagement
    • Department
    • Events
    • Field Configuration
    • IMACD
    • Knowledge Base
    • Leaves
    • Chat
    • Marketplace
    • APIViewSet
    • BeepViewSet
    • SMSviewset
    • Suppressedviewset
    • Organization Location
    • Partner
    • Predicted Events
    • Requester
    • Service Feasibility Requests
    • Role Profile
    • Tag
    • Service_outage
    • Teams
    • Telecom Settings
    • Trap Configurations
    • User Profile
    • Vendor Managemment
    • Association Events
    • Device Template
    • Discovery Configuration
    • Jobs
    • MIB Explorer
    • Seasonal Events
    • IPAM
    • Log Grok Pattern Configuration
    • Log Pipeline Configuration
    • Log Integraion
    • Log Search
    • CLI Download Jobs
    • Configuration Profiles
    • Configuration Policies
    • Configuration Rules
    • Configuration Search
    • Configuration Template
    • Configuration Trigger
    • Jobs Account Audit
    • Manage Vulnerabilities
    • OS Image Download
    • Rule Group
    • Configuration Upload Jobs
    • Work Flow Jobs
    • Change
    • Checklist
    • Incident
    • Problem
    • Release
    • Request Process
    • Task
    • Models
Powered by GitBook
On this page
  1. Modules

Change

PreviousWork Flow JobsNextChecklist

Gets a request with the given id

get

This endpoint is used to fetch a request details in the current organization

Authorizations
Path parameters
idstringRequired
Responses
200Success
application/json
get
GET /ux/sd/change/change/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200Success
{
  "change_id": "text",
  "display_id": "text",
  "is_archive": true,
  "unread_mail": true,
  "requester": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "config": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "reporter_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "basic_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "impacted_asset": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "close_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "current_watcher": [],
  "current_assignment_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "tag": [],
  "kb": [],
  "custom_field_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-06-07T11:51:31.099Z",
  "created_by_id": "text",
  "last_update_time": "2025-06-07T11:51:31.099Z",
  "updated_by_id": "text",
  "change_manager": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "due_date": "2025-06-07T11:51:31.099Z",
  "is_change_ci_lock": 1,
  "location": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Deletes the change with given id

delete

This endpoint is used to delete an existing change for the current organization

Authorizations
Path parameters
idstringRequired
Responses
204
No response body
delete
DELETE /ux/sd/change/change/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
204

No response body

No content

Gets attachments for the selected change.

get

This endpoint is used to fetch the attachments.

Authorizations
Responses
200Success
application/json
get
GET /ux/sd/change/change/attachment/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200Success
{
  "change_id": "text",
  "display_id": "text",
  "is_archive": true,
  "unread_mail": true,
  "requester": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "config": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "reporter_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "basic_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "impacted_asset": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "close_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "current_watcher": [],
  "current_assignment_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "tag": [],
  "kb": [],
  "custom_field_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-06-07T11:51:31.099Z",
  "created_by_id": "text",
  "last_update_time": "2025-06-07T11:51:31.099Z",
  "updated_by_id": "text",
  "change_manager": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "due_date": "2025-06-07T11:51:31.099Z",
  "is_change_ci_lock": 1,
  "location": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}
get

API endpoint that allows Request to be viewed or edited.

Authorizations
Path parameters
idstringRequired
Responses
200Success
application/json
get
GET /ux/sd/change/change/change-data/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200Success
{
  "change_id": "text",
  "display_id": "text",
  "is_archive": true,
  "unread_mail": true,
  "requester": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "config": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "reporter_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "basic_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "impacted_asset": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "close_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "current_watcher": [],
  "current_assignment_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "tag": [],
  "kb": [],
  "custom_field_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-06-07T11:51:31.099Z",
  "created_by_id": "text",
  "last_update_time": "2025-06-07T11:51:31.099Z",
  "updated_by_id": "text",
  "change_manager": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "due_date": "2025-06-07T11:51:31.099Z",
  "is_change_ci_lock": 1,
  "location": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}
get

API endpoint that allows Request to be viewed or edited.

Authorizations
Path parameters
idstringRequired
Responses
200Success
application/json
get
GET /ux/sd/change/change/change-impact/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200Success
{
  "change_id": "text",
  "display_id": "text",
  "is_archive": true,
  "unread_mail": true,
  "requester": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "config": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "reporter_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "basic_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "impacted_asset": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "close_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "current_watcher": [],
  "current_assignment_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "tag": [],
  "kb": [],
  "custom_field_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-06-07T11:51:31.099Z",
  "created_by_id": "text",
  "last_update_time": "2025-06-07T11:51:31.099Z",
  "updated_by_id": "text",
  "change_manager": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "due_date": "2025-06-07T11:51:31.099Z",
  "is_change_ci_lock": 1,
  "location": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}
get

API endpoint that allows Request to be viewed or edited.

Authorizations
Path parameters
idstringRequired
Responses
200Success
application/json
get
GET /ux/sd/change/change/change-risk/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200Success
{
  "change_id": "text",
  "display_id": "text",
  "is_archive": true,
  "unread_mail": true,
  "requester": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "config": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "reporter_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "basic_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "impacted_asset": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "close_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "current_watcher": [],
  "current_assignment_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "tag": [],
  "kb": [],
  "custom_field_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-06-07T11:51:31.099Z",
  "created_by_id": "text",
  "last_update_time": "2025-06-07T11:51:31.099Z",
  "updated_by_id": "text",
  "change_manager": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "due_date": "2025-06-07T11:51:31.099Z",
  "is_change_ci_lock": 1,
  "location": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}
get

API endpoint that allows Request to be viewed or edited.

Authorizations
Path parameters
idstringRequired
Responses
200Success
application/json
get
GET /ux/sd/change/change/change-task/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200Success
{
  "change_id": "text",
  "display_id": "text",
  "is_archive": true,
  "unread_mail": true,
  "requester": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "config": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "reporter_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "basic_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "impacted_asset": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "close_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "current_watcher": [],
  "current_assignment_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "tag": [],
  "kb": [],
  "custom_field_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-06-07T11:51:31.099Z",
  "created_by_id": "text",
  "last_update_time": "2025-06-07T11:51:31.099Z",
  "updated_by_id": "text",
  "change_manager": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "due_date": "2025-06-07T11:51:31.099Z",
  "is_change_ci_lock": 1,
  "location": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Gets history for the selected change.

get

This endpoint is used to fetch the history.

Authorizations
Responses
200Success
application/json
get
GET /ux/sd/change/change/history/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200Success
{
  "change_id": "text",
  "display_id": "text",
  "is_archive": true,
  "unread_mail": true,
  "requester": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "config": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "reporter_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "basic_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "impacted_asset": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "close_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "current_watcher": [],
  "current_assignment_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "tag": [],
  "kb": [],
  "custom_field_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-06-07T11:51:31.099Z",
  "created_by_id": "text",
  "last_update_time": "2025-06-07T11:51:31.099Z",
  "updated_by_id": "text",
  "change_manager": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "due_date": "2025-06-07T11:51:31.099Z",
  "is_change_ci_lock": 1,
  "location": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}
get

function to get impact list :param request: :return: object

Authorizations
Path parameters
idstringRequired
Responses
200Success
application/json
get
GET /ux/sd/change/change/impact-list/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200Success
{
  "change_id": "text",
  "display_id": "text",
  "is_archive": true,
  "unread_mail": true,
  "requester": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "config": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "reporter_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "basic_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "impacted_asset": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "close_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "current_watcher": [],
  "current_assignment_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "tag": [],
  "kb": [],
  "custom_field_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-06-07T11:51:31.099Z",
  "created_by_id": "text",
  "last_update_time": "2025-06-07T11:51:31.099Z",
  "updated_by_id": "text",
  "change_manager": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "due_date": "2025-06-07T11:51:31.099Z",
  "is_change_ci_lock": 1,
  "location": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}
get

API endpoint that allows Request to be viewed or edited.

Authorizations
Responses
200Success
application/json
get
GET /ux/sd/change/change/options/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200Success
{
  "change_id": "text",
  "display_id": "text",
  "is_archive": true,
  "unread_mail": true,
  "requester": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "config": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "reporter_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "basic_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "impacted_asset": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "close_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "current_watcher": [],
  "current_assignment_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "tag": [],
  "kb": [],
  "custom_field_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-06-07T11:51:31.099Z",
  "created_by_id": "text",
  "last_update_time": "2025-06-07T11:51:31.099Z",
  "updated_by_id": "text",
  "change_manager": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "due_date": "2025-06-07T11:51:31.099Z",
  "is_change_ci_lock": 1,
  "location": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Get rich text data

get

This endpoint is used to get the rich text data.

Authorizations
Responses
200Success
application/json
get
GET /ux/sd/change/change/process-rich-text/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200Success
{
  "change_id": "text",
  "display_id": "text",
  "is_archive": true,
  "unread_mail": true,
  "requester": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "config": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "reporter_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "basic_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "impacted_asset": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "close_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "current_watcher": [],
  "current_assignment_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "tag": [],
  "kb": [],
  "custom_field_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-06-07T11:51:31.099Z",
  "created_by_id": "text",
  "last_update_time": "2025-06-07T11:51:31.099Z",
  "updated_by_id": "text",
  "change_manager": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "due_date": "2025-06-07T11:51:31.099Z",
  "is_change_ci_lock": 1,
  "location": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}
get

API endpoint that allows Request to be viewed or edited.

Authorizations
Responses
200Success
application/json
get
GET /ux/sd/change/change/requester_search/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200Success
{
  "change_id": "text",
  "display_id": "text",
  "is_archive": true,
  "unread_mail": true,
  "requester": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "config": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "reporter_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "basic_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "impacted_asset": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "close_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "current_watcher": [],
  "current_assignment_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "tag": [],
  "kb": [],
  "custom_field_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-06-07T11:51:31.099Z",
  "created_by_id": "text",
  "last_update_time": "2025-06-07T11:51:31.099Z",
  "updated_by_id": "text",
  "change_manager": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "due_date": "2025-06-07T11:51:31.099Z",
  "is_change_ci_lock": 1,
  "location": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}
get

API endpoint that allows Request to be viewed or edited.

Authorizations
Path parameters
idstringRequired
Responses
200Success
application/json
get
GET /ux/sd/change/change/risk-list/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200Success
{
  "change_id": "text",
  "display_id": "text",
  "is_archive": true,
  "unread_mail": true,
  "requester": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "config": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "reporter_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "basic_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "impacted_asset": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "close_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "current_watcher": [],
  "current_assignment_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "tag": [],
  "kb": [],
  "custom_field_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-06-07T11:51:31.099Z",
  "created_by_id": "text",
  "last_update_time": "2025-06-07T11:51:31.099Z",
  "updated_by_id": "text",
  "change_manager": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "due_date": "2025-06-07T11:51:31.099Z",
  "is_change_ci_lock": 1,
  "location": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}
get

API endpoint that allows Request to be viewed or edited.

Authorizations
Responses
200Success
application/json
get
GET /ux/sd/change/change/risk_assessment_completion/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200Success
{
  "change_id": "text",
  "display_id": "text",
  "is_archive": true,
  "unread_mail": true,
  "requester": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "config": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "reporter_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "basic_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "impacted_asset": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "close_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "current_watcher": [],
  "current_assignment_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "tag": [],
  "kb": [],
  "custom_field_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-06-07T11:51:31.099Z",
  "created_by_id": "text",
  "last_update_time": "2025-06-07T11:51:31.099Z",
  "updated_by_id": "text",
  "change_manager": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "due_date": "2025-06-07T11:51:31.099Z",
  "is_change_ci_lock": 1,
  "location": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}
get

API endpoint that allows Request to be viewed or edited.

Authorizations
Path parameters
idstringRequired
Responses
200Success
application/json
get
GET /ux/sd/change/change/task-list/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200Success
{
  "change_id": "text",
  "display_id": "text",
  "is_archive": true,
  "unread_mail": true,
  "requester": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "config": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "reporter_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "basic_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "impacted_asset": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "close_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "current_watcher": [],
  "current_assignment_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "tag": [],
  "kb": [],
  "custom_field_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-06-07T11:51:31.099Z",
  "created_by_id": "text",
  "last_update_time": "2025-06-07T11:51:31.099Z",
  "updated_by_id": "text",
  "change_manager": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "due_date": "2025-06-07T11:51:31.099Z",
  "is_change_ci_lock": 1,
  "location": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}
get

API endpoint that allows Request to be viewed or edited.

Authorizations
Responses
200Success
application/json
get
GET /ux/sd/change/change/workflow_status/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200Success
{
  "change_id": "text",
  "display_id": "text",
  "is_archive": true,
  "unread_mail": true,
  "requester": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "config": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "reporter_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "basic_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "impacted_asset": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "close_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "current_watcher": [],
  "current_assignment_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "tag": [],
  "kb": [],
  "custom_field_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-06-07T11:51:31.099Z",
  "created_by_id": "text",
  "last_update_time": "2025-06-07T11:51:31.099Z",
  "updated_by_id": "text",
  "change_manager": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "due_date": "2025-06-07T11:51:31.099Z",
  "is_change_ci_lock": 1,
  "location": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}
get

API endpoint that allows Incident to be viewed or edited.

Authorizations
Responses
200
No response body
get
GET /ux/sd/change/conversation/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

No response body

No content

post

API endpoint that allows Incident to be viewed or edited.

Authorizations
Responses
201
No response body
post
POST /ux/sd/change/conversation/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
201

No response body

No content

get

API endpoint that allows Incident to be viewed or edited.

Authorizations
Path parameters
idstringRequired
Responses
200
No response body
get
GET /ux/sd/change/conversation/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

No response body

No content

put

API endpoint that allows Incident to be viewed or edited.

Authorizations
Path parameters
idstringRequired
Responses
200
No response body
put
PUT /ux/sd/change/conversation/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

No response body

No content

delete

API endpoint that allows Incident to be viewed or edited.

Authorizations
Path parameters
idstringRequired
Responses
204
No response body
delete
DELETE /ux/sd/change/conversation/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
204

No response body

No content

  • GETGets a list of changes
  • POSTCreates a new change
  • GETGets a request with the given id
  • PUTEdits the change with given id
  • DELETEDeletes the change with given id
  • POSTAdd attachments for the selected change.
  • GETGets attachments for the selected change.
  • GET/ux/sd/change/change/change-data/{id}/
  • GET/ux/sd/change/change/change-impact/{id}/
  • GET/ux/sd/change/change/change-risk/{id}/
  • GET/ux/sd/change/change/change-task/{id}/
  • POST/ux/sd/change/change/delete_change/
  • GETGets history for the selected change.
  • GET/ux/sd/change/change/impact-list/{id}/
  • GET/ux/sd/change/change/options/
  • GETGet rich text data
  • GET/ux/sd/change/change/requester_search/
  • GET/ux/sd/change/change/risk-list/{id}/
  • GET/ux/sd/change/change/risk_assessment_completion/
  • POST/ux/sd/change/change/risk_assessment_completion/
  • POST/ux/sd/change/change/save-change-impact/
  • POST/ux/sd/change/change/save-change-risk/
  • POST/ux/sd/change/change/save-change-risk-assessment/
  • POST/ux/sd/change/change/save-change-task/
  • POSTSave rich text data
  • GET/ux/sd/change/change/task-list/{id}/
  • POST/ux/sd/change/change/workflow_options_map/
  • GET/ux/sd/change/change/workflow_status/
  • GET/ux/sd/change/conversation/
  • POST/ux/sd/change/conversation/
  • GET/ux/sd/change/conversation/{id}/
  • PUT/ux/sd/change/conversation/{id}/
  • DELETE/ux/sd/change/conversation/{id}/

Gets a list of changes

get

This endpoint is used to fetch all the change in the current organization

Authorizations
Query parameters
items_per_pageintegerRequired

Items Per Page

pageintegerRequired

Page Number

reversebooleanOptional

Sorting Order

sortstringOptional

Sorting Key

Responses
200Success
application/json
get
GET /ux/sd/change/change/?items_per_page=1&page=1 HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200Success
[
  {
    "change_id": "text",
    "display_id": "text",
    "is_archive": true,
    "unread_mail": true,
    "requester": {
      "keys": "text",
      "values": "text",
      "queryparam": true
    },
    "config": {
      "keys": "text",
      "values": "text",
      "queryparam": true
    },
    "reporter_info": {
      "keys": "text",
      "values": "text",
      "queryparam": true
    },
    "basic_info": {
      "keys": "text",
      "values": "text",
      "queryparam": true
    },
    "impacted_asset": [
      {
        "keys": "text",
        "values": "text",
        "queryparam": true
      }
    ],
    "close_info": {
      "keys": "text",
      "values": "text",
      "queryparam": true
    },
    "current_watcher": [],
    "current_assignment_info": {
      "keys": "text",
      "values": "text",
      "queryparam": true
    },
    "tag": [],
    "kb": [],
    "custom_field_data": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "creation_time": "2025-06-07T11:51:31.099Z",
    "created_by_id": "text",
    "last_update_time": "2025-06-07T11:51:31.099Z",
    "updated_by_id": "text",
    "change_manager": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "due_date": "2025-06-07T11:51:31.099Z",
    "is_change_ci_lock": 1,
    "location": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  }
]

Creates a new change

post

This endpoint is used to save a new change for the current organization

Authorizations
Body
Other propertiesanyOptional
Responses
201
No response body
post
POST /ux/sd/change/change/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 914

{
  "summary": "VPN Issue",
  "description": "",
  "catalogue": "",
  "impact_service": "",
  "impact_service_name": "service1",
  "service_classification": "",
  "service_classification_name": "",
  "state": "Open",
  "state_id": 1,
  "status": "New",
  "status_id": 1,
  "urgency_id": 3,
  "urgency": "Low",
  "priority_id": 5,
  "priority": "Very Low",
  "impact": "Department",
  "impact_id": 3,
  "change_source": {
    "id": 1,
    "name": "Web"
  },
  "resolution_type": "",
  "change_type": {
    "id": 1,
    "name": "Change",
    "prefix": "REQ"
  },
  "requester_id": "",
  "requester_name": "Test req",
  "requester_email": "testreq@gmail.com",
  "requester_phone": "7778889999",
  "reporter_name": "",
  "reporter_email": "",
  "reporter_phone": "",
  "watcher": "",
  "hold_config": {},
  "support_group": "",
  "assignee": "",
  "escalation": {},
  "tag": [],
  "assets": [],
  "config": {},
  "reference": {},
  "template_info": {},
  "closure_info": {},
  "approval_config": {},
  "custom_field": [
    {}
  ],
  "attachment": {},
  "api_link": {},
  "lock_config": {},
  "field_service_config": {},
  "closure_note": ""
}
201

No response body

No content

Edits the change with given id

put

This endpoint is used to edit an existing change for the current organization

Authorizations
Path parameters
idstringRequired
Body

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

change_idstring · max: 25Required
display_idstring · max: 50Optional
is_archivebooleanOptional
unread_mailbooleanOptional
creation_timestring · date-timeOptional
created_by_idstring · max: 225Optional
last_update_timestring · date-timeOptional
updated_by_idstring · max: 225Optional
due_datestring · date-timeOptional
is_change_ci_lockintegerOptional
Responses
200Success
application/json
put
PUT /ux/sd/change/change/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 933

{
  "change_id": "text",
  "display_id": "text",
  "is_archive": true,
  "unread_mail": true,
  "requester": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "config": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "reporter_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "basic_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "impacted_asset": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "close_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "current_watcher": [],
  "current_assignment_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "tag": [],
  "kb": [],
  "custom_field_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-06-07T11:51:31.099Z",
  "created_by_id": "text",
  "last_update_time": "2025-06-07T11:51:31.099Z",
  "updated_by_id": "text",
  "change_manager": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "due_date": "2025-06-07T11:51:31.099Z",
  "is_change_ci_lock": 1,
  "location": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}
200Success
{
  "change_id": "text",
  "display_id": "text",
  "is_archive": true,
  "unread_mail": true,
  "requester": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "config": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "reporter_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "basic_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "impacted_asset": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "close_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "current_watcher": [],
  "current_assignment_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "tag": [],
  "kb": [],
  "custom_field_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-06-07T11:51:31.099Z",
  "created_by_id": "text",
  "last_update_time": "2025-06-07T11:51:31.099Z",
  "updated_by_id": "text",
  "change_manager": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "due_date": "2025-06-07T11:51:31.099Z",
  "is_change_ci_lock": 1,
  "location": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Add attachments for the selected change.

post

This endpoint is used to add new attachments.

Authorizations
Body

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

change_idstring · max: 25Required
display_idstring · max: 50Optional
is_archivebooleanOptional
unread_mailbooleanOptional
creation_timestring · date-timeOptional
created_by_idstring · max: 225Optional
last_update_timestring · date-timeOptional
updated_by_idstring · max: 225Optional
due_datestring · date-timeOptional
is_change_ci_lockintegerOptional
Responses
200Success
application/json
post
POST /ux/sd/change/change/add-attachment/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 933

{
  "change_id": "text",
  "display_id": "text",
  "is_archive": true,
  "unread_mail": true,
  "requester": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "config": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "reporter_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "basic_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "impacted_asset": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "close_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "current_watcher": [],
  "current_assignment_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "tag": [],
  "kb": [],
  "custom_field_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-06-07T11:51:31.099Z",
  "created_by_id": "text",
  "last_update_time": "2025-06-07T11:51:31.099Z",
  "updated_by_id": "text",
  "change_manager": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "due_date": "2025-06-07T11:51:31.099Z",
  "is_change_ci_lock": 1,
  "location": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}
200Success
{
  "change_id": "text",
  "display_id": "text",
  "is_archive": true,
  "unread_mail": true,
  "requester": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "config": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "reporter_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "basic_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "impacted_asset": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "close_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "current_watcher": [],
  "current_assignment_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "tag": [],
  "kb": [],
  "custom_field_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-06-07T11:51:31.099Z",
  "created_by_id": "text",
  "last_update_time": "2025-06-07T11:51:31.099Z",
  "updated_by_id": "text",
  "change_manager": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "due_date": "2025-06-07T11:51:31.099Z",
  "is_change_ci_lock": 1,
  "location": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}
post

API endpoint that allows Request to be viewed or edited.

Authorizations
Body

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

change_idstring · max: 25Required
display_idstring · max: 50Optional
is_archivebooleanOptional
unread_mailbooleanOptional
creation_timestring · date-timeOptional
created_by_idstring · max: 225Optional
last_update_timestring · date-timeOptional
updated_by_idstring · max: 225Optional
due_datestring · date-timeOptional
is_change_ci_lockintegerOptional
Responses
200Success
application/json
post
POST /ux/sd/change/change/delete_change/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 933

{
  "change_id": "text",
  "display_id": "text",
  "is_archive": true,
  "unread_mail": true,
  "requester": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "config": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "reporter_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "basic_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "impacted_asset": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "close_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "current_watcher": [],
  "current_assignment_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "tag": [],
  "kb": [],
  "custom_field_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-06-07T11:51:31.099Z",
  "created_by_id": "text",
  "last_update_time": "2025-06-07T11:51:31.099Z",
  "updated_by_id": "text",
  "change_manager": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "due_date": "2025-06-07T11:51:31.099Z",
  "is_change_ci_lock": 1,
  "location": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}
200Success
{
  "change_id": "text",
  "display_id": "text",
  "is_archive": true,
  "unread_mail": true,
  "requester": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "config": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "reporter_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "basic_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "impacted_asset": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "close_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "current_watcher": [],
  "current_assignment_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "tag": [],
  "kb": [],
  "custom_field_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-06-07T11:51:31.099Z",
  "created_by_id": "text",
  "last_update_time": "2025-06-07T11:51:31.099Z",
  "updated_by_id": "text",
  "change_manager": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "due_date": "2025-06-07T11:51:31.099Z",
  "is_change_ci_lock": 1,
  "location": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}
post

API endpoint that allows Request to be viewed or edited.

Authorizations
Body

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

change_idstring · max: 25Required
display_idstring · max: 50Optional
is_archivebooleanOptional
unread_mailbooleanOptional
creation_timestring · date-timeOptional
created_by_idstring · max: 225Optional
last_update_timestring · date-timeOptional
updated_by_idstring · max: 225Optional
due_datestring · date-timeOptional
is_change_ci_lockintegerOptional
Responses
200Success
application/json
post
POST /ux/sd/change/change/risk_assessment_completion/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 933

{
  "change_id": "text",
  "display_id": "text",
  "is_archive": true,
  "unread_mail": true,
  "requester": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "config": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "reporter_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "basic_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "impacted_asset": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "close_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "current_watcher": [],
  "current_assignment_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "tag": [],
  "kb": [],
  "custom_field_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-06-07T11:51:31.099Z",
  "created_by_id": "text",
  "last_update_time": "2025-06-07T11:51:31.099Z",
  "updated_by_id": "text",
  "change_manager": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "due_date": "2025-06-07T11:51:31.099Z",
  "is_change_ci_lock": 1,
  "location": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}
200Success
{
  "change_id": "text",
  "display_id": "text",
  "is_archive": true,
  "unread_mail": true,
  "requester": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "config": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "reporter_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "basic_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "impacted_asset": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "close_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "current_watcher": [],
  "current_assignment_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "tag": [],
  "kb": [],
  "custom_field_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-06-07T11:51:31.099Z",
  "created_by_id": "text",
  "last_update_time": "2025-06-07T11:51:31.099Z",
  "updated_by_id": "text",
  "change_manager": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "due_date": "2025-06-07T11:51:31.099Z",
  "is_change_ci_lock": 1,
  "location": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}
post

API endpoint that allows Request to be viewed or edited.

Authorizations
Body

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

change_idstring · max: 25Required
display_idstring · max: 50Optional
is_archivebooleanOptional
unread_mailbooleanOptional
creation_timestring · date-timeOptional
created_by_idstring · max: 225Optional
last_update_timestring · date-timeOptional
updated_by_idstring · max: 225Optional
due_datestring · date-timeOptional
is_change_ci_lockintegerOptional
Responses
200Success
application/json
post
POST /ux/sd/change/change/save-change-impact/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 933

{
  "change_id": "text",
  "display_id": "text",
  "is_archive": true,
  "unread_mail": true,
  "requester": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "config": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "reporter_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "basic_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "impacted_asset": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "close_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "current_watcher": [],
  "current_assignment_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "tag": [],
  "kb": [],
  "custom_field_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-06-07T11:51:31.099Z",
  "created_by_id": "text",
  "last_update_time": "2025-06-07T11:51:31.099Z",
  "updated_by_id": "text",
  "change_manager": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "due_date": "2025-06-07T11:51:31.099Z",
  "is_change_ci_lock": 1,
  "location": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}
200Success
{
  "change_id": "text",
  "display_id": "text",
  "is_archive": true,
  "unread_mail": true,
  "requester": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "config": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "reporter_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "basic_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "impacted_asset": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "close_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "current_watcher": [],
  "current_assignment_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "tag": [],
  "kb": [],
  "custom_field_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-06-07T11:51:31.099Z",
  "created_by_id": "text",
  "last_update_time": "2025-06-07T11:51:31.099Z",
  "updated_by_id": "text",
  "change_manager": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "due_date": "2025-06-07T11:51:31.099Z",
  "is_change_ci_lock": 1,
  "location": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}
post

API endpoint that allows Request to be viewed or edited.

Authorizations
Body

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

change_idstring · max: 25Required
display_idstring · max: 50Optional
is_archivebooleanOptional
unread_mailbooleanOptional
creation_timestring · date-timeOptional
created_by_idstring · max: 225Optional
last_update_timestring · date-timeOptional
updated_by_idstring · max: 225Optional
due_datestring · date-timeOptional
is_change_ci_lockintegerOptional
Responses
200Success
application/json
post
POST /ux/sd/change/change/save-change-risk/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 933

{
  "change_id": "text",
  "display_id": "text",
  "is_archive": true,
  "unread_mail": true,
  "requester": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "config": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "reporter_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "basic_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "impacted_asset": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "close_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "current_watcher": [],
  "current_assignment_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "tag": [],
  "kb": [],
  "custom_field_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-06-07T11:51:31.099Z",
  "created_by_id": "text",
  "last_update_time": "2025-06-07T11:51:31.099Z",
  "updated_by_id": "text",
  "change_manager": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "due_date": "2025-06-07T11:51:31.099Z",
  "is_change_ci_lock": 1,
  "location": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}
200Success
{
  "change_id": "text",
  "display_id": "text",
  "is_archive": true,
  "unread_mail": true,
  "requester": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "config": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "reporter_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "basic_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "impacted_asset": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "close_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "current_watcher": [],
  "current_assignment_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "tag": [],
  "kb": [],
  "custom_field_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-06-07T11:51:31.099Z",
  "created_by_id": "text",
  "last_update_time": "2025-06-07T11:51:31.099Z",
  "updated_by_id": "text",
  "change_manager": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "due_date": "2025-06-07T11:51:31.099Z",
  "is_change_ci_lock": 1,
  "location": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}
post

API endpoint that allows Request to be viewed or edited.

Authorizations
Body

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

change_idstring · max: 25Required
display_idstring · max: 50Optional
is_archivebooleanOptional
unread_mailbooleanOptional
creation_timestring · date-timeOptional
created_by_idstring · max: 225Optional
last_update_timestring · date-timeOptional
updated_by_idstring · max: 225Optional
due_datestring · date-timeOptional
is_change_ci_lockintegerOptional
Responses
200Success
application/json
post
POST /ux/sd/change/change/save-change-risk-assessment/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 933

{
  "change_id": "text",
  "display_id": "text",
  "is_archive": true,
  "unread_mail": true,
  "requester": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "config": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "reporter_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "basic_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "impacted_asset": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "close_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "current_watcher": [],
  "current_assignment_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "tag": [],
  "kb": [],
  "custom_field_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-06-07T11:51:31.099Z",
  "created_by_id": "text",
  "last_update_time": "2025-06-07T11:51:31.099Z",
  "updated_by_id": "text",
  "change_manager": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "due_date": "2025-06-07T11:51:31.099Z",
  "is_change_ci_lock": 1,
  "location": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}
200Success
{
  "change_id": "text",
  "display_id": "text",
  "is_archive": true,
  "unread_mail": true,
  "requester": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "config": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "reporter_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "basic_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "impacted_asset": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "close_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "current_watcher": [],
  "current_assignment_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "tag": [],
  "kb": [],
  "custom_field_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-06-07T11:51:31.099Z",
  "created_by_id": "text",
  "last_update_time": "2025-06-07T11:51:31.099Z",
  "updated_by_id": "text",
  "change_manager": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "due_date": "2025-06-07T11:51:31.099Z",
  "is_change_ci_lock": 1,
  "location": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}
post

API endpoint that allows Request to be viewed or edited.

Authorizations
Body

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

change_idstring · max: 25Required
display_idstring · max: 50Optional
is_archivebooleanOptional
unread_mailbooleanOptional
creation_timestring · date-timeOptional
created_by_idstring · max: 225Optional
last_update_timestring · date-timeOptional
updated_by_idstring · max: 225Optional
due_datestring · date-timeOptional
is_change_ci_lockintegerOptional
Responses
200Success
application/json
post
POST /ux/sd/change/change/save-change-task/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 933

{
  "change_id": "text",
  "display_id": "text",
  "is_archive": true,
  "unread_mail": true,
  "requester": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "config": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "reporter_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "basic_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "impacted_asset": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "close_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "current_watcher": [],
  "current_assignment_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "tag": [],
  "kb": [],
  "custom_field_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-06-07T11:51:31.099Z",
  "created_by_id": "text",
  "last_update_time": "2025-06-07T11:51:31.099Z",
  "updated_by_id": "text",
  "change_manager": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "due_date": "2025-06-07T11:51:31.099Z",
  "is_change_ci_lock": 1,
  "location": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}
200Success
{
  "change_id": "text",
  "display_id": "text",
  "is_archive": true,
  "unread_mail": true,
  "requester": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "config": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "reporter_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "basic_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "impacted_asset": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "close_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "current_watcher": [],
  "current_assignment_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "tag": [],
  "kb": [],
  "custom_field_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-06-07T11:51:31.099Z",
  "created_by_id": "text",
  "last_update_time": "2025-06-07T11:51:31.099Z",
  "updated_by_id": "text",
  "change_manager": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "due_date": "2025-06-07T11:51:31.099Z",
  "is_change_ci_lock": 1,
  "location": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Save rich text data

post

This endpoint is used to save the rich text data.

Authorizations
Body

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

change_idstring · max: 25Required
display_idstring · max: 50Optional
is_archivebooleanOptional
unread_mailbooleanOptional
creation_timestring · date-timeOptional
created_by_idstring · max: 225Optional
last_update_timestring · date-timeOptional
updated_by_idstring · max: 225Optional
due_datestring · date-timeOptional
is_change_ci_lockintegerOptional
Responses
200Success
application/json
post
POST /ux/sd/change/change/save-rich-text/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 933

{
  "change_id": "text",
  "display_id": "text",
  "is_archive": true,
  "unread_mail": true,
  "requester": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "config": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "reporter_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "basic_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "impacted_asset": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "close_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "current_watcher": [],
  "current_assignment_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "tag": [],
  "kb": [],
  "custom_field_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-06-07T11:51:31.099Z",
  "created_by_id": "text",
  "last_update_time": "2025-06-07T11:51:31.099Z",
  "updated_by_id": "text",
  "change_manager": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "due_date": "2025-06-07T11:51:31.099Z",
  "is_change_ci_lock": 1,
  "location": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}
200Success
{
  "change_id": "text",
  "display_id": "text",
  "is_archive": true,
  "unread_mail": true,
  "requester": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "config": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "reporter_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "basic_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "impacted_asset": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "close_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "current_watcher": [],
  "current_assignment_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "tag": [],
  "kb": [],
  "custom_field_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-06-07T11:51:31.099Z",
  "created_by_id": "text",
  "last_update_time": "2025-06-07T11:51:31.099Z",
  "updated_by_id": "text",
  "change_manager": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "due_date": "2025-06-07T11:51:31.099Z",
  "is_change_ci_lock": 1,
  "location": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}
post

API endpoint that allows Request to be viewed or edited.

Authorizations
Body

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

change_idstring · max: 25Required
display_idstring · max: 50Optional
is_archivebooleanOptional
unread_mailbooleanOptional
creation_timestring · date-timeOptional
created_by_idstring · max: 225Optional
last_update_timestring · date-timeOptional
updated_by_idstring · max: 225Optional
due_datestring · date-timeOptional
is_change_ci_lockintegerOptional
Responses
200Success
application/json
post
POST /ux/sd/change/change/workflow_options_map/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 933

{
  "change_id": "text",
  "display_id": "text",
  "is_archive": true,
  "unread_mail": true,
  "requester": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "config": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "reporter_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "basic_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "impacted_asset": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "close_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "current_watcher": [],
  "current_assignment_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "tag": [],
  "kb": [],
  "custom_field_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-06-07T11:51:31.099Z",
  "created_by_id": "text",
  "last_update_time": "2025-06-07T11:51:31.099Z",
  "updated_by_id": "text",
  "change_manager": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "due_date": "2025-06-07T11:51:31.099Z",
  "is_change_ci_lock": 1,
  "location": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}
200Success
{
  "change_id": "text",
  "display_id": "text",
  "is_archive": true,
  "unread_mail": true,
  "requester": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "config": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "reporter_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "basic_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "impacted_asset": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "close_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "current_watcher": [],
  "current_assignment_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "tag": [],
  "kb": [],
  "custom_field_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-06-07T11:51:31.099Z",
  "created_by_id": "text",
  "last_update_time": "2025-06-07T11:51:31.099Z",
  "updated_by_id": "text",
  "change_manager": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "due_date": "2025-06-07T11:51:31.099Z",
  "is_change_ci_lock": 1,
  "location": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}