Request Process

PreviousRelease NextTask

get

API endpoint that allows Incident to be viewed or edited.

Authorizations

Responses

200

No response body

get

GET /ux/sd/req/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/req/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/req/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/req/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/req/conversation/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

204

No response body

No content

Gets a list of requests

get

This endpoint is used to fetch all the requests 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/req/request_process/?items_per_page=1&page=1 HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

[
  {
    "request_id": "text",
    "display_id": "text",
    "is_merge_request": true,
    "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
    },
    "reference": [
      {
        "keys": "text",
        "values": "text",
        "queryparam": true
      }
    ],
    "source_info": {
      "keys": "text",
      "values": "text",
      "queryparam": true
    },
    "template_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
    },
    "custom_field": [
      {
        "keys": "text",
        "values": "text",
        "queryparam": true
      }
    ],
    "tag": [],
    "kb": [],
    "custom_field_data": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "creation_time": "2025-06-07T16:08:53.467Z",
    "created_by_id": "text",
    "last_update_time": "2025-06-07T16:08:53.467Z",
    "updated_by_id": "text",
    "service_form_data": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "location": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "employee_info": []
  }
]

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/req/request_process/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "request_id": "text",
  "display_id": "text",
  "is_merge_request": true,
  "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
  },
  "reference": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "source_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "template_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
  },
  "custom_field": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "tag": [],
  "kb": [],
  "custom_field_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-06-07T16:08:53.467Z",
  "created_by_id": "text",
  "last_update_time": "2025-06-07T16:08:53.467Z",
  "updated_by_id": "text",
  "service_form_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "location": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "employee_info": []
}

Deletes the request with given id

delete

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

Authorizations

Path parameters

idstringRequired

Responses

204

No response body

delete

DELETE /ux/sd/req/request_process/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

204

No response body

No content

Gets attachments for the selected request.

get

This endpoint is used to fetch the attachments.

Authorizations

Responses

200Success

application/json

get

GET /ux/sd/req/request_process/attachment/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "request_id": "text",
  "display_id": "text",
  "is_merge_request": true,
  "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
  },
  "reference": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "source_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "template_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
  },
  "custom_field": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "tag": [],
  "kb": [],
  "custom_field_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-06-07T16:08:53.467Z",
  "created_by_id": "text",
  "last_update_time": "2025-06-07T16:08:53.467Z",
  "updated_by_id": "text",
  "service_form_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "location": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "employee_info": []
}

get

API endpoint that allows Request to be viewed or edited.

Authorizations

Responses

200Success

application/json

get

GET /ux/sd/req/request_process/check_list/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "request_id": "text",
  "display_id": "text",
  "is_merge_request": true,
  "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
  },
  "reference": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "source_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "template_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
  },
  "custom_field": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "tag": [],
  "kb": [],
  "custom_field_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-06-07T16:08:53.467Z",
  "created_by_id": "text",
  "last_update_time": "2025-06-07T16:08:53.467Z",
  "updated_by_id": "text",
  "service_form_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "location": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "employee_info": []
}

Gets history for the selected request.

get

This endpoint is used to fetch the history.

Authorizations

Responses

200Success

application/json

get

GET /ux/sd/req/request_process/history/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "request_id": "text",
  "display_id": "text",
  "is_merge_request": true,
  "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
  },
  "reference": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "source_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "template_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
  },
  "custom_field": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "tag": [],
  "kb": [],
  "custom_field_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-06-07T16:08:53.467Z",
  "created_by_id": "text",
  "last_update_time": "2025-06-07T16:08:53.467Z",
  "updated_by_id": "text",
  "service_form_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "location": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "employee_info": []
}

get

API endpoint that allows Request to be viewed or edited.

Authorizations

Responses

200Success

application/json

get

GET /ux/sd/req/request_process/options/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "request_id": "text",
  "display_id": "text",
  "is_merge_request": true,
  "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
  },
  "reference": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "source_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "template_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
  },
  "custom_field": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "tag": [],
  "kb": [],
  "custom_field_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-06-07T16:08:53.467Z",
  "created_by_id": "text",
  "last_update_time": "2025-06-07T16:08:53.467Z",
  "updated_by_id": "text",
  "service_form_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "location": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "employee_info": []
}

Get rich text data

get

This endpoint is used to get the rich text data.

Authorizations

Responses

200Success

application/json

get

GET /ux/sd/req/request_process/process-rich-text/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "request_id": "text",
  "display_id": "text",
  "is_merge_request": true,
  "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
  },
  "reference": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "source_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "template_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
  },
  "custom_field": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "tag": [],
  "kb": [],
  "custom_field_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-06-07T16:08:53.467Z",
  "created_by_id": "text",
  "last_update_time": "2025-06-07T16:08:53.467Z",
  "updated_by_id": "text",
  "service_form_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "location": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "employee_info": []
}

get

API endpoint that allows Request to be viewed or edited.

Authorizations

Responses

200Success

application/json

get

GET /ux/sd/req/request_process/requ_check_list/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "request_id": "text",
  "display_id": "text",
  "is_merge_request": true,
  "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
  },
  "reference": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "source_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "template_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
  },
  "custom_field": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "tag": [],
  "kb": [],
  "custom_field_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-06-07T16:08:53.467Z",
  "created_by_id": "text",
  "last_update_time": "2025-06-07T16:08:53.467Z",
  "updated_by_id": "text",
  "service_form_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "location": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "employee_info": []
}

get

API endpoint that allows Request to be viewed or edited.

Authorizations

Path parameters

idstringRequired

Responses

200Success

application/json

get

GET /ux/sd/req/request_process/request-data/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "request_id": "text",
  "display_id": "text",
  "is_merge_request": true,
  "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
  },
  "reference": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "source_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "template_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
  },
  "custom_field": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "tag": [],
  "kb": [],
  "custom_field_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-06-07T16:08:53.467Z",
  "created_by_id": "text",
  "last_update_time": "2025-06-07T16:08:53.467Z",
  "updated_by_id": "text",
  "service_form_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "location": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "employee_info": []
}

get

API endpoint that allows Request to be viewed or edited.

Authorizations

Responses

200Success

application/json

get

GET /ux/sd/req/request_process/requester_search/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "request_id": "text",
  "display_id": "text",
  "is_merge_request": true,
  "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
  },
  "reference": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "source_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "template_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
  },
  "custom_field": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "tag": [],
  "kb": [],
  "custom_field_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-06-07T16:08:53.467Z",
  "created_by_id": "text",
  "last_update_time": "2025-06-07T16:08:53.467Z",
  "updated_by_id": "text",
  "service_form_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "location": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "employee_info": []
}

get

API endpoint that allows Request to be viewed or edited.

Authorizations

Responses

200Success

application/json

get

GET /ux/sd/req/request_process/workflow_status/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "request_id": "text",
  "display_id": "text",
  "is_merge_request": true,
  "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
  },
  "reference": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "source_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "template_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
  },
  "custom_field": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "tag": [],
  "kb": [],
  "custom_field_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-06-07T16:08:53.467Z",
  "created_by_id": "text",
  "last_update_time": "2025-06-07T16:08:53.467Z",
  "updated_by_id": "text",
  "service_form_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "location": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "employee_info": []
}

Creates a new request

post

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

Authorizations

Body

Other propertiesanyOptional

Responses

201

No response body

post

POST /ux/sd/req/request_process/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 917

{
  "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,
  "request_source": {
    "id": 1,
    "name": "Web"
  },
  "resolution_type": "",
  "request_type": {
    "id": 1,
    "name": "Request",
    "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 request with given id

put

This endpoint is used to edit an existing request 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.

request_idstring · max: 25Required

display_idstring · max: 50Optional

is_merge_requestbooleanOptional

is_archivebooleanOptional

unread_mailbooleanOptional

creation_timestring · date-timeOptional

created_by_idstring · max: 225Optional

last_update_timestring · date-timeOptional

updated_by_idstring · max: 225Optional

Responses

200Success

application/json

put

PUT /ux/sd/req/request_process/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1181

{
  "request_id": "text",
  "display_id": "text",
  "is_merge_request": true,
  "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
  },
  "reference": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "source_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "template_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
  },
  "custom_field": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "tag": [],
  "kb": [],
  "custom_field_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-06-07T16:08:53.467Z",
  "created_by_id": "text",
  "last_update_time": "2025-06-07T16:08:53.467Z",
  "updated_by_id": "text",
  "service_form_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "location": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "employee_info": []
}

200Success

{
  "request_id": "text",
  "display_id": "text",
  "is_merge_request": true,
  "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
  },
  "reference": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "source_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "template_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
  },
  "custom_field": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "tag": [],
  "kb": [],
  "custom_field_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-06-07T16:08:53.467Z",
  "created_by_id": "text",
  "last_update_time": "2025-06-07T16:08:53.467Z",
  "updated_by_id": "text",
  "service_form_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "location": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "employee_info": []
}

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.

request_idstring · max: 25Required

display_idstring · max: 50Optional

is_merge_requestbooleanOptional

is_archivebooleanOptional

unread_mailbooleanOptional

creation_timestring · date-timeOptional

created_by_idstring · max: 225Optional

last_update_timestring · date-timeOptional

updated_by_idstring · max: 225Optional

Responses

200Success

application/json

post

POST /ux/sd/req/request_process/bulk_retry_api/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1181

{
  "request_id": "text",
  "display_id": "text",
  "is_merge_request": true,
  "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
  },
  "reference": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "source_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "template_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
  },
  "custom_field": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "tag": [],
  "kb": [],
  "custom_field_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-06-07T16:08:53.467Z",
  "created_by_id": "text",
  "last_update_time": "2025-06-07T16:08:53.467Z",
  "updated_by_id": "text",
  "service_form_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "location": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "employee_info": []
}

200Success

{
  "request_id": "text",
  "display_id": "text",
  "is_merge_request": true,
  "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
  },
  "reference": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "source_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "template_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
  },
  "custom_field": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "tag": [],
  "kb": [],
  "custom_field_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-06-07T16:08:53.467Z",
  "created_by_id": "text",
  "last_update_time": "2025-06-07T16:08:53.467Z",
  "updated_by_id": "text",
  "service_form_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "location": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "employee_info": []
}

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.

request_idstring · max: 25Required

display_idstring · max: 50Optional

is_merge_requestbooleanOptional

is_archivebooleanOptional

unread_mailbooleanOptional

creation_timestring · date-timeOptional

created_by_idstring · max: 225Optional

last_update_timestring · date-timeOptional

updated_by_idstring · max: 225Optional

Responses

200Success

application/json

post

POST /ux/sd/req/request_process/save-rich-text/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1181

{
  "request_id": "text",
  "display_id": "text",
  "is_merge_request": true,
  "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
  },
  "reference": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "source_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "template_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
  },
  "custom_field": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "tag": [],
  "kb": [],
  "custom_field_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-06-07T16:08:53.467Z",
  "created_by_id": "text",
  "last_update_time": "2025-06-07T16:08:53.467Z",
  "updated_by_id": "text",
  "service_form_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "location": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "employee_info": []
}

200Success

{
  "request_id": "text",
  "display_id": "text",
  "is_merge_request": true,
  "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
  },
  "reference": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "source_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "template_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
  },
  "custom_field": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "tag": [],
  "kb": [],
  "custom_field_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-06-07T16:08:53.467Z",
  "created_by_id": "text",
  "last_update_time": "2025-06-07T16:08:53.467Z",
  "updated_by_id": "text",
  "service_form_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "location": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "employee_info": []
}

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.

request_idstring · max: 25Required

display_idstring · max: 50Optional

is_merge_requestbooleanOptional

is_archivebooleanOptional

unread_mailbooleanOptional

creation_timestring · date-timeOptional

created_by_idstring · max: 225Optional

last_update_timestring · date-timeOptional

updated_by_idstring · max: 225Optional

Responses

200Success

application/json

post

POST /ux/sd/req/request_process/update_requ_checklist/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1181

{
  "request_id": "text",
  "display_id": "text",
  "is_merge_request": true,
  "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
  },
  "reference": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "source_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "template_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
  },
  "custom_field": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "tag": [],
  "kb": [],
  "custom_field_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-06-07T16:08:53.467Z",
  "created_by_id": "text",
  "last_update_time": "2025-06-07T16:08:53.467Z",
  "updated_by_id": "text",
  "service_form_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "location": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "employee_info": []
}

200Success

{
  "request_id": "text",
  "display_id": "text",
  "is_merge_request": true,
  "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
  },
  "reference": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "source_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "template_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
  },
  "custom_field": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "tag": [],
  "kb": [],
  "custom_field_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-06-07T16:08:53.467Z",
  "created_by_id": "text",
  "last_update_time": "2025-06-07T16:08:53.467Z",
  "updated_by_id": "text",
  "service_form_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "location": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "employee_info": []
}

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.

request_idstring · max: 25Required

display_idstring · max: 50Optional

is_merge_requestbooleanOptional

is_archivebooleanOptional

unread_mailbooleanOptional

creation_timestring · date-timeOptional

created_by_idstring · max: 225Optional

last_update_timestring · date-timeOptional

updated_by_idstring · max: 225Optional

Responses

200Success

application/json

post

POST /ux/sd/req/request_process/upload-csv/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1181

{
  "request_id": "text",
  "display_id": "text",
  "is_merge_request": true,
  "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
  },
  "reference": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "source_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "template_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
  },
  "custom_field": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "tag": [],
  "kb": [],
  "custom_field_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-06-07T16:08:53.467Z",
  "created_by_id": "text",
  "last_update_time": "2025-06-07T16:08:53.467Z",
  "updated_by_id": "text",
  "service_form_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "location": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "employee_info": []
}

200Success

{
  "request_id": "text",
  "display_id": "text",
  "is_merge_request": true,
  "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
  },
  "reference": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "source_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "template_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
  },
  "custom_field": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "tag": [],
  "kb": [],
  "custom_field_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-06-07T16:08:53.467Z",
  "created_by_id": "text",
  "last_update_time": "2025-06-07T16:08:53.467Z",
  "updated_by_id": "text",
  "service_form_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "location": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "employee_info": []
}

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.

request_idstring · max: 25Required

display_idstring · max: 50Optional

is_merge_requestbooleanOptional

is_archivebooleanOptional

unread_mailbooleanOptional

creation_timestring · date-timeOptional

created_by_idstring · max: 225Optional

last_update_timestring · date-timeOptional

updated_by_idstring · max: 225Optional

Responses

200Success

application/json

post

POST /ux/sd/req/request_process/workflow_options_map/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1181

{
  "request_id": "text",
  "display_id": "text",
  "is_merge_request": true,
  "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
  },
  "reference": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "source_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "template_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
  },
  "custom_field": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "tag": [],
  "kb": [],
  "custom_field_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-06-07T16:08:53.467Z",
  "created_by_id": "text",
  "last_update_time": "2025-06-07T16:08:53.467Z",
  "updated_by_id": "text",
  "service_form_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "location": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "employee_info": []
}

200Success

{
  "request_id": "text",
  "display_id": "text",
  "is_merge_request": true,
  "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
  },
  "reference": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "source_info": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "template_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
  },
  "custom_field": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "tag": [],
  "kb": [],
  "custom_field_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-06-07T16:08:53.467Z",
  "created_by_id": "text",
  "last_update_time": "2025-06-07T16:08:53.467Z",
  "updated_by_id": "text",
  "service_form_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "location": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "employee_info": []
}