ServiceDesk Plus Cloud (Preview)
ManageEngine ServiceDesk Plus Cloud is a ITIL compliant comprehensive help desk with integrated asset and project management capabilities.
This connector is available in the following products and regions:
Service | Class | Regions |
---|---|---|
Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD) |
Power Automate | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
Power Apps | Premium | All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
Contact | |
---|---|
Name | ServiceDesk Plus Cloud Support |
URL | https://www.manageengine.com/products/service-desk/support.html |
[email protected] |
Connector Metadata | |
---|---|
Publisher | ManageEngine (A division of Zoho Corporation) |
Website | https://www.manageengine.com/products/service-desk/cloud/ |
Privacy policy | https://www.manageengine.com/privacy.html |
Categories | Collaboration;Productivity |
Creating a connection
The connector supports the following authentication types:
Default | Parameters for creating connection. | All regions | Not shareable |
Default
Applicable: All regions
Parameters for creating connection.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
Name | Type | Description | Required |
---|---|---|---|
Select the region. | string | Select the domain. | True |
Throttling Limits
Name | Calls | Renewal Period |
---|---|---|
API calls per connection | 100 | 60 seconds |
Actions
Create Change |
Create new change in SDP Cloud |
Create Request |
Create new request in SDP Cloud |
Update Change |
Update an existing change |
Update Request |
Update an existing request |
Create Change
Create new change in SDP Cloud
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Service Desk Instance
|
serviceDeskInstance | True | string |
Select the ServiceDesk Plus Cloud instance where the API call must be placed |
Title
|
title | True | string |
Specify change title |
Status Comment
|
comment | string |
Specify change status comment |
|
Change Template
|
name | string |
Specify change template name |
|
Change Requester
|
name | string |
Specify change requester name |
|
Site
|
name | string |
Specify site for the change |
|
Group
|
name | string |
Specify group for the change |
|
Description
|
description | string |
Type change description |
|
Change Owner Email Address
|
email_id | string |
Type change owner's email address |
|
Change Type
|
name | string |
Specify change type |
|
Priority
|
name | string |
Specify change priority |
|
Urgency
|
name | string |
Specify change urgency |
|
Impact
|
name | string |
Specify change impact |
|
Change Risk
|
name | string |
Specify change risk |
|
Reason for Change
|
name | string |
Specify reason for initiating change |
|
Category
|
name | string |
Specify change category for the change |
|
Sub Category
|
name | string |
Specify change subcategory for a the change |
|
Item
|
name | string |
Specify change item |
|
name
|
name | string |
Provide assets to be associated with the change |
|
Additional Fields
|
udf_fields | string |
Specify additional fields(e.g. {"udf_char1":"value","udf_char2":"value",..}) |
Returns
Name | Path | Type | Description |
---|---|---|---|
status_code
|
response_status.status_code | integer |
status_code |
status
|
response_status.status | string |
status |
roll_out_plan.roll_out_plan_updated_on.display_value
|
change.roll_out_plan.roll_out_plan_updated_on.display_value | string |
roll_out_plan -> roll_out_plan_updated_on -> display_value |
roll_out_plan.roll_out_plan_updated_on.value
|
change.roll_out_plan.roll_out_plan_updated_on.value | string |
roll_out_plan -> roll_out_plan_updated_on -> value |
roll_out_plan.roll_out_plan_updated_by.email_id
|
change.roll_out_plan.roll_out_plan_updated_by.email_id | string |
roll_out_plan -> roll_out_plan_updated_by -> email_id |
roll_out_plan.roll_out_plan_updated_by.is_technician
|
change.roll_out_plan.roll_out_plan_updated_by.is_technician | boolean |
roll_out_plan -> roll_out_plan_updated_by -> is_technician |
roll_out_plan.roll_out_plan_updated_by.sms_mail
|
change.roll_out_plan.roll_out_plan_updated_by.sms_mail | string |
roll_out_plan -> roll_out_plan_updated_by -> sms_mail |
roll_out_plan.roll_out_plan_updated_by.mobile
|
change.roll_out_plan.roll_out_plan_updated_by.mobile | string |
roll_out_plan -> roll_out_plan_updated_by -> mobile |
roll_out_plan.roll_out_plan_updated_by.last_name
|
change.roll_out_plan.roll_out_plan_updated_by.last_name | string |
roll_out_plan -> roll_out_plan_updated_by -> last_name |
roll_out_plan.roll_out_plan_updated_by.user_scope
|
change.roll_out_plan.roll_out_plan_updated_by.user_scope | string |
roll_out_plan -> roll_out_plan_updated_by -> user_scope |
roll_out_plan.roll_out_plan_updated_by.sms_mail_id
|
change.roll_out_plan.roll_out_plan_updated_by.sms_mail_id | string |
roll_out_plan -> roll_out_plan_updated_by -> sms_mail_id |
roll_out_plan.roll_out_plan_updated_by.phone
|
change.roll_out_plan.roll_out_plan_updated_by.phone | string |
roll_out_plan -> roll_out_plan_updated_by -> phone |
roll_out_plan.roll_out_plan_updated_by.name
|
change.roll_out_plan.roll_out_plan_updated_by.name | string |
roll_out_plan -> roll_out_plan_updated_by -> name |
roll_out_plan.roll_out_plan_updated_by.id
|
change.roll_out_plan.roll_out_plan_updated_by.id | string |
roll_out_plan -> roll_out_plan_updated_by -> id |
roll_out_plan.roll_out_plan_updated_by.photo_url
|
change.roll_out_plan.roll_out_plan_updated_by.photo_url | string |
roll_out_plan -> roll_out_plan_updated_by -> photo_url |
roll_out_plan.roll_out_plan_updated_by.is_vip_user
|
change.roll_out_plan.roll_out_plan_updated_by.is_vip_user | boolean |
roll_out_plan -> roll_out_plan_updated_by -> is_vip_user |
roll_out_plan.roll_out_plan_updated_by.department
|
change.roll_out_plan.roll_out_plan_updated_by.department | string |
roll_out_plan -> roll_out_plan_updated_by -> department |
roll_out_plan.roll_out_plan_updated_by.first_name
|
change.roll_out_plan.roll_out_plan_updated_by.first_name | string |
roll_out_plan -> roll_out_plan_updated_by -> first_name |
roll_out_plan.roll_out_plan_updated_by.job_title
|
change.roll_out_plan.roll_out_plan_updated_by.job_title | string |
roll_out_plan -> roll_out_plan_updated_by -> job_title |
roll_out_plan.roll_out_plan_description
|
change.roll_out_plan.roll_out_plan_description | string |
roll_out_plan -> roll_out_plan_description |
emergency
|
change.emergency | boolean |
emergency |
change_type.color
|
change.change_type.color | string |
change_type -> color |
change_type.pre_approved
|
change.change_type.pre_approved | boolean |
change_type -> pre_approved |
change_type.name
|
change.change_type.name | string |
change_type -> name |
change_type.id
|
change.change_type.id | string |
change_type -> id |
review_details.next_review_on
|
change.review_details.next_review_on | object |
review_details -> next_review_on |
review_details.review_details_updated_by
|
change.review_details.review_details_updated_by | object |
review_details -> review_details_updated_by |
review_details.review_details_updated_on
|
change.review_details.review_details_updated_on | object |
review_details -> review_details_updated_on |
review_details.review_details_description
|
change.review_details.review_details_description | object |
review_details -> review_details_description |
assets
|
change.assets | array of object |
assets |
assets.site
|
change.assets.site | object |
assets -> site |
assets.name
|
change.assets.name | string |
assets -> name |
assets.id
|
change.assets.id | string |
assets -> id |
configuration_items
|
change.configuration_items | array of |
configuration_items |
workflow_instance_details.id
|
change.workflow_instance_details.id | string |
workflow_instance_details -> id |
workflow_instance_details.status.name
|
change.workflow_instance_details.status.name | string |
workflow_instance_details -> status -> name |
workflow_instance_details.status.id
|
change.workflow_instance_details.status.id | string |
workflow_instance_details -> status -> id |
rel.releases
|
change.rel.releases | object |
rel -> releases |
id
|
change.id | string |
change -> id |
change_requester.email_id
|
change.change_requester.email_id | string |
change_requester -> email_id |
change_requester.is_technician
|
change.change_requester.is_technician | boolean |
change_requester -> is_technician |
change_requester.sms_mail
|
change.change_requester.sms_mail | string |
change_requester -> sms_mail |
change_requester.mobile
|
change.change_requester.mobile | string |
change_requester -> mobile |
change_requester.last_name
|
change.change_requester.last_name | string |
change_requester -> last_name |
change_requester.user_scope
|
change.change_requester.user_scope | string |
change_requester -> user_scope |
change_requester.sms_mail_id
|
change.change_requester.sms_mail_id | string |
change_requester -> sms_mail_id |
change_requester.phone
|
change.change_requester.phone | string |
change_requester -> phone |
change_requester.name
|
change.change_requester.name | string |
change_requester -> name |
change_requester.id
|
change.change_requester.id | string |
change_requester -> id |
change_requester.photo_url
|
change.change_requester.photo_url | string |
change_requester -> photo_url |
change_requester.is_vip_user
|
change.change_requester.is_vip_user | boolean |
change_requester -> is_vip_user |
change_requester.department
|
change.change_requester.department | string |
change_requester -> department |
change_requester.first_name
|
change.change_requester.first_name | string |
change_requester -> first_name |
change_requester.job_title
|
change.change_requester.job_title | string |
change_requester -> job_title |
group.site
|
change.group.site | object |
group -> site |
group.deleted
|
change.group.deleted | boolean |
group -> deleted |
group.name
|
change.group.name | string |
group -> name |
group.id
|
change.group.id | string |
group -> id |
created_time.display_value
|
change.created_time.display_value | string |
created_time -> display_value |
created_time.value
|
change.created_time.value | string |
created_time -> value |
item.name
|
change.item.name | string |
item -> name |
item.id
|
change.item.id | string |
item -> id |
workflow.validated
|
change.workflow.validated | boolean |
workflow -> validated |
workflow.name
|
change.workflow.name | string |
workflow -> name |
workflow.id
|
change.workflow.id | string |
workflow -> id |
approval_status
|
change.approval_status | string |
approval_status |
impact.name
|
change.impact.name | string |
impact -> name |
impact.id
|
change.impact.id | string |
impact -> id |
release_details.release_actual_start
|
change.release_details.release_actual_start | object |
release_details -> release_actual_start |
release_details.release_actual_end
|
change.release_details.release_actual_end | object |
release_details -> release_actual_end |
release_details.release_details_description
|
change.release_details.release_details_description | string |
release_details -> release_details_description |
release_details.release_scheduled_end.display_value
|
change.release_details.release_scheduled_end.display_value | string |
release_details -> release_scheduled_end -> display_value |
release_details.release_scheduled_end.value
|
change.release_details.release_scheduled_end.value | string |
release_details -> release_scheduled_end -> value |
release_details.release_details_updated_on.display_value
|
change.release_details.release_details_updated_on.display_value | string |
release_details -> release_details_updated_on -> display_value |
release_details.release_details_updated_on.value
|
change.release_details.release_details_updated_on.value | string |
release_details -> release_details_updated_on -> value |
release_details.release_scheduled_start.display_value
|
change.release_details.release_scheduled_start.display_value | string |
release_details -> release_scheduled_start -> display_value |
release_details.release_scheduled_start.value
|
change.release_details.release_scheduled_start.value | string |
release_details -> release_scheduled_start -> value |
release_details.release_details_updated_by.email_id
|
change.release_details.release_details_updated_by.email_id | string |
release_details -> release_details_updated_by -> email_id |
release_details.release_details_updated_by.is_technician
|
change.release_details.release_details_updated_by.is_technician | boolean |
release_details -> release_details_updated_by -> is_technician |
release_details.release_details_updated_by.sms_mail
|
change.release_details.release_details_updated_by.sms_mail | string |
release_details -> release_details_updated_by -> sms_mail |
release_details.release_details_updated_by.mobile
|
change.release_details.release_details_updated_by.mobile | string |
release_details -> release_details_updated_by -> mobile |
release_details.release_details_updated_by.last_name
|
change.release_details.release_details_updated_by.last_name | string |
release_details -> release_details_updated_by -> last_name |
release_details.release_details_updated_by.user_scope
|
change.release_details.release_details_updated_by.user_scope | string |
release_details -> release_details_updated_by -> user_scope |
release_details.release_details_updated_by.sms_mail_id
|
change.release_details.release_details_updated_by.sms_mail_id | string |
release_details -> release_details_updated_by -> sms_mail_id |
release_details.release_details_updated_by.phone
|
change.release_details.release_details_updated_by.phone | string |
release_details -> release_details_updated_by -> phone |
release_details.release_details_updated_by.name
|
change.release_details.release_details_updated_by.name | string |
release_details -> release_details_updated_by -> name |
release_details.release_details_updated_by.id
|
change.release_details.release_details_updated_by.id | string |
release_details -> release_details_updated_by -> id |
release_details.release_details_updated_by.photo_url
|
change.release_details.release_details_updated_by.photo_url | string |
release_details -> release_details_updated_by -> photo_url |
release_details.release_details_updated_by.is_vip_user
|
change.release_details.release_details_updated_by.is_vip_user | boolean |
release_details -> release_details_updated_by -> is_vip_user |
release_details.release_details_updated_by.department
|
change.release_details.release_details_updated_by.department | string |
release_details -> release_details_updated_by -> department |
release_details.release_details_updated_by.first_name
|
change.release_details.release_details_updated_by.first_name | string |
release_details -> release_details_updated_by -> first_name |
release_details.release_details_updated_by.job_title
|
change.release_details.release_details_updated_by.job_title | string |
release_details -> release_details_updated_by -> job_title |
priority.color
|
change.priority.color | string |
priority -> color |
priority.name
|
change.priority.name | string |
priority -> name |
priority.id
|
change.priority.id | string |
priority -> id |
scheduled_end_time.display_value
|
change.scheduled_end_time.display_value | string |
scheduled_end_time -> display_value |
scheduled_end_time.value
|
change.scheduled_end_time.value | string |
scheduled_end_time -> value |
uat_details.uat_scheduled_start
|
change.uat_details.uat_scheduled_start | object |
uat_details -> uat_scheduled_start |
uat_details.uat_scheduled_end
|
change.uat_details.uat_actual_end | object |
uat_details -> uat_actual_end |
uat_details.uat_details_updated_by.email_id
|
change.uat_details.uat_details_updated_by.email_id | string |
uat_details -> uat_details_updated_by -> email_id |
uat_details.uat_details_updated_by.is_technician
|
change.uat_details.uat_details_updated_by.is_technician | boolean |
uat_details -> uat_details_updated_by -> is_technician |
uat_details.uat_details_updated_by.sms_mail
|
change.uat_details.uat_details_updated_by.sms_mail | string |
uat_details -> uat_details_updated_by -> sms_mail |
uat_details.uat_details_updated_by.mobile
|
change.uat_details.uat_details_updated_by.mobile | string |
uat_details -> uat_details_updated_by -> mobile |
uat_details.uat_details_updated_by.last_name
|
change.uat_details.uat_details_updated_by.last_name | string |
uat_details -> uat_details_updated_by -> last_name |
uat_details.uat_details_updated_by.user_scope
|
change.uat_details.uat_details_updated_by.user_scope | string |
uat_details -> uat_details_updated_by -> user_scope |
uat_details.uat_details_updated_by.sms_mail_id
|
change.uat_details.uat_details_updated_by.sms_mail_id | string |
uat_details -> uat_details_updated_by -> sms_mail_id |
uat_details.uat_details_updated_by.phone
|
change.uat_details.uat_details_updated_by.phone | string |
uat_details -> uat_details_updated_by -> phone |
uat_details.uat_details_updated_by.name
|
change.uat_details.uat_details_updated_by.name | string |
uat_details -> uat_details_updated_by -> name |
uat_details.uat_details_updated_by.id
|
change.uat_details.uat_details_updated_by.id | string |
uat_details -> uat_details_updated_by -> id |
uat_details.uat_details_updated_by.photo_url
|
change.uat_details.uat_details_updated_by.photo_url | string |
uat_details -> uat_details_updated_by -> photo_url |
uat_details.uat_details_updated_by.is_vip_user
|
change.uat_details.uat_details_updated_by.is_vip_user | boolean |
uat_details -> uat_details_updated_by -> is_vip_user |
uat_details.uat_details_updated_by.department
|
change.uat_details.uat_details_updated_by.department | string |
uat_details -> uat_details_updated_by -> department |
uat_details.uat_details_updated_by.first_name
|
change.uat_details.uat_details_updated_by.first_name | string |
uat_details -> uat_details_updated_by -> first_name |
uat_details.uat_details_updated_by.job_title
|
change.uat_details.uat_details_updated_by.job_title | string |
uat_details -> uat_details_updated_by -> job_title |
uat_details.uat_details_description
|
change.uat_details.uat_details_description | string |
uat_details -> uat_details_description |
uat_details.uat_details_updated_on.display_value
|
change.uat_details.uat_details_updated_on.display_value | string |
uat_details -> uat_details_updated_on -> display_value |
uat_details.uat_details_updated_on.value
|
change.uat_details.uat_details_updated_on.value | string |
uat_details -> uat_details_updated_on -> value |
uat_details.uat_scheduled_end
|
change.uat_details.uat_scheduled_end | object |
uat_details -> uat_scheduled_end |
uat_details.uat_actual_start
|
change.uat_details.uat_actual_start | object |
uat_details -> uat_actual_start |
reason_for_change.name
|
change.reason_for_change.name | string |
reason_for_change -> name |
reason_for_change.id
|
change.reason_for_change.id | string |
reason_for_change -> id |
impact_details.impact_details_updated_on.display_value
|
change.impact_details.impact_details_updated_on.display_value | string |
impact_details -> impact_details_updated_on -> display_value |
impact_details.impact_details_updated_on.value
|
change.impact_details.impact_details_updated_on.value | string |
impact_details -> impact_details_updated_on -> value |
impact_details.impact_details_updated_by.email_id
|
change.impact_details.impact_details_updated_by.email_id | string |
impact_details -> impact_details_updated_by -> email_id |
impact_details.impact_details_updated_by.is_technician
|
change.impact_details.impact_details_updated_by.is_technician | boolean |
impact_details -> impact_details_updated_by -> is_technician |
impact_details.impact_details_updated_by.sms_mail
|
change.impact_details.impact_details_updated_by.sms_mail | string |
impact_details -> impact_details_updated_by -> sms_mail |
impact_details.impact_details_updated_by.mobile
|
change.impact_details.impact_details_updated_by.mobile | string |
impact_details -> impact_details_updated_by -> mobile |
impact_details.impact_details_updated_by.last_name
|
change.impact_details.impact_details_updated_by.last_name | string |
impact_details -> impact_details_updated_by -> last_name |
impact_details.impact_details_updated_by.user_scope
|
change.impact_details.impact_details_updated_by.user_scope | string |
impact_details -> impact_details_updated_by -> user_scope |
impact_details.impact_details_updated_by.sms_mail_id
|
change.impact_details.impact_details_updated_by.sms_mail_id | string |
impact_details -> impact_details_updated_by -> sms_mail_id |
impact_details.impact_details_updated_by.phone
|
change.impact_details.impact_details_updated_by.phone | string |
impact_details -> impact_details_updated_by -> phone |
impact_details.impact_details_updated_by.name
|
change.impact_details.impact_details_updated_by.name | string |
impact_details -> impact_details_updated_by -> name |
impact_details.impact_details_updated_by.id
|
change.impact_details.impact_details_updated_by.id | string |
impact_details -> impact_details_updated_by -> id |
impact_details.impact_details_updated_by.photo_url
|
change.impact_details.impact_details_updated_by.photo_url | string |
impact_details -> impact_details_updated_by -> photo_url |
impact_details.impact_details_updated_by.is_vip_user
|
change.impact_details.impact_details_updated_by.is_vip_user | boolean |
impact_details -> impact_details_updated_by -> is_vip_user |
impact_details.impact_details_updated_by.department
|
change.impact_details.impact_details_updated_by.department | string |
impact_details -> impact_details_updated_by -> department |
impact_details.impact_details_updated_by.first_name
|
change.impact_details.impact_details_updated_by.first_name | string |
impact_details -> impact_details_updated_by -> first_name |
impact_details.impact_details_updated_by.job_title
|
change.impact_details.impact_details_updated_by.job_title | string |
impact_details -> impact_details_updated_by -> job_title |
impact_details.impact_details_description
|
change.impact_details.impact_details_description | string |
impact_details -> impact_details_description |
subcategory.name
|
change.subcategory.name | string |
subcategory -> name |
subcategory.id
|
change.subcategory.id | string |
subcategory -> id |
deleted_time
|
change.deleted_time | object |
deleted_time |
is_freeze_conflicted
|
change.is_freeze_conflicted | boolean |
is_freeze_conflicted |
status.internal_name
|
change.status.internal_name | string |
status -> internal_name |
status.stage.id
|
change.status.stage.id | string |
status -> stage -> id |
status.name
|
change.status.name | string |
status -> name |
status.id
|
change.status.id | string |
status -> id |
scheduled_start_time.display_value
|
change.scheduled_start_time.display_value | string |
scheduled_start_time -> display_value |
scheduled_start_time.value
|
change.scheduled_start_time.value | string |
scheduled_start_time -> value |
template.inactive
|
change.template.inactive | boolean |
template -> inactive |
template.name
|
change.template.name | string |
template -> name |
template.id
|
change.template.id | string |
template -> id |
has_release_association
|
change.has_release_association | boolean |
has_release_association |
attachments
|
change.attachments | array of |
attachments |
display_id.display_value
|
change.display_id.display_value | string |
display_id -> display_value |
display_id.value
|
change.display_id.value | string |
display_id -> value |
roles
|
change.roles | array of object |
roles |
roles.role.internal_name
|
change.roles.role.internal_name | string |
roles -> role -> internal_name |
roles.role.user_type
|
change.roles.role.user_type | string |
roles -> role -> user_type |
roles.role.name
|
change.roles.role.name | string |
roles -> role -> name |
roles.role.id
|
change.roles.role.id | string |
roles -> role -> id |
roles.id
|
change.roles.id | string |
roles -> id |
roles.user.email_id
|
change.roles.user.email_id | string |
roles -> user -> email_id |
roles.user.is_technician
|
change.roles.user.is_technician | boolean |
roles -> user -> is_technician |
roles.user.sms_mail
|
change.roles.user.sms_mail | string |
roles -> user -> sms_mail |
roles.user.mobile
|
change.roles.user.mobile | string |
roles -> user -> mobile |
roles.user.last_name
|
change.roles.user.last_name | string |
roles -> user -> last_name |
roles.user.user_scope
|
change.roles.user.user_scope | string |
roles -> user -> user_scope |
roles.user.sms_mail_id
|
change.roles.user.sms_mail_id | string |
roles -> user -> sms_mail_id |
roles.user.phone
|
change.roles.user.phone | string |
roles -> user -> phone |
roles.user.name
|
change.roles.user.name | string |
roles -> user -> name |
roles.user.id
|
change.roles.user.id | string |
roles -> user -> id |
roles.user.photo_url
|
change.roles.user.photo_url | string |
roles -> user -> photo_url |
roles.user.is_vip_user
|
change.roles.user.is_vip_user | boolean |
roles -> user -> is_vip_user |
roles.user.department.site.deleted
|
change.roles.user.department.site.deleted | boolean |
roles -> user -> department -> site -> deleted |
roles.user.department.site.name
|
change.roles.user.department.site.name | string |
roles -> user -> department -> site -> name |
roles.user.department.site.id
|
change.roles.user.department.site.id | string |
roles -> user -> department -> site -> id |
roles.user.department.name
|
change.roles.user.department.name | string |
roles -> user -> department -> name |
roles.user.department.id
|
change.roles.user.department.id | string |
roles -> user -> department -> id |
roles.user.first_name
|
change.roles.user.first_name | string |
roles -> user -> first_name |
roles.user.job_title
|
change.roles.user.job_title | string |
roles -> user ->job_title |
description
|
change.description | string |
description |
title
|
change.title | string |
title |
change_owner.email_id
|
change.change_owner.email_id | string |
change_owner -> email_id |
change_owner.is_technician
|
change.change_owner.is_technician | boolean |
change_owner -> is_technician |
change_owner.sms_mail
|
change.change_owner.sms_mail | string |
change_owner -> sms_mail |
change_owner.mobile
|
change.change_owner.mobile | string |
change_owner -> mobile |
change_owner.last_name
|
change.change_owner.last_name | string |
change_owner -> last_name |
change_owner.user_scope
|
change.change_owner.user_scope | string |
change_owner -> user_scope |
change_owner.sms_mail_id
|
change.change_owner.sms_mail_id | string |
change_owner -> sms_mail_id |
change_owner.cost_per_hour
|
change.change_owner.cost_per_hour | string |
change_owner -> cost_per_hour |
change_owner.phone
|
change.change_owner.phone | string |
change_owner -> phone |
change_owner.name
|
change.change_owner.name | string |
change_owner -> name |
change_owner.id
|
change.change_owner.id | string |
change_owner -> id |
change_owner.photo_url
|
change.change_owner.photo_url | string |
change_owner -> photo_url |
change_owner.is_vip_user
|
change.change_owner.is_vip_user | boolean |
change_owner -> is_vip_user |
change_owner.department
|
change.change_owner.department | string |
change_owner -> department |
change_owner.first_name
|
change.change_owner.first_name | string |
change_owner -> first_name |
change_owner.job_title
|
change.change_owner.job_title | string |
change_owner -> job_title |
urgency.name
|
change.urgency.name | string |
urgency -> name |
urgency.id
|
change.urgency.id | string |
urgency -> id |
close_details.close_details_updated_on.display_value
|
change.close_details.close_details_updated_on.display_value | string |
close_details -> close_details_updated_on -> display_value |
close_details.close_details_updated_on.value
|
change.close_details.close_details_updated_on.value | string |
close_details -> close_details_updated_on -> value |
close_details.close_details_description
|
change.close_details.close_details_description | string |
close_details -> close_details_description |
close_details.closure_code.name
|
change.close_details.closure_code.name | string |
close_details -> closure_code -> name |
close_details.closure_code.id
|
change.close_details.closure_code.id | string |
close_details -> closure_code -> id |
close_details.close_details_updated_by.email_id
|
change.close_details.close_details_updated_by.email_id | string |
close_details -> close_details_updated_by -> email_id |
close_details.close_details_updated_by.is_technician
|
change.close_details.close_details_updated_by.is_technician | boolean |
close_details -> close_details_updated_by -> is_technician |
close_details.close_details_updated_by.sms_mail
|
change.close_details.close_details_updated_by.sms_mail | string |
close_details -> close_details_updated_by -> sms_mail |
close_details.close_details_updated_by.mobile
|
change.close_details.close_details_updated_by.mobile | string |
close_details -> close_details_updated_by -> mobile |
close_details.close_details_updated_by.last_name
|
change.close_details.close_details_updated_by.last_name | string |
close_details -> close_details_updated_by -> last_name |
close_details.close_details_updated_by.user_scope
|
change.close_details.close_details_updated_by.user_scope | string |
close_details -> close_details_updated_by -> user_scope |
close_details.close_details_updated_by.sms_mail_id
|
change.close_details.close_details_updated_by.sms_mail_id | string |
close_details -> close_details_updated_by -> sms_mail_id |
close_details.close_details_updated_by.phone
|
change.close_details.close_details_updated_by.phone | string |
close_details -> close_details_updated_by -> phone |
close_details.close_details_updated_by.name
|
change.close_details.close_details_updated_by.name | string |
close_details -> close_details_updated_by -> name |
close_details.close_details_updated_by.id
|
change.close_details.close_details_updated_by.id | string |
close_details -> close_details_updated_by -> id |
close_details.close_details_updated_by.photo_url
|
change.close_details.close_details_updated_by.photo_url | string |
close_details -> close_details_updated_by -> photo_url |
close_details.close_details_updated_by.is_vip_user
|
change.close_details.close_details_updated_by.is_vip_user | boolean |
close_details -> close_details_updated_by -> is_vip_user |
close_details.close_details_updated_by.department
|
change.close_details.close_details_updated_by.department | string |
close_details -> close_details_updated_by -> department |
close_details.close_details_updated_by.first_name
|
change.close_details.close_details_updated_by.first_name | string |
close_details -> close_details_updated_by -> first_name |
close_details.close_details_updated_by.job_title
|
change.close_details.close_details_updated_by.job_title | string |
close_details -> close_details_updated_by -> job_title |
change_manager
|
change.change_manager | string |
change_manager |
is_freezed
|
change.is_freezed | boolean |
is_freezed |
retrospective
|
change.retrospective | boolean |
retrospective |
checklist.checklist_description
|
change.checklist.checklist_description | string |
checklist -> checklist_description |
checklist.checklist_updated_on.display_value
|
change.checklist.checklist_updated_on.display_value | string |
checklist -> checklist_updated_on -> display_value |
checklist.checklist_updated_on.value
|
change.checklist.checklist_updated_on.value | string |
checklist -> checklist_updated_on -> value |
checklist.checklist_updated_by.email_id
|
change.checklist.checklist_updated_by.email_id | string |
checklist -> checklist_updated_by -> email_id |
checklist.checklist_updated_by.is_technician
|
change.checklist.checklist_updated_by.is_technician | boolean |
checklist -> checklist_updated_by -> is_technician |
checklist.checklist_updated_by.sms_mail
|
change.checklist.checklist_updated_by.sms_mail | string |
checklist -> checklist_updated_by -> sms_mail |
checklist.checklist_updated_by.mobile
|
change.checklist.checklist_updated_by.mobile | string |
checklist -> checklist_updated_by -> mobile |
checklist.checklist_updated_by.last_name
|
change.checklist.checklist_updated_by.last_name | string |
checklist -> checklist_updated_by -> last_name |
checklist.checklist_updated_by.user_scope
|
change.checklist.checklist_updated_by.user_scope | string |
checklist -> checklist_updated_by -> user_scope |
checklist.checklist_updated_by.sms_mail_id
|
change.checklist.checklist_updated_by.sms_mail_id | string |
checklist -> checklist_updated_by -> sms_mail_id |
checklist.checklist_updated_by.phone
|
change.checklist.checklist_updated_by.phone | string |
checklist -> checklist_updated_by -> phone |
checklist.checklist_updated_by.name
|
change.checklist.checklist_updated_by.name | string |
checklist -> checklist_updated_by -> name |
checklist.checklist_updated_by.id
|
change.checklist.checklist_updated_by.id | string |
checklist -> checklist_updated_by -> id |
checklist.checklist_updated_by.photo_url
|
change.checklist.checklist_updated_by.photo_url | string |
checklist -> checklist_updated_by -> photo_url |
checklist.checklist_updated_by.is_vip_user
|
change.checklist.checklist_updated_by.is_vip_user | boolean |
checklist -> checklist_updated_by -> is_vip_user |
checklist.checklist_updated_by.department
|
change.checklist.checklist_updated_by.department | string |
checklist -> checklist_updated_by -> department |
checklist.checklist_updated_by.first_name
|
change.checklist.checklist_updated_by.first_name | string |
checklist -> checklist_updated_by -> first_name |
checklist.checklist_updated_by.job_title
|
change.checklist.checklist_updated_by.job_title | string |
checklist -> checklist_updated_by -> job_title |
services
|
change.services | array of object |
services |
services.inactive
|
change.services.inactive | boolean |
services -> inactive |
services.name
|
change.services.name | string |
services -> name |
services.id
|
change.services.id | string |
services -> id |
services.sort_index
|
change.services.sort_index | integer |
services -> sort_index |
back_out_plan.back_out_plan_updated_by.email_id
|
change.back_out_plan.back_out_plan_updated_by.email_id | string |
back_out_plan -> back_out_plan_updated_by -> email_id |
back_out_plan.back_out_plan_updated_by.is_technician
|
change.back_out_plan.back_out_plan_updated_by.is_technician | boolean |
back_out_plan -> back_out_plan_updated_by -> is_technician |
back_out_plan.back_out_plan_updated_by.sms_mail
|
change.back_out_plan.back_out_plan_updated_by.sms_mail | string |
back_out_plan -> back_out_plan_updated_by -> sms_mail |
back_out_plan.back_out_plan_updated_by.mobile
|
change.back_out_plan.back_out_plan_updated_by.mobile | string |
back_out_plan -> back_out_plan_updated_by -> mobile |
back_out_plan.back_out_plan_updated_by.last_name
|
change.back_out_plan.back_out_plan_updated_by.last_name | string |
back_out_plan -> back_out_plan_updated_by -> last_name |
back_out_plan.back_out_plan_updated_by.user_scope
|
change.back_out_plan.back_out_plan_updated_by.user_scope | string |
back_out_plan -> back_out_plan_updated_by -> user_scope |
back_out_plan.back_out_plan_updated_by.sms_mail_id
|
change.back_out_plan.back_out_plan_updated_by.sms_mail_id | string |
back_out_plan -> back_out_plan_updated_by -> sms_mail_id |
back_out_plan.back_out_plan_updated_by.phone
|
change.back_out_plan.back_out_plan_updated_by.phone | string |
back_out_plan -> back_out_plan_updated_by -> phone |
back_out_plan.back_out_plan_updated_by.name
|
change.back_out_plan.back_out_plan_updated_by.name | string |
back_out_plan -> back_out_plan_updated_by -> name |
back_out_plan.back_out_plan_updated_by.id
|
change.back_out_plan.back_out_plan_updated_by.id | string |
back_out_plan -> back_out_plan_updated_by -> id |
back_out_plan.back_out_plan_updated_by.photo_url
|
change.back_out_plan.back_out_plan_updated_by.photo_url | string |
back_out_plan -> back_out_plan_updated_by -> photo_url |
back_out_plan.back_out_plan_updated_by.is_vip_user
|
change.back_out_plan.back_out_plan_updated_by.is_vip_user | boolean |
back_out_plan -> back_out_plan_updated_by -> is_vip_user |
back_out_plan.back_out_plan_updated_by.department
|
change.back_out_plan.back_out_plan_updated_by.department | string |
back_out_plan -> back_out_plan_updated_by -> department |
back_out_plan.back_out_plan_updated_by.first_name
|
change.back_out_plan.back_out_plan_updated_by.first_name | string |
back_out_plan -> back_out_plan_updated_by -> first_name |
back_out_plan.back_out_plan_updated_by.job_title
|
change.back_out_plan.back_out_plan_updated_by.job_title | string |
back_out_plan -> back_out_plan_updated_by -> job_title |
back_out_plan.back_out_plan_updated_on.display_value
|
change.back_out_plan.back_out_plan_updated_on.display_value | string |
back_out_plan -> back_out_plan_updated_on -> display_value |
back_out_plan.back_out_plan_updated_on.value
|
change.back_out_plan.back_out_plan_updated_on.value | string |
back_out_plan -> back_out_plan_updated_on -> value |
back_out_plan.back_out_plan_description
|
change.back_out_plan.back_out_plan_description | string |
back_out_plan -> back_out_plan_description |
site.site
|
change.site.deleted | boolean |
site -> deleted |
site.name
|
change.site.name | string |
site -> name |
site.id
|
change.site.id | string |
site -> id |
stage.internal_name
|
change.stage.internal_name | string |
stage -> internal_name |
stage.stage_index
|
change.stage.stage_index | integer |
stage -> stage_index |
stage.name
|
change.stage.name | string |
stage -> name |
stage.id
|
change.stage.id | string |
stage -> id |
completed_time.display_value
|
change.completed_time.display_value | string |
completed_time -> display_value |
completed_time.value
|
change.completed_time.value | string |
completed_time -> value |
risk.name
|
change.risk.name | string |
risk -> name |
risk.id
|
change.risk.id | string |
risk -> id |
category.deleted
|
change.category.deleted | boolean |
category -> deleted |
category.name
|
change.category.name | string |
category -> name |
category.id
|
change.category.id | string |
category -> id |
notes_present
|
change.notes_present | boolean |
notes_present |
Create Request
Create new request in SDP Cloud
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Service Desk Instance
|
serviceDeskInstance | True | string |
Select the ServiceDesk Plus Cloud instance where the API call must be placed |
Subject
|
subject | True | string |
Specify request subject |
Request Template
|
name | string |
Specify request template name |
|
Request Type
|
name | string |
Specify request type |
|
Requester
|
name | string |
Provide requester name |
|
Status
|
name | string |
Specify request status |
|
Technician Email Address
|
email_id | string |
Specify technician email address |
|
Site
|
name | string |
Specify request site |
|
Group
|
name | string |
Specify request group |
|
Description
|
description | string |
Type request description |
|
Priority
|
name | string |
Specify request priority |
|
Urgency
|
name | string |
Specify request urgency |
|
Impact
|
name | string |
Specify request impact |
|
Mode
|
name | string |
Specify request mode |
|
Category
|
name | string |
Specify request category |
|
Sub Category
|
name | string |
Specify request subcategory |
|
Item
|
name | string |
Specify request item |
|
name
|
name | string |
Provide assets to be associated with request |
|
Additional Fields
|
udf_fields | string |
Specify additional fields(e.g.{"udf_char1":"value","udf_char2":"value",..}) |
Returns
Name | Path | Type | Description |
---|---|---|---|
subject
|
request.subject | string |
Subject |
project.display_id.display_value
|
request.project.display_id.display_value | string |
project -> display_id -> display_value |
project.display_id.value
|
request.project.display_id.value | string |
project -> display_id -> value |
project.project_code
|
request.project.project_code | object |
project -> project_code |
project.id
|
request.project.id | string |
project -> id |
project.title
|
request.project.title | string |
project -> title |
resolution.content
|
request.resolution.content | string |
resolution -> content |
linked_to_request.request.display_id
|
request.linked_to_request.request.display_id | integer |
linked_to_request -> request -> display_id |
linked_to_request.request.subject
|
request.linked_to_request.request.subject | string |
linked_to_request -> request -> subject |
linked_to_request.request.id
|
request.linked_to_request.request.id | string |
linked_to_request -> request -> id |
linked_to_request.comments
|
request.linked_to_request.comments | string |
linked_to_request -> comments |
mode.name
|
request.mode.name | string |
mode -> name |
mode.id
|
request.mode.id | string |
mode -> id |
lifecycle
|
request.lifecycle | object |
lifecycle |
is_read
|
request.is_read | boolean |
is_read |
assets
|
request.assets | array of object |
assets |
assets.site
|
request.assets.site | object |
assets -> site |
assets.name
|
request.assets.name | string |
assets -> name |
assets.id
|
request.assets.id | string |
assets -> id |
cancellation_requested
|
request.cancellation_requested | boolean |
cancellation_requested |
is_trashed
|
request.is_trashed | boolean |
is_trashed |
has_change_initiated_request
|
request.has_change_initiated_request | boolean |
has_change_initiated_request |
id
|
request.id | string |
request -> id |
assigned_time.display_value
|
request.assigned_time.display_value | string |
assigned_time -> display_value |
assigned_time.value
|
request.assigned_time.value | string |
assigned_time -> value |
group.site
|
request.group.site | object |
group -> site |
group.deleted
|
request.group.deleted | boolean |
group -> deleted |
group.name
|
request.group.name | string |
group -> name |
group.id
|
request.group.id | string |
group -> id |
requester.email_id
|
request.requester.email_id | string |
requester -> email_id |
requester.is_technician
|
request.requester.is_technician | boolean |
requester -> is_technician |
requester.sms_mail
|
request.requester.sms_mail | string |
requester -> sms_mail |
requester.mobile
|
request.requester.mobile | string |
requester -> mobile |
requester.last_name
|
request.requester.last_name | string |
requester -> last_name |
requester.user_scope
|
request.requester.user_scope | string |
requester -> user_scope |
requester.sms_mail_id
|
request.requester.sms_mail_id | string |
requester -> sms_mail_id |
requester.phone
|
request.requester.phone | string |
requester -> phone |
requester.name
|
request.requester.name | string |
requester -> name |
requester.id
|
request.requester.id | string |
requester -> id |
requester.photo_url
|
request.requester.photo_url | string |
requester -> photo_url |
requester.is_vip_user
|
request.requester.is_vip_user | boolean |
requester -> is_vip_user |
requester.department
|
request.requester.department | object |
requester -> department |
requester.first_name
|
request.requester.first_name | string |
requester -> first_name |
requester.job_title
|
request.requester.job_title | string |
requester -> job_title |
email_to
|
request.email_to | array of |
email_to |
created_time.display_value
|
request.created_time.display_value | string |
created_time -> display_value |
created_time.value
|
request.created_time.value | string |
created_time -> value |
item.name
|
request.item.name | string |
item -> name |
item.id
|
request.item.id | string |
item -> id |
cancel_flag_comments
|
request.cancel_flag_comments | object |
cancel_flag_comments |
level.name
|
request.level.name | string |
level -> name |
level.id
|
request.level.id | string |
level -> id |
approval_status
|
request.approval_status | object |
approval_status |
impact.name
|
request.impact.name | string |
impact -> name |
impact.id
|
request.impact.id | string |
impact -> id |
service_category.inactive
|
request.service_category.inactive | boolean |
service_category -> inactive |
service_category.name
|
request.service_category.name | string |
service_category -> name |
service_category.id
|
request.service_category.id | string |
service_category -> id |
service_category.sort_index
|
request.service_category.sort_index | integer |
service_category -> sort_index |
sla.name
|
request.sla.name | string |
sla -> name |
sla.id
|
request.sla.id | string |
sla -> id |
resolved_time
|
request.resolved_time | object |
resolved_time |
priority.color
|
request.priority.color | string |
priority -> color |
priority.name
|
request.priority.name | string |
priority -> name |
priority.id
|
request.priority.id | string |
priority -> id |
created_by.email_id
|
request.created_by.email_id | string |
created_by -> email_id |
created_by.is_technician
|
request.created_by.is_technician | boolean |
created_by -> is_technician |
created_by.sms_mail
|
request.created_by.sms_mail | string |
created_by -> sms_mail |
created_by.mobile
|
request.created_by.mobile | string |
created_by -> mobile |
created_by.last_name
|
request.created_by.last_name | string |
created_by -> last_name |
created_by.user_scope
|
request.created_by.user_scope | string |
created_by -> user_scope |
created_by.sms_mail_id
|
request.created_by.sms_mail_id | string |
created_by -> sms_mail_id |
created_by.phone
|
request.created_by.phone | string |
created_by -> phone |
created_by.name
|
request.created_by.name | string |
created_by -> name |
created_by.id
|
request.created_by.id | string |
created_by -> id |
created_by.photo_url
|
request.created_by.photo_url | string |
created_by -> photo_url |
created_by.is_vip_user
|
request.created_by.is_vip_user | boolean |
created_by -> is_vip_user |
created_by.department
|
request.created_by.department | object |
created_by -> department |
created_by.first_name
|
request.created_by.first_name | string |
created_by -> first_name |
created_by.job_title
|
request.created_by.job_title | string |
created_by -> job_title |
scheduled_end_time.display_value
|
request.scheduled_end_time.display_value | string |
scheduled_end_time -> display_value |
scheduled_end_time.value
|
request.scheduled_end_time.value | string |
scheduled_end_time -> value |
first_response_due_by_time.display_value
|
request.first_response_due_by_time.display_value | string |
first_response_due_by_time -> display_value |
first_response_due_by_time.value
|
request.first_response_due_by_time.value | string |
first_response_due_by_time -> value |
is_escalated
|
request.is_escalated | boolean |
is_escalated |
last_updated_time.display_value
|
request.last_updated_time.display_value | string |
last_updated_time -> display_value |
last_updated_time.value
|
request.last_updated_time.value | string |
last_updated_time -> value |
has_notes
|
request.has_notes | boolean |
has_notes |
impact_details
|
request.impact_details | string |
impact_details |
subcategory.name
|
request.subcategory.name | string |
subcategory -> name |
subcategory.id
|
request.subcategory.id | string |
subcategory -> id |
deleted_time
|
request.deleted_time | object |
deleted_time |
email_cc
|
request.email_cc | array of string |
email_cc |
onhold_scheduler
|
request.onhold_scheduler | object |
onhold_scheduler |
status.in_progress
|
request.status.in_progress | boolean |
status -> in_progress |
status.internal_name
|
request.status.internal_name | string |
status -> internal_name |
status.stop_timer
|
request.status.stop_timer | boolean |
status -> stop_timer |
status.color
|
request.status.color | string |
status -> color |
status.name
|
request.status.name | string |
status -> name |
status.id
|
request.status.id | string |
status -> id |
scheduled_start_time.display_value
|
request.scheduled_start_time.display_value | string |
scheduled_start_time -> display_value |
scheduled_start_time.value
|
request.scheduled_start_time.value | string |
scheduled_start_time -> value |
template.name
|
request.template.name | string |
template -> name |
template.id
|
request.template.id | string |
template -> id |
email_ids_to_notify
|
request.email_ids_to_notify | array of string |
email_ids_to_notify |
attachments
|
request.attachments | array of |
attachments |
request_type.name
|
request.request_type.name | string |
request_type -> name |
request_type.id
|
request.request_type.id | string |
request_type -> id |
completed_by_denial
|
request.completed_by_denial | boolean |
completed_by_denial |
display_id
|
request.display_id | string |
display_id |
time_elapsed
|
request.time_elapsed | string |
time_elapsed |
notification_status
|
request.notification_status | object |
notification_status |
description
|
request.description | string |
description |
responded_time
|
request.responded_time | string |
responded_time |
is_service_request
|
request.is_service_request | boolean |
is_service_request |
deleted_assets
|
request.deleted_assets | array of |
deleted_assets |
urgency.name
|
request.urgency.name | string |
urgency -> name |
urgency.id
|
request.urgency.id | string |
urgency -> id |
has_request_initiated_change
|
request.has_request_initiated_change | boolean |
has_request_initiated_change |
request_template_task_ids
|
request.request_template_task_ids | array of object |
request_template_task_ids |
request_template_task_ids.id
|
request.request_template_task_ids.id | string |
request_template_task_ids -> id |
department
|
request.department | object |
department |
is_reopened
|
request.is_reopened | boolean |
is_reopened |
has_draft
|
request.has_draft | boolean |
has_draft |
has_attachments
|
request.has_attachments | boolean |
has_attachments |
has_linked_requests
|
request.has_linked_requests | boolean |
has_linked_requests |
is_overdue
|
request.is_overdue | boolean |
is_overdue |
technician.email_id
|
request.technician.email_id | string |
technician -> email_id |
technician.is_technician
|
request.technician.is_technician | boolean |
technician -> is_technician |
technician.sms_mail
|
request.technician.sms_mail | string |
technician -> sms_mail |
technician.mobile
|
request.technician.mobile | string |
technician -> mobile |
technician.last_name
|
request.technician.last_name | string |
technician -> last_name |
technician.user_scope
|
request.technician.user_scope | string |
technician -> user_scope |
technician.sms_mail_id
|
request.technician.sms_mail_id | string |
technician -> sms_mail_id |
technician.cost_per_hour
|
request.technician.cost_per_hour | string |
technician -> cost_per_hour |
technician.phone
|
request.technician.phone | string |
technician -> phone |
technician.name
|
request.technician.name | string |
technician -> name |
technician.id
|
request.technician.id | string |
technician -> id |
technician.photo_url
|
request.technician.photo_url | string |
technician -> photo_url |
technician.is_vip_user
|
request.technician.is_vip_user | boolean |
technician -> is_vip_user |
technician.department.id
|
request.technician.department.id | string |
technician -> department -> id |
technician.first_name
|
request.technician.first_name | string |
technician -> first_name |
technician.job_title
|
request.technician.job_title | string |
technician -> job_title |
has_problem
|
request.has_problem | boolean |
has_problem |
due_by_time.display_value
|
request.due_by_time.display_value | string |
due_by_time -> display_value |
due_by_time.value
|
request.due_by_time.value | string |
due_by_time -> value |
is_fcr
|
request.is_fcr | boolean |
is_fcr |
has_project
|
request.has_project | boolean |
has_project |
site.deleted
|
request.site.deleted | boolean |
site -> deleted |
site.name
|
request.site.name | string |
site -> name |
site.id
|
request.site.id | string |
site -> id |
is_first_response_overdue
|
request.is_first_response_overdue | boolean |
is_first_response_overdue |
completed_time
|
request.completed_time | object |
completed_time |
unreplied_count
|
request.unreplied_count | integer |
unreplied_count |
email_bcc
|
request.email_bcc | array of |
email_bcc |
category.deleted
|
request.category.deleted | boolean |
category -> deleted |
category.name
|
request.category.name | string |
category -> name |
category.id
|
request.category.id | string |
category -> id |
maintenance
|
request.maintenance | object |
maintenance |
Update Change
Update an existing change
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Service Desk Instance
|
serviceDeskInstance | True | string |
Select the ServiceDesk Plus Cloud instance where the API call must be placed |
Change Id
|
id | True | string |
Specify change ID |
Title
|
title | string |
Specify change title |
|
Status Comment
|
comment | string |
Specify change status comment |
|
Change Template
|
name | string |
Specify change template name |
|
Change Requester
|
name | string |
Specify change requester name |
|
Site
|
name | string |
Specify site for the change |
|
Group
|
name | string |
Specify group for the change |
|
Description
|
description | string |
Type change description |
|
Change Owner Email Address
|
email_id | string |
Type change owner's email address |
|
Change Type
|
name | string |
Specify change type |
|
Priority
|
name | string |
Specify change priority |
|
Urgency
|
name | string |
Specify change urgency |
|
Impact
|
name | string |
Specify change impact |
|
Change Risk
|
name | string |
Specify change risk |
|
Reason for Change
|
name | string |
Specify reason for initiating change |
|
Category
|
name | string |
Specify change category for the change |
|
Sub Category
|
name | string |
Specify change subcategory for a the change |
|
Item
|
name | string |
Specify change item |
|
name
|
name | string |
Provide assets to be associated with the change |
|
Additional Fields
|
udf_fields | string |
Specify additional fields(e.g. {"udf_char1":"value","udf_char2":"value",..}) |
Returns
Name | Path | Type | Description |
---|---|---|---|
status_code
|
response_status.status_code | integer |
status_code |
status
|
response_status.status | string |
status |
roll_out_plan.roll_out_plan_updated_on.display_value
|
change.roll_out_plan.roll_out_plan_updated_on.display_value | string |
roll_out_plan -> roll_out_plan_updated_on -> display_value |
roll_out_plan.roll_out_plan_updated_on.value
|
change.roll_out_plan.roll_out_plan_updated_on.value | string |
roll_out_plan -> roll_out_plan_updated_on -> value |
roll_out_plan.roll_out_plan_updated_by.email_id
|
change.roll_out_plan.roll_out_plan_updated_by.email_id | string |
roll_out_plan -> roll_out_plan_updated_by -> email_id |
roll_out_plan.roll_out_plan_updated_by.is_technician
|
change.roll_out_plan.roll_out_plan_updated_by.is_technician | boolean |
roll_out_plan -> roll_out_plan_updated_by -> is_technician |
roll_out_plan.roll_out_plan_updated_by.sms_mail
|
change.roll_out_plan.roll_out_plan_updated_by.sms_mail | string |
roll_out_plan -> roll_out_plan_updated_by -> sms_mail |
roll_out_plan.roll_out_plan_updated_by.mobile
|
change.roll_out_plan.roll_out_plan_updated_by.mobile | string |
roll_out_plan -> roll_out_plan_updated_by -> mobile |
roll_out_plan.roll_out_plan_updated_by.last_name
|
change.roll_out_plan.roll_out_plan_updated_by.last_name | string |
roll_out_plan -> roll_out_plan_updated_by -> last_name |
roll_out_plan.roll_out_plan_updated_by.user_scope
|
change.roll_out_plan.roll_out_plan_updated_by.user_scope | string |
roll_out_plan -> roll_out_plan_updated_by -> user_scope |
roll_out_plan.roll_out_plan_updated_by.sms_mail_id
|
change.roll_out_plan.roll_out_plan_updated_by.sms_mail_id | string |
roll_out_plan -> roll_out_plan_updated_by -> sms_mail_id |
roll_out_plan.roll_out_plan_updated_by.phone
|
change.roll_out_plan.roll_out_plan_updated_by.phone | string |
roll_out_plan -> roll_out_plan_updated_by -> phone |
roll_out_plan.roll_out_plan_updated_by.name
|
change.roll_out_plan.roll_out_plan_updated_by.name | string |
roll_out_plan -> roll_out_plan_updated_by -> name |
roll_out_plan.roll_out_plan_updated_by.id
|
change.roll_out_plan.roll_out_plan_updated_by.id | string |
roll_out_plan -> roll_out_plan_updated_by -> id |
roll_out_plan.roll_out_plan_updated_by.photo_url
|
change.roll_out_plan.roll_out_plan_updated_by.photo_url | string |
roll_out_plan -> roll_out_plan_updated_by -> photo_url |
roll_out_plan.roll_out_plan_updated_by.is_vip_user
|
change.roll_out_plan.roll_out_plan_updated_by.is_vip_user | boolean |
roll_out_plan -> roll_out_plan_updated_by -> is_vip_user |
roll_out_plan.roll_out_plan_updated_by.department
|
change.roll_out_plan.roll_out_plan_updated_by.department | string |
roll_out_plan -> roll_out_plan_updated_by -> department |
roll_out_plan.roll_out_plan_updated_by.first_name
|
change.roll_out_plan.roll_out_plan_updated_by.first_name | string |
roll_out_plan -> roll_out_plan_updated_by -> first_name |
roll_out_plan.roll_out_plan_updated_by.job_title
|
change.roll_out_plan.roll_out_plan_updated_by.job_title | string |
roll_out_plan -> roll_out_plan_updated_by -> job_title |
roll_out_plan.roll_out_plan_description
|
change.roll_out_plan.roll_out_plan_description | string |
roll_out_plan -> roll_out_plan_description |
emergency
|
change.emergency | boolean |
emergency |
change_type.color
|
change.change_type.color | string |
change_type -> color |
change_type.pre_approved
|
change.change_type.pre_approved | boolean |
change_type -> pre_approved |
change_type.name
|
change.change_type.name | string |
change_type -> name |
change_type.id
|
change.change_type.id | string |
change_type -> id |
review_details.next_review_on
|
change.review_details.next_review_on | object |
review_details -> next_review_on |
review_details.review_details_updated_by
|
change.review_details.review_details_updated_by | object |
review_details -> review_details_updated_by |
review_details.review_details_updated_on
|
change.review_details.review_details_updated_on | object |
review_details -> review_details_updated_on |
review_details.review_details_description
|
change.review_details.review_details_description | object |
review_details -> review_details_description |
assets
|
change.assets | array of object |
assets |
assets.site
|
change.assets.site | object |
assets -> site |
assets.name
|
change.assets.name | string |
assets -> name |
assets.id
|
change.assets.id | string |
assets -> id |
configuration_items
|
change.configuration_items | array of |
configuration_items |
workflow_instance_details.id
|
change.workflow_instance_details.id | string |
workflow_instance_details -> id |
workflow_instance_details.status.name
|
change.workflow_instance_details.status.name | string |
workflow_instance_details -> status -> name |
workflow_instance_details.status.id
|
change.workflow_instance_details.status.id | string |
workflow_instance_details -> status -> id |
rel.releases
|
change.rel.releases | object |
rel -> releases |
id
|
change.id | string |
change -> id |
change_requester.email_id
|
change.change_requester.email_id | string |
change_requester -> email_id |
change_requester.is_technician
|
change.change_requester.is_technician | boolean |
change_requester -> is_technician |
change_requester.sms_mail
|
change.change_requester.sms_mail | string |
change_requester -> sms_mail |
change_requester.mobile
|
change.change_requester.mobile | string |
change_requester -> mobile |
change_requester.last_name
|
change.change_requester.last_name | string |
change_requester -> last_name |
change_requester.user_scope
|
change.change_requester.user_scope | string |
change_requester -> user_scope |
change_requester.sms_mail_id
|
change.change_requester.sms_mail_id | string |
change_requester -> sms_mail_id |
change_requester.phone
|
change.change_requester.phone | string |
change_requester -> phone |
change_requester.name
|
change.change_requester.name | string |
change_requester -> name |
change_requester.id
|
change.change_requester.id | string |
change_requester -> id |
change_requester.photo_url
|
change.change_requester.photo_url | string |
change_requester -> photo_url |
change_requester.is_vip_user
|
change.change_requester.is_vip_user | boolean |
change_requester -> is_vip_user |
change_requester.department
|
change.change_requester.department | string |
change_requester -> department |
change_requester.first_name
|
change.change_requester.first_name | string |
change_requester -> first_name |
change_requester.job_title
|
change.change_requester.job_title | string |
change_requester -> job_title |
group.site
|
change.group.site | object |
group -> site |
group.deleted
|
change.group.deleted | boolean |
group -> deleted |
group.name
|
change.group.name | string |
group -> name |
group.id
|
change.group.id | string |
group -> id |
created_time.display_value
|
change.created_time.display_value | string |
created_time -> display_value |
created_time.value
|
change.created_time.value | string |
created_time -> value |
item.name
|
change.item.name | string |
item -> name |
item.id
|
change.item.id | string |
item -> id |
workflow.validated
|
change.workflow.validated | boolean |
workflow -> validated |
workflow.name
|
change.workflow.name | string |
workflow -> name |
workflow.id
|
change.workflow.id | string |
workflow -> id |
approval_status
|
change.approval_status | string |
approval_status |
impact.name
|
change.impact.name | string |
impact -> name |
impact.id
|
change.impact.id | string |
impact -> id |
release_details.release_actual_start
|
change.release_details.release_actual_start | object |
release_details -> release_actual_start |
release_details.release_actual_end
|
change.release_details.release_actual_end | object |
release_details -> release_actual_end |
release_details.release_details_description
|
change.release_details.release_details_description | string |
release_details -> release_details_description |
release_details.release_scheduled_end.display_value
|
change.release_details.release_scheduled_end.display_value | string |
release_details -> release_scheduled_end -> display_value |
release_details.release_scheduled_end.value
|
change.release_details.release_scheduled_end.value | string |
release_details -> release_scheduled_end -> value |
release_details.release_details_updated_on.display_value
|
change.release_details.release_details_updated_on.display_value | string |
release_details -> release_details_updated_on -> display_value |
release_details.release_details_updated_on.value
|
change.release_details.release_details_updated_on.value | string |
release_details -> release_details_updated_on -> value |
release_details.release_scheduled_start.display_value
|
change.release_details.release_scheduled_start.display_value | string |
release_details -> release_scheduled_start -> display_value |
release_details.release_scheduled_start.value
|
change.release_details.release_scheduled_start.value | string |
release_details -> release_scheduled_start -> value |
release_details.release_details_updated_by.email_id
|
change.release_details.release_details_updated_by.email_id | string |
release_details -> release_details_updated_by -> email_id |
release_details.release_details_updated_by.is_technician
|
change.release_details.release_details_updated_by.is_technician | boolean |
release_details -> release_details_updated_by -> is_technician |
release_details.release_details_updated_by.sms_mail
|
change.release_details.release_details_updated_by.sms_mail | string |
release_details -> release_details_updated_by -> sms_mail |
release_details.release_details_updated_by.mobile
|
change.release_details.release_details_updated_by.mobile | string |
release_details -> release_details_updated_by -> mobile |
release_details.release_details_updated_by.last_name
|
change.release_details.release_details_updated_by.last_name | string |
release_details -> release_details_updated_by -> last_name |
release_details.release_details_updated_by.user_scope
|
change.release_details.release_details_updated_by.user_scope | string |
release_details -> release_details_updated_by -> user_scope |
release_details.release_details_updated_by.sms_mail_id
|
change.release_details.release_details_updated_by.sms_mail_id | string |
release_details -> release_details_updated_by -> sms_mail_id |
release_details.release_details_updated_by.phone
|
change.release_details.release_details_updated_by.phone | string |
release_details -> release_details_updated_by -> phone |
release_details.release_details_updated_by.name
|
change.release_details.release_details_updated_by.name | string |
release_details -> release_details_updated_by -> name |
release_details.release_details_updated_by.id
|
change.release_details.release_details_updated_by.id | string |
release_details -> release_details_updated_by -> id |
release_details.release_details_updated_by.photo_url
|
change.release_details.release_details_updated_by.photo_url | string |
release_details -> release_details_updated_by -> photo_url |
release_details.release_details_updated_by.is_vip_user
|
change.release_details.release_details_updated_by.is_vip_user | boolean |
release_details -> release_details_updated_by -> is_vip_user |
release_details.release_details_updated_by.department
|
change.release_details.release_details_updated_by.department | string |
release_details -> release_details_updated_by -> department |
release_details.release_details_updated_by.first_name
|
change.release_details.release_details_updated_by.first_name | string |
release_details -> release_details_updated_by -> first_name |
release_details.release_details_updated_by.job_title
|
change.release_details.release_details_updated_by.job_title | string |
release_details -> release_details_updated_by -> job_title |
priority.color
|
change.priority.color | string |
priority -> color |
priority.name
|
change.priority.name | string |
priority -> name |
priority.id
|
change.priority.id | string |
priority -> id |
scheduled_end_time.display_value
|
change.scheduled_end_time.display_value | string |
scheduled_end_time -> display_value |
scheduled_end_time.value
|
change.scheduled_end_time.value | string |
scheduled_end_time -> value |
uat_details.uat_scheduled_start
|
change.uat_details.uat_scheduled_start | object |
uat_details -> uat_scheduled_start |
uat_details.uat_scheduled_end
|
change.uat_details.uat_actual_end | object |
uat_details -> uat_actual_end |
uat_details.uat_details_updated_by.email_id
|
change.uat_details.uat_details_updated_by.email_id | string |
uat_details -> uat_details_updated_by -> email_id |
uat_details.uat_details_updated_by.is_technician
|
change.uat_details.uat_details_updated_by.is_technician | boolean |
uat_details -> uat_details_updated_by -> is_technician |
uat_details.uat_details_updated_by.sms_mail
|
change.uat_details.uat_details_updated_by.sms_mail | string |
uat_details -> uat_details_updated_by -> sms_mail |
uat_details.uat_details_updated_by.mobile
|
change.uat_details.uat_details_updated_by.mobile | string |
uat_details -> uat_details_updated_by -> mobile |
uat_details.uat_details_updated_by.last_name
|
change.uat_details.uat_details_updated_by.last_name | string |
uat_details -> uat_details_updated_by -> last_name |
uat_details.uat_details_updated_by.user_scope
|
change.uat_details.uat_details_updated_by.user_scope | string |
uat_details -> uat_details_updated_by -> user_scope |
uat_details.uat_details_updated_by.sms_mail_id
|
change.uat_details.uat_details_updated_by.sms_mail_id | string |
uat_details -> uat_details_updated_by -> sms_mail_id |
uat_details.uat_details_updated_by.phone
|
change.uat_details.uat_details_updated_by.phone | string |
uat_details -> uat_details_updated_by -> phone |
uat_details.uat_details_updated_by.name
|
change.uat_details.uat_details_updated_by.name | string |
uat_details -> uat_details_updated_by -> name |
uat_details.uat_details_updated_by.id
|
change.uat_details.uat_details_updated_by.id | string |
uat_details -> uat_details_updated_by -> id |
uat_details.uat_details_updated_by.photo_url
|
change.uat_details.uat_details_updated_by.photo_url | string |
uat_details -> uat_details_updated_by -> photo_url |
uat_details.uat_details_updated_by.is_vip_user
|
change.uat_details.uat_details_updated_by.is_vip_user | boolean |
uat_details -> uat_details_updated_by -> is_vip_user |
uat_details.uat_details_updated_by.department
|
change.uat_details.uat_details_updated_by.department | string |
uat_details -> uat_details_updated_by -> department |
uat_details.uat_details_updated_by.first_name
|
change.uat_details.uat_details_updated_by.first_name | string |
uat_details -> uat_details_updated_by -> first_name |
uat_details.uat_details_updated_by.job_title
|
change.uat_details.uat_details_updated_by.job_title | string |
uat_details -> uat_details_updated_by -> job_title |
uat_details.uat_details_description
|
change.uat_details.uat_details_description | string |
uat_details -> uat_details_description |
uat_details.uat_details_updated_on.display_value
|
change.uat_details.uat_details_updated_on.display_value | string |
uat_details -> uat_details_updated_on -> display_value |
uat_details.uat_details_updated_on.value
|
change.uat_details.uat_details_updated_on.value | string |
uat_details -> uat_details_updated_on -> value |
uat_details.uat_scheduled_end
|
change.uat_details.uat_scheduled_end | object |
uat_details -> uat_scheduled_end |
uat_details.uat_actual_start
|
change.uat_details.uat_actual_start | object |
uat_details -> uat_actual_start |
reason_for_change.name
|
change.reason_for_change.name | string |
reason_for_change -> name |
reason_for_change.id
|
change.reason_for_change.id | string |
reason_for_change -> id |
impact_details.impact_details_updated_on.display_value
|
change.impact_details.impact_details_updated_on.display_value | string |
impact_details -> impact_details_updated_on -> display_value |
impact_details.impact_details_updated_on.value
|
change.impact_details.impact_details_updated_on.value | string |
impact_details -> impact_details_updated_on -> value |
impact_details.impact_details_updated_by.email_id
|
change.impact_details.impact_details_updated_by.email_id | string |
impact_details -> impact_details_updated_by -> email_id |
impact_details.impact_details_updated_by.is_technician
|
change.impact_details.impact_details_updated_by.is_technician | boolean |
impact_details -> impact_details_updated_by -> is_technician |
impact_details.impact_details_updated_by.sms_mail
|
change.impact_details.impact_details_updated_by.sms_mail | string |
impact_details -> impact_details_updated_by -> sms_mail |
impact_details.impact_details_updated_by.mobile
|
change.impact_details.impact_details_updated_by.mobile | string |
impact_details -> impact_details_updated_by -> mobile |
impact_details.impact_details_updated_by.last_name
|
change.impact_details.impact_details_updated_by.last_name | string |
impact_details -> impact_details_updated_by -> last_name |
impact_details.impact_details_updated_by.user_scope
|
change.impact_details.impact_details_updated_by.user_scope | string |
impact_details -> impact_details_updated_by -> user_scope |
impact_details.impact_details_updated_by.sms_mail_id
|
change.impact_details.impact_details_updated_by.sms_mail_id | string |
impact_details -> impact_details_updated_by -> sms_mail_id |
impact_details.impact_details_updated_by.phone
|
change.impact_details.impact_details_updated_by.phone | string |
impact_details -> impact_details_updated_by -> phone |
impact_details.impact_details_updated_by.name
|
change.impact_details.impact_details_updated_by.name | string |
impact_details -> impact_details_updated_by -> name |
impact_details.impact_details_updated_by.id
|
change.impact_details.impact_details_updated_by.id | string |
impact_details -> impact_details_updated_by -> id |
impact_details.impact_details_updated_by.photo_url
|
change.impact_details.impact_details_updated_by.photo_url | string |
impact_details -> impact_details_updated_by -> photo_url |
impact_details.impact_details_updated_by.is_vip_user
|
change.impact_details.impact_details_updated_by.is_vip_user | boolean |
impact_details -> impact_details_updated_by -> is_vip_user |
impact_details.impact_details_updated_by.department
|
change.impact_details.impact_details_updated_by.department | string |
impact_details -> impact_details_updated_by -> department |
impact_details.impact_details_updated_by.first_name
|
change.impact_details.impact_details_updated_by.first_name | string |
impact_details -> impact_details_updated_by -> first_name |
impact_details.impact_details_updated_by.job_title
|
change.impact_details.impact_details_updated_by.job_title | string |
impact_details -> impact_details_updated_by -> job_title |
impact_details.impact_details_description
|
change.impact_details.impact_details_description | string |
impact_details -> impact_details_description |
subcategory.name
|
change.subcategory.name | string |
subcategory -> name |
subcategory.id
|
change.subcategory.id | string |
subcategory -> id |
deleted_time
|
change.deleted_time | object |
deleted_time |
is_freeze_conflicted
|
change.is_freeze_conflicted | boolean |
is_freeze_conflicted |
status.internal_name
|
change.status.internal_name | string |
status -> internal_name |
status.stage.id
|
change.status.stage.id | string |
status -> stage -> id |
status.name
|
change.status.name | string |
status -> name |
status.id
|
change.status.id | string |
status -> id |
scheduled_start_time.display_value
|
change.scheduled_start_time.display_value | string |
scheduled_start_time -> display_value |
scheduled_start_time.value
|
change.scheduled_start_time.value | string |
scheduled_start_time -> value |
template.inactive
|
change.template.inactive | boolean |
template -> inactive |
template.name
|
change.template.name | string |
template -> name |
template.id
|
change.template.id | string |
template -> id |
has_release_association
|
change.has_release_association | boolean |
has_release_association |
attachments
|
change.attachments | array of |
attachments |
display_id.display_value
|
change.display_id.display_value | string |
display_id -> display_value |
display_id.value
|
change.display_id.value | string |
display_id -> value |
roles
|
change.roles | array of object |
roles |
roles.role.internal_name
|
change.roles.role.internal_name | string |
roles -> role -> internal_name |
roles.role.user_type
|
change.roles.role.user_type | string |
roles -> role -> user_type |
roles.role.name
|
change.roles.role.name | string |
roles -> role -> name |
roles.role.id
|
change.roles.role.id | string |
roles -> role -> id |
roles.id
|
change.roles.id | string |
roles -> id |
roles.user.email_id
|
change.roles.user.email_id | string |
roles -> user -> email_id |
roles.user.is_technician
|
change.roles.user.is_technician | boolean |
roles -> user -> is_technician |
roles.user.sms_mail
|
change.roles.user.sms_mail | string |
roles -> user -> sms_mail |
roles.user.mobile
|
change.roles.user.mobile | string |
roles -> user -> mobile |
roles.user.last_name
|
change.roles.user.last_name | string |
roles -> user -> last_name |
roles.user.user_scope
|
change.roles.user.user_scope | string |
roles -> user -> user_scope |
roles.user.sms_mail_id
|
change.roles.user.sms_mail_id | string |
roles -> user -> sms_mail_id |
roles.user.phone
|
change.roles.user.phone | string |
roles -> user -> phone |
roles.user.name
|
change.roles.user.name | string |
roles -> user -> name |
roles.user.id
|
change.roles.user.id | string |
roles -> user -> id |
roles.user.photo_url
|
change.roles.user.photo_url | string |
roles -> user -> photo_url |
roles.user.is_vip_user
|
change.roles.user.is_vip_user | boolean |
roles -> user -> is_vip_user |
roles.user.department.site.deleted
|
change.roles.user.department.site.deleted | boolean |
roles -> user -> department -> site -> deleted |
roles.user.department.site.name
|
change.roles.user.department.site.name | string |
roles -> user -> department -> site -> name |
roles.user.department.site.id
|
change.roles.user.department.site.id | string |
roles -> user -> department -> site -> id |
roles.user.department.name
|
change.roles.user.department.name | string |
roles -> user -> department -> name |
roles.user.department.id
|
change.roles.user.department.id | string |
roles -> user -> department -> id |
roles.user.first_name
|
change.roles.user.first_name | string |
roles -> user -> first_name |
roles.user.job_title
|
change.roles.user.job_title | string |
roles -> user ->job_title |
description
|
change.description | string |
description |
title
|
change.title | string |
title |
change_owner.email_id
|
change.change_owner.email_id | string |
change_owner -> email_id |
change_owner.is_technician
|
change.change_owner.is_technician | boolean |
change_owner -> is_technician |
change_owner.sms_mail
|
change.change_owner.sms_mail | string |
change_owner -> sms_mail |
change_owner.mobile
|
change.change_owner.mobile | string |
change_owner -> mobile |
change_owner.last_name
|
change.change_owner.last_name | string |
change_owner -> last_name |
change_owner.user_scope
|
change.change_owner.user_scope | string |
change_owner -> user_scope |
change_owner.sms_mail_id
|
change.change_owner.sms_mail_id | string |
change_owner -> sms_mail_id |
change_owner.cost_per_hour
|
change.change_owner.cost_per_hour | string |
change_owner -> cost_per_hour |
change_owner.phone
|
change.change_owner.phone | string |
change_owner -> phone |
change_owner.name
|
change.change_owner.name | string |
change_owner -> name |
change_owner.id
|
change.change_owner.id | string |
change_owner -> id |
change_owner.photo_url
|
change.change_owner.photo_url | string |
change_owner -> photo_url |
change_owner.is_vip_user
|
change.change_owner.is_vip_user | boolean |
change_owner -> is_vip_user |
change_owner.department
|
change.change_owner.department | string |
change_owner -> department |
change_owner.first_name
|
change.change_owner.first_name | string |
change_owner -> first_name |
change_owner.job_title
|
change.change_owner.job_title | string |
change_owner -> job_title |
urgency.name
|
change.urgency.name | string |
urgency -> name |
urgency.id
|
change.urgency.id | string |
urgency -> id |
close_details.close_details_updated_on.display_value
|
change.close_details.close_details_updated_on.display_value | string |
close_details -> close_details_updated_on -> display_value |
close_details.close_details_updated_on.value
|
change.close_details.close_details_updated_on.value | string |
close_details -> close_details_updated_on -> value |
close_details.close_details_description
|
change.close_details.close_details_description | string |
close_details -> close_details_description |
close_details.closure_code.name
|
change.close_details.closure_code.name | string |
close_details -> closure_code -> name |
close_details.closure_code.id
|
change.close_details.closure_code.id | string |
close_details -> closure_code -> id |
close_details.close_details_updated_by.email_id
|
change.close_details.close_details_updated_by.email_id | string |
close_details -> close_details_updated_by -> email_id |
close_details.close_details_updated_by.is_technician
|
change.close_details.close_details_updated_by.is_technician | boolean |
close_details -> close_details_updated_by -> is_technician |
close_details.close_details_updated_by.sms_mail
|
change.close_details.close_details_updated_by.sms_mail | string |
close_details -> close_details_updated_by -> sms_mail |
close_details.close_details_updated_by.mobile
|
change.close_details.close_details_updated_by.mobile | string |
close_details -> close_details_updated_by -> mobile |
close_details.close_details_updated_by.last_name
|
change.close_details.close_details_updated_by.last_name | string |
close_details -> close_details_updated_by -> last_name |
close_details.close_details_updated_by.user_scope
|
change.close_details.close_details_updated_by.user_scope | string |
close_details -> close_details_updated_by -> user_scope |
close_details.close_details_updated_by.sms_mail_id
|
change.close_details.close_details_updated_by.sms_mail_id | string |
close_details -> close_details_updated_by -> sms_mail_id |
close_details.close_details_updated_by.phone
|
change.close_details.close_details_updated_by.phone | string |
close_details -> close_details_updated_by -> phone |
close_details.close_details_updated_by.name
|
change.close_details.close_details_updated_by.name | string |
close_details -> close_details_updated_by -> name |
close_details.close_details_updated_by.id
|
change.close_details.close_details_updated_by.id | string |
close_details -> close_details_updated_by -> id |
close_details.close_details_updated_by.photo_url
|
change.close_details.close_details_updated_by.photo_url | string |
close_details -> close_details_updated_by -> photo_url |
close_details.close_details_updated_by.is_vip_user
|
change.close_details.close_details_updated_by.is_vip_user | boolean |
close_details -> close_details_updated_by -> is_vip_user |
close_details.close_details_updated_by.department
|
change.close_details.close_details_updated_by.department | string |
close_details -> close_details_updated_by -> department |
close_details.close_details_updated_by.first_name
|
change.close_details.close_details_updated_by.first_name | string |
close_details -> close_details_updated_by -> first_name |
close_details.close_details_updated_by.job_title
|
change.close_details.close_details_updated_by.job_title | string |
close_details -> close_details_updated_by -> job_title |
change_manager
|
change.change_manager | string |
change_manager |
is_freezed
|
change.is_freezed | boolean |
is_freezed |
retrospective
|
change.retrospective | boolean |
retrospective |
checklist.checklist_description
|
change.checklist.checklist_description | string |
checklist -> checklist_description |
checklist.checklist_updated_on.display_value
|
change.checklist.checklist_updated_on.display_value | string |
checklist -> checklist_updated_on -> display_value |
checklist.checklist_updated_on.value
|
change.checklist.checklist_updated_on.value | string |
checklist -> checklist_updated_on -> value |
checklist.checklist_updated_by.email_id
|
change.checklist.checklist_updated_by.email_id | string |
checklist -> checklist_updated_by -> email_id |
checklist.checklist_updated_by.is_technician
|
change.checklist.checklist_updated_by.is_technician | boolean |
checklist -> checklist_updated_by -> is_technician |
checklist.checklist_updated_by.sms_mail
|
change.checklist.checklist_updated_by.sms_mail | string |
checklist -> checklist_updated_by -> sms_mail |
checklist.checklist_updated_by.mobile
|
change.checklist.checklist_updated_by.mobile | string |
checklist -> checklist_updated_by -> mobile |
checklist.checklist_updated_by.last_name
|
change.checklist.checklist_updated_by.last_name | string |
checklist -> checklist_updated_by -> last_name |
checklist.checklist_updated_by.user_scope
|
change.checklist.checklist_updated_by.user_scope | string |
checklist -> checklist_updated_by -> user_scope |
checklist.checklist_updated_by.sms_mail_id
|
change.checklist.checklist_updated_by.sms_mail_id | string |
checklist -> checklist_updated_by -> sms_mail_id |
checklist.checklist_updated_by.phone
|
change.checklist.checklist_updated_by.phone | string |
checklist -> checklist_updated_by -> phone |
checklist.checklist_updated_by.name
|
change.checklist.checklist_updated_by.name | string |
checklist -> checklist_updated_by -> name |
checklist.checklist_updated_by.id
|
change.checklist.checklist_updated_by.id | string |
checklist -> checklist_updated_by -> id |
checklist.checklist_updated_by.photo_url
|
change.checklist.checklist_updated_by.photo_url | string |
checklist -> checklist_updated_by -> photo_url |
checklist.checklist_updated_by.is_vip_user
|
change.checklist.checklist_updated_by.is_vip_user | boolean |
checklist -> checklist_updated_by -> is_vip_user |
checklist.checklist_updated_by.department
|
change.checklist.checklist_updated_by.department | string |
checklist -> checklist_updated_by -> department |
checklist.checklist_updated_by.first_name
|
change.checklist.checklist_updated_by.first_name | string |
checklist -> checklist_updated_by -> first_name |
checklist.checklist_updated_by.job_title
|
change.checklist.checklist_updated_by.job_title | string |
checklist -> checklist_updated_by -> job_title |
services
|
change.services | array of object |
services |
services.inactive
|
change.services.inactive | boolean |
services -> inactive |
services.name
|
change.services.name | string |
services -> name |
services.id
|
change.services.id | string |
services -> id |
services.sort_index
|
change.services.sort_index | integer |
services -> sort_index |
back_out_plan.back_out_plan_updated_by.email_id
|
change.back_out_plan.back_out_plan_updated_by.email_id | string |
back_out_plan -> back_out_plan_updated_by -> email_id |
back_out_plan.back_out_plan_updated_by.is_technician
|
change.back_out_plan.back_out_plan_updated_by.is_technician | boolean |
back_out_plan -> back_out_plan_updated_by -> is_technician |
back_out_plan.back_out_plan_updated_by.sms_mail
|
change.back_out_plan.back_out_plan_updated_by.sms_mail | string |
back_out_plan -> back_out_plan_updated_by -> sms_mail |
back_out_plan.back_out_plan_updated_by.mobile
|
change.back_out_plan.back_out_plan_updated_by.mobile | string |
back_out_plan -> back_out_plan_updated_by -> mobile |
back_out_plan.back_out_plan_updated_by.last_name
|
change.back_out_plan.back_out_plan_updated_by.last_name | string |
back_out_plan -> back_out_plan_updated_by -> last_name |
back_out_plan.back_out_plan_updated_by.user_scope
|
change.back_out_plan.back_out_plan_updated_by.user_scope | string |
back_out_plan -> back_out_plan_updated_by -> user_scope |
back_out_plan.back_out_plan_updated_by.sms_mail_id
|
change.back_out_plan.back_out_plan_updated_by.sms_mail_id | string |
back_out_plan -> back_out_plan_updated_by -> sms_mail_id |
back_out_plan.back_out_plan_updated_by.phone
|
change.back_out_plan.back_out_plan_updated_by.phone | string |
back_out_plan -> back_out_plan_updated_by -> phone |
back_out_plan.back_out_plan_updated_by.name
|
change.back_out_plan.back_out_plan_updated_by.name | string |
back_out_plan -> back_out_plan_updated_by -> name |
back_out_plan.back_out_plan_updated_by.id
|
change.back_out_plan.back_out_plan_updated_by.id | string |
back_out_plan -> back_out_plan_updated_by -> id |
back_out_plan.back_out_plan_updated_by.photo_url
|
change.back_out_plan.back_out_plan_updated_by.photo_url | string |
back_out_plan -> back_out_plan_updated_by -> photo_url |
back_out_plan.back_out_plan_updated_by.is_vip_user
|
change.back_out_plan.back_out_plan_updated_by.is_vip_user | boolean |
back_out_plan -> back_out_plan_updated_by -> is_vip_user |
back_out_plan.back_out_plan_updated_by.department
|
change.back_out_plan.back_out_plan_updated_by.department | string |
back_out_plan -> back_out_plan_updated_by -> department |
back_out_plan.back_out_plan_updated_by.first_name
|
change.back_out_plan.back_out_plan_updated_by.first_name | string |
back_out_plan -> back_out_plan_updated_by -> first_name |
back_out_plan.back_out_plan_updated_by.job_title
|
change.back_out_plan.back_out_plan_updated_by.job_title | string |
back_out_plan -> back_out_plan_updated_by -> job_title |
back_out_plan.back_out_plan_updated_on.display_value
|
change.back_out_plan.back_out_plan_updated_on.display_value | string |
back_out_plan -> back_out_plan_updated_on -> display_value |
back_out_plan.back_out_plan_updated_on.value
|
change.back_out_plan.back_out_plan_updated_on.value | string |
back_out_plan -> back_out_plan_updated_on -> value |
back_out_plan.back_out_plan_description
|
change.back_out_plan.back_out_plan_description | string |
back_out_plan -> back_out_plan_description |
site.site
|
change.site.deleted | boolean |
site -> deleted |
site.name
|
change.site.name | string |
site -> name |
site.id
|
change.site.id | string |
site -> id |
stage.internal_name
|
change.stage.internal_name | string |
stage -> internal_name |
stage.stage_index
|
change.stage.stage_index | integer |
stage -> stage_index |
stage.name
|
change.stage.name | string |
stage -> name |
stage.id
|
change.stage.id | string |
stage -> id |
completed_time.display_value
|
change.completed_time.display_value | string |
completed_time -> display_value |
completed_time.value
|
change.completed_time.value | string |
completed_time -> value |
risk.name
|
change.risk.name | string |
risk -> name |
risk.id
|
change.risk.id | string |
risk -> id |
category.deleted
|
change.category.deleted | boolean |
category -> deleted |
category.name
|
change.category.name | string |
category -> name |
category.id
|
change.category.id | string |
category -> id |
notes_present
|
change.notes_present | boolean |
notes_present |
Update Request
Update an existing request
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Service Desk Instance
|
serviceDeskInstance | True | string |
Select the ServiceDesk Plus Cloud instance where the API call must be placed |
Request Id
|
id | True | string |
Specify request ID |
Subject
|
subject | string |
Specify request subject |
|
Request Template
|
name | string |
Specify request template name |
|
Request Type
|
name | string |
Specify request type |
|
Requester
|
name | string |
Provide requester name |
|
Status
|
name | string |
Specify request status |
|
Technician Email Address
|
email_id | string |
Specify technician email address |
|
Site
|
name | string |
Specify request site |
|
Group
|
name | string |
Specify request group |
|
Description
|
description | string |
Type request description |
|
Priority
|
name | string |
Specify request priority |
|
Urgency
|
name | string |
Specify request urgency |
|
Impact
|
name | string |
Specify request impact |
|
Mode
|
name | string |
Specify request mode |
|
Category
|
name | string |
Specify request category |
|
Sub Category
|
name | string |
Specify request subcategory |
|
Item
|
name | string |
Specify request item |
|
name
|
name | string |
Provide assets to be associated with request |
|
Additional Fields
|
udf_fields | string |
Specify additional fields(e.g.{"udf_char1":"value","udf_char2":"value",..}) |
Returns
Name | Path | Type | Description |
---|---|---|---|
subject
|
request.subject | string |
Subject |
project.display_id.display_value
|
request.project.display_id.display_value | string |
project -> display_id -> display_value |
project.display_id.value
|
request.project.display_id.value | string |
project -> display_id -> value |
project.project_code
|
request.project.project_code | object |
project -> project_code |
project.id
|
request.project.id | string |
project -> id |
project.title
|
request.project.title | string |
project -> title |
resolution.content
|
request.resolution.content | string |
resolution -> content |
linked_to_request.request.display_id
|
request.linked_to_request.request.display_id | integer |
linked_to_request -> request -> display_id |
linked_to_request.request.subject
|
request.linked_to_request.request.subject | string |
linked_to_request -> request -> subject |
linked_to_request.request.id
|
request.linked_to_request.request.id | string |
linked_to_request -> request -> id |
linked_to_request.comments
|
request.linked_to_request.comments | string |
linked_to_request -> comments |
mode.name
|
request.mode.name | string |
mode -> name |
mode.id
|
request.mode.id | string |
mode -> id |
lifecycle
|
request.lifecycle | object |
lifecycle |
is_read
|
request.is_read | boolean |
is_read |
assets
|
request.assets | array of object |
assets |
assets.site
|
request.assets.site | object |
assets -> site |
assets.name
|
request.assets.name | string |
assets -> name |
assets.id
|
request.assets.id | string |
assets -> id |
cancellation_requested
|
request.cancellation_requested | boolean |
cancellation_requested |
is_trashed
|
request.is_trashed | boolean |
is_trashed |
has_change_initiated_request
|
request.has_change_initiated_request | boolean |
has_change_initiated_request |
id
|
request.id | string |
request -> id |
assigned_time.display_value
|
request.assigned_time.display_value | string |
assigned_time -> display_value |
assigned_time.value
|
request.assigned_time.value | string |
assigned_time -> value |
group.site
|
request.group.site | object |
group -> site |
group.deleted
|
request.group.deleted | boolean |
group -> deleted |
group.name
|
request.group.name | string |
group -> name |
group.id
|
request.group.id | string |
group -> id |
requester.email_id
|
request.requester.email_id | string |
requester -> email_id |
requester.is_technician
|
request.requester.is_technician | boolean |
requester -> is_technician |
requester.sms_mail
|
request.requester.sms_mail | string |
requester -> sms_mail |
requester.mobile
|
request.requester.mobile | string |
requester -> mobile |
requester.last_name
|
request.requester.last_name | string |
requester -> last_name |
requester.user_scope
|
request.requester.user_scope | string |
requester -> user_scope |
requester.sms_mail_id
|
request.requester.sms_mail_id | string |
requester -> sms_mail_id |
requester.phone
|
request.requester.phone | string |
requester -> phone |
requester.name
|
request.requester.name | string |
requester -> name |
requester.id
|
request.requester.id | string |
requester -> id |
requester.photo_url
|
request.requester.photo_url | string |
requester -> photo_url |
requester.is_vip_user
|
request.requester.is_vip_user | boolean |
requester -> is_vip_user |
requester.department
|
request.requester.department | object |
requester -> department |
requester.first_name
|
request.requester.first_name | string |
requester -> first_name |
requester.job_title
|
request.requester.job_title | string |
requester -> job_title |
email_to
|
request.email_to | array of |
email_to |
created_time.display_value
|
request.created_time.display_value | string |
created_time -> display_value |
created_time.value
|
request.created_time.value | string |
created_time -> value |
item.name
|
request.item.name | string |
item -> name |
item.id
|
request.item.id | string |
item -> id |
cancel_flag_comments
|
request.cancel_flag_comments | object |
cancel_flag_comments |
level.name
|
request.level.name | string |
level -> name |
level.id
|
request.level.id | string |
level -> id |
approval_status
|
request.approval_status | object |
approval_status |
impact.name
|
request.impact.name | string |
impact -> name |
impact.id
|
request.impact.id | string |
impact -> id |
service_category.inactive
|
request.service_category.inactive | boolean |
service_category -> inactive |
service_category.name
|
request.service_category.name | string |
service_category -> name |
service_category.id
|
request.service_category.id | string |
service_category -> id |
service_category.sort_index
|
request.service_category.sort_index | integer |
service_category -> sort_index |
sla.name
|
request.sla.name | string |
sla -> name |
sla.id
|
request.sla.id | string |
sla -> id |
resolved_time
|
request.resolved_time | object |
resolved_time |
priority.color
|
request.priority.color | string |
priority -> color |
priority.name
|
request.priority.name | string |
priority -> name |
priority.id
|
request.priority.id | string |
priority -> id |
created_by.email_id
|
request.created_by.email_id | string |
created_by -> email_id |
created_by.is_technician
|
request.created_by.is_technician | boolean |
created_by -> is_technician |
created_by.sms_mail
|
request.created_by.sms_mail | string |
created_by -> sms_mail |
created_by.mobile
|
request.created_by.mobile | string |
created_by -> mobile |
created_by.last_name
|
request.created_by.last_name | string |
created_by -> last_name |
created_by.user_scope
|
request.created_by.user_scope | string |
created_by -> user_scope |
created_by.sms_mail_id
|
request.created_by.sms_mail_id | string |
created_by -> sms_mail_id |
created_by.phone
|
request.created_by.phone | string |
created_by -> phone |
created_by.name
|
request.created_by.name | string |
created_by -> name |
created_by.id
|
request.created_by.id | string |
created_by -> id |
created_by.photo_url
|
request.created_by.photo_url | string |
created_by -> photo_url |
created_by.is_vip_user
|
request.created_by.is_vip_user | boolean |
created_by -> is_vip_user |
created_by.department
|
request.created_by.department | object |
created_by -> department |
created_by.first_name
|
request.created_by.first_name | string |
created_by -> first_name |
created_by.job_title
|
request.created_by.job_title | string |
created_by -> job_title |
scheduled_end_time.display_value
|
request.scheduled_end_time.display_value | string |
scheduled_end_time -> display_value |
scheduled_end_time.value
|
request.scheduled_end_time.value | string |
scheduled_end_time -> value |
first_response_due_by_time.display_value
|
request.first_response_due_by_time.display_value | string |
first_response_due_by_time -> display_value |
first_response_due_by_time.value
|
request.first_response_due_by_time.value | string |
first_response_due_by_time -> value |
is_escalated
|
request.is_escalated | boolean |
is_escalated |
last_updated_time.display_value
|
request.last_updated_time.display_value | string |
last_updated_time -> display_value |
last_updated_time.value
|
request.last_updated_time.value | string |
last_updated_time -> value |
has_notes
|
request.has_notes | boolean |
has_notes |
impact_details
|
request.impact_details | string |
impact_details |
subcategory.name
|
request.subcategory.name | string |
subcategory -> name |
subcategory.id
|
request.subcategory.id | string |
subcategory -> id |
deleted_time
|
request.deleted_time | object |
deleted_time |
email_cc
|
request.email_cc | array of string |
email_cc |
onhold_scheduler
|
request.onhold_scheduler | object |
onhold_scheduler |
status.in_progress
|
request.status.in_progress | boolean |
status -> in_progress |
status.internal_name
|
request.status.internal_name | string |
status -> internal_name |
status.stop_timer
|
request.status.stop_timer | boolean |
status -> stop_timer |
status.color
|
request.status.color | string |
status -> color |
status.name
|
request.status.name | string |
status -> name |
status.id
|
request.status.id | string |
status -> id |
scheduled_start_time.display_value
|
request.scheduled_start_time.display_value | string |
scheduled_start_time -> display_value |
scheduled_start_time.value
|
request.scheduled_start_time.value | string |
scheduled_start_time -> value |
template.name
|
request.template.name | string |
template -> name |
template.id
|
request.template.id | string |
template -> id |
email_ids_to_notify
|
request.email_ids_to_notify | array of string |
email_ids_to_notify |
attachments
|
request.attachments | array of |
attachments |
request_type.name
|
request.request_type.name | string |
request_type -> name |
request_type.id
|
request.request_type.id | string |
request_type -> id |
completed_by_denial
|
request.completed_by_denial | boolean |
completed_by_denial |
display_id
|
request.display_id | string |
display_id |
time_elapsed
|
request.time_elapsed | string |
time_elapsed |
notification_status
|
request.notification_status | object |
notification_status |
description
|
request.description | string |
description |
responded_time
|
request.responded_time | string |
responded_time |
is_service_request
|
request.is_service_request | boolean |
is_service_request |
deleted_assets
|
request.deleted_assets | array of |
deleted_assets |
urgency.name
|
request.urgency.name | string |
urgency -> name |
urgency.id
|
request.urgency.id | string |
urgency -> id |
has_request_initiated_change
|
request.has_request_initiated_change | boolean |
has_request_initiated_change |
request_template_task_ids
|
request.request_template_task_ids | array of object |
request_template_task_ids |
request_template_task_ids.id
|
request.request_template_task_ids.id | string |
request_template_task_ids -> id |
department
|
request.department | object |
department |
is_reopened
|
request.is_reopened | boolean |
is_reopened |
has_draft
|
request.has_draft | boolean |
has_draft |
has_attachments
|
request.has_attachments | boolean |
has_attachments |
has_linked_requests
|
request.has_linked_requests | boolean |
has_linked_requests |
is_overdue
|
request.is_overdue | boolean |
is_overdue |
technician.email_id
|
request.technician.email_id | string |
technician -> email_id |
technician.is_technician
|
request.technician.is_technician | boolean |
technician -> is_technician |
technician.sms_mail
|
request.technician.sms_mail | string |
technician -> sms_mail |
technician.mobile
|
request.technician.mobile | string |
technician -> mobile |
technician.last_name
|
request.technician.last_name | string |
technician -> last_name |
technician.user_scope
|
request.technician.user_scope | string |
technician -> user_scope |
technician.sms_mail_id
|
request.technician.sms_mail_id | string |
technician -> sms_mail_id |
technician.cost_per_hour
|
request.technician.cost_per_hour | string |
technician -> cost_per_hour |
technician.phone
|
request.technician.phone | string |
technician -> phone |
technician.name
|
request.technician.name | string |
technician -> name |
technician.id
|
request.technician.id | string |
technician -> id |
technician.photo_url
|
request.technician.photo_url | string |
technician -> photo_url |
technician.is_vip_user
|
request.technician.is_vip_user | boolean |
technician -> is_vip_user |
technician.department.id
|
request.technician.department.id | string |
technician -> department -> id |
technician.first_name
|
request.technician.first_name | string |
technician -> first_name |
technician.job_title
|
request.technician.job_title | string |
technician -> job_title |
has_problem
|
request.has_problem | boolean |
has_problem |
due_by_time.display_value
|
request.due_by_time.display_value | string |
due_by_time -> display_value |
due_by_time.value
|
request.due_by_time.value | string |
due_by_time -> value |
is_fcr
|
request.is_fcr | boolean |
is_fcr |
has_project
|
request.has_project | boolean |
has_project |
site.deleted
|
request.site.deleted | boolean |
site -> deleted |
site.name
|
request.site.name | string |
site -> name |
site.id
|
request.site.id | string |
site -> id |
is_first_response_overdue
|
request.is_first_response_overdue | boolean |
is_first_response_overdue |
completed_time
|
request.completed_time | object |
completed_time |
unreplied_count
|
request.unreplied_count | integer |
unreplied_count |
email_bcc
|
request.email_bcc | array of |
email_bcc |
category.deleted
|
request.category.deleted | boolean |
category -> deleted |
category.name
|
request.category.name | string |
category -> name |
category.id
|
request.category.id | string |
category -> id |
maintenance
|
request.maintenance | object |
maintenance |