API Gestão de mudanças
A API Gestão de mudanças fornece endpoints que permitem a integração de aplicações de terceiros com o processo ServiceNow Gestão de mudanças.
Use esta REST API para integrar seu processo de gestão de mudanças com aplicações externas e ao desenvolver ServiceNow aplicações do lado do cliente.
Esta REST API permite que os integradores:
- Inicie uma solicitação de mudança padrão a partir de um modelo de solicitação de mudança padrão publicado.
- Crie uma solicitação de mudança do tipo emergencial ou normal.
- Atualize qualquer campo que exista na tabela de solicitação de mudança para qualquer solicitação de mudança.
- Atualize qualquer campo existente na tabela de tarefas de mudança e nas tarefas de trabalho desde a criação até o fechamento/cancelamento.
- Recupere uma solicitação de mudança, modelo padrão, tarefa de solicitação de mudança ou modelo de mudança específico.
- Recupere várias solicitações de mudança, modelos padrão e tarefas de solicitação de mudança usando paginação.
- Executar avaliação de risco.
- Atualizar serviços afetados.
- Gere e processe qualquer atividade de aprovação relacionada a uma solicitação de mudança.
- Identifique possíveis conflitos de programação e identifique períodos em que não existem conflitos.
- Exclua solicitações de mudança, tarefas de solicitação de mudança e processos de verificação de conflitos.
- Crie um registro de solicitação de mudança com base em um registro de modelo de mudança.
- Recupera uma lista de estados disponíveis para a solicitação de mudança especificada, incluindo o estado atual.
- Tipos ITIL tradicionais: Standard, Emergency e Normal.
- Estados do modelo de mudança: Novo, Programado, Implementar, Revisar e Encerrado.
Você pode configurar modelos de mudança adicionais em sua instância ServiceNow e criar solicitações de mudança com base nesses modelos de mudança usando endpoints nesta API. Use os endpoints Gestão de mudanças - GET /sn_chg_rest/change/model/{sys_id} e Gestão de mudanças - GET /sn_chg_rest/change/model para obter os modelos de mudança disponíveis em uma instância. Em seguida, use o Gestão de mudanças - POST /sn_chg_rest/change para criar uma solicitação de mudança com base em um modelo de mudança especificado.
Para obter informações sobre como configurar modelos de mudança, consulte Configurar Gestão de mudanças.
- EXCLUIR: change_manager ou administrador
- GET: change_manager, itil, sn_change_read ou admin
- PATCH/POST: change_manager, itil ou admin
Além disso, os administradores podem definir propriedades de mudança para configurar o comportamento da Gestão de mudanças. Para obter uma lista dessas propriedades e uma descrição da funcionalidade disponível, consulte Propriedades do Gestão de mudanças.
Gestão de mudanças - DELETE /sn_chg_rest/change/{change_sys_id}/task/{task_sys_id}
Exclui a tarefa de solicitação de mudança identificada pelos sys_ids especificados.
Formato da URL
URL com controle de versão: /api/sn_chg_rest/{api_version}/change/{change_sys_id}/task/{task_sys_id}
URL padrão: /api/sn_chg_rest/change/{change_sys_id}/task/{task_sys_id}
Parâmetros de solicitação compatíveis
| Nome | Descrição |
|---|---|
| api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres |
| change_sys_id | Sys_id da solicitação de mudança à qual a tarefa está associada. Localizado na tabela Solicitação de mudança [change_request]. Verifica se a tarefa está realmente associada à solicitação de mudança especificada. Tipo de dados: cadeia de caracteres |
| task_sys_id | Sys_id da tarefa de solicitação de mudança a ser excluída. Localizado na tabela Tarefas de mudança [change_task]. Tipo de dados: cadeia de caracteres |
| Nome | Descrição |
|---|---|
| Nenhum(a) |
| Nome | Descrição |
|---|---|
| Nenhum(a) |
Cabeçalhos
Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.
| Cabeçalho | Descrição |
|---|---|
| Aceitar | Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json |
| Cabeçalho | Descrição |
|---|---|
| Nenhum(a) |
Códigos de status
Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.
| Código de status | Descrição |
|---|---|
| 200 | Bem-sucedido. A solicitação foi processada com sucesso. |
| 400 | Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada. |
| 401 | Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas. |
| 404 | Não encontrado. Não foi possível encontrar o registro especificado. |
| 500 | Erro Interno do Servidor. Ocorreu um erro de lógica no código do lado do servidor. |
Parâmetros do corpo da resposta (JSON ou XML)
| Nome | Descrição |
|---|---|
| pares de nome-valor | Todos os campos (chave) com seus valores associados para a tarefa de solicitação de mudança identificada antes da exclusão. Tipo de dados: objeto |
| primário | Informações da solicitação de mudança à qual esta tarefa foi associada. Tipo de dados: objeto |
| primário.display_value | Sys_id da tarefa primária a ser exibida em uma IU. Tipo de dados: cadeia de caracteres |
| primário.valor | Sys_id da tarefa primária. Tipo de dados: cadeia de caracteres |
| sys_id | Informações de Sys_id da solicitação de mudança excluída. Tipo de dados: objeto |
| sys_id.display_value | Sys_id da solicitação de mudança a ser exibida em uma IU. Tipo de dados: cadeia de caracteres |
| sys_id.value | Sys_id da solicitação de mudança. Tipo de dados: cadeia de caracteres |
Solicitação de cURL
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/0f4ac6c4b750230096c3e4f6ee11a9fe/task/12629ec4b750230096c3e4f6ee11a9d5" \
--request DELETE \
--header "Accept:application/json" \
--user "username":"password"{
result: [
{
sys_id: {
value: "12629ec4b750230096c3e4f6ee11a9d5",
display_value: "12629ec4b750230096c3e4f6ee11a9d5"
},
parent: {
value: "0f4ac6c4b750230096c3e4f6ee11a9fe",
display_value: "CHG0033046 "
},
..., // all valid fields in record, example below
short_description: {
value: "Retire both nodes",
display_value: "Retire both nodes"
}
}
]
}Gestão de mudanças - DELETE /sn_chg_rest/change/{sys_id}
Exclui a solicitação de mudança associada ao sys_id especificado.
Formato da URL
URL com controle de versão: /api/sn_chg_rest/{api_version}/change/{sys_id}
URL padrão: /api/sn_chg_rest/change/{sys_id}
Parâmetros de solicitação compatíveis
| Nome | Descrição |
|---|---|
| api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres |
| sys_id | Sys_id do registro de solicitação de mudança a ser excluído. Localizado na tabela Solicitação de mudança [change_request]. Tipo de dados: cadeia de caracteres |
| Nome | Descrição |
|---|---|
| Nenhum(a) |
| Nome | Descrição |
|---|---|
| Nenhum(a) |
Cabeçalhos
Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.
| Cabeçalho | Descrição |
|---|---|
| Aceitar | Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json |
| Cabeçalho | Descrição |
|---|---|
| Nenhum(a) |
Códigos de status
Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.
| Código de status | Descrição |
|---|---|
| 200 | Solicitação concluída com sucesso. |
| 400 | Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada. |
| 401 | Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas. |
| 404 | Não encontrado. Não foi possível encontrar o registro especificado. |
| 500 | Erro Interno do Servidor. Ocorreu um erro de lógica no código do lado do servidor. |
Parâmetros do corpo da resposta (JSON ou XML)
| Nome | Descrição |
|---|---|
| resultado | Registro de solicitação de mudança que foi excluído. Cada elemento neste objeto corresponde a um campo no registro da tabela Solicitação de mudança [change_request]. Tipo de dados: objeto |
Solicitação de cURL
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/b0dbda5347c12200e0ef563dbb9a718f" \
--request DELETE \
--header "Accept:application/json" \
--user "username":"password"
{
"result":
{
"reason": {
"display_value": "",
"value": ""
},
"parent": {
"display_value": "",
"value": ""
},
"watch_list": {
"display_value": "",
"value": ""
},
"proposed_change": {
"display_value": "",
"value": ""
},
"upon_reject": {
"display_value": "Cancel all future Tasks",
"value": "cancel"
},
"sys_updated_on": {
"display_value": "2015-07-06 11:59:27",
"value": "2015-07-06 18:59:27",
"display_value_internal": "2015-07-06 11:59:27"
},
"type": {
"display_value": "Standard",
"value": "standard"
},
"approval_history": {
"display_value": "",
"value": ""
},
"skills": {
"display_value": "",
"value": ""
},
"test_plan": {
"display_value": "--Confirm that there are no monitoring alerts for the router",
"value": "--Confirm that there are no monitoring alerts for the router"
},
"number": {
"display_value": "CHG0000024",
"value": "CHG0000024"
},
"is_bulk": {
"display_value": "false",
"value": false
},
"cab_delegate": {
"display_value": "",
"value": ""
},
"requested_by_date": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"ci_class": {
"display_value": "cmdb_ci",
"value": "cmdb_ci"
},
"state": {
"display_value": "Closed",
"value": 3.0
},
"sys_created_by": {
"display_value": "admin",
"value": "admin"
},
"knowledge": {
"display_value": "false",
"value": false
},
"order": {
"display_value": "",
"value": ""
},
"phase": {
"display_value": "Requested",
"value": "requested"
},
"cmdb_ci": {
"display_value": "",
"value": ""
},
"delivery_plan": {
"display_value": "",
"value": ""
},
"impact": {
"display_value": "3 - Low",
"value": 3.0
},
"contract": {
"display_value": "",
"value": ""
},
"active": {
"display_value": "false",
"value": false
},
"work_notes_list": {
"display_value": "",
"value": ""
},
"priority": {
"display_value": "4 - Low",
"value": 4.0
},
"sys_domain_path": {
"display_value": "/",
"value": "/"
},
"cab_recommendation": {
"display_value": "",
"value": ""
},
"production_system": {
"display_value": "false",
"value": false
},
"rejection_goto": {
"display_value": "",
"value": ""
},
"review_date": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"requested_by": {
"display_value": "System Administrator",
"value": "6816f79cc0a8016401c5a33be04be441"
},
"business_duration": {
"display_value": "",
"value": ""
},
"group_list": {
"display_value": "",
"value": ""
},
"change_plan": {
"display_value": "",
"value": ""
},
"approval_set": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"wf_activity": {
"display_value": "",
"value": ""
},
"implementation_plan": {
"display_value": "-- Place router into maintenance mode in the monitoring platform\r\n-- Logon to router through SSH\r\n-- Run the following command\r\n\r\nrouter(config-router)#router bgp 12345\r\nrouter(config-router)#neighbor {neighbor ip} soft-reconfig [inbound]\r\nrouter#clear ip bgp {neighbor ip} soft in\r\n\r\n-- Confirm the sessions have been cleared\r\n-- Place router back into operational mode in the monitoring platform",
"value": "-- Place router into maintenance mode in the monitoring platform\r\n-- Logon to router through SSH\r\n-- Run the following command\r\n\r\nrouter(config-router)#router bgp 12345\r\nrouter(config-router)#neighbor {neighbor ip} soft-reconfig [inbound]\r\nrouter#clear ip bgp {neighbor ip} soft in\r\n\r\n-- Confirm the sessions have been cleared\r\n-- Place router back into operational mode in the monitoring platform"
},
"universal_request": {
"display_value": "",
"value": ""
},
"end_date": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"short_description": {
"display_value": "Reboot the server at 6 am",
"value": "Reboot the server at 6 am"
},
"correlation_display": {
"display_value": "",
"value": ""
},
"work_start": {
"display_value": "2015-07-06 11:56:04",
"value": "2015-07-06 18:56:04",
"display_value_internal": "2015-07-06 11:56:04"
},
"delivery_task": {
"display_value": "",
"value": ""
},
"outside_maintenance_schedule": {
"display_value": "false",
"value": false
},
"additional_assignee_list": {
"display_value": "",
"value": ""
},
"std_change_producer_version": {
"display_value": "Clear BGP sessions on a Cisco router - 1",
"value": "16c2273c47010200e90d87e8dee49006"
},
"sys_class_name": {
"display_value": "Change Request",
"value": "change_request"
},
"service_offering": {
"display_value": "",
"value": ""
},
"closed_by": {
"display_value": "System Administrator",
"value": "6816f79cc0a8016401c5a33be04be441"
},
"follow_up": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"review_status": {
"display_value": "",
"value": ""
},
"reassignment_count": {
"display_value": "2",
"value": 2.0
},
"start_date": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"assigned_to": {
"display_value": "",
"value": ""
},
"variables": {
"display_value": "variable_pool",
"value": "variable_pool"
},
"sla_due": {
"display_value": "UNKNOWN",
"value": "",
"display_value_internal": ""
},
"comments_and_work_notes": {
"display_value": "",
"value": ""
},
"escalation": {
"display_value": "Normal",
"value": 0.0
},
"upon_approval": {
"display_value": "Proceed to Next Task",
"value": "proceed"
},
"correlation_id": {
"display_value": "",
"value": ""
},
"made_sla": {
"display_value": "true",
"value": true
},
"backout_plan": {
"display_value": "Due to the limited number of commands in the implementation plan it is not possible to backout the change.\r\n\r\nIf required you are authorized to reboot the router if BGP fails to work",
"value": "Due to the limited number of commands in the implementation plan it is not possible to backout the change.\r\n\r\nIf required you are authorized to reboot the router if BGP fails to work"
},
"conflict_status": {
"display_value": "Not Run",
"value": "Not Run"
},
"task_effective_number": {
"display_value": "CHG0000024",
"value": "CHG0000024"
},
"sys_updated_by": {
"display_value": "admin",
"value": "admin"
},
"opened_by": {
"display_value": "System Administrator",
"value": "6816f79cc0a8016401c5a33be04be441"
},
"user_input": {
"display_value": "",
"value": ""
},
"sys_created_on": {
"display_value": "2015-07-06 11:55:46",
"value": "2015-07-06 18:55:46",
"display_value_internal": "2015-07-06 11:55:46"
},
"on_hold_task": {
"display_value": "",
"value": ""
},
"sys_domain": {
"display_value": "global",
"value": "global"
},
"route_reason": {
"display_value": "",
"value": ""
},
"closed_at": {
"display_value": "2015-07-06 11:56:23",
"value": "2015-07-06 18:56:23",
"display_value_internal": "2015-07-06 11:56:23"
},
"review_comments": {
"display_value": "",
"value": ""
},
"business_service": {
"display_value": "",
"value": ""
},
"time_worked": {
"display_value": "",
"value": ""
},
"chg_model": {
"display_value": "",
"value": ""
},
"expected_start": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"opened_at": {
"display_value": "2015-06-09 11:55:46",
"value": "2015-06-09 18:55:46",
"display_value_internal": "2015-06-09 11:55:46"
},
"work_end": {
"display_value": "2015-07-06 11:56:10",
"value": "2015-07-06 18:56:10",
"display_value_internal": "2015-07-06 11:56:10"
},
"phase_state": {
"display_value": "Open",
"value": "open"
},
"cab_date": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"work_notes": {
"display_value": "",
"value": ""
},
"close_code": {
"display_value": "Successful",
"value": "successful"
},
"assignment_group": {
"display_value": "Network",
"value": "287ebd7da9fe198100f92cc8d1d2154e"
},
"description": {
"display_value": "Resend the complete BGP table to neighboring routers\r\n\r\n--Both neighbors need to support soft reset route refresh capability.\r\n--Stores complete BGP table of you neighbor in router memory.\r\n--Not a good idea on a peering router with full feed, due to the memory requirements.\r\n",
"value": "Resend the complete BGP table to neighboring routers\r\n\r\n--Both neighbors need to support soft reset route refresh capability.\r\n--Stores complete BGP table of you neighbor in router memory.\r\n--Not a good idea on a peering router with full feed, due to the memory requirements.\r\n"
},
"on_hold_reason": {
"display_value": "",
"value": ""
},
"calendar_duration": {
"display_value": "",
"value": ""
},
"close_notes": {
"display_value": "Completed without issues",
"value": "Completed without issues"
},
"sys_id": {
"display_value": "b0dbda5347c12200e0ef563dbb9a718f",
"value": "b0dbda5347c12200e0ef563dbb9a718f"
},
"contact_type": {
"display_value": "Phone",
"value": "phone"
},
"cab_required": {
"display_value": "false",
"value": false
},
"urgency": {
"display_value": "3 - Low",
"value": 3.0
},
"scope": {
"display_value": "Medium",
"value": 3.0
},
"company": {
"display_value": "",
"value": ""
},
"justification": {
"display_value": "",
"value": ""
},
"activity_due": {
"display_value": "UNKNOWN",
"value": "",
"display_value_internal": ""
},
"comments": {
"display_value": "",
"value": ""
},
"approval": {
"display_value": "Approved",
"value": "approved"
},
"due_date": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"sys_mod_count": {
"display_value": "10",
"value": 10.0
},
"on_hold": {
"display_value": "false",
"value": false
},
"sys_tags": {
"display_value": "",
"value": ""
},
"conflict_last_run": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"risk_value": {
"display_value": "",
"value": ""
},
"unauthorized": {
"display_value": "false",
"value": false
},
"risk": {
"display_value": "Moderate",
"value": 3.0
},
"location": {
"display_value": "",
"value": ""
},
"category": {
"display_value": "Other",
"value": "Other"
},
"risk_impact_analysis": {
"display_value": "",
"value": ""
}
}
}Gestão de mudanças - DELETE /sn_chg_rest/change/{sys_id}/conflict
Cancela o processo de verificação de conflitos em execução para a solicitação de mudança especificada (sys_id).
Formato da URL
URL com controle de versão: /api/sn_chg_rest/{api_version}/change/{sys_id}/conflict
URL padrão: /api/sn_chg_rest/change/{sys_id}/conflict
Parâmetros de solicitação compatíveis
| Nome | Descrição |
|---|---|
| api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres |
| sys_id | Sys_id do registro de solicitação de mudança para o qual o processo de verificação de conflitos em execução será cancelado. Localizado na tabela Solicitação de mudança [change_request]. Tipo de dados: cadeia de caracteres |
| Nome | Descrição |
|---|---|
| Nenhum(a) |
| Nome | Descrição |
|---|---|
| Nenhum(a) |
Cabeçalhos
Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.
| Cabeçalho | Descrição |
|---|---|
| Nenhum(a) |
| Cabeçalho | Descrição |
|---|---|
| Nenhum(a) |
Códigos de status
Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.
| Código de status | Descrição |
|---|---|
| 200 | Bem-sucedido. A solicitação foi processada com sucesso. |
| 400 | Solicitação incorreta. Falha ao cancelar solicitação. |
| 401 | Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas. |
| 404 | Não encontrado. Não foi possível encontrar o registro especificado. |
| 500 | Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro. |
Parâmetros do corpo da resposta (JSON ou XML)
| Nome | Descrição |
|---|---|
| Nenhum(a) |
Solicitação de cURL
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/0f4ac6c4b750230096c3e4f6ee11a9fe/conflict" \
--request DELETE \
--user "username":"password"
NoneGestão de mudanças - DELETE /sn_chg_rest/change/emergency/{sys_id}
Exclui a solicitação de mudança de emergência identificada pelo sys_id especificado.
Formato da URL
URL com controle de versões: /api/sn_chg_rest/{api_version}/change/emergency/{sys_id}
URL padrão: /api/sn_chg_rest/change/emergency/{sys_id}
Parâmetros de solicitação compatíveis
| Nome | Descrição |
|---|---|
| api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres |
| sys_id | Sys_id da solicitação de mudança de emergência a ser excluída. Localizado na tabela Solicitação de mudança [ change_request]. |
| Nome | Descrição |
|---|---|
| Nenhum(a) |
| Nome | Descrição |
|---|---|
| Nenhum(a) |
Cabeçalhos
Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.
| Cabeçalho | Descrição |
|---|---|
| Aceitar | Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json |
| Cabeçalho | Descrição |
|---|---|
| Nenhum(a) |
Códigos de status
Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.
| Código de status | Descrição |
|---|---|
| 200 | Solicitação concluída com sucesso. |
| 400 | Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada. |
| 401 | Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas. |
| 404 | Não encontrado. Não foi possível encontrar o registro especificado. |
| 500 | Erro Interno do Servidor. Ocorreu um erro de lógica no código do lado do servidor. |
Parâmetros do corpo da resposta (JSON ou XML)
| Nome | Descrição |
|---|---|
| pares de nome-valor | Valores para todos os campos na solicitação de mudança associada. Tipo de dados: objeto |
| estado | Estado da solicitação de mudança antes da exclusão. Tipo de dados: objeto |
| estado.display_value | Estado a ser exibido na IU. Tipo de dados: cadeia de caracteres |
| estado.valor | Valor do estado interno. Tipo de dados: cadeia de caracteres |
| sys_id | Informações de Sys_id para a solicitação de mudança. Tipo de dados: objeto |
| sys_id.display_value | Sys_id da solicitação de mudança a ser exibida em uma IU. Tipo de dados: cadeia de caracteres |
| sys_id.value | Sys_id da solicitação de mudança. Tipo de dados: cadeia de caracteres |
| tipo | Tipo de solicitação de mudança Tipo de dados: objeto |
| tipo.exibição_valor | Mude o tipo para exibir em uma IU. O valor é sempre "Emergência". Tipo de dados: cadeia de caracteres |
| tipo.valor | Valor de tipo interno. O valor é sempre "emergência". Tipo de dados: cadeia de caracteres |
Solicitação de cURL
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/emergency/b0dbda5347c12200e0ef563dbb9a718f" \
--request DELETE \
--header "Accept:application/json" \
--user "username":"password"
{
result: [
{
sys_id: {
value: "b0dbda5347c12200e0ef563dbb9a718f",
display_value: "b0dbda5347c12200e0ef563dbb9a718f"
},
state: {
value: "-5",
display_value: "New"
},
type: {
value: "emergency",
display_value: "Emergency"
},
..., // all valid fields in record, example below
short_description: {
value: "Remove server",
display_value: "Remove server"
},
},
]
}Gestão de mudanças - DELETE /sn_chg_rest/change/normal/{sys_id}
Exclui a solicitação de mudança normal identificada pelo sys_id especificado.
Formato da URL
URL com controle de versão: /api/sn_chg_rest/{api_version}/change/normal/{sys_id}
URL padrão: /api/sn_chg_rest/change/normal/{sys_id}
Parâmetros de solicitação compatíveis
| Nome | Descrição |
|---|---|
| api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres |
| sys_id | Sys_id da solicitação de mudança normal a ser excluída Localizada na tabela Solicitação de mudança [ change_request]. Tipo de dados: cadeia de caracteres |
| Nome | Descrição |
|---|---|
| Nenhum(a) |
| Nome | Descrição |
|---|---|
| Nenhum(a) |
Cabeçalhos
Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.
| Cabeçalho | Descrição |
|---|---|
| Aceitar | Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json |
| Cabeçalho | Descrição |
|---|---|
| Nenhum(a) |
Códigos de status
Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.
| Código de status | Descrição |
|---|---|
| 200 | Bem-sucedido. A solicitação foi processada com sucesso. |
| 400 | Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada. |
| 401 | Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas. |
| 404 | Não encontrado. Não foi possível encontrar o registro especificado. |
| 500 | Erro Interno do Servidor. Ocorreu um erro de lógica no código do lado do servidor. |
Parâmetros do corpo da resposta (JSON ou XML)
| Nome | Descrição |
|---|---|
| pares de nome-valor | Valores para todos os campos na solicitação de mudança associada. Tipo de dados: objeto |
| estado | Estado da solicitação de mudança antes da exclusão. Tipo de dados: objeto |
| estado.display_value | Estado a ser exibido na IU. Tipo de dados: cadeia de caracteres |
| estado.valor | Valor do estado interno. Tipo de dados: cadeia de caracteres |
| sys_id | Sys_id da solicitação de mudança. Tipo de dados: cadeia de caracteres |
| tipo | Tipo de solicitação de mudança Tipo de dados: objeto |
| tipo.exibição_valor | Mude o tipo para exibir na IU. O valor é sempre "Normal". Tipo de dados: cadeia de caracteres |
| tipo.valor | Valor de tipo interno. O valor é sempre "normal". Tipo de dados: cadeia de caracteres |
Solicitação de cURL
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/normal/b0dbda5347c12200e0ef563dbb9a718f" \
--request DELETE \
--header "Accept:application/json" \
--user "username":"password"
{
result: [
{
sys_id: "b0dbda5347c12200e0ef563dbb9a718f",
state: {
value: "-5",
display_value: "New"
},
type: {
value: "normal",
display_value: "Normal"
},
..., // all valid fields in record, example below
short_description: {
value: "Remove server",
display_value: "Remove server"
},
},
]
}
Gestão de mudanças - DELETE /sn_chg_rest/change/standard/{sys_id}
Exclui a solicitação de mudança padrão identificada pelo sys_id especificado.
Formato da URL
URL com controle de versões: /api/sn_chg_rest/{api_version}/change/standard/{sys_id}
URL padrão: /api/sn_chg_rest/change/standard/{sys_id}
Parâmetros de solicitação compatíveis
| Nome | Descrição |
|---|---|
| api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres |
| sys_id | Sys_id da solicitação de mudança padrão a ser excluída. Localizado na tabela Solicitação de mudança [change_request]. Tipo de dados: cadeia de caracteres |
| Nome | Descrição |
|---|---|
| Nenhum(a) |
| Nome | Descrição |
|---|---|
| Nenhum(a) |
Cabeçalhos
Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.
| Cabeçalho | Descrição |
|---|---|
| Aceitar | Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json |
| Cabeçalho | Descrição |
|---|---|
| Nenhum(a) |
Códigos de status
Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.
| Código de status | Descrição |
|---|---|
| 200 | Solicitação concluída com sucesso. |
| 401 | Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas. |
| 404 | Não encontrado. Não foi possível encontrar o registro especificado. |
| 500 | Erro Interno do Servidor. Ocorreu um erro de lógica no código do lado do servidor. |
Parâmetros do corpo da resposta (JSON ou XML)
| Nome | Descrição |
|---|---|
| pares de nome-valor | Todos os campos (chave) com seus valores associados para a solicitação de mudança identificada. |
| estado | Estado da solicitação de mudança antes da exclusão. Tipo de dados: objeto |
| estado.display_value | Estado a ser exibido na IU. Tipo de dados: cadeia de caracteres |
| estado.valor | Valor do estado interno. Tipo de dados: cadeia de caracteres |
| sys_id | Identificador exclusivo da solicitação de mudança. |
Solicitação de cURL
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/standard/1c87925347c12200e0ef563dbb9a7177" \
--request DELETE \
--header "Accept:application/json" \
--user "username":"password"
{
result: [
{
sys_id: "1c87925347c12200e0ef563dbb9a7177",
state: {
value: "-5",
display_value: "New"
},
..., // all valid fields in record, example below
short_description: {
value: "Add network switch to cabinet",
display_value: "Add network switch to cabinet"
},
},
]
}
Gestão de mudanças - GET /sn_chg_rest/change/ci/{cmdb_ci_sys_id}/schedule
Habilita a recuperação de intervalos de tempo disponíveis por ID e duração do item de configuração, com uma opção para incluir a hora de início planejada.
Função necessária: sn_change_writer.
Formato da URL
URL com controle de versões: /api/sn_chg_rest/{api_version}/change/ci/{cmdb_ci_sys_id}/schedule
URL padrão: /api/sn_chg_rest/change/ci/{cmdb_ci_sys_id}/schedule
Parâmetros de solicitação compatíveis
| Nome | Descrição |
|---|---|
| api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres |
| cmdb_ci_sys_id | Sys_id de um registro na tabela Itens de configuração [cmdb_ci]. Este endpoint não requer uma solicitação de mudança. |
| Nome | Descrição |
|---|---|
| duração_em_segundos | Duração da mudança em segundos, ou seja, quanto tempo é necessário para concluir a tarefa de solicitação de mudança. Tipo de dados: inteiro |
| hora_de_início_planejada | Opcional. Data e hora em que a solicitação de mudança está planejada para iniciar a implementação em UTC. Recupere o início do intervalo de tempo disponível em ou após esta hora. Se não for fornecido, o sistema usará a hora atual como a hora de início. Formato de hora: aaaa-mm-dd hh:mm:ss Tipo de dados: cadeia de caracteres |
| Nome | Descrição |
|---|---|
| Nenhum(a) |
Cabeçalhos
Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.
| Cabeçalho | Descrição |
|---|---|
| Aceitar | Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json |
| Cabeçalho | Descrição |
|---|---|
| Nenhum(a) |
Códigos de status
Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.
| Código de status | Descrição |
|---|---|
| 202 | O sistema aceitou a solicitação. |
| 400 | Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada. Possíveis problemas:
|
Parâmetros do corpo da resposta (JSON ou XML)
| Nome | Descrição |
|---|---|
| erro | Informações sobre erros encontrados ao processar a solicitação de endpoint. Tipo de dados: objeto |
| erro.detalhe | Informações adicionais sobre o erro. Tipo de dados: cadeia de caracteres |
| mensagem.erro | Mensagem que identifica o erro. Tipo de dados: cadeia de caracteres |
| mensagens | Informações da mensagem. Tipo de dados: objeto |
| mensagens.MensagensDeErro | Mensagens de erro encontradas ao processar a solicitação. Tipo de dados: matriz |
| mensagens.infoMensagens | Mensagens informativas encontradas durante o processamento da solicitação. Tipo de dados: matriz |
| mensagens.avisosMensagens | Mensagens de aviso encontradas durante o processamento da solicitação. Tipo de dados: matriz |
| solicitação | Solicitação de endpoint original. Tipo de dados: cadeia de caracteres |
| estado | Informações sobre o estado atual do trabalhador. Tipo de dados: objeto |
| estado.display_value | Valor de exibição do estado do trabalhador. Esses valores estão diretamente correlacionados ao parâmetro state.value. Valores possíveis:
Tipo de dados: cadeia de caracteres |
| estado.valor | Valor numérico do estado do trabalhador. Valores possíveis:
Tipo de dados: número |
| tipo | Indica o tipo de solicitação. Valor válido: programação Tipo de dados: cadeia de caracteres |
| trabalhador | Informações sobre o trabalhador associado. Tipo de dados: objeto |
| trabalhador.link | Link para recuperar dados de intervalo de tempo. Use o sys_id em GET /sn_chg_rest/change/worker/{sys_id} para exibir os resultados. Tipo de dados: cadeia de caracteres |
| trabalhador.sysId | Sys_id do trabalhador associado à solicitação de mudança. Tipo de dados: cadeia de caracteres |
| status | Aparece somente se um erro for encontrado. Status do processamento do endpoint. Valor possível: falha Tipo de dados: cadeia de caracteres |
Obter intervalos de tempo disponíveis
Use o valor fornecido em worker.link para obter detalhes da janela de programação. O valor está no seguinte formato:
https://instance.service-now.com/api/sn_chg_rest/change/worker/<worker_sys_id>
Use o work_sys_id em GET /sn_chg_rest/change/worker/{sys_id} para exibir os resultados.
O corpo da resposta contém o status e fornece resultados quando o processamento é concluído.
- Se o intervalo de tempo fornecido estiver disponível para a solicitação de mudança dentro do intervalo de tempo programado, a API do trabalhador listará os intervalos de tempo disponíveis na propriedade payload.spans . Caso contrário, a propriedade payload.spans não está listada nos resultados.
- Se não houver intervalos de tempo disponíveis para a duração da solicitação de mudança fornecida dentro do intervalo de tempo de programação definido, o messages.infoMessages indicará o seguinte:
DNota:O valor padrão do intervalo de tempo de programação da solicitação de mudança é 90 dias. Para alterar este valor, modifique a propriedade change.conflict.next_available.schedule_window. Para obter mais informações, consulte Configuração de propriedades de análise de conflitos.
O exemplo de GET /sn_chg_rest/change/worker/{sys_id} a seguir mostra a saída fornecida usando o ID fornecido no detalhe do work.link. Os resultados listam os períodos de tempo em aberto disponíveis para a duração da tarefa.
{
"result": {
"worker": {
"sysId": "d7d1f2b4a444b010f87712198fe9caae",
"link": "https://instance.service-now.com/api/sn_chg_rest/change/worker/d7d1f2b4a444b010f87712198fe9caae"
},
"request": "{\"cmdb_ci_sys_id\":\"82967cdd0ad3370236092104ce988d76\",\"planned_start_time\":\"\",\"duration_in_seconds\":10800,\"timezone\":\"America/Los_Angeles\"}",
"state": {
"value": 3,
"display_value": "Complete"
},
"type": "schedule",
"messages": {
"errorMessages": [],
"warningMessages": [],
"infoMessages": []
},
"payload": {
"spans": [
{
"start": {
"value": "2021-05-15 08:00:00",
"display_value": "2021-05-15 01:00:00"
},
"end": {
"value": "2021-05-15 11:00:00",
"display_value": "2021-05-15 04:00:00"
}
},
{
"start": {
"value": "2021-05-22 08:00:00",
"display_value": "2021-05-22 01:00:00"
},
"end": {
"value": "2021-05-22 11:00:00",
"display_value": "2021-05-22 04:00:00"
}
},
...
]
}
}
}Solicitação de cURL
curl "https://instance.service-now.com/api/sn_chg_rest/change/ci/<cmdb_ci_sys_id>/schedule?duration_in_seconds=10800" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"Os resultados incluem detalhes de work.link que você pode usar para executar o sys_id fornecido no endpoint GET /sn_chg_rest/change/worker/.
{
"result": {
"worker": {
"sysId": "1049419c1b4c3010f58a6572604bcb7a",
"link": "https://instance.service-now.com/api/sn_chg_rest/change/worker/1049419c1b4c3010f58a6572604bcb7a"
},
"request": "{\"cmdb_ci_sys_id\":\"<cmdb_ci_sys_id>\",\"planned_start_time\":\"\",\"duration_in_seconds\":10800,\"timezone\":\"America/Los_Angeles\"}",
"state": {
"value": 1,
"display_value": "Waiting"
},
"type": "schedule",
"messages": {
"errorMessages": [],
"warningMessages": [],
"infoMessages": []
}
}
}Gestão de mudanças - GET /sn_chg_rest/change
Recupera uma ou mais solicitações de mudança com base nos critérios especificados.
Formato da URL
URL com controle de versão: /api/sn_chg_rest/{api_version}/change
URL padrão: /api/sn_chg_rest/change
Parâmetros de solicitação compatíveis
| Nome | Descrição |
|---|---|
| api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres |
| Nome | Descrição |
|---|---|
| pares de nome-valor | Pares de nome-valor a serem usados para filtrar o conjunto de resultados. O nome é o campo no qual o valor especificado é filtrado. Este parâmetro é mutuamente exclusivo com sysparm_query. Por exemplo, em vez de usar &sysparm_query=active=true, você pode simplificar a declaração de chamada usando &active=true. Você também pode usar o valor de exibição quando o campo for do tipo opção ou referência, como &state=closed em vez de &state=7. Para especificar vários pares de chave-valor, separe cada um com um e comercial, como &active=true&assigned_to=john.smith. Tipo de dados: cadeia de caracteres |
| pedido | Campo pelo qual classificar as solicitações de mudança retornadas. Tipo de dados: cadeia de caracteres Padrão: nome |
| sysparm_offset | Índice de registro inicial para o qual a recuperação de registros será iniciada. Use este valor para paginar a recuperação do registro. Essa funcionalidade permite a recuperação de todos os registros, independentemente do número de registros, em pequenos blocos gerenciáveis. Por exemplo, na primeira vez que você chama este endpoint, sysparm_offset é definido como "0". Para simplesmente percorrer todos os registros disponíveis, use Tipo de dados: número Padrão: 0 |
| sysparm_query | Consulta codificada usada para filtrar o conjunto de resultados. Você pode usar um filtro de IU para obter uma consulta codificada corretamente. Sintaxe: sysparm_query=<col_name><operator><value> .
Todos os parâmetros fazem distinção entre maiúsculas e minúsculas. As consultas podem conter mais de uma entrada, como sysparm_query=<col_name><operator><value> [ ] . Por exemplo:
As consultas codificadas também oferecem suporte à ordem por funcionalidade. Para classificar respostas com base em determinados campos, use as cláusulas Sintaxe:
Por exemplo: Esta consulta filtra todos os registros ativos e ordena os resultados em ordem crescente por número e, em seguida, em ordem decrescente por categoria. Se parte da consulta for inválida, por exemplo, especificando um nome de campo inválido, a instância ignorará a parte inválida. Em seguida, ele retorna linhas usando somente a parte válida da consulta. Você pode controlar esse comportamento usando a propriedade glide.invalid_query.returns_no_rows. Defina esta propriedade como verdadeira para não retornar linhas em uma consulta inválida. Nota: A propriedade glide.invalid_query.returns_no_rows controla o comportamento de todas as consultas na instância, como em listas, scripts (GlideRecord.query()) e APIs de serviço web. Tipo de dados: cadeia de caracteres |
| pesquisa de texto | Cadeia de caracteres a ser usada para pesquisar todos os campos de registro de solicitação de mudança normais. Esta pesquisa usa a funcionalidade ServiceNow da plataforma de pesquisa de texto completo. Para obter mais informações sobre ServiceNow, capacidades de pesquisa, consulte Administração de pesquisa. Padrão: IR_AND_OR_QUERY |
| Nome | Descrição |
|---|---|
| Nenhum(a) |
Cabeçalhos
Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.
| Cabeçalho | Descrição |
|---|---|
| Aceitar | Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json |
| Cabeçalho | Descrição |
|---|---|
| Nenhum(a) |
Códigos de status
Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.
| Código de status | Descrição |
|---|---|
| 200 | Solicitação concluída com sucesso. |
| 401 | Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas. |
| 500 | Erro Interno do Servidor. Ocorreu um erro de lógica no código do lado do servidor. |
Parâmetros do corpo da resposta (JSON ou XML)
| Elemento | Descrição |
|---|---|
| resultado | Lista que contém um ou mais objetos de registro de solicitação de mudança. Cada objeto descreve uma solicitação de mudança. Cada elemento no objeto de solicitação de mudança corresponde a um campo em seu registro associado na tabela Solicitação de mudança [change_request]. Todos os elementos contêm pares de nome-valor value e display_value. Os campos de data também contêm pares de nome-valor display_value_internal. Tipo de dados: matriz |
| action_status | Status da ação atual da solicitação de mudança associada. Valores possíveis:
Tipo de dados: número |
| ativo | Sinalizador que indica se a solicitação de mudança está ativa. Valores possíveis:
Tipo de dados: booliano Padrão: verdadeiro |
| atividade_vencida | Data e hora em que o caso associado deve ser concluído. Tipo de dados: cadeia de caracteres |
| adicional_designado_lista | Lista de sys_ids de pessoas adicionais atribuídas para trabalhar na solicitação de mudança. Tipo de dados: matriz |
| aprovação | Tipo de processo de aprovação necessário. Tipo de dados: cadeia de caracteres Padrão: não solicitado |
| histórico_de_aprovação | Entrada de registro do histórico de aprovação mais recente. Tipo de dados: cadeia de caracteres |
| aprovação_conjunto | Data e hora em que a ação associada foi aprovada. Tipo de dados: cadeia de caracteres |
| assigned_to | Sys_id do usuário atribuído à solicitação de mudança. Tipo de dados: cadeia de caracteres |
| assignment_group | Sys_id do grupo atribuído à solicitação de mudança. Tipo de dados: cadeia de caracteres |
| backout_plan | Descrição do plano a ser executado se a mudança precisar ser revertida. Tipo de dados: cadeia de caracteres |
| business_duration | Duração em horas de trabalho programadas, dias úteis e semanas de trabalho necessários para concluir a mudança. Tipo de dados: cadeia de caracteres |
| business_service | Sys_id do serviço de negócio associado à solicitação de mudança. Localizado na tabela Serviço [cmdb_ci_service]. Tipo de dados: cadeia de caracteres |
| data_cab | Data em que o Comitê Consultivo de Mudança (CCM) se reúne. Tipo de dados: cadeia de caracteres |
| delegado_cab | Sys_id do usuário que pode substituir o gerente do CCM durante uma reunião do CCM. Localizado na tabela Usuário [sys_user] Tipo de dados: cadeia de caracteres |
| recomendação_cab | Descrição das recomendações do CCM para a solicitação de mudança. Tipo de dados: cadeia de caracteres Tamanho máximo: 4.000 |
| cab_required | Sinalizador que indica se o CCM é necessário. Valores possíveis:
Tipo de dados: booliano Padrão: falso |
| calendar_duration | Não usado atualmente por Gestão de mudanças. Tipo de dados: cadeia de caracteres |
| categoria | Categoria da mudança, por exemplo, hardware, rede ou software. Tipo de dados: cadeia de caracteres Padrão: outro |
| plano_mudança | Atividades e funções para gerenciar e controlar a solicitação de mudança. Tipo de dados: cadeia de caracteres |
| modelo_chg | Sys_id do modelo de mudança no qual a solicitação de mudança associada se baseou. Localizado na tabela Modelo de mudança [chg_model]. O modelo de mudança define o fluxo de estado, as transições e as atividades do processo que devem ser concluídas para a solicitação de mudança. Tipo de dados: cadeia de caracteres |
| closed_at | Data e hora em que a solicitação de mudança associada foi encerrada. Tipo de dados: cadeia de caracteres |
| closed_by | Sys_id da pessoa que fechou a solicitação de mudança. Localizado na tabela Usuário [sys_user]. Tipo de dados: cadeia de caracteres |
| close_code | Código atribuído à solicitação de mudança quando ela foi fechada. Por exemplo, Bem-sucedido, Bem-sucedido com problemas e Mal-sucedido. Tipo de dados: cadeia de caracteres |
| close_notes | Anotações que a pessoa inseriu ao fechar a solicitação de mudança. Tipo de dados: cadeia de caracteres |
| cmdb_ci | Sys_id do item de configuração associado à solicitação de mudança. Localizado na tabela Item de configuração [cmdb_ci]. Tipo de dados: cadeia de caracteres |
| comentários | Lista de anotações de trabalho do cliente inseridas na solicitação de mudança associada. Tipo de dados: matriz |
| comments_and_work_notes | Lista de anotações de trabalho internas e de contato com o cliente inseridas para a solicitação de mudança associada. Tipo de dados: matriz Tamanho máximo: 4.000 |
| empresa | Sys_id da empresa associada à solicitação de mudança. Localizado na tabela Empresa [core_company]. Tipo de dados: cadeia de caracteres |
| conflito_última_execução | Data e hora em que o script de detecção de conflitos foi executado pela última vez na solicitação de mudança. Tipo de dados: cadeia de caracteres |
| conflito_status | Status de conflito atual conforme detectado pelo script de detecção de conflitos, como Conflito e Não executado. Tipo de dados: cadeia de caracteres Tamanho máximo: 40 Padrão: não executado |
| contato_tipo | Método no qual a solicitação de mudança foi solicitada inicialmente. Valores possíveis:
Tipo de dados: cadeia de caracteres |
| contrato | Sys_id do contrato associado à solicitação de mudança. Localizado na tabela Contrato [ast_contract]. Tipo de dados: cadeia de caracteres |
| correlação_display | Nome amigável para o correlation_id. Tipo de dados: cadeia de caracteres Tamanho máximo: 100 |
| correlation_id | ID exclusivo globalmente (GUID) de um registro de solicitação de mudança correspondente em um sistema de terceiros. Tipo de dados: cadeia de caracteres Tamanho máximo: 100 |
| plano_de_entrega | Não está mais em uso. Sys_id do plano de entrega associado à solicitação de mudança. Localizado na tabela Plano de execução [sc_cat_item_delivery_plan]. Tipo de dados: cadeia de caracteres |
| entrega_tarefa | Não está mais em uso. Sys_id da tarefa de entrega associada à solicitação de mudança. Localizado na tabela Tarefa do plano de execução [sc_cat_item_delivery_task]. Tipo de dados: cadeia de caracteres |
| descrição | Descrição detalhada da solicitação de mudança. Tipo de dados: cadeia de caracteres Tamanho máximo: 4.000 |
| due_date | Prazo da tarefa. Não usado pelo processo de solicitação de mudança. Tipo de dados: cadeia de caracteres |
| end_date | Data e hora em que a solicitação de mudança deve ser concluída. Tipo de dados: cadeia de caracteres |
| escalação | Nível de escalação atual. Valores possíveis:
Tipo de dados: número (inteiro) Padrão: 0 |
| expected_start | Data e hora em que a tarefa deve ser iniciada. Não usado pelo processo de solicitação de mudança. Tipo de dados: cadeia de caracteres |
| acompanhamento | Data e hora em que um usuário fez o acompanhamento da pessoa que solicitou a solicitação de mudança. Tipo de dados: cadeia de caracteres |
| group_list | Lista de sys_ids e nomes dos grupos associados à solicitação de mudança. Tipo de dados: matriz Tamanho máximo: 4.000 |
| impacto | O impacto que a solicitação de mudança terá sobre o cliente. Valores possíveis:
Tipo de dados: número (inteiro) Padrão: 3 |
| implementação_plano | Etapas sequenciais a serem executadas para implementar esta mudança. Ele também contém todas as dependências entre etapas e detalhes do designado para cada etapa. Tipo de dados: cadeia de caracteres Tamanho máximo: 4.000 |
| justificativa | Benefícios da implementação desta mudança e o impacto se esta mudança não for implementada. Tipo de dados: cadeia de caracteres Tamanho máximo: 4.000 |
| conhecimento | Sinalizador que indica se há artigos da base de conhecimento ()KB) associados à solicitação de mudança. Valores possíveis:
Tipo de dados: booliano |
| local | Sys_id e nome do local do equipamento referenciado na solicitação de mudança. Localizado no Local Localizado na tabela Local [cmn_location]. Tipo de dados: cadeia de caracteres |
| ANS_feito | Não mais usado. Sinalizador que indica se a solicitação de mudança foi implementada de acordo com o acordo de nível de serviço associado. Tipo de dados: booliano |
| precisa_atenção | Sinalizador que indica se a solicitação de mudança precisa de atenção. Valores possíveis:
Tipo de dados: booliano Padrão: falso |
| número | Número de mudança atribuído à solicitação de mudança pelo sistema, como CHG0040007. Tipo de dados: cadeia de caracteres |
| em espera | Sinalizador que indica se a solicitação de mudança está em espera no momento. Valores possíveis:
Tipo de dados: booliano Padrão: falso |
| em_hold_reason | Se o parâmetro on_hold for "verdadeiro", descrição do motivo pelo qual a solicitação de mudança está sendo retida. Tipo de dados: cadeia de caracteres Tamanho máximo: 4.000 |
| em espera_tarefa | Se o parâmetro on_hold for "verdadeiro", a lista dos sys_ids das tarefas que devem ser concluídas antes que a espera seja liberada. Tipo de dados: cadeia de caracteres Tamanho máximo: 4.000 |
| opened_at | Data e hora em que a versão de mudança foi criada. Tipo de dados: cadeia de caracteres |
| opened_by | Sys_id e nome do usuário que criou a versão de mudança. Localizado na tabela Usuário [sys_user]. Tipo de dados: cadeia de caracteres |
| pedido | Não usado por Gestão de mudanças. Campo numérico opcional pelo qual os registros são ordenados, como ao recuperá-los de um banco de dados. Tipo de dados: número (inteiro) |
| programação_de_manutenção_fora | Sinalizador que indica se a manutenção de uma empresa externa foi programada para a solicitação de mudança. Valores possíveis:
Tipo de dados: booliano Padrão: falso |
| primário | Sys_id e nome da tarefa primária para esta solicitação de mudança, se houver. Localizado na tabela Tarefa [task]. Tipo de dados: cadeia de caracteres |
| fase | Fase atual da solicitação de mudança. Isso define o que a mudança está fazendo com mais detalhes. Valores possíveis:
Tipo de dados: cadeia de caracteres |
| fase_estado | Registros change_phase que devem ser criados para uma mudança. Eles dependem da categoria, de modo que cada tipo de mudança pode ter diferentes registros change_phase. Os registros change_phase oferecem uma oportunidade de controlar o processo de aprovação, já que cada change_phase pode ter uma programação e um conjunto de aprovadores. Valores possíveis:
Tipo de dados: cadeia de caracteres |
| prioridade | Prioridade da solicitação de mudança. Valores possíveis:
Tipo de dados: número (inteiro) Padrão: 4 |
| produção_sistema | Sinalizador que indica se a solicitação de mudança é para uma instância ServiceNow que está em um ambiente de produção. Valores possíveis:
Tipo de dados: booliano |
| motivo | Descrição do motivo pelo qual a solicitação de mudança foi iniciada. Valores possíveis:
Tipo de dados: cadeia de caracteres Tamanho máximo: 40 |
| reatribuição_conta | Número de vezes que a solicitação de mudança foi reatribuída a um novo proprietário. Tipo de dados: número (inteiro) Padrão: 0 |
| rejeição_ir para | Sys_id da tarefa a ser executada se a solicitação de mudança for rejeitada. Localizado na Tarefa [tabela]. Tipo de dados: cadeia de caracteres |
| solicitado_por | Sys_id do usuário que solicitou a mudança. Localizado na tabela Usuário [sys_user]. Tipo de dados: cadeia de caracteres |
| solicitado_por_data | Data e hora em que a mudança deve ser implementada por. Tipo de dados: cadeia de caracteres |
| revisão_comentários | Comentários inseridos quando a solicitação de mudança foi revisada. Tipo de dados: cadeia de caracteres Tamanho máximo: 4.000 |
| revisão_data | Data em que a solicitação de mudança foi revisada. Tipo de dados: cadeia de caracteres |
| revisão_status | Status atual da revisão da solicitação de mudança solicitada. Tipo de dados: cadeia de caracteres |
| risco | Nível de risco associado à solicitação de mudança. Valores válidos:
Tipo de dados: número Padrão: 3 |
| análise_de_impacto_risco | Descrição do risco e análise da implementação da solicitação de mudança. Tipo de dados: cadeia de caracteres Tamanho máximo: 4.000 |
| rota_reason | Não usado atualmente por Gestão de mudanças. Motivo pelo qual a solicitação de mudança foi transferida. Valores possíveis:
Tipo de dados: número |
| scope | Tamanho da solicitação de mudança. Valores possíveis:
Tipo de dados: número Padrão: 3 |
| service_offering | Sys_id da oferta de serviço associada à solicitação de mudança. As ofertas de serviço definem exclusivamente o nível de serviço em termos de disponibilidade, escopo, preço e opções de pacote. Localizado na tabela Oferta [service_offering]. Tipo de dados: cadeia de caracteres |
| short_description | Descrição da solicitação de mudança. Tipo de dados: cadeia de caracteres Tamanho máximo: 40 |
| habilidades | Lista de sys_ids de todas as habilidades necessárias para implementar a solicitação de mudança. Localizado na tabela Habilidade [cmn_skill]. Tipo de dados: matriz |
| atraso_devido | Não está mais em uso. Data e hora em que a solicitação de mudança deve ser concluída com base no acordo de nível de serviço associado. Tipo de dados: cadeia de caracteres |
| sn_esign_document | Sys_id de qualquer documento assinado eletronicamente anexado à solicitação de mudança. Localizado na tabela Anexo [sys_attachment]. Tipo de dados: cadeia de caracteres |
| sn_esign_esignature_configuration | Sys_id do modelo de assinatura eletrônica usado para o documento associado. Localizado na tabela Modelo de assinatura eletrônica [sn_esign_configuration]. Tipo de dados: cadeia de caracteres |
| start_date | Data e hora em que a solicitação de mudança está planejada para iniciar a implementação. Tipo de dados: cadeia de caracteres |
| estado | Estado atual da solicitação de mudança. Os valores possíveis são definidos no modelo de mudança. Tipo de dados: número (inteiro) Padrão: 1 |
| std_change_producer_version | Sys_id do produtor de registro e da proposta de mudança associada à solicitação de mudança. Ele também inclui o número e a porcentagem de solicitações de mudança bem-sucedidas e malsucedidas criadas a partir da proposta. Localizado na tabela Versão do modelo de mudança padrão [std_change_producer_version]. Tipo de dados: cadeia de caracteres |
| sys_class_name | Nome da tabela na qual a solicitação de mudança está localizada. Tipo de dados: cadeia de caracteres |
| sys_created_by | Nome do usuário que criou inicialmente a solicitação de mudança. Tipo de dados: cadeia de caracteres Tamanho máximo: 40 |
| sys_created_on | Data e hora em que o registro de solicitação de mudança associado foi criado originalmente. Tipo de dados: cadeia de caracteres |
| sys_domain | Se estiver usando domínios na instância, o nome do domínio ao qual o registro do módulo de mudança está associado. Tipo de dados: cadeia de caracteres |
| sys_domain_path | Se estiver usando domínios na instância, o caminho do domínio no qual o registro do módulo de mudança associado reside. Tipo de dados: cadeia de caracteres |
| sys_id | Identificador exclusivo do registro de solicitação de mudança associado. Tipo de dados: cadeia de caracteres |
| sys_mod_count | Número de atualizações do caso desde que ele foi criado pela primeira vez. Tipo de dados: número (inteiro) |
| sys_updated_by | Pessoa que atualizou o caso pela última vez. Tipo de dados: cadeia de caracteres Tamanho máximo: 40 |
| sys_updated_on | Data e hora em que o caso foi atualizado pela última vez. Tipo de dados: cadeia de caracteres |
| número_efetivo_tarefa | Número da Solicitação universal. Tipo de dados: cadeia de caracteres Tamanho máximo: 40 |
| tarefa_para | Não usado por Gestão de mudanças. Sys_id do usuário para o qual a tarefa foi criada. Localizado na tabela Usuário [sys_user]. Tipo de dados: cadeia de caracteres |
| plano_teste | Descrição do plano de testes associado à mudança. Tipo de dados: cadeia de caracteres Tamanho máximo: 4.000 |
| tempo_trabalhado | Quantidade total de tempo trabalhado na solicitação de mudança. Tipo de dados: cadeia de caracteres |
| tipo | Tipo de solicitação de mudança. Valores possíveis:
Tipo de dados: cadeia de caracteres Tamanho máximo: 40 |
| não autorizado | Sinalizador que indica se a solicitação de mudança não foi autorizada Valores possíveis:
Tipo de dados: booliano |
| universal_request | Sys_id da Solicitação universal primária da qual esta solicitação de mudança faz parte. Localizado na tabela Tarefa [task]. Tipo de dados: cadeia de caracteres |
| mediante_aprovação | Ação a ser tomada se a solicitação de mudança for aprovada. Valores possíveis:
Tipo de dados: cadeia de caracteres Tamanho máximo: 40 Padrão: prosseguir |
| mediante_rejeitar | Ação a ser tomada se a solicitação de mudança for rejeitada. Valores possíveis:
Tipo de dados: cadeia de caracteres Tamanho máximo: 40 Padrão: cancelar |
| urgência | Urgência da solicitação de mudança. Valores possíveis:
Tipo de dados: número (inteiro) Padrão: 3 |
| user_input | Entrada adicional do usuário. Tipo de dados: cadeia de caracteres Tamanho máximo: 4.000 |
| variáveis | Pares de nome-valor de variáveis associadas à solicitação de mudança. Tipo de dados: cadeia de caracteres Tamanho máximo: 40 |
| watch_list | Lista de sys_ids dos usuários que recebem notificações sobre esta solicitação de mudança quando comentários adicionais são adicionados ou se o estado de uma solicitação de mudança é alterado para Resolvido ou Encerrado. Localizado na tabela Usuário [sys_user]. Tipo de dados: matriz |
| wf_activity | Sys_id do registro de atividade de fluxo de trabalho associado à solicitação de mudança. Localizado na tabela Atividade de fluxo de trabalho [wf_activity]. Tipo de dados: cadeia de caracteres |
| fim_trabalho | Data e hora em que o trabalho foi encerrado na solicitação de mudança. Tipo de dados: cadeia de caracteres |
| work_notes | Informações sobre como resolver a solicitação de mudança ou as medidas tomadas para resolvê-la. Tipo de dados: cadeia de caracteres Tamanho máximo: 4.000 |
| lista_anotações_trabalho | Lista de sys_ids dos usuários internos que recebem notificações sobre essa solicitação de mudança quando anotações de trabalho são adicionadas. Localizado na tabela Usuário [sys_user]. Tipo de dados: matriz |
| início_trabalho | Data e hora em que o trabalho foi iniciado na solicitação de mudança. Tipo de dados: cadeia de caracteres |
Solicitação de cURL
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change?sysparm_query=active=true^ORDERBYnumber" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
Para abreviar, os resultados contêm apenas um único registro de solicitação de mudança.
{
"result": [
{
"reason": {
"display_value": "",
"value": ""
},
"parent": {
"display_value": "",
"value": ""
},
"watch_list": {
"display_value": "",
"value": ""
},
"proposed_change": {
"display_value": "",
"value": ""
},
"upon_reject": {
"display_value": "Cancel all future Tasks",
"value": "cancel"
},
"sys_updated_on": {
"display_value": "2015-07-06 11:59:27",
"value": "2015-07-06 18:59:27",
"display_value_internal": "2015-07-06 11:59:27"
},
"type": {
"display_value": "Standard",
"value": "standard"
},
"approval_history": {
"display_value": "",
"value": ""
},
"skills": {
"display_value": "",
"value": ""
},
"test_plan": {
"display_value": "--Confirm that there are no monitoring alerts for the router",
"value": "--Confirm that there are no monitoring alerts for the router"
},
"number": {
"display_value": "CHG0000024",
"value": "CHG0000024"
},
"is_bulk": {
"display_value": "false",
"value": false
},
"cab_delegate": {
"display_value": "",
"value": ""
},
"requested_by_date": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"ci_class": {
"display_value": "cmdb_ci",
"value": "cmdb_ci"
},
"state": {
"display_value": "Closed",
"value": 3.0
},
"sys_created_by": {
"display_value": "admin",
"value": "admin"
},
"knowledge": {
"display_value": "false",
"value": false
},
"order": {
"display_value": "",
"value": ""
},
"phase": {
"display_value": "Requested",
"value": "requested"
},
"cmdb_ci": {
"display_value": "",
"value": ""
},
"delivery_plan": {
"display_value": "",
"value": ""
},
"impact": {
"display_value": "3 - Low",
"value": 3.0
},
"contract": {
"display_value": "",
"value": ""
},
"active": {
"display_value": "false",
"value": false
},
"work_notes_list": {
"display_value": "",
"value": ""
},
"priority": {
"display_value": "4 - Low",
"value": 4.0
},
"sys_domain_path": {
"display_value": "/",
"value": "/"
},
"cab_recommendation": {
"display_value": "",
"value": ""
},
"production_system": {
"display_value": "false",
"value": false
},
"rejection_goto": {
"display_value": "",
"value": ""
},
"review_date": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"requested_by": {
"display_value": "System Administrator",
"value": "6816f79cc0a8016401c5a33be04be441"
},
"business_duration": {
"display_value": "",
"value": ""
},
"group_list": {
"display_value": "",
"value": ""
},
"change_plan": {
"display_value": "",
"value": ""
},
"approval_set": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"wf_activity": {
"display_value": "",
"value": ""
},
"implementation_plan": {
"display_value": "-- Place router into maintenance mode in the monitoring platform\r\n-- Logon to router through SSH\r\n-- Run the following command\r\n\r\nrouter(config-router)#router bgp 12345\r\nrouter(config-router)#neighbor {neighbor ip} soft-reconfig [inbound]\r\nrouter#clear ip bgp {neighbor ip} soft in\r\n\r\n-- Confirm the sessions have been cleared\r\n-- Place router back into operational mode in the monitoring platform",
"value": "-- Place router into maintenance mode in the monitoring platform\r\n-- Logon to router through SSH\r\n-- Run the following command\r\n\r\nrouter(config-router)#router bgp 12345\r\nrouter(config-router)#neighbor {neighbor ip} soft-reconfig [inbound]\r\nrouter#clear ip bgp {neighbor ip} soft in\r\n\r\n-- Confirm the sessions have been cleared\r\n-- Place router back into operational mode in the monitoring platform"
},
"universal_request": {
"display_value": "",
"value": ""
},
"end_date": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"short_description": {
"display_value": "Clear BGP sessions on a Cisco router",
"value": "Clear BGP sessions on a Cisco router"
},
"correlation_display": {
"display_value": "",
"value": ""
},
"work_start": {
"display_value": "2015-07-06 11:56:04",
"value": "2015-07-06 18:56:04",
"display_value_internal": "2015-07-06 11:56:04"
},
"delivery_task": {
"display_value": "",
"value": ""
},
"outside_maintenance_schedule": {
"display_value": "false",
"value": false
},
"additional_assignee_list": {
"display_value": "",
"value": ""
},
"std_change_producer_version": {
"display_value": "Clear BGP sessions on a Cisco router - 1",
"value": "16c2273c47010200e90d87e8dee49006"
},
"sys_class_name": {
"display_value": "Change Request",
"value": "change_request"
},
"service_offering": {
"display_value": "",
"value": ""
},
"closed_by": {
"display_value": "System Administrator",
"value": "6816f79cc0a8016401c5a33be04be441"
},
"follow_up": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"review_status": {
"display_value": "",
"value": ""
},
"reassignment_count": {
"display_value": "2",
"value": 2.0
},
"start_date": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"assigned_to": {
"display_value": "",
"value": ""
},
"variables": {
"display_value": "variable_pool",
"value": "variable_pool"
},
"sla_due": {
"display_value": "UNKNOWN",
"value": "",
"display_value_internal": ""
},
"comments_and_work_notes": {
"display_value": "",
"value": ""
},
"escalation": {
"display_value": "Normal",
"value": 0.0
},
"upon_approval": {
"display_value": "Proceed to Next Task",
"value": "proceed"
},
"correlation_id": {
"display_value": "",
"value": ""
},
"made_sla": {
"display_value": "true",
"value": true
},
"backout_plan": {
"display_value": "Due to the limited number of commands in the implementation plan it is not possible to backout the change.\r\n\r\nIf required you are authorized to reboot the router if BGP fails to work",
"value": "Due to the limited number of commands in the implementation plan it is not possible to backout the change.\r\n\r\nIf required you are authorized to reboot the router if BGP fails to work"
},
"conflict_status": {
"display_value": "Not Run",
"value": "Not Run"
},
"task_effective_number": {
"display_value": "CHG0000024",
"value": "CHG0000024"
},
"sys_updated_by": {
"display_value": "admin",
"value": "admin"
},
"opened_by": {
"display_value": "System Administrator",
"value": "6816f79cc0a8016401c5a33be04be441"
},
"user_input": {
"display_value": "",
"value": ""
},
"sys_created_on": {
"display_value": "2015-07-06 11:55:46",
"value": "2015-07-06 18:55:46",
"display_value_internal": "2015-07-06 11:55:46"
},
"on_hold_task": {
"display_value": "",
"value": ""
},
"sys_domain": {
"display_value": "global",
"value": "global"
},
"route_reason": {
"display_value": "",
"value": ""
},
"closed_at": {
"display_value": "2015-07-06 11:56:23",
"value": "2015-07-06 18:56:23",
"display_value_internal": "2015-07-06 11:56:23"
},
"review_comments": {
"display_value": "",
"value": ""
},
"business_service": {
"display_value": "",
"value": ""
},
"time_worked": {
"display_value": "",
"value": ""
},
"chg_model": {
"display_value": "",
"value": ""
},
"expected_start": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"opened_at": {
"display_value": "2015-06-09 11:55:46",
"value": "2015-06-09 18:55:46",
"display_value_internal": "2015-06-09 11:55:46"
},
"work_end": {
"display_value": "2015-07-06 11:56:10",
"value": "2015-07-06 18:56:10",
"display_value_internal": "2015-07-06 11:56:10"
},
"phase_state": {
"display_value": "Open",
"value": "open"
},
"cab_date": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"work_notes": {
"display_value": "",
"value": ""
},
"close_code": {
"display_value": "Successful",
"value": "successful"
},
"assignment_group": {
"display_value": "Network",
"value": "287ebd7da9fe198100f92cc8d1d2154e"
},
"description": {
"display_value": "Resend the complete BGP table to neighboring routers\r\n\r\n--Both neighbors need to support soft reset route refresh capability.\r\n--Stores complete BGP table of you neighbor in router memory.\r\n--Not a good idea on a peering router with full feed, due to the memory requirements.\r\n",
"value": "Resend the complete BGP table to neighboring routers\r\n\r\n--Both neighbors need to support soft reset route refresh capability.\r\n--Stores complete BGP table of you neighbor in router memory.\r\n--Not a good idea on a peering router with full feed, due to the memory requirements.\r\n"
},
"on_hold_reason": {
"display_value": "",
"value": ""
},
"calendar_duration": {
"display_value": "",
"value": ""
},
"close_notes": {
"display_value": "Completed without issues",
"value": "Completed without issues"
},
"sys_id": {
"display_value": "1766f1de47410200e90d87e8dee490f6",
"value": "1766f1de47410200e90d87e8dee490f6"
},
"contact_type": {
"display_value": "Phone",
"value": "phone"
},
"cab_required": {
"display_value": "false",
"value": false
},
"urgency": {
"display_value": "3 - Low",
"value": 3.0
},
"scope": {
"display_value": "Medium",
"value": 3.0
},
"company": {
"display_value": "",
"value": ""
},
"justification": {
"display_value": "",
"value": ""
},
"activity_due": {
"display_value": "UNKNOWN",
"value": "",
"display_value_internal": ""
},
"comments": {
"display_value": "",
"value": ""
},
"approval": {
"display_value": "Approved",
"value": "approved"
},
"due_date": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"sys_mod_count": {
"display_value": "10",
"value": 10.0
},
"on_hold": {
"display_value": "false",
"value": false
},
"sys_tags": {
"display_value": "",
"value": ""
},
"conflict_last_run": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"risk_value": {
"display_value": "",
"value": ""
},
"unauthorized": {
"display_value": "false",
"value": false
},
"risk": {
"display_value": "Moderate",
"value": 3.0
},
"location": {
"display_value": "",
"value": ""
},
"category": {
"display_value": "Other",
"value": "Other"
},
"risk_impact_analysis": {
"display_value": "",
"value": ""
}
}
]
}Gestão de mudanças - GET /sn_chg_rest/change/{change_sys_id}/nextstates
Recupera uma lista de estados disponíveis para a solicitação de mudança especificada, incluindo o estado atual.
Se disponível, ele também mostra como fazer a transição para o próximo estado com base na versão da Gestão de mudanças implementada. Se as mudanças forem orientadas pelo modelo de mudança, o endpoint retornará condições que foram aprovadas ou não. Ele também fornece informações sobre se todas as condições foram aprovadas para uma determinada transição. Essas informações não estão disponíveis para solicitações de mudança orientadas por tipo e legadas.
Formato da URL
URL com controle de versão: /api/sn_chg_rest/{api_version}/change/{change_sys_id}/nextstates
URL padrão: /api/sn_chg_rest/change/{change_sys_id}/nextstates
Parâmetros de solicitação compatíveis
| Nome | Descrição |
|---|---|
| api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres |
| change_sys_id | Sys_id da solicitação de mudança. Localizado na tabela Solicitação de mudança [change_request]. Tipo de dados: cadeia de caracteres |
| Nome | Descrição |
|---|---|
| Nenhum(a) |
| Nome | Descrição |
|---|---|
| Nenhum(a) |
Cabeçalhos
Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.
| Cabeçalho | Descrição |
|---|---|
| Aceitar | Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json |
| Cabeçalho | Descrição |
|---|---|
| Nenhum(a) |
Códigos de status
Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.
| Código de status | Descrição |
|---|---|
| 200 | Bem-sucedido. A solicitação foi processada com sucesso. |
| 404 | Não encontrado. O item solicitado não foi encontrado. |
Parâmetros do corpo da resposta (JSON ou XML)
| Nome | Descrição |
|---|---|
| estados_disponíveis | Valores para os estados que estão disponíveis para a solicitação de mudança especificada, incluindo o estado atual. Tipo de dados: matriz |
| rótulo_estado | Pares de chave-valor que associam rótulos aos estados disponíveis. Tipo de dados: objeto |
| transições_estado | Informações sobre o que é necessário para fazer a transição para cada estado disponível. Cada "estado de destino" distinto disponível está em sua própria matriz com cada conjunto diferente de condições para esse estado de destino em seu próprio objeto. Tipo de dados: matriz |
| state_transitions.automatic_transition | Sinalizador que indica se a transição deve ser feita automaticamente para este estado. Valores válidos:
Tipo de dados: booliano |
| transições_estado.condições | Lista das condições associadas ao estado [ . Tipo de dados: matriz de objetos |
| transições_estado.condições.condição | Valores de uma condição específica. Tipo de dados: objeto |
| state_transitions.conditions.condition.description | Descrição da condição. Tipo de dados: cadeia de caracteres |
| state_transitions.conditions.condition.name | Nome da condição. Tipo de dados: cadeia de caracteres |
| state_transitions.conditions.condition.sys_id | Sys_id da condição. Tipo de dados: cadeia de caracteres |
| state_transitions.conditions.passed | Sinalizador que indica se a solicitação de mudança atendeu à condição associada. Valores válidos:
|
| transições_estado.display_value | Descrição exibida do estado. Tipo de dados: cadeia de caracteres |
| transições_de_estado.do_estado | Valor do estado de transição da solicitação de mudança. Tipo de dados: cadeia de caracteres |
| state_transitions.sys_id | Sys_id do estado de transição. Tipo de dados: cadeia de caracteres |
| transições_estado.para_estado | Valor do estado para o qual a solicitação de mudança está fazendo a transição. Tipo de dados: cadeia de caracteres |
| estado_transições.transição_disponível | Sinalizador que indica se a solicitação de mudança pode fazer a transição do estado atual para este estado. Valores válidos:
|
Solicitação de cURL
O exemplo de código a seguir mostra como chamar este endpoint.
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/b0dbda5347c12200e0ef563dbb9a718f"/nextstates \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
Retornar resultados:
{
"result": {
"available_states": [ "0", "4", "-1" ], // State values
"state_transitions": [
[
{
"sys_id": "7a0d2ccdc343101035ae3f52c1d3ae2e", // sttrm_state_transition sys id
"display_value": "Implement to Review",
"from_state": "-1",
"to_state": "0",
"transition_available": false, // If true, can move to this state
"automatic_transition": true, // If true, automatically moves to this state
"conditions": [
{
"passed": false, // If true, change request met this condition
"condition": {
"name": "No active Change Tasks",
"description": null,
"sys_id": "3c1d2ccdc343101035ae3f52c1d3aea4"
}
}
]
},
{
"sys_id": "db401481c343101035ae3f52c1d3aedd",
"display_value": "Implement to Review",
"from_state": "-1",
"to_state": "0",
"transition_available": true,
"automatic_transition": false,
"conditions": [
{
"passed": true,
"condition": {
"name": "Not On hold",
"description": null,
"sys_id": "2132deb6c303101035ae3f52c1d3ae8c"
}
}
]
}
],
[
{
"sys_id": "5327c551c343101035ae3f52c1d3aeec",
"display_value": "Implement to Canceled",
"from_state": "-1",
"to_state": "4",
"transition_available": true,
"automatic_transition": false,
"conditions": []
}
]
],
"state_label": { // state value to label pairs
"0": "Review",
"4": "Canceled",
"-1": "Implement"
}
}
}Gestão de mudanças - GET /sn_chg_rest/change/{change_sys_id}/schedule
Habilita a recuperação dos intervalos de tempo disponíveis para uma solicitação de mudança.
Função necessária: sn_change_writer.
Formato da URL
URL com controle de versão: /api/sn_chg_rest/{api_version}/change/{change_sys_id}/schedule
URL padrão: /api/sn_chg_rest/change/{change_sys_id}/schedule
Parâmetros de solicitação compatíveis
| Nome | Descrição |
|---|---|
| api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres |
| change_sys_id | Sys_id da solicitação de mudança na qual encontrar o próximo intervalo de tempo disponível. Localizado na tabela [change_request]. A solicitação de mudança selecionada deve ter um item de configuração (cmdb_ci) com horários de início e término planejados. |
| Nome | Descrição |
|---|---|
| Nenhum(a) |
| Nome | Descrição |
|---|---|
| Nenhum(a) |
Cabeçalhos
Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.
| Cabeçalho | Descrição |
|---|---|
| Aceitar | Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json |
| Cabeçalho | Descrição |
|---|---|
| Nenhum(a) |
Códigos de status
Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.
| Código de status | Descrição |
|---|---|
| 202 | O sistema aceitou a solicitação. |
| 400 | Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada. Possíveis problemas:
|
| 404 | Não encontrado. Não foi possível encontrar o registro especificado.
Possíveis problemas:
|
Parâmetros do corpo da resposta (JSON ou XML)
| Nome | Descrição |
|---|---|
| erro | Informações sobre erros encontrados ao processar a solicitação de endpoint. Tipo de dados: objeto |
| erro.detalhe | Informações adicionais sobre o erro. Tipo de dados: cadeia de caracteres |
| mensagem.erro | Mensagem que identifica o erro. Tipo de dados: cadeia de caracteres |
| mensagens | Informações da mensagem. Tipo de dados: objeto |
| mensagens.MensagensDeErro | Mensagens de erro encontradas ao processar a solicitação. Tipo de dados: matriz |
| mensagens.infoMensagens | Mensagens informativas encontradas durante o processamento da solicitação. Tipo de dados: matriz |
| mensagens.avisosMensagens | Mensagens de aviso encontradas durante o processamento da solicitação. Tipo de dados: matriz |
| solicitação | Solicitação de endpoint original. Tipo de dados: cadeia de caracteres |
| estado | Informações sobre o estado atual do trabalhador. Tipo de dados: objeto |
| estado.display_value | Valor de exibição do estado do trabalhador. Esses valores estão diretamente correlacionados ao parâmetro state.value. Valores possíveis:
Tipo de dados: cadeia de caracteres |
| estado.valor | Valor numérico do estado do trabalhador. Valores possíveis:
Tipo de dados: número |
| tipo | Indica o tipo de solicitação. Valor válido: programação Tipo de dados: cadeia de caracteres |
| trabalhador | Informações sobre o trabalhador associado. Tipo de dados: objeto |
| trabalhador.link | Link para recuperar dados de intervalo de tempo. Use o sys_id em GET /sn_chg_rest/change/worker/{sys_id} para exibir os resultados. Tipo de dados: cadeia de caracteres |
| trabalhador.sysId | Sys_id do trabalhador associado à solicitação de mudança. Tipo de dados: cadeia de caracteres |
| status | Aparece somente se um erro for encontrado. Status do processamento do endpoint. Valor possível: falha Tipo de dados: cadeia de caracteres |
Obter intervalos de tempo disponíveis
Use o valor fornecido em worker.link para obter detalhes da janela de programação. O valor está no seguinte formato:
https://instance.service-now.com/api/sn_chg_rest/change/worker/<worker_sys_id>
Use o work_sys_id em GET /sn_chg_rest/change/worker/{worker_sys_id} para exibir os resultados.
O corpo da resposta contém o status e fornece resultados quando o processamento é concluído.
- Se o intervalo de tempo fornecido estiver disponível para a solicitação de mudança dentro do intervalo de tempo programado, a API do trabalhador listará os intervalos de tempo disponíveis na propriedade payload.spans . Caso contrário, a propriedade payload.spans não está listada nos resultados.
- Se não houver intervalos de tempo disponíveis para a duração da solicitação de mudança fornecida dentro do intervalo de tempo de programação definido, o messages.infoMessages indicará o seguinte:
DNota:O valor padrão do intervalo de tempo de programação da solicitação de mudança é 90 dias. Para alterar este valor, modifique a propriedade change.conflict.next_available.schedule_window. Para obter mais informações, consulte Configuração de propriedades de análise de conflitos.
O exemplo de GET /sn_chg_rest/change/worker/{sys_id} a seguir mostra a saída fornecida usando o ID fornecido no detalhe do work.link. Os resultados listam os períodos de tempo em aberto disponíveis para a duração da tarefa.
{
"result": {
"worker": {
"sysId": "9b3f62e0a4c87010f87712198fe9cad1",
"link": "https://instance.service-now.com/api/sn_chg_rest/change/worker/9b3f62e0a4c87010f87712198fe9cad1"
},
"request": "{\"change_sys_id\":\"87ae5e900a0a2c3e263e8304e727c646\",\"timezone\":\"America/Los_Angeles\"}",
"state": {
"value": 3,
"display_value": "Complete"
},
"type": "schedule",
"messages": {
"errorMessages": [],
"warningMessages": [],
"infoMessages": []
},
"payload": {
"spans": [
{
"start": {
"value": "2021-05-08 08:00:00",
"display_value": "2021-05-08 01:00:00"
},
"end": {
"value": "2021-05-08 11:00:00",
"display_value": "2021-05-08 04:00:00"
}
},
{
"start": {
"value": "2021-05-15 08:00:00",
"display_value": "2021-05-15 01:00:00"
},
"end": {
"value": "2021-05-15 11:00:00",
"display_value": "2021-05-15 04:00:00"
}
},
...
]
}
}
}Solicitação de cURL
curl "https://instance.servicenow.com/api/sn_chg_rest/change/{change_sys_id}/schedule" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
Os resultados incluem detalhes de work.link que você pode usar para executar o sys_id fornecido no endpoint GET /sn_chg_rest/change/worker/.
{
"result": {
"worker": {
"sysId": "9b3f62e0a4c87010f87712198fe9cad1",
"link": "https://instance.service-now.com/api/sn_chg_rest/change/worker/9b3f62e0a4c87010f87712198fe9cad1"
},
"request": "{\"change_sys_id\":\"87ae5e900a0a2c3e263e8304e727c646\",\"timezone\":\"America/Los_Angeles\"}",
"state": {
"value": 1,
"display_value": "Waiting"
},
"type": "schedule",
"messages": {
"errorMessages": [],
"warningMessages": [],
"infoMessages": []
}
}
}Gestão de mudanças - GET /sn_chg_rest/change/{change_sys_id}/task
Recupera uma ou mais tarefas associadas a uma solicitação de mudança especificada com base nos critérios especificados.
Formato da URL
URL com controle de versão: /api/sn_chg_rest/{api_version}/change/{change_sys_id}/task
URL padrão: /api/sn_chg_rest/change/{change_sys_id}/task
Parâmetros de solicitação compatíveis
| Nome | Descrição |
|---|---|
| api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres |
| change_sys_id | Sys_id da solicitação de mudança cujas tarefas serão recuperadas. Localizado na tabela Solicitação de mudança [change_request]. Tipo de dados: cadeia de caracteres |
| Nome | Descrição |
|---|---|
| pares de chave-valor | Campos a serem modificados ao criar a solicitação. A chave é o nome do campo no modelo e o valor são as informações a serem preenchidas no campo. Campos que não podem ser modificados e serão ignorados se passados:
Tipo de dados: cadeia de caracteres |
| pedido | Campo pelo qual classificar as solicitações de mudança retornadas. Padrão: número Tipo de dados: cadeia de caracteres |
| sysparm_limit | Número máximo de registros a serem retornados. Para solicitações que excedem esse número de registros, use o parâmetro sysparm_offset para paginar a recuperação do registro. Tipo de dados: número Padrão: 500 |
| sysparm_offset | Índice de registro inicial para o qual a recuperação de registros será iniciada. Use este valor para paginar a recuperação do registro. Essa funcionalidade permite a recuperação de todos os registros, independentemente do número de registros, em pequenos blocos gerenciáveis. Por exemplo, na primeira vez que você chama este endpoint, sysparm_offset é definido como "0". Para simplesmente percorrer todos os registros disponíveis, use Tipo de dados: número Padrão: 0 |
| sysparm_query | Consulta codificada usada para filtrar o conjunto de resultados. Você pode usar um filtro de IU para obter uma consulta codificada corretamente. Sintaxe: sysparm_query=<col_name><operator><value> .
Todos os parâmetros fazem distinção entre maiúsculas e minúsculas. As consultas podem conter mais de uma entrada, como sysparm_query=<col_name><operator><value> [ ] . Por exemplo:
As consultas codificadas também oferecem suporte à ordem por funcionalidade. Para classificar respostas com base em determinados campos, use as cláusulas Sintaxe:
Por exemplo: Esta consulta filtra todos os registros ativos e ordena os resultados em ordem crescente por número e, em seguida, em ordem decrescente por categoria. Se parte da consulta for inválida, por exemplo, especificando um nome de campo inválido, a instância ignorará a parte inválida. Em seguida, ele retorna linhas usando somente a parte válida da consulta. Você pode controlar esse comportamento usando a propriedade glide.invalid_query.returns_no_rows. Defina esta propriedade como verdadeira para não retornar linhas em uma consulta inválida. Nota: A propriedade glide.invalid_query.returns_no_rows controla o comportamento de todas as consultas na instância, como em listas, scripts (GlideRecord.query()) e APIs de serviço web. Tipo de dados: cadeia de caracteres |
| pesquisa de texto | Cadeia de caracteres a ser usada para pesquisar todos os campos de registro de tarefa de mudança. Esta pesquisa usa ServiceNow a funcionalidade da plataforma de pesquisa de texto completo e o padrão é IR_AND_OR_QUERY.Tipo de dados: cadeia de caracteres |
| Nome | Descrição |
|---|---|
| Nenhum(a) |
Cabeçalhos
Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.
| Cabeçalho | Descrição |
|---|---|
| Aceitar | Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json |
| Cabeçalho | Descrição |
|---|---|
| Nenhum(a) |
Códigos de status
Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.
| Código de status | Descrição |
|---|---|
| 200 | Solicitação concluída com sucesso. |
| 400 | Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada. |
| 401 | Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas. |
| 404 | Não encontrado. Não foi possível encontrar o registro especificado. |
| 500 | Erro Interno do Servidor. Ocorreu um erro de lógica no código do lado do servidor. |
Parâmetros do corpo da resposta (JSON ou XML)
| Nome | Descrição |
|---|---|
| pares de nome-valor | Todos os campos (chave) com seus valores associados para a tarefa de solicitação de mudança identificada antes da exclusão. Tipo de dados: objeto |
| primário | Informações da solicitação de mudança associada à tarefa. Tipo de dados: objeto |
| primário.display_value | Informações da solicitação de mudança a serem exibidas em uma IU. Tipo de dados: cadeia de caracteres |
| primário.valor | Sys_id da solicitação de mudança associada à tarefa. Tipo de dados: cadeia de caracteres |
| sys_id | Informações de Sys_id para a tarefa de solicitação de mudança. Tipo de dados: objeto |
| sys_id.display_value | Sys_id da tarefa de solicitação de mudança a ser exibida em uma IU. Tipo de dados: cadeia de caracteres |
| sys_id.value | Sys_id da tarefa de solicitação de mudança. Tipo de dados: cadeia de caracteres |
Solicitação de cURL
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/0f4ac6c4b750230096c3e4f6ee11a9fe/task?sysparm_query=active=true^ORDERBYnumber" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'
{
result: [
{
sys_id: {
value: "12629ec4b750230096c3e4f6ee11a9d5",
display_value: "12629ec4b750230096c3e4f6ee11a9d5"
},
parent: {
value: "0f4ac6c4b750230096c3e4f6ee11a9fe ",
display_value: "CHG0033046 "
},
..., // all valid fields in record, example below
short_description: {
value: "Retire node",
display_value: "Retire node"
}
},
{ // next record found }, ... // and so on
]
}
Gestão de mudanças - GET /sn_chg_rest/change/{sys_id}
Recupera a solicitação de mudança identificada pelo sys_id especificado.
Formato da URL
URL com controle de versão: /api/sn_chg_rest/{api_version}/change/{sys_id}
URL padrão: /api/sn_chg_rest/change/{sys_id}
Parâmetros de solicitação compatíveis
| Nome | Descrição |
|---|---|
| api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres |
| sys_id | Sys_id do registro de solicitação de mudança a ser recuperado da tabela Solicitação de Mudança [change_request]. Tipo de dados: cadeia de caracteres |
| Nome | Descrição |
|---|---|
| Nenhum(a) |
| Nome | Descrição |
|---|---|
| Nenhum(a) |
Cabeçalhos
Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.
| Cabeçalho | Descrição |
|---|---|
| Aceitar | Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json |
| Cabeçalho | Descrição |
|---|---|
| Nenhum(a) |
Códigos de status
Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.
| Código de status | Descrição |
|---|---|
| 200 | Solicitação concluída com sucesso. |
| 400 | Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada. |
| 401 | Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas. |
| 404 | Não encontrado. Não foi possível encontrar o registro especificado. |
| 500 | Erro Interno do Servidor. Ocorreu um erro de lógica no código do lado do servidor. |
Parâmetros do corpo da resposta (JSON ou XML)
| Elemento | Descrição |
|---|---|
| resultado | Lista que contém um ou mais objetos de registro de solicitação de mudança. Cada objeto descreve uma solicitação de mudança. Cada elemento no objeto de solicitação de mudança corresponde a um campo em seu registro associado na tabela Solicitação de mudança [change_request]. Todos os elementos contêm pares de nome-valor value e display_value. Os campos de data também contêm pares de nome-valor display_value_internal. Tipo de dados: matriz |
| action_status | Status da ação atual da solicitação de mudança associada. Valores possíveis:
Tipo de dados: número |
| ativo | Sinalizador que indica se a solicitação de mudança está ativa. Valores possíveis:
Tipo de dados: booliano Padrão: verdadeiro |
| atividade_vencida | Data e hora em que o caso associado deve ser concluído. Tipo de dados: cadeia de caracteres |
| adicional_designado_lista | Lista de sys_ids de pessoas adicionais atribuídas para trabalhar na solicitação de mudança. Tipo de dados: matriz |
| aprovação | Tipo de processo de aprovação necessário. Tipo de dados: cadeia de caracteres Padrão: não solicitado |
| histórico_de_aprovação | Entrada de registro do histórico de aprovação mais recente. Tipo de dados: cadeia de caracteres |
| aprovação_conjunto | Data e hora em que a ação associada foi aprovada. Tipo de dados: cadeia de caracteres |
| assigned_to | Sys_id do usuário atribuído à solicitação de mudança. Tipo de dados: cadeia de caracteres |
| assignment_group | Sys_id do grupo atribuído à solicitação de mudança. Tipo de dados: cadeia de caracteres |
| backout_plan | Descrição do plano a ser executado se a mudança precisar ser revertida. Tipo de dados: cadeia de caracteres |
| business_duration | Duração em horas de trabalho programadas, dias úteis e semanas de trabalho necessários para concluir a mudança. Tipo de dados: cadeia de caracteres |
| business_service | Sys_id do serviço de negócio associado à solicitação de mudança. Localizado na tabela Serviço [cmdb_ci_service]. Tipo de dados: cadeia de caracteres |
| data_cab | Data em que o Comitê Consultivo de Mudança (CCM) se reúne. Tipo de dados: cadeia de caracteres |
| delegado_cab | Sys_id do usuário que pode substituir o gerente do CCM durante uma reunião do CCM. Localizado na tabela Usuário [sys_user] Tipo de dados: cadeia de caracteres |
| recomendação_cab | Descrição das recomendações do CCM para a solicitação de mudança. Tipo de dados: cadeia de caracteres Tamanho máximo: 4.000 |
| cab_required | Sinalizador que indica se o CCM é necessário. Valores possíveis:
Tipo de dados: booliano Padrão: falso |
| calendar_duration | Não usado atualmente por Gestão de mudanças. Tipo de dados: cadeia de caracteres |
| categoria | Categoria da mudança, por exemplo, hardware, rede ou software. Tipo de dados: cadeia de caracteres Padrão: outro |
| plano_mudança | Atividades e funções para gerenciar e controlar a solicitação de mudança. Tipo de dados: cadeia de caracteres |
| modelo_chg | Sys_id do modelo de mudança no qual a solicitação de mudança associada se baseou. Localizado na tabela Modelo de mudança [chg_model]. O modelo de mudança define o fluxo de estado, as transições e as atividades do processo que devem ser concluídas para a solicitação de mudança. Tipo de dados: cadeia de caracteres |
| closed_at | Data e hora em que a solicitação de mudança associada foi encerrada. Tipo de dados: cadeia de caracteres |
| closed_by | Sys_id da pessoa que fechou a solicitação de mudança. Localizado na tabela Usuário [sys_user]. Tipo de dados: cadeia de caracteres |
| close_code | Código atribuído à solicitação de mudança quando ela foi fechada. Por exemplo, Bem-sucedido, Bem-sucedido com problemas e Mal-sucedido. Tipo de dados: cadeia de caracteres |
| close_notes | Anotações que a pessoa inseriu ao fechar a solicitação de mudança. Tipo de dados: cadeia de caracteres |
| cmdb_ci | Sys_id do item de configuração associado à solicitação de mudança. Localizado na tabela Item de configuração [cmdb_ci]. Tipo de dados: cadeia de caracteres |
| comentários | Lista de anotações de trabalho do cliente inseridas na solicitação de mudança associada. Tipo de dados: matriz |
| comments_and_work_notes | Lista de anotações de trabalho internas e de contato com o cliente inseridas para a solicitação de mudança associada. Tipo de dados: matriz Tamanho máximo: 4.000 |
| empresa | Sys_id da empresa associada à solicitação de mudança. Localizado na tabela Empresa [core_company]. Tipo de dados: cadeia de caracteres |
| conflito_última_execução | Data e hora em que o script de detecção de conflitos foi executado pela última vez na solicitação de mudança. Tipo de dados: cadeia de caracteres |
| conflito_status | Status de conflito atual conforme detectado pelo script de detecção de conflitos, como Conflito e Não executado. Tipo de dados: cadeia de caracteres Tamanho máximo: 40 Padrão: não executado |
| contato_tipo | Método no qual a solicitação de mudança foi solicitada inicialmente. Valores possíveis:
Tipo de dados: cadeia de caracteres |
| contrato | Sys_id do contrato associado à solicitação de mudança. Localizado na tabela Contrato [ast_contract]. Tipo de dados: cadeia de caracteres |
| correlação_display | Nome amigável para o correlation_id. Tipo de dados: cadeia de caracteres Tamanho máximo: 100 |
| correlation_id | ID exclusivo globalmente (GUID) de um registro de solicitação de mudança correspondente em um sistema de terceiros. Tipo de dados: cadeia de caracteres Tamanho máximo: 100 |
| plano_de_entrega | Não está mais em uso. Sys_id do plano de entrega associado à solicitação de mudança. Localizado na tabela Plano de execução [sc_cat_item_delivery_plan]. Tipo de dados: cadeia de caracteres |
| entrega_tarefa | Não está mais em uso. Sys_id da tarefa de entrega associada à solicitação de mudança. Localizado na tabela Tarefa do plano de execução [sc_cat_item_delivery_task]. Tipo de dados: cadeia de caracteres |
| descrição | Descrição detalhada da solicitação de mudança. Tipo de dados: cadeia de caracteres Tamanho máximo: 4.000 |
| due_date | Prazo da tarefa. Não usado pelo processo de solicitação de mudança. Tipo de dados: cadeia de caracteres |
| end_date | Data e hora em que a solicitação de mudança deve ser concluída. Tipo de dados: cadeia de caracteres |
| escalação | Nível de escalação atual. Valores possíveis:
Tipo de dados: número (inteiro) Padrão: 0 |
| expected_start | Data e hora em que a tarefa deve ser iniciada. Não usado pelo processo de solicitação de mudança. Tipo de dados: cadeia de caracteres |
| acompanhamento | Data e hora em que um usuário fez o acompanhamento da pessoa que solicitou a solicitação de mudança. Tipo de dados: cadeia de caracteres |
| group_list | Lista de sys_ids e nomes dos grupos associados à solicitação de mudança. Tipo de dados: matriz Tamanho máximo: 4.000 |
| impacto | O impacto que a solicitação de mudança terá sobre o cliente. Valores possíveis:
Tipo de dados: número (inteiro) Padrão: 3 |
| implementação_plano | Etapas sequenciais a serem executadas para implementar esta mudança. Ele também contém todas as dependências entre etapas e detalhes do designado para cada etapa. Tipo de dados: cadeia de caracteres Tamanho máximo: 4.000 |
| justificativa | Benefícios da implementação desta mudança e o impacto se esta mudança não for implementada. Tipo de dados: cadeia de caracteres Tamanho máximo: 4.000 |
| conhecimento | Sinalizador que indica se há artigos da base de conhecimento ()KB) associados à solicitação de mudança. Valores possíveis:
Tipo de dados: booliano |
| local | Sys_id e nome do local do equipamento referenciado na solicitação de mudança. Localizado no Local Localizado na tabela Local [cmn_location]. Tipo de dados: cadeia de caracteres |
| ANS_feito | Não mais usado. Sinalizador que indica se a solicitação de mudança foi implementada de acordo com o acordo de nível de serviço associado. Tipo de dados: booliano |
| precisa_atenção | Sinalizador que indica se a solicitação de mudança precisa de atenção. Valores possíveis:
Tipo de dados: booliano Padrão: falso |
| número | Número de mudança atribuído à solicitação de mudança pelo sistema, como CHG0040007. Tipo de dados: cadeia de caracteres |
| em espera | Sinalizador que indica se a solicitação de mudança está em espera no momento. Valores possíveis:
Tipo de dados: booliano Padrão: falso |
| em_hold_reason | Se o parâmetro on_hold for "verdadeiro", descrição do motivo pelo qual a solicitação de mudança está sendo retida. Tipo de dados: cadeia de caracteres Tamanho máximo: 4.000 |
| em espera_tarefa | Se o parâmetro on_hold for "verdadeiro", a lista dos sys_ids das tarefas que devem ser concluídas antes que a espera seja liberada. Tipo de dados: cadeia de caracteres Tamanho máximo: 4.000 |
| opened_at | Data e hora em que a versão de mudança foi criada. Tipo de dados: cadeia de caracteres |
| opened_by | Sys_id e nome do usuário que criou a versão de mudança. Localizado na tabela Usuário [sys_user]. Tipo de dados: cadeia de caracteres |
| pedido | Não usado por Gestão de mudanças. Campo numérico opcional pelo qual os registros são ordenados, como ao recuperá-los de um banco de dados. Tipo de dados: número (inteiro) |
| programação_de_manutenção_fora | Sinalizador que indica se a manutenção de uma empresa externa foi programada para a solicitação de mudança. Valores possíveis:
Tipo de dados: booliano Padrão: falso |
| primário | Sys_id e nome da tarefa primária para esta solicitação de mudança, se houver. Localizado na tabela Tarefa [task]. Tipo de dados: cadeia de caracteres |
| fase | Fase atual da solicitação de mudança. Isso define o que a mudança está fazendo com mais detalhes. Valores possíveis:
Tipo de dados: cadeia de caracteres |
| fase_estado | Registros change_phase que devem ser criados para uma mudança. Eles dependem da categoria, de modo que cada tipo de mudança pode ter diferentes registros change_phase. Os registros change_phase oferecem uma oportunidade de controlar o processo de aprovação, já que cada change_phase pode ter uma programação e um conjunto de aprovadores. Valores possíveis:
Tipo de dados: cadeia de caracteres |
| prioridade | Prioridade da solicitação de mudança. Valores possíveis:
Tipo de dados: número (inteiro) Padrão: 4 |
| produção_sistema | Sinalizador que indica se a solicitação de mudança é para uma instância ServiceNow que está em um ambiente de produção. Valores possíveis:
Tipo de dados: booliano |
| motivo | Descrição do motivo pelo qual a solicitação de mudança foi iniciada. Valores possíveis:
Tipo de dados: cadeia de caracteres Tamanho máximo: 40 |
| reatribuição_conta | Número de vezes que a solicitação de mudança foi reatribuída a um novo proprietário. Tipo de dados: número (inteiro) Padrão: 0 |
| rejeição_ir para | Sys_id da tarefa a ser executada se a solicitação de mudança for rejeitada. Localizado na Tarefa [tabela]. Tipo de dados: cadeia de caracteres |
| solicitado_por | Sys_id do usuário que solicitou a mudança. Localizado na tabela Usuário [sys_user]. Tipo de dados: cadeia de caracteres |
| solicitado_por_data | Data e hora em que a mudança deve ser implementada por. Tipo de dados: cadeia de caracteres |
| revisão_comentários | Comentários inseridos quando a solicitação de mudança foi revisada. Tipo de dados: cadeia de caracteres Tamanho máximo: 4.000 |
| revisão_data | Data em que a solicitação de mudança foi revisada. Tipo de dados: cadeia de caracteres |
| revisão_status | Status atual da revisão da solicitação de mudança solicitada. Tipo de dados: cadeia de caracteres |
| risco | Nível de risco associado à solicitação de mudança. Valores válidos:
Tipo de dados: número Padrão: 3 |
| análise_de_impacto_risco | Descrição do risco e análise da implementação da solicitação de mudança. Tipo de dados: cadeia de caracteres Tamanho máximo: 4.000 |
| rota_reason | Não usado atualmente por Gestão de mudanças. Motivo pelo qual a solicitação de mudança foi transferida. Valores possíveis:
Tipo de dados: número |
| scope | Tamanho da solicitação de mudança. Valores possíveis:
Tipo de dados: número Padrão: 3 |
| service_offering | Sys_id da oferta de serviço associada à solicitação de mudança. As ofertas de serviço definem exclusivamente o nível de serviço em termos de disponibilidade, escopo, preço e opções de pacote. Localizado na tabela Oferta [service_offering]. Tipo de dados: cadeia de caracteres |
| short_description | Descrição da solicitação de mudança. Tipo de dados: cadeia de caracteres Tamanho máximo: 40 |
| habilidades | Lista de sys_ids de todas as habilidades necessárias para implementar a solicitação de mudança. Localizado na tabela Habilidade [cmn_skill]. Tipo de dados: matriz |
| atraso_devido | Não está mais em uso. Data e hora em que a solicitação de mudança deve ser concluída com base no acordo de nível de serviço associado. Tipo de dados: cadeia de caracteres |
| sn_esign_document | Sys_id de qualquer documento assinado eletronicamente anexado à solicitação de mudança. Localizado na tabela Anexo [sys_attachment]. Tipo de dados: cadeia de caracteres |
| sn_esign_esignature_configuration | Sys_id do modelo de assinatura eletrônica usado para o documento associado. Localizado na tabela Modelo de assinatura eletrônica [sn_esign_configuration]. Tipo de dados: cadeia de caracteres |
| start_date | Data e hora em que a solicitação de mudança está planejada para iniciar a implementação. Tipo de dados: cadeia de caracteres |
| estado | Estado atual da solicitação de mudança. Os valores possíveis são definidos no modelo de mudança. Tipo de dados: número (inteiro) Padrão: 1 |
| std_change_producer_version | Sys_id do produtor de registro e da proposta de mudança associada à solicitação de mudança. Ele também inclui o número e a porcentagem de solicitações de mudança bem-sucedidas e malsucedidas criadas a partir da proposta. Localizado na tabela Versão do modelo de mudança padrão [std_change_producer_version]. Tipo de dados: cadeia de caracteres |
| sys_class_name | Nome da tabela na qual a solicitação de mudança está localizada. Tipo de dados: cadeia de caracteres |
| sys_created_by | Nome do usuário que criou inicialmente a solicitação de mudança. Tipo de dados: cadeia de caracteres Tamanho máximo: 40 |
| sys_created_on | Data e hora em que o registro de solicitação de mudança associado foi criado originalmente. Tipo de dados: cadeia de caracteres |
| sys_domain | Se estiver usando domínios na instância, o nome do domínio ao qual o registro do módulo de mudança está associado. Tipo de dados: cadeia de caracteres |
| sys_domain_path | Se estiver usando domínios na instância, o caminho do domínio no qual o registro do módulo de mudança associado reside. Tipo de dados: cadeia de caracteres |
| sys_id | Identificador exclusivo do registro de solicitação de mudança associado. Tipo de dados: cadeia de caracteres |
| sys_mod_count | Número de atualizações do caso desde que ele foi criado pela primeira vez. Tipo de dados: número (inteiro) |
| sys_updated_by | Pessoa que atualizou o caso pela última vez. Tipo de dados: cadeia de caracteres Tamanho máximo: 40 |
| sys_updated_on | Data e hora em que o caso foi atualizado pela última vez. Tipo de dados: cadeia de caracteres |
| número_efetivo_tarefa | Número da Solicitação universal. Tipo de dados: cadeia de caracteres Tamanho máximo: 40 |
| tarefa_para | Não usado por Gestão de mudanças. Sys_id do usuário para o qual a tarefa foi criada. Localizado na tabela Usuário [sys_user]. Tipo de dados: cadeia de caracteres |
| plano_teste | Descrição do plano de testes associado à mudança. Tipo de dados: cadeia de caracteres Tamanho máximo: 4.000 |
| tempo_trabalhado | Quantidade total de tempo trabalhado na solicitação de mudança. Tipo de dados: cadeia de caracteres |
| tipo | Tipo de solicitação de mudança. Valores possíveis:
Tipo de dados: cadeia de caracteres Tamanho máximo: 40 |
| não autorizado | Sinalizador que indica se a solicitação de mudança não foi autorizada Valores possíveis:
Tipo de dados: booliano |
| universal_request | Sys_id da Solicitação universal primária da qual esta solicitação de mudança faz parte. Localizado na tabela Tarefa [task]. Tipo de dados: cadeia de caracteres |
| mediante_aprovação | Ação a ser tomada se a solicitação de mudança for aprovada. Valores possíveis:
Tipo de dados: cadeia de caracteres Tamanho máximo: 40 Padrão: prosseguir |
| mediante_rejeitar | Ação a ser tomada se a solicitação de mudança for rejeitada. Valores possíveis:
Tipo de dados: cadeia de caracteres Tamanho máximo: 40 Padrão: cancelar |
| urgência | Urgência da solicitação de mudança. Valores possíveis:
Tipo de dados: número (inteiro) Padrão: 3 |
| user_input | Entrada adicional do usuário. Tipo de dados: cadeia de caracteres Tamanho máximo: 4.000 |
| variáveis | Pares de nome-valor de variáveis associadas à solicitação de mudança. Tipo de dados: cadeia de caracteres Tamanho máximo: 40 |
| watch_list | Lista de sys_ids dos usuários que recebem notificações sobre esta solicitação de mudança quando comentários adicionais são adicionados ou se o estado de uma solicitação de mudança é alterado para Resolvido ou Encerrado. Localizado na tabela Usuário [sys_user]. Tipo de dados: matriz |
| wf_activity | Sys_id do registro de atividade de fluxo de trabalho associado à solicitação de mudança. Localizado na tabela Atividade de fluxo de trabalho [wf_activity]. Tipo de dados: cadeia de caracteres |
| fim_trabalho | Data e hora em que o trabalho foi encerrado na solicitação de mudança. Tipo de dados: cadeia de caracteres |
| work_notes | Informações sobre como resolver a solicitação de mudança ou as medidas tomadas para resolvê-la. Tipo de dados: cadeia de caracteres Tamanho máximo: 4.000 |
| lista_anotações_trabalho | Lista de sys_ids dos usuários internos que recebem notificações sobre essa solicitação de mudança quando anotações de trabalho são adicionadas. Localizado na tabela Usuário [sys_user]. Tipo de dados: matriz |
| início_trabalho | Data e hora em que o trabalho foi iniciado na solicitação de mudança. Tipo de dados: cadeia de caracteres |
Solicitação de cURL
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/b0dbda5347c12200e0ef563dbb9a718f" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
{
"result":
{
"reason": {
"display_value": "",
"value": ""
},
"parent": {
"display_value": "",
"value": ""
},
"watch_list": {
"display_value": "",
"value": ""
},
"proposed_change": {
"display_value": "",
"value": ""
},
"upon_reject": {
"display_value": "Cancel all future Tasks",
"value": "cancel"
},
"sys_updated_on": {
"display_value": "2015-07-06 11:59:27",
"value": "2015-07-06 18:59:27",
"display_value_internal": "2015-07-06 11:59:27"
},
"type": {
"display_value": "Standard",
"value": "standard"
},
"approval_history": {
"display_value": "",
"value": ""
},
"skills": {
"display_value": "",
"value": ""
},
"test_plan": {
"display_value": "--Confirm that there are no monitoring alerts for the router",
"value": "--Confirm that there are no monitoring alerts for the router"
},
"number": {
"display_value": "CHG0000024",
"value": "CHG0000024"
},
"is_bulk": {
"display_value": "false",
"value": false
},
"cab_delegate": {
"display_value": "",
"value": ""
},
"requested_by_date": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"ci_class": {
"display_value": "cmdb_ci",
"value": "cmdb_ci"
},
"state": {
"display_value": "Closed",
"value": 3.0
},
"sys_created_by": {
"display_value": "admin",
"value": "admin"
},
"knowledge": {
"display_value": "false",
"value": false
},
"order": {
"display_value": "",
"value": ""
},
"phase": {
"display_value": "Requested",
"value": "requested"
},
"cmdb_ci": {
"display_value": "",
"value": ""
},
"delivery_plan": {
"display_value": "",
"value": ""
},
"impact": {
"display_value": "3 - Low",
"value": 3.0
},
"contract": {
"display_value": "",
"value": ""
},
"active": {
"display_value": "false",
"value": false
},
"work_notes_list": {
"display_value": "",
"value": ""
},
"priority": {
"display_value": "4 - Low",
"value": 4.0
},
"sys_domain_path": {
"display_value": "/",
"value": "/"
},
"cab_recommendation": {
"display_value": "",
"value": ""
},
"production_system": {
"display_value": "false",
"value": false
},
"rejection_goto": {
"display_value": "",
"value": ""
},
"review_date": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"requested_by": {
"display_value": "System Administrator",
"value": "6816f79cc0a8016401c5a33be04be441"
},
"business_duration": {
"display_value": "",
"value": ""
},
"group_list": {
"display_value": "",
"value": ""
},
"change_plan": {
"display_value": "",
"value": ""
},
"approval_set": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"wf_activity": {
"display_value": "",
"value": ""
},
"implementation_plan": {
"display_value": "-- Place router into maintenance mode in the monitoring platform\r\n-- Logon to router through SSH\r\n-- Run the following command\r\n\r\nrouter(config-router)#router bgp 12345\r\nrouter(config-router)#neighbor {neighbor ip} soft-reconfig [inbound]\r\nrouter#clear ip bgp {neighbor ip} soft in\r\n\r\n-- Confirm the sessions have been cleared\r\n-- Place router back into operational mode in the monitoring platform",
"value": "-- Place router into maintenance mode in the monitoring platform\r\n-- Logon to router through SSH\r\n-- Run the following command\r\n\r\nrouter(config-router)#router bgp 12345\r\nrouter(config-router)#neighbor {neighbor ip} soft-reconfig [inbound]\r\nrouter#clear ip bgp {neighbor ip} soft in\r\n\r\n-- Confirm the sessions have been cleared\r\n-- Place router back into operational mode in the monitoring platform"
},
"universal_request": {
"display_value": "",
"value": ""
},
"end_date": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"short_description": {
"display_value": "Clear BGP sessions on a Cisco router",
"value": "Clear BGP sessions on a Cisco router"
},
"correlation_display": {
"display_value": "",
"value": ""
},
"work_start": {
"display_value": "2015-07-06 11:56:04",
"value": "2015-07-06 18:56:04",
"display_value_internal": "2015-07-06 11:56:04"
},
"delivery_task": {
"display_value": "",
"value": ""
},
"outside_maintenance_schedule": {
"display_value": "false",
"value": false
},
"additional_assignee_list": {
"display_value": "",
"value": ""
},
"std_change_producer_version": {
"display_value": "Clear BGP sessions on a Cisco router - 1",
"value": "16c2273c47010200e90d87e8dee49006"
},
"sys_class_name": {
"display_value": "Change Request",
"value": "change_request"
},
"service_offering": {
"display_value": "",
"value": ""
},
"closed_by": {
"display_value": "System Administrator",
"value": "6816f79cc0a8016401c5a33be04be441"
},
"follow_up": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"review_status": {
"display_value": "",
"value": ""
},
"reassignment_count": {
"display_value": "2",
"value": 2.0
},
"start_date": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"assigned_to": {
"display_value": "",
"value": ""
},
"variables": {
"display_value": "variable_pool",
"value": "variable_pool"
},
"sla_due": {
"display_value": "UNKNOWN",
"value": "",
"display_value_internal": ""
},
"comments_and_work_notes": {
"display_value": "",
"value": ""
},
"escalation": {
"display_value": "Normal",
"value": 0.0
},
"upon_approval": {
"display_value": "Proceed to Next Task",
"value": "proceed"
},
"correlation_id": {
"display_value": "",
"value": ""
},
"made_sla": {
"display_value": "true",
"value": true
},
"backout_plan": {
"display_value": "Due to the limited number of commands in the implementation plan it is not possible to backout the change.\r\n\r\nIf required you are authorized to reboot the router if BGP fails to work",
"value": "Due to the limited number of commands in the implementation plan it is not possible to backout the change.\r\n\r\nIf required you are authorized to reboot the router if BGP fails to work"
},
"conflict_status": {
"display_value": "Not Run",
"value": "Not Run"
},
"task_effective_number": {
"display_value": "CHG0000024",
"value": "CHG0000024"
},
"sys_updated_by": {
"display_value": "admin",
"value": "admin"
},
"opened_by": {
"display_value": "System Administrator",
"value": "6816f79cc0a8016401c5a33be04be441"
},
"user_input": {
"display_value": "",
"value": ""
},
"sys_created_on": {
"display_value": "2015-07-06 11:55:46",
"value": "2015-07-06 18:55:46",
"display_value_internal": "2015-07-06 11:55:46"
},
"on_hold_task": {
"display_value": "",
"value": ""
},
"sys_domain": {
"display_value": "global",
"value": "global"
},
"route_reason": {
"display_value": "",
"value": ""
},
"closed_at": {
"display_value": "2015-07-06 11:56:23",
"value": "2015-07-06 18:56:23",
"display_value_internal": "2015-07-06 11:56:23"
},
"review_comments": {
"display_value": "",
"value": ""
},
"business_service": {
"display_value": "",
"value": ""
},
"time_worked": {
"display_value": "",
"value": ""
},
"chg_model": {
"display_value": "",
"value": ""
},
"expected_start": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"opened_at": {
"display_value": "2015-06-09 11:55:46",
"value": "2015-06-09 18:55:46",
"display_value_internal": "2015-06-09 11:55:46"
},
"work_end": {
"display_value": "2015-07-06 11:56:10",
"value": "2015-07-06 18:56:10",
"display_value_internal": "2015-07-06 11:56:10"
},
"phase_state": {
"display_value": "Open",
"value": "open"
},
"cab_date": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"work_notes": {
"display_value": "",
"value": ""
},
"close_code": {
"display_value": "Successful",
"value": "successful"
},
"assignment_group": {
"display_value": "Network",
"value": "287ebd7da9fe198100f92cc8d1d2154e"
},
"description": {
"display_value": "Resend the complete BGP table to neighboring routers\r\n\r\n--Both neighbors need to support soft reset route refresh capability.\r\n--Stores complete BGP table of you neighbor in router memory.\r\n--Not a good idea on a peering router with full feed, due to the memory requirements.\r\n",
"value": "Resend the complete BGP table to neighboring routers\r\n\r\n--Both neighbors need to support soft reset route refresh capability.\r\n--Stores complete BGP table of you neighbor in router memory.\r\n--Not a good idea on a peering router with full feed, due to the memory requirements.\r\n"
},
"on_hold_reason": {
"display_value": "",
"value": ""
},
"calendar_duration": {
"display_value": "",
"value": ""
},
"close_notes": {
"display_value": "Completed without issues",
"value": "Completed without issues"
},
"sys_id": {
"display_value": "1766f1de47410200e90d87e8dee490f6",
"value": "1766f1de47410200e90d87e8dee490f6"
},
"contact_type": {
"display_value": "Phone",
"value": "phone"
},
"cab_required": {
"display_value": "false",
"value": false
},
"urgency": {
"display_value": "3 - Low",
"value": 3.0
},
"scope": {
"display_value": "Medium",
"value": 3.0
},
"company": {
"display_value": "",
"value": ""
},
"justification": {
"display_value": "",
"value": ""
},
"activity_due": {
"display_value": "UNKNOWN",
"value": "",
"display_value_internal": ""
},
"comments": {
"display_value": "",
"value": ""
},
"approval": {
"display_value": "Approved",
"value": "approved"
},
"due_date": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"sys_mod_count": {
"display_value": "10",
"value": 10.0
},
"on_hold": {
"display_value": "false",
"value": false
},
"sys_tags": {
"display_value": "",
"value": ""
},
"conflict_last_run": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"risk_value": {
"display_value": "",
"value": ""
},
"unauthorized": {
"display_value": "false",
"value": false
},
"risk": {
"display_value": "Moderate",
"value": 3.0
},
"location": {
"display_value": "",
"value": ""
},
"category": {
"display_value": "Other",
"value": "Other"
},
"risk_impact_analysis": {
"display_value": "",
"value": ""
}
}
}Gestão de mudanças - GET /sn_chg_rest/change/{sys_id}/ci
Recupera vários itens de configuração (ICs) associados a uma solicitação de mudança especificada com base no tipo de associação especificado.
Formato da URL
URL com controle de versões: /api/sn_chg_rest/{api_version}/change/{sys_id}/ci
URL padrão: /api/sn_chg_rest/change/{sys_id}/ci
Parâmetros de solicitação compatíveis
| Nome | Descrição |
|---|---|
| api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres |
| sys_id | Sys_id da solicitação de mudança para a qual os ICs do CMDB associados serão retornados. Tipo de dados: cadeia de caracteres |
| Nome | Descrição |
|---|---|
| tipo_associação | Obrigatório. Tipo de associação entre o IC do CMDB e a solicitação de mudança. Valores válidos:
Tipo de dados: cadeia de caracteres |
| pares de nome-valor | Pares de nome-valor a serem usados para filtrar o conjunto de resultados. O nome é o campo no qual o valor especificado é filtrado. Este parâmetro é mutuamente exclusivo com sysparm_query. Por exemplo, em vez de usar &sysparm_query=active=true, você pode simplificar a declaração de chamada usando &active=true. Você também pode usar o valor de exibição quando o campo for do tipo opção ou referência, como &state=closed em vez de &state=7. Para especificar vários pares de chave-valor, separe cada um com um e comercial, como &active=true&assigned_to=john.smith. Tipo de dados: cadeia de caracteres |
| sysparm_limit | Número máximo de registros a serem retornados. Para solicitações que excedem esse número de registros, use o parâmetro sysparm_offset para paginar a recuperação do registro. Tipo de dados: número Padrão: 500 |
| sysparm_offset | Índice de registro inicial para o qual a recuperação de registros será iniciada. Use este valor para paginar a recuperação do registro. Essa funcionalidade permite a recuperação de todos os registros, independentemente do número de registros, em pequenos blocos gerenciáveis. Por exemplo, na primeira vez que você chama este endpoint, sysparm_offset é definido como "0". Para simplesmente percorrer todos os registros disponíveis, use Tipo de dados: número Padrão: 0 |
| sysparm_query | Consulta codificada usada para filtrar o conjunto de resultados. Você pode usar um filtro de IU para obter uma consulta codificada corretamente. Sintaxe: sysparm_query=<col_name><operator><value> .
Todos os parâmetros fazem distinção entre maiúsculas e minúsculas. As consultas podem conter mais de uma entrada, como sysparm_query=<col_name><operator><value> [ ] . Por exemplo:
As consultas codificadas também oferecem suporte à ordem por funcionalidade. Para classificar respostas com base em determinados campos, use as cláusulas Sintaxe:
Por exemplo: Esta consulta filtra todos os registros ativos e ordena os resultados em ordem crescente por número e, em seguida, em ordem decrescente por categoria. Se parte da consulta for inválida, por exemplo, especificando um nome de campo inválido, a instância ignorará a parte inválida. Em seguida, ele retorna linhas usando somente a parte válida da consulta. Você pode controlar esse comportamento usando a propriedade glide.invalid_query.returns_no_rows. Defina esta propriedade como verdadeira para não retornar linhas em uma consulta inválida. Nota: A propriedade glide.invalid_query.returns_no_rows controla o comportamento de todas as consultas na instância, como em listas, scripts (GlideRecord.query()) e APIs de serviço web. Tipo de dados: cadeia de caracteres |
| Nome | Descrição |
|---|---|
| Nenhum(a) |
Cabeçalhos
Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.
| Cabeçalho | Descrição |
|---|---|
| Aceitar | Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json |
| Cabeçalho | Descrição |
|---|---|
| Nenhum(a) |
Códigos de status
Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.
| Código de status | Descrição |
|---|---|
| 200 | Bem-sucedido. A solicitação foi processada com sucesso. |
| 400 | Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada. A resposta de erro contém mensagens pertinentes para ajudar a solucionar o problema. |
| 401 | Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas. |
| 500 | Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro. |
Parâmetros do corpo da resposta (JSON ou XML)
| Nome | Descrição |
|---|---|
| ci_item|cmdb_ci_service | As variáveis ci_item ou cmdb_ci_service, dependendo do tipo de associação. Tipo de dados: matriz |
| ci_item|cmdb_ci_service.value | Sys_id do ci_item ou cmdb_ci_service. Tipo de dados: cadeia de caracteres |
| ci_item|cmdb_ci_service.display_value | Valor de exibição de ci_item ou cmdb_ci_service. Tipo de dados: cadeia de caracteres |
| sys_id | Informações de sys_id da solicitação de mudança. Tipo de dados: objeto |
| sys_id.value | Sys_id da solicitação de mudança. Tipo de dados: cadeia de caracteres |
| sys_id.display_value | Sys_id da solicitação de mudança a ser exibida em uma IU. Tipo de dados: cadeia de caracteres |
| <record_fields> | Todos os campos válidos no registro ci_item ou cmdb_ci_service; tabela com base no tipo de associação. Tipo de dados: objeto |
Solicitação de cURL
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/c286d61347c12200e0ef563dbb9a71df/ci?association_type=affected" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'
{
result: [
{
sys_id: {
value: "92b8544047810200e90d87e8dee490b0",
display_value: "92b8544047810200e90d87e8dee490b0"
},
ci_item|cmdb_ci_service : {
value: "3a27d4370a0a0bb4006316812bf45439",
display_value: "PS Apache01"
},
..., // all valid fields in record, table based on association type
},
{ // next record found }, ... // and so on
]
}Gestão de mudanças - GET /sn_chg_rest/change/{sys_id}/conflict
Recupera o status do processo de verificação de conflitos de solicitação de mudança em execução ou os resultados do último processo de verificação de conflitos concluído para a solicitação de mudança especificada.
Formato da URL
URL com controle de versão: /api/sn_chg_rest/{api_version}/change/{sys_id}/conflict
URL padrão: /api/sn_chg_rest/change/{sys_id}/conflict
Parâmetros de solicitação compatíveis
| Nome | Descrição |
|---|---|
| api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres |
| sys_id | Sys_id da solicitação de mudança para a qual o status do processo de verificação de conflitos em execução/concluído será retornado. Localizado na tabela Solicitação de mudança [change_request]. Tipo de dados: cadeia de caracteres |
| Nome | Descrição |
|---|---|
| Nenhum(a) |
| Nome | Descrição |
|---|---|
| Nenhum(a) |
Cabeçalhos
Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.
| Cabeçalho | Descrição |
|---|---|
| Aceitar | Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json |
| Cabeçalho | Descrição |
|---|---|
| Nenhum(a) |
Códigos de status
Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.
| Código de status | Descrição |
|---|---|
| 200 | Status atual do processo de verificação de conflitos; incluindo conflitos se algum for detectado. |
| 400 | Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada. |
| 401 | Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas. |
| 404 | Não encontrado. Não foi possível encontrar o registro especificado. |
| 500 | Erro Interno do Servidor. Ocorreu um erro de lógica no código do lado do servidor. |
Parâmetros do corpo da resposta (JSON ou XML)
| Nome | Descrição |
|---|---|
| conflicts | Lista de conflitos encontrados para a solicitação de mudança. Um objeto vazio indica que nenhum conflito foi detectado. Tipo de dados: matriz |
| status_trabalho | Status do trabalho de verificação de conflitos real. Tipo de dados: cadeia de caracteres |
| última_execução | Data e hora em que o último processo de verificação de conflitos foi iniciado. Tipo de dados: cadeia de caracteres |
| record_count | Número de registros verificados. Tipo de dados: cadeia de caracteres |
| status | Resultado do processo de verificação de conflitos, como "Conflito" ou "Não executado". Nota:
Mesmo que a solicitação de mudança não tenha conflitos, este campo será definido como "Conflito". No entanto, o objeto conflicts está vazio. Tipo de dados: cadeia de caracteres |
Solicitação de cURL
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/0f4ac6c4b750230096c3e4f6ee11a9fe/conflict" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"Resposta bem-sucedida - sem conflitos
{
result: {
status: "Conflict",
last_run": "2018-08-30 12:58:05",
record_count: "1",
job_status: "2",
conflicts: []
}
}Solicitação de cURL
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/0f4ac6c4b750230096c3e4f6ee11a9fe/conflict" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
Resposta bem-sucedida - com conflitos
{
result: {
status: "Conflict",
last_run": "2018-08-30 12:58:05",
record_count: "1",
job_status: "2",
conflicts: [
{
change: {
display_value: "CHG0030001",
value: "afbffb24b758230096c3e4f6ee11a972"
},
type: {
display_value: "Not In Maintenance Window",
value: "not_in_maintenance_window"
}
..., // all valid fields in record, example below
}
]
}
}Gestão de mudanças - GET /sn_chg_rest/change/emergency
Recupera uma ou mais solicitações de mudança de emergência com base nos critérios especificados.
Formato da URL
URL com controle de versão: /api/sn_chg_rest/{api_version}/change/emergency
URL padrão: /api/sn_chg_rest/change/emergency
Parâmetros de solicitação compatíveis
| Nome | Descrição |
|---|---|
| api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres |
| Nome | Descrição |
|---|---|
| pedido | Campo pelo qual classificar as solicitações de mudança retornadas. Padrão: número Tipo de dados: cadeia de caracteres Padrão: número |
| sysparm_limit | Número máximo de registros a serem retornados. Para solicitações que excedem esse número de registros, use o parâmetro sysparm_offset para paginar a recuperação do registro. Tipo de dados: número Padrão: 500 |
| sysparm_offset | Índice de registro inicial para o qual a recuperação de registros será iniciada. Use este valor para paginar a recuperação do registro. Essa funcionalidade permite a recuperação de todos os registros, independentemente do número de registros, em pequenos blocos gerenciáveis. Por exemplo, na primeira vez que você chama este endpoint, sysparm_offset é definido como "0". Para simplesmente percorrer todos os registros disponíveis, use Tipo de dados: número Padrão: 0 |
| sysparm_query | Consulta codificada usada para filtrar o conjunto de resultados. Você pode usar um filtro de IU para obter uma consulta codificada corretamente. Sintaxe: sysparm_query=<col_name><operator><value> .
Todos os parâmetros fazem distinção entre maiúsculas e minúsculas. As consultas podem conter mais de uma entrada, como sysparm_query=<col_name><operator><value> [ ] . Por exemplo:
As consultas codificadas também oferecem suporte à ordem por funcionalidade. Para classificar respostas com base em determinados campos, use as cláusulas Sintaxe:
Por exemplo: Esta consulta filtra todos os registros ativos e ordena os resultados em ordem crescente por número e, em seguida, em ordem decrescente por categoria. Se parte da consulta for inválida, por exemplo, especificando um nome de campo inválido, a instância ignorará a parte inválida. Em seguida, ele retorna linhas usando somente a parte válida da consulta. Você pode controlar esse comportamento usando a propriedade glide.invalid_query.returns_no_rows. Defina esta propriedade como verdadeira para não retornar linhas em uma consulta inválida. Nota: A propriedade glide.invalid_query.returns_no_rows controla o comportamento de todas as consultas na instância, como em listas, scripts (GlideRecord.query()) e APIs de serviço web. Tipo de dados: cadeia de caracteres |
| pares de chave-valor | Pares de nome-valor a serem usados para filtrar o conjunto de resultados. O nome é o campo no qual o valor especificado é filtrado. Este parâmetro é mutuamente exclusivo com sysparm_query. Por exemplo, em vez de usar &sysparm_query=active=true, você pode simplificar a declaração de chamada usando &active=true. Você também pode usar o valor de exibição quando o campo for do tipo opção ou referência, como &state=closed em vez de &state=7. Para especificar vários pares de chave-valor, separe cada um com um e comercial, como &active=true&assigned_to=john.smith. Tipo de dados: cadeia de caracteres |
| pesquisa de texto | Cadeia de caracteres a ser usada para pesquisar todos os campos de registro de solicitação de mudança de emergência. Esta pesquisa usa ServiceNow a funcionalidade da plataforma de pesquisa de texto completo e o padrão é IR_AND_OR_QUERY.Tipo de dados: cadeia de caracteres |
| Nome | Descrição |
|---|---|
| Nenhum(a) |
Cabeçalhos
Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.
| Cabeçalho | Descrição |
|---|---|
| Aceitar | Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json |
| Cabeçalho | Descrição |
|---|---|
| Nenhum(a) |
Códigos de status
Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.
| Código de status | Descrição |
|---|---|
| 200 | Solicitação concluída com sucesso. |
| 401 | Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas. |
| 500 | Erro Interno do Servidor. Ocorreu um erro de lógica no código do lado do servidor. |
Parâmetros do corpo da resposta (JSON ou XML)
| Nome | Descrição |
|---|---|
| pares de nome-valor | Valores para todos os campos na solicitação de mudança associada. Tipo de dados: objeto |
| estado | Estado da solicitação de mudança. Tipo de dados: objeto |
| estado.display_value | Estado a ser exibido em uma IU. Tipo de dados: cadeia de caracteres |
| estado.valor | Valor do estado interno. Tipo de dados: cadeia de caracteres |
| sys_id | Informações de Sys_id para a solicitação de mudança. Tipo de dados: objeto |
| sys_id.display_value | Sys_id da solicitação de mudança a ser exibida em uma IU. Tipo de dados: cadeia de caracteres |
| sys_id.value | Sys_id da solicitação de mudança. Tipo de dados: cadeia de caracteres |
| tipo | Tipo de solicitação de mudança Tipo de dados: objeto |
| tipo.exibição_valor | Mude o tipo para exibir em uma IU. O valor é sempre "Emergência". Tipo de dados: cadeia de caracteres |
| tipo.valor | Valor de tipo interno. O valor é sempre "emergência". Tipo de dados: cadeia de caracteres |
Solicitação de cURL
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/emergency?sysparm_query=active=true^ORDERBYnumber" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
{
result: [
{
sys_id: {
value: "1c87925347c12200e0ef563dbb9a7177",
display_value: "1c87925347c12200e0ef563dbb9a7177"
},
state: {
value: "-5",
display_value: "New"
},
type: {
value: "emergency",
display_value: "Emergency"
},
..., // all valid fields in record, example below
short_description: {
value: "Reboot server",
display_value: "Reboot server"
},
},
{ // next record found }, ... // and so on
]
}Gestão de mudanças - GET /sn_chg_rest/change/emergency/{sys_id}
Recupera a solicitação de mudança de emergência identificada pelo sys_id especificado.
Formato da URL
URL com controle de versões: /api/sn_chg_rest/{api_version}/change/emergency/{sys_id}
URL padrão: /api/sn_chg_rest/change/emergency/{sys_id}
Parâmetros de solicitação compatíveis
| Nome | Descrição |
|---|---|
| api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres |
| sys_id | Sys_id da solicitação de mudança de emergência a ser recuperada da tabela Solicitação de mudança [change_request]. Tipo de dados: cadeia de caracteres |
| Nome | Descrição |
|---|---|
| Nenhum(a) |
| Nome | Descrição |
|---|---|
| Nenhum(a) |
Cabeçalhos
Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.
| Cabeçalho | Descrição |
|---|---|
| Aceitar | Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json |
| Cabeçalho | Descrição |
|---|---|
| Nenhum(a) |
Códigos de status
Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.
| Código de status | Descrição |
|---|---|
| 200 | Solicitação concluída com sucesso. |
| 400 | Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada. |
| 401 | Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas. |
| 404 | Não encontrado. Não foi possível encontrar o registro especificado. |
| 500 | Erro Interno do Servidor. Ocorreu um erro de lógica no código do lado do servidor. |
Parâmetros do corpo da resposta (JSON ou XML)
| Nome | Descrição |
|---|---|
| pares de nome-valor | Valores para todos os campos na solicitação de mudança associada. Tipo de dados: objeto |
| estado | Estado da solicitação de mudança. Tipo de dados: objeto |
| estado.display_value | Estado a ser exibido em uma IU. Tipo de dados: cadeia de caracteres |
| estado.valor | Valor do estado interno. Tipo de dados: cadeia de caracteres |
| sys_id | Informações de Sys_id para a solicitação de mudança. Tipo de dados: objeto |
| sys_id.display_value | Sys_id da solicitação de mudança a ser exibida em uma IU. Tipo de dados: cadeia de caracteres |
| sys_id.value | Sys_id da solicitação de mudança. Tipo de dados: cadeia de caracteres |
| tipo | Tipo de solicitação de mudança Tipo de dados: objeto |
| tipo.exibição_valor | Mude o tipo para exibir em uma IU. O valor é sempre "Emergência". Tipo de dados: cadeia de caracteres |
| tipo.valor | Valor de tipo interno. O valor é sempre "emergência". Tipo de dados: cadeia de caracteres |
Solicitação de cURL
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/emergency/b0dbda5347c12200e0ef563dbb9a718f" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
{
result: [
{
sys_id: {
value: "b0dbda5347c12200e0ef563dbb9a718f",
display_value: "b0dbda5347c12200e0ef563dbb9a718f"
},
state: {
value: "-5",
display_value: "New"
},
type: {
value: "emergency",
display_value: "Emergency"
},
..., // all valid fields in record, example below
short_description: {
value: "Reboot server",
display_value: "Reboot server"
},
},
]
}Gestão de mudanças - GET /sn_chg_rest/change/model
Recupera um ou mais modelos de mudança com base nos critérios especificados.
Use este endpoint para encontrar um modelo de mudança que melhor se ajuste à solicitação de mudança que você está tentando criar. Para obter informações adicionais, consulte Modelos de mudança.
Formato da URL
URL com controle de versão: /api/sn_chg_rest/{api_version}/change/model
URL padrão: /api/sn_chg_rest/change/model
Parâmetros de solicitação compatíveis
| Nome | Descrição |
|---|---|
| api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres |
| Nome | Descrição |
|---|---|
| pares de nome-valor | Pares de nome-valor a serem usados para filtrar o conjunto de resultados. O nome é o campo no qual o valor especificado é filtrado. Este parâmetro é mutuamente exclusivo com sysparm_query. Por exemplo, em vez de usar &sysparm_query=active=true, você pode simplificar a declaração de chamada usando &active=true. Você também pode usar o valor de exibição quando o campo for do tipo opção ou referência, como &state=closed em vez de &state=7. Para especificar vários pares de chave-valor, separe cada um com um e comercial, como &active=true&assigned_to=john.smith. Tipo de dados: cadeia de caracteres |
| pedido | Campo pelo qual classificar os modelos de mudança retornados. Tipo de dados: cadeia de caracteres Padrão: nome |
| sysparm_offset | Índice de registro inicial para o qual a recuperação de registros será iniciada. Use este valor para paginar a recuperação do registro. Essa funcionalidade permite a recuperação de todos os registros, independentemente do número de registros, em pequenos blocos gerenciáveis. Por exemplo, na primeira vez que você chama este endpoint, sysparm_offset é definido como "0". Para simplesmente percorrer todos os registros disponíveis, use Tipo de dados: número Padrão: 0 |
| sysparm_query | Consulta codificada usada para filtrar o conjunto de resultados. Você pode usar um filtro de IU para obter uma consulta codificada corretamente. Sintaxe: sysparm_query=<col_name><operator><value> .
Todos os parâmetros fazem distinção entre maiúsculas e minúsculas. As consultas podem conter mais de uma entrada, como sysparm_query=<col_name><operator><value> [ ] . Por exemplo:
As consultas codificadas também oferecem suporte à ordem por funcionalidade. Para classificar respostas com base em determinados campos, use as cláusulas Sintaxe:
Por exemplo: Esta consulta filtra todos os registros ativos e ordena os resultados em ordem crescente por número e, em seguida, em ordem decrescente por categoria. Se parte da consulta for inválida, por exemplo, especificando um nome de campo inválido, a instância ignorará a parte inválida. Em seguida, ele retorna linhas usando somente a parte válida da consulta. Você pode controlar esse comportamento usando a propriedade glide.invalid_query.returns_no_rows. Defina esta propriedade como verdadeira para não retornar linhas em uma consulta inválida. Nota: A propriedade glide.invalid_query.returns_no_rows controla o comportamento de todas as consultas na instância, como em listas, scripts (GlideRecord.query()) e APIs de serviço web. Tipo de dados: cadeia de caracteres |
| pesquisa de texto | Cadeia de caracteres a ser usada para pesquisar todos os campos de registro do modelo de mudança. Esta pesquisa usa a funcionalidade ServiceNow da plataforma de pesquisa de texto completo. Para obter mais informações sobre ServiceNow, capacidades de pesquisa, consulte Administração de pesquisa. Tipo de dados: cadeia de caracteres Padrão: IR_AND_OR_QUERY |
| Nome | Descrição |
|---|---|
| Nenhum(a) |
Cabeçalhos
Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.
| Cabeçalho | Descrição |
|---|---|
| Aceitar | Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json |
| Cabeçalho | Descrição |
|---|---|
| Nenhum(a) |
Códigos de status
Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.
| Código de status | Descrição |
|---|---|
| 200 | Solicitação concluída com sucesso. |
| 401 | Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas. |
| 500 | Erro Interno do Servidor. Ocorreu um erro de lógica no código do lado do servidor. |
Parâmetros do corpo da resposta (JSON ou XML)
| Nome | Descrição |
|---|---|
| resultado | Lista que contém um ou mais objetos de registro de modelo de mudança. Cada objeto descreve um modelo de mudança. Cada elemento no objeto do modelo de mudança corresponde a um campo em seu registro associado na tabela Modelo de mudança [chg_model]. Todos os elementos contêm pares de nome-valor value e display_value. Alguns contêm pares de nome-valor display_value_internal. Tipo de dados: matriz |
| resultado.ativo | Sinalizador que indica se o registro do modelo de mudança associado está ativo e disponível na instância. Valores válidos:
Tipo de dados: booliano Padrão: verdadeiro |
| resultado.disponível_na_ui | Sinalizador que indica se o registro do modelo de mudança associado está disponível na interface do usuário. Valores válidos:
Tipo de dados: booliano Padrão: verdadeiro |
| resultado.cor | Cor do modelo de mudança associado na página principal da solicitação de mudança. Tipo de dados: cadeia de caracteres Padrão: #cbcbcb |
| resultado.padrão_mudança_modelo | Sinalizador que indica se o registro do modelo de mudança associado é o modelo de mudança padrão. Valores válidos:
Tipo de dados: booliano Padrão: falso |
| resultado.descrição | Descrição resumida da finalidade do modelo de mudança. Tipo de dados: cadeia de caracteres Tamanho máximo: 4.000 |
| result.name | Nome do modelo de mudança. Tipo de dados: cadeia de caracteres Tamanho máximo: 200 |
| resultado.registro_predefinido | Pares de nome-valor dos campos que devem ser preenchidos automaticamente, com seus valores associados, quando um novo registro de solicitação de mudança é criado. Os valores são separados por símbolos de acento circunflexo. Por exemplo:
Tipo de dados: cadeia de caracteres |
| resultado.estado_campo | Campo de lista de seleção do qual serão coletadas opções, com base no fornecido em table_name. Para modelos de mudança, isso é sempre definido como "estado". Tipo de dados: cadeia de caracteres |
| resultado.sys_class_name | Mude o nome da tabela do módulo. Sempre mude o modelo/chg_model. Tipo de dados: cadeia de caracteres |
| resultado.sys_created_by | Nome do usuário que criou inicialmente o registro do módulo de mudança associado. Tipo de dados: cadeia de caracteres |
| resultado.sys_created_on | Data e hora em que o registro do módulo de mudança foi criado originalmente. Tipo de dados: cadeia de caracteres |
| resultado.sys_domain | Se estiver usando domínios na instância, o nome do domínio ao qual o registro do módulo de mudança está associado. Tipo de dados: cadeia de caracteres |
| resultado.sys_domain_path | Se estiver usando domínios na instância, o caminho do domínio no qual o registro do módulo de mudança associado reside. Tipo de dados: cadeia de caracteres |
| resultado.sys_id | Identificador exclusivo do registro do modelo de mudança associado. Tipo de dados: cadeia de caracteres |
| resultado.sys_mod_count | Número de vezes que o registro do modelo de mudança associado foi modificado. Tipo de dados: número |
| resultado.sys_name | Nome do modelo de mudança. Sempre igual ao parâmetro name. Tipo de dados: cadeia de caracteres |
| resultado.sys_tags | Marcadores do sistema associados ao registro do modelo de mudança. Tipo de dados: cadeia de caracteres |
| resultado.sys_updated_by | Nome do usuário que atualizou pela última vez o registro do modelo de mudança associado. Tipo de dados: cadeia de caracteres Tamanho máximo: 40 |
| resultado.sys_updated_on | Data e hora em que o registro do modelo de mudança associado foi atualizado pela última vez. Tipo de dados: cadeia de caracteres |
| resultado.table_name | Tabela que define o campo Lista de seleção do qual as escolhas serão coletadas. Para modelos de mudança, isso é sempre definido como "change_request". Tipo de dados: cadeia de caracteres Tamanho máximo: 80 |
Solicitação de cURL
Este exemplo mostra uma solicitação para obter todos os registros de modelo de mudança.
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/model \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
Para resumir, esta resposta mostra apenas um único objeto de modelo de mudança.
{
"result": [
{
"record_preset": {
"display_value": "type=normal^assignment_group=a715cd759f2002002920bde8132e7018^short_description=Automated : Change^EQ",
"value": "type=normal^assignment_group=a715cd759f2002002920bde8132e7018^short_description=Automated : Change^EQ"
},
"color": {
"display_value": "#488df4",
"value": "#488df4"
},
"default_change_model": {
"display_value": "false",
"value": false
},
"sys_mod_count": {
"display_value": "6",
"value": 6.0
},
"description": {
"display_value": "This model is intended to capture a record of an automated change. There are no approvals associated with this change model.\r\n",
"value": "This model is intended to capture a record of an automated change. There are no approvals associated with this change model.\r\n"
},
"active": {
"display_value": "true",
"value": true
},
"sys_updated_on": {
"display_value": "2020-10-02 06:24:24",
"value": "2020-10-02 13:24:24",
"display_value_internal": "2020-10-02 06:24:24"
},
"sys_tags": {
"display_value": "",
"value": ""
},
"table_name": {
"display_value": "change_request",
"value": "change_request"
},
"sys_class_name": {
"display_value": "Change Model",
"value": "chg_model"
},
"sys_id": {
"display_value": "7840d2515323101034d1ddeeff7b12a6",
"value": "7840d2515323101034d1ddeeff7b12a6"
},
"sys_updated_by": {
"display_value": "admin",
"value": "admin"
},
"available_in_ui": {
"display_value": "false",
"value": false
},
"state_field": {
"display_value": "state",
"value": "state"
},
"sys_created_on": {
"display_value": "2020-09-28 07:33:25",
"value": "2020-09-28 14:33:25",
"display_value_internal": "2020-09-28 07:33:25"
},
"name": {
"display_value": "Change Registration",
"value": "Change Registration"
},
"sys_name": {
"display_value": "Change Registration",
"value": "Change Registration"
},
"sys_created_by": {
"display_value": "admin",
"value": "admin"
}
}
]
}Gestão de mudanças - GET /sn_chg_rest/change/model/{sys_id}
Recupera o modelo de mudança identificado pelo sys_id especificado.
Você pode usar este modelo de mudança para criar a solicitação de mudança desejada. Para obter informações adicionais sobre modelos de mudança, consulte Modelos de mudança.
Formato da URL
URL com controle de versões: /api/sn_chg_rest/{api_version}/change/model/{sys_id}
URL padrão: /api/sn_chg_rest/change/model/{sys_id}
Parâmetros de solicitação compatíveis
| Nome | Descrição |
|---|---|
| api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres |
| sys_id | Sys_id do registro do modelo de mudança a ser recuperado da tabela Modelo de mudança [chg_model]. Tipo de dados: cadeia de caracteres |
| Nome | Descrição |
|---|---|
| Nenhum(a) |
| Nome | Descrição |
|---|---|
| Nenhum(a) |
Cabeçalhos
Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.
| Cabeçalho | Descrição |
|---|---|
| Aceitar | Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json |
| Cabeçalho | Descrição |
|---|---|
| Nenhum(a) |
Códigos de status
Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.
| Código de status | Descrição |
|---|---|
| 200 | Solicitação concluída com sucesso. |
| 400 | Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada. |
| 401 | Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas. |
| 404 | Não encontrado. Não foi possível encontrar o registro especificado. |
| 500 | Erro Interno do Servidor. Ocorreu um erro de lógica no código do lado do servidor. |
Parâmetros do corpo da resposta (JSON ou XML)
| Nome | Descrição |
|---|---|
| resultado | Objeto de registro do modelo de mudança solicitado. Cada elemento neste objeto corresponde a um campo no registro na tabela Modelo de mudança [chg_model]. Todos os elementos contêm pares de nome-valor value e display_value. Alguns contêm display_value_internal pares de nome-valor. Tipo de dados: objeto |
| resultado.ativo | Sinalizador que indica se o registro do modelo de mudança associado está ativo e disponível na instância. Valores válidos:
Tipo de dados: booliano Padrão: verdadeiro |
| resultado.disponível_na_ui | Sinalizador que indica se o registro do modelo de mudança associado está disponível na interface do usuário. Valores válidos:
Tipo de dados: booliano Padrão: verdadeiro |
| resultado.cor | Cor do modelo de mudança associado na página principal da solicitação de mudança. Tipo de dados: cadeia de caracteres Padrão: #cbcbcb |
| resultado.padrão_mudança_modelo | Sinalizador que indica se o registro do modelo de mudança associado é o modelo de mudança padrão. Valores válidos:
Tipo de dados: booliano Padrão: falso |
| resultado.descrição | Descrição resumida da finalidade do modelo de mudança. Tipo de dados: cadeia de caracteres Tamanho máximo: 4.000 |
| result.name | Nome do modelo de mudança. Tipo de dados: cadeia de caracteres Tamanho máximo: 200 |
| resultado.registro_predefinido | Pares de nome-valor dos campos que devem ser preenchidos automaticamente, com seus valores associados, quando um novo registro de solicitação de mudança é criado. Os valores são separados por símbolos de acento circunflexo. Por exemplo:
Tipo de dados: cadeia de caracteres |
| resultado.estado_campo | Campo de lista de seleção do qual serão coletadas opções, com base no fornecido em table_name. Para modelos de mudança, isso é sempre definido como "estado". Tipo de dados: cadeia de caracteres |
| resultado.sys_class_name | Mude o nome da tabela do módulo. Sempre mude o modelo/chg_model. Tipo de dados: cadeia de caracteres |
| resultado.sys_created_by | Nome do usuário que criou inicialmente o registro do módulo de mudança associado. Tipo de dados: cadeia de caracteres |
| resultado.sys_created_on | Data e hora em que o registro do módulo de mudança foi criado originalmente. Tipo de dados: cadeia de caracteres |
| resultado.sys_domain | Se estiver usando domínios na instância, o nome do domínio ao qual o registro do módulo de mudança está associado. Tipo de dados: cadeia de caracteres |
| resultado.sys_domain_path | Se estiver usando domínios na instância, o caminho do domínio no qual o registro do módulo de mudança associado reside. Tipo de dados: cadeia de caracteres |
| resultado.sys_id | Identificador exclusivo do registro do modelo de mudança associado. Tipo de dados: cadeia de caracteres |
| resultado.sys_mod_count | Número de vezes que o registro do modelo de mudança associado foi modificado. Tipo de dados: número |
| resultado.sys_name | Nome do modelo de mudança. Sempre igual ao parâmetro name. Tipo de dados: cadeia de caracteres |
| resultado.sys_tags | Marcadores do sistema associados ao registro do modelo de mudança. Tipo de dados: cadeia de caracteres |
| resultado.sys_updated_by | Nome do usuário que atualizou pela última vez o registro do modelo de mudança associado. Tipo de dados: cadeia de caracteres Tamanho máximo: 40 |
| resultado.sys_updated_on | Data e hora em que o registro do modelo de mudança associado foi atualizado pela última vez. Tipo de dados: cadeia de caracteres |
| resultado.table_name | Tabela que define o campo Lista de seleção do qual as escolhas serão coletadas. Para modelos de mudança, isso é sempre definido como "change_request". Tipo de dados: cadeia de caracteres Tamanho máximo: 80 |
Solicitação de cURL
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/model/c0efda5347c12200e0ef563dbb9a81e3" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
{
"result": {
"record_preset": {
"display_value": "type=emergency^EQ",
"value": "type=emergency^EQ"
},
"color": {
"display_value": "#ea3423",
"value": "#ea3423"
},
"default_change_model": {
"display_value": "false",
"value": false
},
"sys_mod_count": {
"display_value": "2",
"value": 2.0
},
"description": {
"display_value": "ITIL Mode 1 Emergency Change",
"value": "ITIL Mode 1 Emergency Change"
},
"active": {
"display_value": "true",
"value": true
},
"sys_updated_on": {
"display_value": "2020-09-28 08:53:12",
"value": "2020-09-28 15:53:12",
"display_value_internal": "2020-09-28 08:53:12"
},
"sys_tags": {
"display_value": "",
"value": ""
},
"table_name": {
"display_value": "change_request",
"value": "change_request"
},
"sys_class_name": {
"display_value": "Change Model",
"value": "chg_model"
},
"sys_id": {
"display_value": "c0efda5347c12200e0ef563dbb9a81e3",
"value": "c0efda5347c12200e0ef563dbb9a81e3"
},
"sys_updated_by": {
"display_value": "admin",
"value": "admin"
},
"available_in_ui": {
"display_value": "true",
"value": true
},
"state_field": {
"display_value": "state",
"value": "state"
},
"sys_created_on": {
"display_value": "2020-09-04 09:16:03",
"value": "2020-09-04 16:16:03",
"display_value_internal": "2020-09-04 09:16:03"
},
"name": {
"display_value": "Emergency",
"value": "Emergency"
},
"sys_name": {
"display_value": "Emergency",
"value": "Emergency"
},
"sys_created_by": {
"display_value": "admin",
"value": "admin"
}
}
}Gestão de mudanças - GET /sn_chg_rest/change/normal
Recupera uma ou mais solicitações de mudança normais com base nos critérios especificados.
Formato da URL
URL com controle de versões: /api/sn_chg_rest/{api_version}/change/normal
URL padrão: /api/sn_chg_rest/change/normal
Parâmetros de solicitação compatíveis
| Nome | Descrição |
|---|---|
| api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres |
| Nome | Descrição |
|---|---|
| pares de nome-valor | Pares de nome-valor a serem usados para filtrar o conjunto de resultados. O nome é o campo no qual o valor especificado é filtrado. Este parâmetro é mutuamente exclusivo com sysparm_query. Por exemplo, em vez de usar &sysparm_query=active=true, você pode simplificar a declaração de chamada usando &active=true. Você também pode usar o valor de exibição quando o campo for do tipo opção ou referência, como &state=closed em vez de &state=7. Para especificar vários pares de chave-valor, separe cada um com um e comercial, como &active=true&assigned_to=john.smith. Tipo de dados: cadeia de caracteres |
| pedido | Campo pelo qual classificar as solicitações de mudança retornadas. Padrão: número Tipo de dados: cadeia de caracteres |
| sysparm_limit | Número máximo de registros a serem retornados. Para solicitações que excedem esse número de registros, use o parâmetro sysparm_offset para paginar a recuperação do registro. Tipo de dados: número Padrão: 500 |
| sysparm_offset | Índice de registro inicial para o qual a recuperação de registros será iniciada. Use este valor para paginar a recuperação do registro. Essa funcionalidade permite a recuperação de todos os registros, independentemente do número de registros, em pequenos blocos gerenciáveis. Por exemplo, na primeira vez que você chama este endpoint, sysparm_offset é definido como "0". Para simplesmente percorrer todos os registros disponíveis, use Tipo de dados: número Padrão: 0 |
| sysparm_query | Consulta codificada usada para filtrar o conjunto de resultados. Você pode usar um filtro de IU para obter uma consulta codificada corretamente. Sintaxe: sysparm_query=<col_name><operator><value> .
Todos os parâmetros fazem distinção entre maiúsculas e minúsculas. As consultas podem conter mais de uma entrada, como sysparm_query=<col_name><operator><value> [ ] . Por exemplo:
As consultas codificadas também oferecem suporte à ordem por funcionalidade. Para classificar respostas com base em determinados campos, use as cláusulas Sintaxe:
Por exemplo: Esta consulta filtra todos os registros ativos e ordena os resultados em ordem crescente por número e, em seguida, em ordem decrescente por categoria. Se parte da consulta for inválida, por exemplo, especificando um nome de campo inválido, a instância ignorará a parte inválida. Em seguida, ele retorna linhas usando somente a parte válida da consulta. Você pode controlar esse comportamento usando a propriedade glide.invalid_query.returns_no_rows. Defina esta propriedade como verdadeira para não retornar linhas em uma consulta inválida. Nota: A propriedade glide.invalid_query.returns_no_rows controla o comportamento de todas as consultas na instância, como em listas, scripts (GlideRecord.query()) e APIs de serviço web. Tipo de dados: cadeia de caracteres |
| pesquisa de texto | Cadeia de caracteres a ser usada para pesquisar todos os campos de registro de solicitação de mudança normais. Esta pesquisa usa a funcionalidade da plataforma de pesquisa de texto completo da ServiceNow e o padrão é IR_AND_OR_QUERY.Tipo de dados: cadeia de caracteres |
| Nome | Descrição |
|---|---|
| Nenhum(a) |
Cabeçalhos
Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.
| Cabeçalho | Descrição |
|---|---|
| Aceitar | Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json |
| Cabeçalho | Descrição |
|---|---|
| Nenhum(a) |
Códigos de status
Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.
| Código de status | Descrição |
|---|---|
| 200 | Solicitação concluída com sucesso. |
| 401 | Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas. |
| 500 | Erro Interno do Servidor. Ocorreu um erro de lógica no código do lado do servidor. |
Parâmetros do corpo da resposta (JSON ou XML)
| Nome | Descrição |
|---|---|
| pares de nome-valor | Valores para todos os campos na solicitação de mudança associada. Tipo de dados: objeto |
| estado | Estado da solicitação de mudança antes da exclusão. Tipo de dados: objeto |
| estado.display_value | Estado a ser exibido em uma IU. Tipo de dados: cadeia de caracteres |
| estado.valor | Valor do estado interno. Tipo de dados: cadeia de caracteres |
| sys_id | Informações de Sys_id para a solicitação de mudança. Tipo de dados: objeto |
| sys_id.display_value | Sys_id da solicitação de mudança a ser exibida em uma IU. Tipo de dados: cadeia de caracteres |
| sys_id.value | Sys_id da solicitação de mudança. Tipo de dados: cadeia de caracteres |
| tipo | Tipo de solicitação de mudança Tipo de dados: objeto |
| tipo.exibição_valor | Mude o tipo para exibir em uma IU. O valor é sempre "Normal". Tipo de dados: cadeia de caracteres |
| tipo.valor | Valor de tipo interno. O valor é sempre "normal". Tipo de dados: cadeia de caracteres |
Solicitação de cURL
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/normal?sysparm_query=active=true^ORDERBYnumber" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"{
result: [
{
sys_id: {
value: "1c87925347c12200e0ef563dbb9a7177",
display_value: "1c87925347c12200e0ef563dbb9a7177"
},
state: {
value: "-5",
display_value: "New"
},
type: {
value: "normal",
display_value: "Normal"
},
..., // all valid fields in record, example below
short_description: {
value: "Add network switch to cabinet",
display_value: "Add network switch to cabinet"
},
},
{ // next record found }, ... // and so on
]
}Gestão de mudanças - GET /sn_chg_rest/change/normal/{sys_id}
Recupera a solicitação de mudança normal identificada pelo sys_id especificado.
Formato da URL
URL com controle de versão: /api/sn_chg_rest/{api_version}/change/normal/{sys_id}
URL padrão: /api/sn_chg_rest/change/normal/{sys_id}
Parâmetros de solicitação compatíveis
| Nome | Descrição |
|---|---|
| api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres |
| sys_id | Sys_id da solicitação de mudança normal a ser recuperada da tabela Solicitação de Mudança [change_request]. Tipo de dados: cadeia de caracteres |
| Nome | Descrição |
|---|---|
| Nenhum(a) |
| Nome | Descrição |
|---|---|
| Nenhum(a) |
Cabeçalhos
Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.
| Cabeçalho | Descrição |
|---|---|
| Aceitar | Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json |
| Cabeçalho | Descrição |
|---|---|
| Nenhum(a) |
Códigos de status
Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.
| Código de status | Descrição |
|---|---|
| 200 | Solicitação concluída com sucesso. |
| 400 | Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada. |
| 401 | Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas. |
| 404 | Não encontrado. Não foi possível encontrar o registro especificado. |
| 500 | Erro Interno do Servidor. Ocorreu um erro de lógica no código do lado do servidor. |
Parâmetros do corpo da resposta (JSON ou XML)
| Nome | Descrição |
|---|---|
| pares de nome-valor | Valores para todos os campos na solicitação de mudança associada. Tipo de dados: objeto |
| estado | Estado da solicitação de mudança antes da exclusão. Tipo de dados: objeto |
| estado.display_value | Estado a ser exibido em uma IU. Tipo de dados: cadeia de caracteres |
| estado.valor | Valor do estado interno. Tipo de dados: cadeia de caracteres |
| sys_id | Sys_id da solicitação de mudança. Tipo de dados: cadeia de caracteres |
| tipo | Tipo de solicitação de mudança Tipo de dados: objeto |
| tipo.exibição_valor | Mude o tipo para exibir em uma IU. O valor é sempre "Normal". Tipo de dados: cadeia de caracteres |
| tipo.valor | Valor de tipo interno. O valor é sempre "normal". Tipo de dados: cadeia de caracteres |
Solicitação de cURL
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/normal/b0dbda5347c12200e0ef563dbb9a718f" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
{
result: [
{
sys_id: "b0dbda5347c12200e0ef563dbb9a718f",
state: {
value: "-5",
display_value: "New"
},
type: {
value: "normal",
display_value: "Normal"
},
..., // all valid fields in record, example below
short_description: {
value: "Add network switch to cabinet",
display_value: "Add network switch to cabinet"
},
},
]
}Gestão de mudanças - GET /sn_chg_rest/change/standard
Recupera uma ou mais solicitações de mudança padrão com base nos critérios especificados.
Formato da URL
URL com controle de versão: /api/sn_chg_rest/{api_version}/change/standard
URL padrão: /api/sn_chg_rest/change/standard
Parâmetros de solicitação compatíveis
| Nome | Descrição |
|---|---|
| api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres |
| Nome | Descrição |
|---|---|
| pares de nome-valor | Pares de nome-valor a serem usados para filtrar o conjunto de resultados. O nome é o campo no qual o valor especificado é filtrado. Este parâmetro é mutuamente exclusivo com sysparm_query. Por exemplo, em vez de usar &sysparm_query=active=true, você pode simplificar a declaração de chamada usando &active=true. Você também pode usar o valor de exibição quando o campo for do tipo opção ou referência, como &state=closed em vez de &state=7. Para especificar vários pares de chave-valor, separe cada um com um e comercial, como &active=true&assigned_to=john.smith. Tipo de dados: cadeia de caracteres |
| pedido | Campo pelo qual classificar as solicitações de mudança retornadas. Padrão: número Tipo de dados: cadeia de caracteres |
| sysparm_limit | Número máximo de registros a serem retornados. Para solicitações que excedem esse número de registros, use o parâmetro sysparm_offset para paginar a recuperação do registro. Tipo de dados: cadeia de caracteres Padrão: 500 |
| sysparm_offset | Índice de registro inicial para o qual a recuperação de registros será iniciada. Use este valor para paginar a recuperação do registro. Essa funcionalidade permite a recuperação de todos os registros, independentemente do número de registros, em pequenos blocos gerenciáveis. Por exemplo, na primeira vez que você chama este endpoint, sysparm_offset é definido como "0". Para simplesmente percorrer todos os registros disponíveis, use Tipo de dados: número Padrão: 0 |
| sysparm_query | Consulta codificada usada para filtrar o conjunto de resultados. Você pode usar um filtro de IU para obter uma consulta codificada corretamente. Sintaxe: sysparm_query=<col_name><operator><value> .
Todos os parâmetros fazem distinção entre maiúsculas e minúsculas. As consultas podem conter mais de uma entrada, como sysparm_query=<col_name><operator><value> [ ] . Por exemplo:
As consultas codificadas também oferecem suporte à ordem por funcionalidade. Para classificar respostas com base em determinados campos, use as cláusulas Sintaxe:
Por exemplo: Esta consulta filtra todos os registros ativos e ordena os resultados em ordem crescente por número e, em seguida, em ordem decrescente por categoria. Se parte da consulta for inválida, por exemplo, especificando um nome de campo inválido, a instância ignorará a parte inválida. Em seguida, ele retorna linhas usando somente a parte válida da consulta. Você pode controlar esse comportamento usando a propriedade glide.invalid_query.returns_no_rows. Defina esta propriedade como verdadeira para não retornar linhas em uma consulta inválida. Nota: A propriedade glide.invalid_query.returns_no_rows controla o comportamento de todas as consultas na instância, como em listas, scripts (GlideRecord.query()) e APIs de serviço web. Tipo de dados: cadeia de caracteres |
| pesquisa de texto | Cadeia de caracteres a ser usada para pesquisar todos os campos de registro de solicitação de mudança padrão. Esta pesquisa usa ServiceNow a funcionalidade da plataforma de pesquisa de texto completo e o padrão é IR_AND_OR_QUERY.Tipo de dados: cadeia de caracteres |
| Nome | Descrição |
|---|---|
| Nenhum(a) |
Cabeçalhos
Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.
| Cabeçalho | Descrição |
|---|---|
| Aceitar | Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json |
| Cabeçalho | Descrição |
|---|---|
| Nenhum(a) |
Códigos de status
Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.
| Código de status | Descrição |
|---|---|
| 200 | Bem-sucedido. A solicitação foi processada com sucesso. |
| 401 | Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas. |
| 500 | Erro Interno do Servidor. Ocorreu um erro de lógica no código do lado do servidor. |
Parâmetros do corpo da resposta (JSON ou XML)
| Nome | Descrição |
|---|---|
| pares de nome-valor | Todos os campos (chave) com seus valores associados para a solicitação de mudança identificada. Tipo de dados: objeto |
| estado | Estado da solicitação de mudança antes da exclusão. Tipo de dados: objeto |
| estado.display_value | Estado a ser exibido em uma IU. Tipo de dados: cadeia de caracteres |
| estado.valor | Valor do estado interno. Tipo de dados: cadeia de caracteres |
| sys_id | Informações de Sys_id para a solicitação de mudança. Tipo de dados: objeto |
| sys_id.display_value | Sys_id da solicitação de mudança a ser exibida em uma IU. Tipo de dados: cadeia de caracteres |
| sys_id.value | Sys_id da solicitação de mudança. Tipo de dados: cadeia de caracteres |
| tipo | Tipo de solicitação de mudança Tipo de dados: objeto |
| tipo.exibição_valor | Mude o tipo para exibir em uma IU. O valor é sempre "Padrão". Tipo de dados: cadeia de caracteres |
| tipo.valor | Valor de tipo interno. O valor é sempre "padrão". Tipo de dados: cadeia de caracteres |
Amostra de solicitação cURL
curl "https://instance.service-now.com/api/sn_chg_rest/v1/change/standard?sysparm_query=active=true^ORDERBYnumber" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"{
result: [
{
sys_id: {
value: "1c87925347c12200e0ef563dbb9a7177",
display_value: "1c87925347c12200e0ef563dbb9a7177"
},
state: {
value: "-5",
display_value: "New"
},
type: {
value: "standard",
display_value: "Standard"
},
..., // all valid fields in record, example below
short_description: {
value: "Add network switch to cabinet",
display_value: "Add network switch to cabinet"
},
},
{ // next record found }, ... // and so on
]
}Gestão de mudanças - GET /sn_chg_rest/change/standard/{sys_id}
Recupera a solicitação de mudança padrão identificada pelo sys_id especificado.
Formato da URL
URL com controle de versões: /api/sn_chg_rest/{api_version}/change/standard/{sys_id}
URL padrão: /api/sn_chg_rest/change/standard/{sys_id}
Parâmetros de solicitação compatíveis
| Nome | Descrição |
|---|---|
| api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres |
| sys_id | Sys_id da solicitação de mudança padrão a ser recuperada da tabela Solicitação de Mudança [change_request]. Tipo de dados: cadeia de caracteres |
| Nome | Descrição |
|---|---|
| Nenhum(a) |
| Nome | Descrição |
|---|---|
| Nenhum(a) |
Cabeçalhos
Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.
| Cabeçalho | Descrição |
|---|---|
| Aceitar | Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json |
| Cabeçalho | Descrição |
|---|---|
| Nenhum(a) |
Códigos de status
Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.
| Código de status | Descrição |
|---|---|
| 200 | Solicitação concluída com sucesso. |
| 400 | Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada. |
| 401 | Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas. |
| 404 | Não encontrado. Não foi possível encontrar o registro especificado. |
| 500 | Erro Interno do Servidor. Ocorreu um erro de lógica no código do lado do servidor. |
Parâmetros do corpo da resposta (JSON ou XML)
| Nome | Descrição |
|---|---|
| pares de nome-valor | Todos os campos (chave) com seus valores associados para a solicitação de mudança identificada. Tipo de dados: objeto |
| estado | Estado da solicitação de mudança antes da exclusão. Tipo de dados: objeto |
| estado.display_value | Estado a ser exibido em uma IU. Tipo de dados: cadeia de caracteres |
| estado.valor | Valor do estado interno. Tipo de dados: cadeia de caracteres |
| sys_id | Informações de Sys_id para a solicitação de mudança. Tipo de dados: objeto |
| sys_id.display_value | Sys_id da solicitação de mudança a ser exibida em uma IU. Tipo de dados: cadeia de caracteres |
| sys_id.value | Sys_id da solicitação de mudança. Tipo de dados: cadeia de caracteres |
Solicitação de cURL
curl "https://https://instance.servicenow.com/api/sn_chg_rest/v1/change/standard/b0dbda5347c12200e0ef563dbb9a718f" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"{
result: [
{
sys_id: {
value: "1c87925347c12200e0ef563dbb9a7177",
display_value: "1c87925347c12200e0ef563dbb9a7177"
},
state: {
value: "-5",
display_value: "New"
},
..., // all valid fields in record, example below
short_description: {
value: "Add network switch to cabinet",
display_value: "Add network switch to cabinet"
},
},
]
}Gestão de mudanças - GET /sn_chg_rest/change/standard/template
Recupera um ou mais modelos de mudança padrão com base nos critérios especificados.
Formato da URL
URL com controle de versões: /api/sn_chg_rest/{api_version}/change/standard/template
URL padrão: /api/sn_chg_rest/change/standard/template
Parâmetros de solicitação compatíveis
| Nome | Descrição |
|---|---|
| api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres |
| Nome | Descrição |
|---|---|
| pares de nome-valor | Pares de nome-valor a serem usados para filtrar o conjunto de resultados. O nome é o campo no qual o valor especificado é filtrado. Este parâmetro é mutuamente exclusivo com sysparm_query. Por exemplo, em vez de usar &sysparm_query=active=true, você pode simplificar a declaração de chamada usando &active=true. Você também pode usar o valor de exibição quando o campo for do tipo opção ou referência, como &state=closed em vez de &state=7. Para especificar vários pares de chave-valor, separe cada um com um e comercial, como &active=true&assigned_to=john.smith. Tipo de dados: cadeia de caracteres |
| pedido | Campo pelo qual classificar os modelos de mudança padrão retornados. Tipo de dados: cadeia de caracteres Padrão: número |
| sysparm_limit | Número máximo de registros a serem retornados. Para solicitações que excedem esse número de registros, use o parâmetro sysparm_offset para paginar a recuperação do registro. Tipo de dados: número Padrão: 500 |
| sysparm_offset | Índice de registro inicial para o qual a recuperação de registros será iniciada. Use este valor para paginar a recuperação do registro. Essa funcionalidade permite a recuperação de todos os registros, independentemente do número de registros, em pequenos blocos gerenciáveis. Por exemplo, na primeira vez que você chama este endpoint, sysparm_offset é definido como "0". Para simplesmente percorrer todos os registros disponíveis, use Tipo de dados: número Padrão: 0 |
| sysparm_query | Consulta codificada usada para filtrar o conjunto de resultados. Você pode usar um filtro de IU para obter uma consulta codificada corretamente. Sintaxe: sysparm_query=<col_name><operator><value> .
Todos os parâmetros fazem distinção entre maiúsculas e minúsculas. As consultas podem conter mais de uma entrada, como sysparm_query=<col_name><operator><value> [ ] . Por exemplo:
As consultas codificadas também oferecem suporte à ordem por funcionalidade. Para classificar respostas com base em determinados campos, use as cláusulas Sintaxe:
Por exemplo: Esta consulta filtra todos os registros ativos e ordena os resultados em ordem crescente por número e, em seguida, em ordem decrescente por categoria. Se parte da consulta for inválida, por exemplo, especificando um nome de campo inválido, a instância ignorará a parte inválida. Em seguida, ele retorna linhas usando somente a parte válida da consulta. Você pode controlar esse comportamento usando a propriedade glide.invalid_query.returns_no_rows. Defina esta propriedade como verdadeira para não retornar linhas em uma consulta inválida. Nota: A propriedade glide.invalid_query.returns_no_rows controla o comportamento de todas as consultas na instância, como em listas, scripts (GlideRecord.query()) e APIs de serviço web. Tipo de dados: cadeia de caracteres |
| pesquisa de texto | Cadeia de caracteres a ser usada para pesquisar todos os campos de registro de solicitação de mudança padrão. Esta pesquisa usa a funcionalidade da plataforma de pesquisa de texto completo da ServiceNow e o padrão é IR_AND_OR_QUERY.Tipo de dados: cadeia de caracteres |
| Nome | Descrição |
|---|---|
| Nenhum(a) |
Cabeçalhos
Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.
| Cabeçalho | Descrição |
|---|---|
| Aceitar | Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json |
| Cabeçalho | Descrição |
|---|---|
| Nenhum(a) |
Códigos de status
Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.
| Código de status | Descrição |
|---|---|
| 200 | Solicitação concluída com sucesso. |
| 401 | Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas. |
| 500 | Erro Interno do Servidor. Ocorreu um erro de lógica no código do lado do servidor. |
Parâmetros do corpo da resposta (JSON ou XML)
| Nome | Descrição |
|---|---|
| pares de nome-valor | Todos os campos com seus valores associados para o modelo de mudança padrão identificado. Tipo de dados: objeto |
| sys_id | Informações de Sys_id para a solicitação de mudança. Tipo de dados: objeto |
| sys_id.display_value | Sys_id da solicitação de mudança a ser exibida em uma IU. Tipo de dados: cadeia de caracteres |
| sys_id.value | Sys_id da solicitação de mudança. Tipo de dados: cadeia de caracteres |
| modelo | Informações sobre o modelo de mudança padrão. Tipo de dados: objeto |
| modelo.display_value | Informações do modelo a serem exibidas na IU. Tipo de dados: cadeia de caracteres |
| modelo.valor | sys_id do modelo. Tipo de dados: cadeia de caracteres |
Solicitação de cURL
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/standard/template?sysparm_query=active=true^ORDERBYnumber" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
{
result: [
{
sys_id: {
value: "92b8544047810200e90d87e8dee490b0",
display_value: "92b8544047810200e90d87e8dee490b0"
},
template : {
value: "1c8e02ec47410200e90d87e8dee49057",
display_value: "Add network switch to datacenter cabinet"
},
..., // all valid fields in record, example below
short_description: {
value: "Standard change template to add network switch to cabinet",
display_value: "Standard change template to add network switch to cabinet"
},
},
{ // next record found }, ... // and so on
]
}Gestão de mudanças - GET /sn_chg_rest/change/standard/template/{sys_id}
Recupera o modelo de mudança padrão identificado pelo sys_id especificado.
Formato da URL
URL com controle de versões: /api/sn_chg_rest/{api_version}/change/standard/template/{sys_id}
URL padrão: /api/sn_chg_rest/change/standard/template/{sys_id}
Parâmetros de solicitação compatíveis
| Nome | Descrição |
|---|---|
| api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres |
| sys_id | Sys_id do modelo de mudança padrão a ser recuperado da tabela [std_change_record_producer]. Tipo de dados: cadeia de caracteres |
| Nome | Descrição |
|---|---|
| Nenhum(a) |
| Nome | Descrição |
|---|---|
| Nenhum(a) |
Cabeçalhos
Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.
| Cabeçalho | Descrição |
|---|---|
| Aceitar | Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json |
| Cabeçalho | Descrição |
|---|---|
| Nenhum(a) |
Códigos de status
Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.
| Código de status | Descrição |
|---|---|
| 200 | Solicitação concluída com sucesso. |
| 400 | Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada. |
| 401 | Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas. |
| 404 | Não encontrado. Não foi possível encontrar o registro especificado. |
| 500 | Erro Interno do Servidor. Ocorreu um erro de lógica no código do lado do servidor. |
Parâmetros do corpo da resposta (JSON ou XML)
| Nome | Descrição |
|---|---|
| pares de nome-valor | Todos os campos com seus valores associados para o modelo de mudança padrão identificado. Tipo de dados: objeto |
| sys_id | Sys_id da solicitação de mudança. Tipo de dados: cadeia de caracteres |
| modelo | Informações sobre o modelo de mudança padrão. Tipo de dados: objeto |
| modelo.display_value | Informações do modelo a serem exibidas em uma IU. Tipo de dados: cadeia de caracteres |
| modelo.valor | sys_id do modelo. Tipo de dados: cadeia de caracteres |
Solicitação de cURL
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/standard/template/92b8544047810200e90d87e8dee490b0" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"{
result: [
{
sys_id: "92b8544047810200e90d87e8dee490b0",
template : {
value: "1c8e02ec47410200e90d87e8dee49057",
display_value: "Add network switch to datacenter cabinet"
},
..., // all valid fields in record, example below
short_description: {
value: "Standard change template to add network switch to cabinet",
display_value: "Standard change template to add network switch to cabinet"
},
},
]
}
Gestão de mudanças - GET /sn_chg_rest/change/worker/{sys_id}
Recupera o status atual, as informações e os erros do trabalhador assíncrono especificado.
Formato da URL
URL com controle de versões: /api/sn_chg_rest/{api_version}/change/worker/{sys_id}
URL padrão: /api/sn_chg_rest/{change/worker/{sys_id}
Parâmetros de solicitação compatíveis
| Nome | Descrição |
|---|---|
| api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres |
| sys_id | Sys_id do trabalhador assíncrono de gestão de mudanças. Localizado na tabela Trabalhador da Gestão de mudanças [chg_mgt_worker]. Tipo de dados: cadeia de caracteres |
| Nome | Descrição |
|---|---|
| Nenhum(a) |
| Nome | Descrição |
|---|---|
| Nenhum(a) |
Cabeçalhos
Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.
| Cabeçalho | Descrição |
|---|---|
| Aceitar | Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json |
| Cabeçalho | Descrição |
|---|---|
| Nenhum(a) |
Códigos de status
Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.
| Código de status | Descrição |
|---|---|
| 200 | Bem-sucedido. A solicitação foi processada com sucesso. |
| 401 | Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas. |
| 404 | Não encontrado. Não foi possível encontrar o registro especificado. |
| 500 | Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro. |
Parâmetros do corpo da resposta (JSON ou XML)
| Nome | Descrição |
|---|---|
| mensagens | Informações da mensagem. Tipo de dados: objeto |
| mensagens.MensagensDeErro | Mensagens de erro encontradas ao processar a solicitação. Por exemplo: sys_id de CMDB_CI fornecido inválido Tipo de dados: matriz |
| mensagens.infoMensagens | Mensagens informativas encontradas durante o processamento da solicitação. Por exemplo: O sys_id do CMDB_CI já está associado ao fornecido. Tipo de dados: matriz |
| mensagens.avisosMensagens | Mensagens de aviso encontradas durante o processamento da solicitação. Por exemplo: sys_id do CMDB_CI fornecido inválido. Tipo de dados: matriz |
| carga | Carga exclusiva fornecida ao usar um sys_id de trabalhador do corpo de resposta bem-sucedido de um endpoint de programação.
Tipo de dados: objeto |
| carga.períodos | Se um período de tempo estiver disponível dentro da duração fornecida no endpoint de programação, a API do trabalhador listará os períodos de tempo disponíveis.Tipo de dados: matriz |
| carga.períodos.início | Tipo de dados: objeto |
| carga.períodos.valor.início | Data e hora em que a solicitação de mudança está planejada para iniciar a implementação. Tipo de dados: cadeia de caracteres |
| payload.spans.start.display_value | Exibe o valor da hora de início da solicitação de mudança. Formato de hora: aaaa-mm-dd hh:mm:ss Tipo de dados: cadeia de caracteres |
| carga.períodos.término | Tipo de dados: objeto |
| carga.períodos.valor.término | Data e hora em que a solicitação de mudança está planejada para conclusão. Formato de hora: aaaa-mm-dd hh:mm:ss Tipo de dados: cadeia de caracteres |
| payload.spans.end.display_value | Exibe o valor do tempo de conclusão da solicitação de mudança. Tipo de dados: cadeia de caracteres |
| solicitação | Solicitação de endpoint original. Tipo de dados: cadeia de caracteres |
| estado | Informações sobre o estado atual do trabalhador. Tipo de dados: objeto |
| estado.display_value | Valor de exibição do estado do trabalhador. Esses valores estão diretamente correlacionados ao parâmetro state.value. Valores possíveis:
Tipo de dados: cadeia de caracteres |
| estado.valor | Valor numérico do estado do trabalhador. Valores possíveis:
Tipo de dados: número |
| tipo | Tipo de associação entre o IC do CMDB e a solicitação de mudança. Tipo de dados: cadeia de caracteres |
| trabalhador | Informações sobre o trabalhador associado. Tipo de dados: objeto |
| trabalhador.link | URL para recuperar o status do trabalhador associado e outras informações pertinentes ao trabalhador. Tipo de dados: cadeia de caracteres |
| trabalhador.sysId | Sys_id do trabalhador associado à solicitação de mudança. Tipo de dados: cadeia de caracteres |
| <other_params> | Outros parâmetros específicos do processo, como ignored_cmdb_ci_sys_ids. |
Solicitação de cURL
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/worker/0644cd02dbec330084f07ffdbf9619c1" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"{
"result": {
"worker": {
"sysId": "0644cd02dbec330084f07ffdbf9619c1",
"link": "https://instance.service-now.com/api/sn_chg_rest/change/worker/0644cd02dbec330084f07ffdbf9619c1"
},
"request": "{\"task\":\"c286d61347c12200e0ef563dbb9a71df\"}",
"state": {
"value": 3,
"display_value": "Complete"
},
"type": "impacted",
"messages": {
"errorMessages": [],
"warningMessages": [],
"infoMessages": []
}
}
}Gestão de mudanças - PATCH /sn_chg_rest/change/{sys_id}
Atualiza a solicitação de mudança identificada pelo sys_id especificado com os pares de chave-valor no corpo da solicitação ou na URL.
Formato da URL
URL com controle de versão: /api/sn_chg_rest/{api_version}/change/{sys_id}
URL padrão: /api/sn_chg_rest/change/{sys_id}
Parâmetros de solicitação compatíveis
| Nome | Descrição |
|---|---|
| api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres |
| sys_id | Sys_id da solicitação de mudança a ser modificada. Localizado na tabela Solicitação de mudança [change_request]. Tipo de dados: cadeia de caracteres |
| Nome | Descrição |
|---|---|
| pares de nome-valor | Pares de nome-valor que representam os campos a serem atualizados. Os parâmetros do corpo da solicitação substituem os parâmetros de URL. No entanto, os parâmetros obrigatórios devem ser especificados no URL. Tipo de dados: cadeia de caracteres |
| campos_criptografia | Lista de campos separados por vírgula para criptografar. Esses campos são criptografados antes de serem armazenados no registro associado. Quando especificado, o endpoint chama o método GlideRecord setDisplayValue(), em vez de chamar o método setValue(). Por isso, você também pode usar este parâmetro para passar valores de exibição para campos não criptografados, como campos de referência ou de opção, em vez de passar sys_ids ou valores. Tipo de dados: cadeia de caracteres |
| Nome | Descrição |
|---|---|
| dados | Pares de nome-valor que representam os campos a serem atualizados na solicitação de mudança associada. Por exemplo, para atualizar o arquivo de descrição resumida, insira um par de nome-valor semelhante ao seguinte: --data "{"short_description": "my short desc" }" \. Tipo de dados: cadeia de caracteres |
| campos_criptografia | Lista de campos separados por vírgula para criptografar. Esses campos são criptografados antes de serem armazenados no registro associado. Quando especificado, o endpoint chama o método GlideRecord setDisplayValue(), em vez de chamar o método setValue(). Por isso, você também pode usar este parâmetro para passar valores de exibição para campos não criptografados, como campos de referência ou de opção, em vez de passar sys_ids ou valores. Tipo de dados: cadeia de caracteres |
Cabeçalhos
Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.
| Cabeçalho | Descrição |
|---|---|
| Aceitar | Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json |
| Tipo de conteúdo | Formato de dados do corpo da solicitação. Tipos compatíveis: application/json ou application/xml. Padrão: application/json |
| Cabeçalho | Descrição |
|---|---|
| Nenhum(a) |
Códigos de status
Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.
| Código de status | Descrição |
|---|---|
| 200 | Solicitação concluída com sucesso. |
| 400 | Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada. |
| 401 | Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas. |
| 404 | Não encontrado. Não foi possível encontrar o registro especificado. |
| 500 | Erro Interno do Servidor. Ocorreu um erro de lógica no código do lado do servidor. |
Parâmetros do corpo da resposta (JSON ou XML)
| Nome | Descrição |
|---|---|
| resultado | Registro de solicitação de mudança atualizado. Cada elemento neste objeto corresponde a um campo no registro na tabela Solicitação de mudança [change_request]. Todos os elementos contêm pares de nome-valor value e display_value. Alguns contêm display_value_internal pares de nome-valor. Tipo de dados: objeto |
Solicitação de cURL
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/b0dbda5347c12200e0ef563dbb9a718f" \
--request PATCH \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--data "{\"short_desription\": \"Reboot the server at 6 am\" }" \
--user "username":"password"{
"result":
{
"reason": {
"display_value": "",
"value": ""
},
"parent": {
"display_value": "",
"value": ""
},
"watch_list": {
"display_value": "",
"value": ""
},
"proposed_change": {
"display_value": "",
"value": ""
},
"upon_reject": {
"display_value": "Cancel all future Tasks",
"value": "cancel"
},
"sys_updated_on": {
"display_value": "2015-07-06 11:59:27",
"value": "2015-07-06 18:59:27",
"display_value_internal": "2015-07-06 11:59:27"
},
"type": {
"display_value": "Standard",
"value": "standard"
},
"approval_history": {
"display_value": "",
"value": ""
},
"skills": {
"display_value": "",
"value": ""
},
"test_plan": {
"display_value": "--Confirm that there are no monitoring alerts for the router",
"value": "--Confirm that there are no monitoring alerts for the router"
},
"number": {
"display_value": "CHG0000024",
"value": "CHG0000024"
},
"is_bulk": {
"display_value": "false",
"value": false
},
"cab_delegate": {
"display_value": "",
"value": ""
},
"requested_by_date": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"ci_class": {
"display_value": "cmdb_ci",
"value": "cmdb_ci"
},
"state": {
"display_value": "Closed",
"value": 3.0
},
"sys_created_by": {
"display_value": "admin",
"value": "admin"
},
"knowledge": {
"display_value": "false",
"value": false
},
"order": {
"display_value": "",
"value": ""
},
"phase": {
"display_value": "Requested",
"value": "requested"
},
"cmdb_ci": {
"display_value": "",
"value": ""
},
"delivery_plan": {
"display_value": "",
"value": ""
},
"impact": {
"display_value": "3 - Low",
"value": 3.0
},
"contract": {
"display_value": "",
"value": ""
},
"active": {
"display_value": "false",
"value": false
},
"work_notes_list": {
"display_value": "",
"value": ""
},
"priority": {
"display_value": "4 - Low",
"value": 4.0
},
"sys_domain_path": {
"display_value": "/",
"value": "/"
},
"cab_recommendation": {
"display_value": "",
"value": ""
},
"production_system": {
"display_value": "false",
"value": false
},
"rejection_goto": {
"display_value": "",
"value": ""
},
"review_date": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"requested_by": {
"display_value": "System Administrator",
"value": "6816f79cc0a8016401c5a33be04be441"
},
"business_duration": {
"display_value": "",
"value": ""
},
"group_list": {
"display_value": "",
"value": ""
},
"change_plan": {
"display_value": "",
"value": ""
},
"approval_set": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"wf_activity": {
"display_value": "",
"value": ""
},
"implementation_plan": {
"display_value": "-- Place router into maintenance mode in the monitoring platform\r\n-- Logon to router through SSH\r\n-- Run the following command\r\n\r\nrouter(config-router)#router bgp 12345\r\nrouter(config-router)#neighbor {neighbor ip} soft-reconfig [inbound]\r\nrouter#clear ip bgp {neighbor ip} soft in\r\n\r\n-- Confirm the sessions have been cleared\r\n-- Place router back into operational mode in the monitoring platform",
"value": "-- Place router into maintenance mode in the monitoring platform\r\n-- Logon to router through SSH\r\n-- Run the following command\r\n\r\nrouter(config-router)#router bgp 12345\r\nrouter(config-router)#neighbor {neighbor ip} soft-reconfig [inbound]\r\nrouter#clear ip bgp {neighbor ip} soft in\r\n\r\n-- Confirm the sessions have been cleared\r\n-- Place router back into operational mode in the monitoring platform"
},
"universal_request": {
"display_value": "",
"value": ""
},
"end_date": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"short_description": {
"display_value": "Reboot the server at 6 am",
"value": "Reboot the server at 6 am"
},
"correlation_display": {
"display_value": "",
"value": ""
},
"work_start": {
"display_value": "2015-07-06 11:56:04",
"value": "2015-07-06 18:56:04",
"display_value_internal": "2015-07-06 11:56:04"
},
"delivery_task": {
"display_value": "",
"value": ""
},
"outside_maintenance_schedule": {
"display_value": "false",
"value": false
},
"additional_assignee_list": {
"display_value": "",
"value": ""
},
"std_change_producer_version": {
"display_value": "Clear BGP sessions on a Cisco router - 1",
"value": "16c2273c47010200e90d87e8dee49006"
},
"sys_class_name": {
"display_value": "Change Request",
"value": "change_request"
},
"service_offering": {
"display_value": "",
"value": ""
},
"closed_by": {
"display_value": "System Administrator",
"value": "6816f79cc0a8016401c5a33be04be441"
},
"follow_up": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"review_status": {
"display_value": "",
"value": ""
},
"reassignment_count": {
"display_value": "2",
"value": 2.0
},
"start_date": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"assigned_to": {
"display_value": "",
"value": ""
},
"variables": {
"display_value": "variable_pool",
"value": "variable_pool"
},
"sla_due": {
"display_value": "UNKNOWN",
"value": "",
"display_value_internal": ""
},
"comments_and_work_notes": {
"display_value": "",
"value": ""
},
"escalation": {
"display_value": "Normal",
"value": 0.0
},
"upon_approval": {
"display_value": "Proceed to Next Task",
"value": "proceed"
},
"correlation_id": {
"display_value": "",
"value": ""
},
"made_sla": {
"display_value": "true",
"value": true
},
"backout_plan": {
"display_value": "Due to the limited number of commands in the implementation plan it is not possible to backout the change.\r\n\r\nIf required you are authorized to reboot the router if BGP fails to work",
"value": "Due to the limited number of commands in the implementation plan it is not possible to backout the change.\r\n\r\nIf required you are authorized to reboot the router if BGP fails to work"
},
"conflict_status": {
"display_value": "Not Run",
"value": "Not Run"
},
"task_effective_number": {
"display_value": "CHG0000024",
"value": "CHG0000024"
},
"sys_updated_by": {
"display_value": "admin",
"value": "admin"
},
"opened_by": {
"display_value": "System Administrator",
"value": "6816f79cc0a8016401c5a33be04be441"
},
"user_input": {
"display_value": "",
"value": ""
},
"sys_created_on": {
"display_value": "2015-07-06 11:55:46",
"value": "2015-07-06 18:55:46",
"display_value_internal": "2015-07-06 11:55:46"
},
"on_hold_task": {
"display_value": "",
"value": ""
},
"sys_domain": {
"display_value": "global",
"value": "global"
},
"route_reason": {
"display_value": "",
"value": ""
},
"closed_at": {
"display_value": "2015-07-06 11:56:23",
"value": "2015-07-06 18:56:23",
"display_value_internal": "2015-07-06 11:56:23"
},
"review_comments": {
"display_value": "",
"value": ""
},
"business_service": {
"display_value": "",
"value": ""
},
"time_worked": {
"display_value": "",
"value": ""
},
"chg_model": {
"display_value": "",
"value": ""
},
"expected_start": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"opened_at": {
"display_value": "2015-06-09 11:55:46",
"value": "2015-06-09 18:55:46",
"display_value_internal": "2015-06-09 11:55:46"
},
"work_end": {
"display_value": "2015-07-06 11:56:10",
"value": "2015-07-06 18:56:10",
"display_value_internal": "2015-07-06 11:56:10"
},
"phase_state": {
"display_value": "Open",
"value": "open"
},
"cab_date": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"work_notes": {
"display_value": "",
"value": ""
},
"close_code": {
"display_value": "Successful",
"value": "successful"
},
"assignment_group": {
"display_value": "Network",
"value": "287ebd7da9fe198100f92cc8d1d2154e"
},
"description": {
"display_value": "Resend the complete BGP table to neighboring routers\r\n\r\n--Both neighbors need to support soft reset route refresh capability.\r\n--Stores complete BGP table of you neighbor in router memory.\r\n--Not a good idea on a peering router with full feed, due to the memory requirements.\r\n",
"value": "Resend the complete BGP table to neighboring routers\r\n\r\n--Both neighbors need to support soft reset route refresh capability.\r\n--Stores complete BGP table of you neighbor in router memory.\r\n--Not a good idea on a peering router with full feed, due to the memory requirements.\r\n"
},
"on_hold_reason": {
"display_value": "",
"value": ""
},
"calendar_duration": {
"display_value": "",
"value": ""
},
"close_notes": {
"display_value": "Completed without issues",
"value": "Completed without issues"
},
"sys_id": {
"display_value": "b0dbda5347c12200e0ef563dbb9a718f",
"value": "b0dbda5347c12200e0ef563dbb9a718f"
},
"contact_type": {
"display_value": "Phone",
"value": "phone"
},
"cab_required": {
"display_value": "false",
"value": false
},
"urgency": {
"display_value": "3 - Low",
"value": 3.0
},
"scope": {
"display_value": "Medium",
"value": 3.0
},
"company": {
"display_value": "",
"value": ""
},
"justification": {
"display_value": "",
"value": ""
},
"activity_due": {
"display_value": "UNKNOWN",
"value": "",
"display_value_internal": ""
},
"comments": {
"display_value": "",
"value": ""
},
"approval": {
"display_value": "Approved",
"value": "approved"
},
"due_date": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"sys_mod_count": {
"display_value": "10",
"value": 10.0
},
"on_hold": {
"display_value": "false",
"value": false
},
"sys_tags": {
"display_value": "",
"value": ""
},
"conflict_last_run": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"risk_value": {
"display_value": "",
"value": ""
},
"unauthorized": {
"display_value": "false",
"value": false
},
"risk": {
"display_value": "Moderate",
"value": 3.0
},
"location": {
"display_value": "",
"value": ""
},
"category": {
"display_value": "Other",
"value": "Other"
},
"risk_impact_analysis": {
"display_value": "",
"value": ""
}
}
}Solicitação de cURL
O exemplo a seguir mostra como passar campos criptografados no corpo da solicitação.
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/b0dbda5347c12200e0ef563dbb9a718f" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
\"encrypted_fields\":\"short_description,description\",
\"short_description\":\"my short desc\",
\"description\":\"my desc\"
}" \
--user "username":"password"Solicitação de cURL
O exemplo a seguir mostra como passar campos criptografados como parâmetros de consulta.
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/b0dbda5347c12200e0ef563dbb9a718f?encrypted_fields=short_description%2Cdescription&short_description=my%20short%20desc&description=my%20desc" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{}" \
--user "username":"password"Gestão de mudanças - PATCH /sn_chg_rest/change/{sys_id}/approvals
Permite que o usuário atual aprove ou rejeite um registro de aprovação de solicitação de mudança para a solicitação de mudança especificada.
Formato da URL
URL com controle de versão: /api/sn_chg_rest/{api_version}/change/{sys_id}/approvals
URL padrão: /api/sn_chg_rest/change/{sys_id}/approvals
Parâmetros de solicitação compatíveis
| Nome | Descrição |
|---|---|
| api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres |
| sys_id | Sys_id da solicitação de mudança à qual a aprovação/rejeição se aplica. Localizado na tabela Solicitação de mudança [change_request]. Tipo de dados: cadeia de caracteres |
| Nome | Descrição |
|---|---|
| Nenhum(a) |
| Nome | Descrição |
|---|---|
| comentários | Obrigatório se state for rejeitado. Motivo pelo qual a mudança foi rejeitada.Tipo de dados: cadeia de caracteres |
| estado | Obrigatório. Estado de aprovação. Por exemplo: Valores válidos:
Tipo de dados: cadeia de caracteres |
Cabeçalhos
Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.
| Cabeçalho | Descrição |
|---|---|
| Aceitar | Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json |
| Tipo de conteúdo | Formato de dados do corpo da solicitação. Tipos compatíveis: application/json ou application/xml. Padrão: application/json |
| Cabeçalho | Descrição |
|---|---|
| Nenhum(a) |
Códigos de status
Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.
| Código de status | Descrição |
|---|---|
| 200 | Bem-sucedido. A solicitação foi processada com sucesso. |
| 401 | Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas. |
| 400 | Solicitação incorreta. Indica um tipo de solicitação incorreta, como o usuário não ter autoridade para aprovar ou rejeitar a solicitação de mudança. |
| 500 | Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro. |
Parâmetros do corpo da resposta (JSON ou XML)
| Nome | Descrição |
|---|---|
| pares de nome-valor | Valores para todos os campos na solicitação de mudança associada. Tipo de dados: objeto |
| estado | Estado atual da solicitação de mudança. Tipo de dados: objeto |
| estado.display_value | Estado a ser exibido em uma IU. Tipo de dados: cadeia de caracteres |
| estado.valor | Valor do estado interno. Tipo de dados: cadeia de caracteres |
| sys_id | Sys_id da solicitação de mudança que está sendo aprovada/rejeitada. Tipo de dados: cadeia de caracteres |
| tipo | Tipo de solicitação de mudança Tipo de dados: objeto |
| tipo.exibição_valor | Mude o tipo para exibir em uma IU. Valores possíveis:
Tipo de dados: cadeia de caracteres |
| tipo.valor | Valor de tipo interno. Valores possíveis:
Tipo de dados: cadeia de caracteres |
Solicitação de cURL
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/0f4ac6c4b750230096c3e4f6ee11a9fe/approvals" \
--request POST \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--data "{\"state\": \"approved\"}" \
--user "username":"password"
{
result: [
{
sys_id: "0f4ac6c4b750230096c3e4f6ee11a9fe",
state: {
value: "-2",
display_value: "Scheduled"
},
type: {
value: "normal",
display_value: "Normal"
},
..., // all valid fields in record, single parameter example below
short_description: {
value: "Remove server",
display_value: "Remove server"
}
}
]
}Gestão de mudanças - PATCH /sn_chg_rest/change/{change_sys_id}/schedule/first_available
Atualiza os horários de início e término planejados de uma solicitação de mudança usando o primeiro intervalo de tempo disponível encontrado.
Função necessária: sn_change_writer.
Formato da URL
URL com controle de versão: /api/sn_chg_rest/{api_version}/change/{change_sys_id}/schedule/first_available
URL padrão: /api/sn_chg_rest/change/{change_sys_id}/schedule/first_available
Parâmetros de solicitação compatíveis
| Nome | Descrição |
|---|---|
| api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres |
| change_sys_id | Sys_id da solicitação de mudança na qual atualizar com o próximo intervalo de tempo disponível. Localizado na tabela Solicitações de mudança [change_request]. A solicitação de mudança selecionada deve ter um item de configuração (cmdb_ci). |
| Nome | Descrição |
|---|---|
| Nenhum(a) |
| Nome | Descrição |
|---|---|
| duração_em_segundos | Duração da mudança em segundos, ou seja, quanto tempo é necessário para concluir a tarefa de solicitação de mudança. Tipo de dados: inteiro |
| hora_de_início_planejada | Opcional. Data e hora em que a solicitação de mudança está planejada para iniciar a implementação em UTC. Recupere o início do intervalo de tempo disponível em ou após esta hora. Se não for fornecido, o sistema usará a hora atual como a hora de início. Formato de hora: aaaa-mm-dd hh:mm:ss Tipo de dados: cadeia de caracteres |
Cabeçalhos
Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.
| Cabeçalho | Descrição |
|---|---|
| Aceitar | Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json |
| Cabeçalho | Descrição |
|---|---|
| Nenhum(a) |
Códigos de status
Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.
| Código de status | Descrição |
|---|---|
| 202 | O sistema aceitou a solicitação. |
| 400 | Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada. Possíveis problemas:
|
| 403 | Proibido. O usuário não tem acesso de gravação aos valores de data de início e término planejados da solicitação de mudança. |
| 404 | Não encontrado. Não foi possível encontrar o registro especificado.
Possíveis problemas:
|
Parâmetros do corpo da resposta (JSON ou XML)
| Nome | Descrição |
|---|---|
| erro | Informações sobre erros encontrados ao processar a solicitação de endpoint. Tipo de dados: objeto |
| erro.detalhe | Informações adicionais sobre o erro. Tipo de dados: cadeia de caracteres |
| mensagem.erro | Mensagem que identifica o erro. Tipo de dados: cadeia de caracteres |
| mensagens | Informações da mensagem. Tipo de dados: objeto |
| mensagens.MensagensDeErro | Mensagens de erro encontradas ao processar a solicitação. Tipo de dados: matriz |
| mensagens.infoMensagens | Mensagens informativas encontradas durante o processamento da solicitação. Tipo de dados: matriz |
| mensagens.avisosMensagens | Mensagens de aviso encontradas durante o processamento da solicitação. Tipo de dados: matriz |
| solicitação | Solicitação de endpoint original. Tipo de dados: cadeia de caracteres |
| estado | Informações sobre o estado atual do trabalhador. Tipo de dados: objeto |
| estado.display_value | Valor de exibição do estado do trabalhador. Esses valores estão diretamente correlacionados ao parâmetro state.value. Valores possíveis:
Tipo de dados: cadeia de caracteres |
| estado.valor | Valor numérico do estado do trabalhador. Valores possíveis:
Tipo de dados: número |
| tipo | Indica o tipo de solicitação. Valor válido: programação Tipo de dados: cadeia de caracteres |
| trabalhador | Informações sobre o trabalhador associado. Tipo de dados: objeto |
| trabalhador.link | Link para recuperar o status da programação da solicitação de mudança. Use o sys_id em GET /sn_chg_rest/change/worker/{sys_id} para exibir os resultados. Tipo de dados: cadeia de caracteres |
| trabalhador.sysId | Sys_id do trabalhador associado à solicitação de mudança. Tipo de dados: cadeia de caracteres |
| status | Aparece somente se um erro for encontrado. Status do processamento do endpoint. Valor possível: falha Tipo de dados: cadeia de caracteres |
Obter status da programação da solicitação de mudança
Use o valor fornecido em worker.link para determinar se o registro de mudança foi programado com sucesso para o primeiro intervalo de tempo disponível. O valor está no seguinte formato:
https://instance.service-now.com/api/sn_chg_rest/change/worker/<worker_sys_id>
Use os detalhes do work.link para executar o sys_id fornecido em GET /sn_chg_rest/change/worker/{sys_id} para exibir os resultados.
O corpo da resposta contém o status e fornece resultados quando o processamento é concluído.
Se um slot de tempo disponível for encontrado, o sistema atualizará a solicitação de mudança com o primeiro slot disponível. Quando o estado é concluído, o messages.infoMessages revela que o primeiro intervalo de tempo disponível foi definido.
A mudança foi atualizada– A mudança solicitada foi atualizada para o intervalo de tempo.Nenhum slot encontrado para<number> dias a partir de agora – Não há intervalos de tempo disponíveis para a duração da solicitação de mudança fornecida dentro do número de dias definido na janela de programação.Nota:O valor padrão do intervalo de tempo de programação da solicitação de mudança é 90 dias. Para alterar este valor, modifique a propriedade change.conflict.next_available.schedule_window. Para obter mais informações, consulte Configuração de propriedades de análise de conflitos.
O exemplo de GET /sn_chg_rest/change/worker/{sys_id} a seguir mostra a saída fornecida usando o ID fornecido no detalhe do work.link. Os resultados indicam que o processamento está concluído e a solicitação de mudança foi atualizada com o primeiro intervalo de tempo disponível.
{
"result": {
"worker": {
"sysId": "355c62e0a4c87010f87712198fe9cacf",
"link": "https://instance.service-now.com/api/sn_chg_rest/change/worker/355c62e0a4c87010f87712198fe9cacf"
},
"request": "{\"change_sys_id\":\"87ae5e900a0a2c3e263e8304e727c646\",\"duration_in_seconds\":10800,\"timezone\":\"America/Los_Angeles\"}",
"state": {
"value": 3,
"display_value": "Complete"
},
"type": "schedule",
"messages": {
"errorMessages": [],
"warningMessages": [],
"infoMessages": [
"Change has been updated"
]
}
}
}Solicitação de cURL
curl "https://instance.service-now.com/api/sn_chg_rest/change/87ae5e900a0a2c3e263e8304e727c646/schedule/first_available" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{\"duration_in_seconds\":\"10800\"}" \
--user "username":"password"
Os resultados incluem detalhes de work.link que você pode usar para executar o sys_id fornecido no endpoint GET /sn_chg_rest/change/worker/.
{
"result": {
"worker": {
"sysId": "355c62e0a4c87010f87712198fe9cacf",
"link": "https://instance.service-now.com/api/sn_chg_rest/change/worker/355c62e0a4c87010f87712198fe9cacf"
},
"request": "{\"change_sys_id\":\"87ae5e900a0a2c3e263e8304e727c646\",\"duration_in_seconds\":10800,\"timezone\":\"America/Los_Angeles\"}",
"state": {
"value": 1,
"display_value": "Waiting"
},
"type": "schedule",
"messages": {
"errorMessages": [],
"warningMessages": [],
"infoMessages": []
}
}
}Gestão de mudanças - PATCH /sn_chg_rest/change/{change_sys_id}/task/{task_sys_id}
Atualiza a tarefa de solicitação de mudança identificada pelos sys_ids especificados com os pares de chave-valor no corpo da solicitação ou no URL.
Formato da URL
URL com controle de versão: /api/sn_chg_rest/{api_version}/change/{change_sys_id}/task/{task_sys_id}
URL padrão: /api/sn_chg_rest/change/{change_sys_id}/task/{task_sys_id}
Parâmetros de solicitação compatíveis
| Nome | Descrição |
|---|---|
| api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres |
| change_sys_id | Sys_id da solicitação de mudança à qual a tarefa está associada. Verifica se a tarefa especificada está associada à solicitação de mudança especificada. Localizado na tabela Solicitação de mudança [change_request]. Tipo de dados: cadeia de caracteres |
| task_sys_id | Sys_id da tarefa a ser modificada. Localizado na tabela Tarefa de mudança [change_task]. Tipo de dados: cadeia de caracteres |
| Nome | Descrição |
|---|---|
| pares de chave-valor | Pares de nome-valor que representam os campos a serem atualizados. Os parâmetros do corpo da solicitação substituem os parâmetros de URL. No entanto, os parâmetros obrigatórios devem ser especificados no URL. Tipo de dados: cadeia de caracteres |
| Nome | Descrição |
|---|---|
| dados | Pares de nome-valor que representam os campos a serem atualizados na solicitação de mudança associada. Por exemplo, para atualizar o arquivo de descrição resumida, insira um par de nome-valor semelhante ao seguinte: --data "{"short_description": "my short desc" }" \. Tipo de dados: cadeia de caracteres |
Cabeçalhos
Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.
| Cabeçalho | Descrição |
|---|---|
| Aceitar | Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json |
| Tipo de conteúdo | Formato de dados do corpo da solicitação. Tipos compatíveis: application/json ou application/xml. Padrão: application/json |
| Cabeçalho | Descrição |
|---|---|
| Nenhum(a) |
Códigos de status
Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.
| Código de status | Descrição |
|---|---|
| 200 | Bem-sucedido. A solicitação foi processada com sucesso. |
| 400 | Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada. |
| 401 | Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas. |
| 404 | Não encontrado. Não foi possível encontrar o registro especificado. |
| 500 | Erro Interno do Servidor. Ocorreu um erro de lógica no código do lado do servidor. |
Parâmetros do corpo da resposta (JSON ou XML)
| Nome | Descrição |
|---|---|
| pares de nome-valor | Todos os campos (chave) com seus valores associados para a tarefa de solicitação de mudança identificada antes da exclusão. Tipo de dados: objeto |
| sys_id | Informações de Sys_id para a tarefa de solicitação de mudança. Tipo de dados: objeto |
| sys_id.display_value | Sys_id da tarefa de solicitação de mudança a ser exibida em uma IU. Tipo de dados: cadeia de caracteres |
| sys_id.value | Sys_id da tarefa de solicitação de mudança. Tipo de dados: cadeia de caracteres |
| primário | Informações do identificador exclusivo da solicitação de mudança associada a esta tarefa. Tipo de dados: objeto |
| primário.display_value | Informações da tarefa a serem exibidas em uma IU. Tipo de dados: cadeia de caracteres |
| primário.valor | Sys_id da tarefa primária. Tipo de dados: cadeia de caracteres |
| __meta.ignoredFields | Pares de chave-valor que foram passados na chamada, mas não foram aplicados à solicitação de mudança porque não existem no registro base ou os campos são somente leitura. Tipo de dados: matriz |
Solicitação de cURL
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/0f4ac6c4b750230096c3e4f6ee11a9fe/task/12629ec4b750230096c3e4f6ee11a9d5?short_description=Retire both nodes" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type: application/json" \
--data "{\"state\": \"assess\", \"no_such_field\": \"this will be ignored\" }" \
--user "username":"password"{
result: [
{
sys_id: {
value: "12629ec4b750230096c3e4f6ee11a9d5",
display_value: "12629ec4b750230096c3e4f6ee11a9d5"
},
parent: {
value: "0f4ac6c4b750230096c3e4f6ee11a9fe",
display_value: "CHG0033046 "
},
..., // all valid fields in record, example below
short_description: {
value: "Retire both nodes",
display_value: "Retire both nodes"
}
__meta: {
ignoredFields: ["no_such_field"]
}
}
]
}Gestão de mudanças - PATCH /sn_chg_rest/change/emergency/{sys_id}
Atualiza a solicitação de mudança de emergência identificada pelo sys_id especificado com os pares de chave-valor no corpo da solicitação ou no URL.
Formato da URL
URL com controle de versões: /api/sn_chg_rest/{api_version}/change/emergency/{sys_id}
URL padrão: /api/sn_chg_rest/change/emergency/{sys_id}
Parâmetros de solicitação compatíveis
| Nome | Descrição |
|---|---|
| api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres |
| sys_id | Sys_id da solicitação de mudança a ser modificada. Localizado na tabela [change_request]. Tipo de dados: cadeia de caracteres |
| Nome | Descrição |
|---|---|
| pares de nome-valor | Pares de nome-valor que representam os campos a serem atualizados. Os parâmetros do corpo da solicitação substituem os parâmetros de URL. No entanto, os parâmetros obrigatórios devem ser especificados no URL. Tipo de dados: cadeia de caracteres |
| Nome | Descrição |
|---|---|
| dados | Pares de nome-valor que representam os campos a serem atualizados na solicitação de mudança associada. Por exemplo, para atualizar o arquivo de descrição resumida, insira um par de nome-valor semelhante ao seguinte: --data "{"short_description": "my short desc" }" \. Tipo de dados: cadeia de caracteres |
Cabeçalhos
Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.
| Cabeçalho | Descrição |
|---|---|
| Aceitar | Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json |
| Tipo de conteúdo | Formato de dados do corpo da solicitação. Tipos compatíveis: application/json ou application/xml. Padrão: application/json |
| Cabeçalho | Descrição |
|---|---|
| Nenhum(a) |
Códigos de status
Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.
| Código de status | Descrição |
|---|---|
| 200 | Solicitação concluída com sucesso. |
| 400 | Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada. |
| 401 | Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas. |
| 404 | Não encontrado. Não foi possível encontrar o registro especificado. |
| 500 | Erro Interno do Servidor. Ocorreu um erro de lógica no código do lado do servidor. |
Parâmetros do corpo da resposta (JSON ou XML)
| Nome | Descrição |
|---|---|
| pares de nome-valor | Valores para todos os campos na solicitação de mudança associada. Tipo de dados: cadeia de caracteres |
| estado | Estado atual da solicitação de mudança. Tipo de dados: objeto |
| estado.display_value | Estado a ser exibido em uma IU. Tipo de dados: cadeia de caracteres |
| estado.valor | Valor do estado interno. Tipo de dados: cadeia de caracteres |
| sys_id | Sys_id da solicitação de mudança. Tipo de dados: cadeia de caracteres |
| tipo | Tipo de solicitação de mudança Tipo de dados: objeto |
| tipo.exibição_valor | Mude o tipo para exibir em uma IU. O valor é sempre "Emergência". Tipo de dados: cadeia de caracteres |
| tipo.valor | Valor de tipo interno. O valor é sempre "emergência". Tipo de dados: cadeia de caracteres |
| __meta.ignoredFields | Pares de nome-valor que foram passados na chamada, mas não foram aplicados à solicitação de mudança porque não existem no registro base ou os campos são somente leitura. Tipo de dados: matriz |
Solicitação de cURL
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/emergency/b0dbda5347c12200e0ef563dbb9a718f" \
--request PATCH \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--data "{\"no_such_field\": \"this will be ignored\", }" \
--user "username":"password"{
result: [
{
sys_id: "b0dbda5347c12200e0ef563dbb9a718f", },
state: {
value: "-4",
display_value: "Assess"
},
type: {
value: "emergency",
display_value: "Emergency"
},
..., // all valid fields in record, example below
short_description: {
value: "Reboot server",
display_value: "Reboot server"
}
__meta: {
ignoredFields: ["no_such_field"]
}
}
]
}Gestão de mudanças - PATCH /sn_chg_rest/change/normal/{sys_id}
Atualiza a solicitação de mudança normal identificada pelo sys_id especificado com os parâmetros no corpo da solicitação ou no URL.
Formato da URL
URL com controle de versão: /api/sn_chg_rest/{api_version}/change/normal/{sys_id}
URL padrão: /api/sn_chg_rest/change/normal/{sys_id}
Parâmetros de solicitação compatíveis
| Nome | Descrição |
|---|---|
| api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres |
| sys_id | Sys_id da solicitação de mudança a ser modificada. Localizado na tabela [change_request]. Tipo de dados: cadeia de caracteres |
| Nome | Descrição |
|---|---|
| pares de nome-valor | Pares de nome-valor que representam os campos a serem atualizados. Os parâmetros do corpo da solicitação substituem os parâmetros de URL. No entanto, os parâmetros obrigatórios devem ser especificados no URL. Tipo de dados: cadeia de caracteres |
| Nome | Descrição |
|---|---|
| dados | Pares de nome-valor que representam os campos a serem atualizados na solicitação de mudança associada. Por exemplo, para atualizar o arquivo de descrição resumida, insira um par de nome-valor semelhante ao seguinte: --data "{"short_description": "my short desc" }" \. Tipo de dados: cadeia de caracteres |
Cabeçalhos
Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.
| Cabeçalho | Descrição |
|---|---|
| Aceitar | Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json |
| Tipo de conteúdo | Formato de dados do corpo da solicitação. Tipos compatíveis: application/json ou application/xml. Padrão: application/json |
| Cabeçalho | Descrição |
|---|---|
| Nenhum(a) |
Códigos de status
Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.
| Código de status | Descrição |
|---|---|
| 200 | Solicitação concluída com sucesso. |
| 400 | Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada. |
| 401 | Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas. |
| 404 | Não encontrado. Não foi possível encontrar o registro especificado. |
| 500 | Erro Interno do Servidor. Ocorreu um erro de lógica no código do lado do servidor. |
Parâmetros do corpo da resposta (JSON ou XML)
| Nome | Descrição |
|---|---|
| pares de nome-valor | Valores para todos os campos na solicitação de mudança associada. Tipo de dados: objeto |
| estado | Estado atual da solicitação de mudança. Tipo de dados: objeto |
| estado.display_value | Estado a ser exibido em uma IU. Tipo de dados: cadeia de caracteres |
| estado.valor | Valor do estado interno. Tipo de dados: cadeia de caracteres |
| sys_id | Sys_id da solicitação de mudança. Tipo de dados: cadeia de caracteres |
| tipo | Tipo de solicitação de mudança Tipo de dados: objeto |
| tipo.exibição_valor | Mude o tipo para exibir em uma IU. O valor é sempre "Normal". Tipo de dados: cadeia de caracteres |
| tipo.valor | Valor de tipo interno. O valor é sempre "normal". Tipo de dados: cadeia de caracteres |
| __meta.ignoredFields | Pares de nome-valor que foram passados na chamada, mas não foram aplicados à solicitação de mudança porque não existem no registro base ou os campos são somente leitura. Tipo de dados: matriz |
Solicitação de cURL
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/normal/b0dbda5347c12200e0ef563dbb9a718f?state=assess" \
--request PATCH \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--data "{\"state\": \"assess\", \"no_such_field\": \"this will be ignored\" }" \
--user "username":"password"
{
result: [
{
sys_id: "b0dbda5347c12200e0ef563dbb9a718f",
state: {
value: "-4",
display_value: "Assess"
},
type: {
value: "normal",
display_value: "Normal"
},
..., // all valid fields in record, example below
short_description: {
value: "Remove server",
display_value: "Remove server"
}
__meta: {
ignoredFields: ["no_such_field"]
}
}
]
}Gestão de mudanças - PATCH /sn_chg_rest/change/standard/{sys_id}
Atualiza a solicitação de mudança padrão identificada pelo sys_id especificado com os parâmetros no corpo da solicitação ou no URL.
Formato da URL
URL com controle de versões: /api/sn_chg_rest/{api_version}/change/standard/{sys_id}
URL padrão: /api/sn_chg_rest/change/standard/{sys_id}
Parâmetros de solicitação compatíveis
| Nome | Descrição |
|---|---|
| api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres |
| sys_id | Sys_id da solicitação de mudança a ser modificada. Localizado na tabela [change_request]. Tipo de dados: cadeia de caracteres |
| Nome | Descrição |
|---|---|
| pares de nome-valor | Pares de nome-valor que representam os campos a serem atualizados. Os parâmetros do corpo da solicitação substituem os parâmetros de URL. No entanto, os parâmetros obrigatórios devem ser especificados no URL. Tipo de dados: cadeia de caracteres |
| Nome | Descrição |
|---|---|
| dados | Pares de nome-valor que representam os campos a serem atualizados na solicitação de mudança associada. Por exemplo, para atualizar o arquivo de descrição resumida, insira um par de nome-valor semelhante ao seguinte: --data "{"short_description": "my short desc" }" \. Tipo de dados: cadeia de caracteres |
Cabeçalhos
Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.
| Cabeçalho | Descrição |
|---|---|
| Aceitar | Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json |
| Tipo de conteúdo | Formato de dados do corpo da solicitação. Tipos compatíveis: application/json ou application/xml. Padrão: application/json |
| Cabeçalho | Descrição |
|---|---|
| Nenhum(a) |
Códigos de status
Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.
| Código de status | Descrição |
|---|---|
| 200 | Solicitação concluída com sucesso. |
| 400 | Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada. |
| 401 | Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas. |
| 404 | Não encontrado. Não foi possível encontrar o registro especificado. |
| 500 | Erro Interno do Servidor. Ocorreu um erro de lógica no código do lado do servidor. |
Parâmetros do corpo da resposta (JSON ou XML)
| Nome | Descrição |
|---|---|
| pares de nome-valor | Todos os campos (chave) com seus valores associados para a solicitação de mudança identificada. Tipo de dados: objeto |
| estado | Estado da solicitação de mudança. Tipo de dados: objeto |
| estado.display_value | Estado a ser exibido em uma IU. Tipo de dados: cadeia de caracteres |
| estado.valor | Valor do estado interno. Tipo de dados: cadeia de caracteres |
| sys_id | Informações de Sys_id para a solicitação de mudança. Tipo de dados: objeto |
| sys_id.display_value | Sys_id da solicitação de mudança a ser exibida em uma IU. Tipo de dados: cadeia de caracteres |
| sys_id.value | Sys_id da solicitação de mudança. Tipo de dados: cadeia de caracteres |
Solicitação de cURL
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/standard/1c87925347c12200e0ef563dbb9a7177?description=Reboot my email server" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{\"short_description\": \"my short desc\" }" \
--user "username":"password"
{
result: [
{
sys_id: {
value: "1c87925347c12200e0ef563dbb9a7177",
display_value: "1c87925347c12200e0ef563dbb9a7177"
},
state: {
value: "-5",
display_value: "New"
},
..., // all valid fields in record, example below
short_description: {
value: "Reboot my email server",
display_value: "Reboot my email server"
},
}
]
}Gestão de mudanças - PATCH /sn_chg_rest/change/standard/{sys_id}/risk
Calcula o risco e o impacto da mudança padrão especificada com base em uma avaliação das condições de risco.
Se o plug-in Avaliação de risco de mudança estiver instalado, ele também calculará o risco cumulativo mais alto quando a avaliação de risco for concluída.
Formato da URL
URL com controle de versões: /api/sn_chg_rest/{api_version}/change/{sys_id}/risk
URL padrão: /api/sn_chg_rest/change/{sys_id}/risk
Parâmetros de solicitação compatíveis
| Nome | Descrição |
|---|---|
| api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres |
| sys_id | Sys_id da mudança padrão a ser avaliada. Localizado na tabela Solicitação de mudança [change_request]. Tipo de dados: cadeia de caracteres |
| Nome | Descrição |
|---|---|
| Nenhum(a) |
| Nome | Descrição |
|---|---|
| Nenhum(a) |
Cabeçalhos
Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.
| Cabeçalho | Descrição |
|---|---|
| Aceitar | Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json |
| Cabeçalho | Descrição |
|---|---|
| Nenhum(a) |
Códigos de status
Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.
| Código de status | Descrição |
|---|---|
| 200 | Avaliação de risco concluída com sucesso. |
| 400 | Falha na avaliação de risco. Detalhes do tipo de falha estão incluídos nos dados de erro. |
| 401 | Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas. |
| 404 | Não encontrado. O item solicitado não foi encontrado. |
| 500 | Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro. |
Parâmetros do corpo da resposta (JSON ou XML)
| Nome | Descrição |
|---|---|
| impacto | Impacto associado à mudança padrão especificada. Tipo de dados: objeto |
| impacto.display_value | Informações de impacto a serem exibidas em uma IU. Tipo de dados: cadeia de caracteres |
| impacto.valor | Valor do impacto interno. Tipo de dados: cadeia de caracteres |
| pares de nome-valor | Todos os campos válidos no registro de mudança padrão. Tipo de dados: objeto |
| risco | Risco calculado para a mudança padrão especificada. Tipo de dados: objeto |
| risco.display_value | Informações de risco a serem exibidas em uma IU. Tipo de dados: cadeia de caracteres |
| risco.valor | Valor de risco interno. Tipo de dados: cadeia de caracteres |
| sys_id | Informações de Sys_id para a solicitação de mudança padrão. Tipo de dados: objeto |
| sys_id.display_value | Sys_id da solicitação de mudança a ser exibida em uma IU. Tipo de dados: cadeia de caracteres |
| sys_id.value | Sys_id da solicitação de mudança. Tipo de dados: cadeia de caracteres |
Solicitação de cURL
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/1c87925347c12200e0ef563dbb9a7177/risk" \
--request PATCH \
--header "Accept:application/json" \
--user "username":"password"{
sys_id: {
value: "1c87925347c12200e0ef563dbb9a7177",
display_value: "1c87925347c12200e0ef563dbb9a7177"
},
risk: {
value: "4",
display_value: "Low"
},
impact: {
value: "3",
display_value: "3 - Low"
}
..., // all valid fields in record
}Gestão de mudanças - POST /sn_chg_rest/change
Cria um registro de solicitação de mudança com base na solicitação de mudança. Não há suporte para a criação de várias solicitações de mudança em uma única chamada.
Você pode obter a lista de modelos de mudança disponíveis usando os endpoints Gestão de mudanças - GET /sn_chg_rest/change/model ou Gestão de mudanças - GET /sn_chg_rest/change/model/{sys_id}.
Ao criar uma solicitação de mudança, defina o modelo de mudança (chg_model) ou type. Se chg_modele type estiverem definidos, o tipo será simplesmente uma categorização da mudança. Não fornecer pelo menos um desses valores resulta em uma configuração padrão que está sujeita a mudança pela versão. É altamente recomendável definir pelo menos um desses valores.
Os valores podem ser definidos como um parâmetro de consulta ou um parâmetro de corpo de solicitação.
Formato da URL
URL com controle de versão: /api/sn_chg_rest/{api_version}/change
URL padrão: /api/sn_chg_rest/change
Parâmetros de solicitação compatíveis
| Nome | Descrição |
|---|---|
| api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres |
| Nome | Descrição |
|---|---|
| pares de nome-valor | Pares de nome-valor que representam os campos a serem atualizados. Os parâmetros do corpo da solicitação substituem os parâmetros de URL. No entanto, os parâmetros obrigatórios devem ser especificados no URL. Os mesmos valores podem ser definidos como parâmetros do corpo da solicitação. Nota: Ao criar uma solicitação de mudança, defina o modelo de mudança (chg_model) ou type. Se chg_modele type estiverem definidos, o tipo será simplesmente uma categorização da mudança. Não fornecer pelo menos um desses valores resulta em uma configuração padrão que está sujeita a mudança pela versão. É altamente recomendável definir pelo menos um desses valores. Tipo de dados: cadeia de caracteres |
| modelo_chg | Nome de um modelo de mudança listado na tabela Modelo de mudança [chg_model]. Fornecido no seguinte formato: Para obter mais informações, consulte Modelos de mudança. Nota: Não fornecer o modelo de mudança (chg_model) ou o valor type resulta em uma configuração padrão que está sujeita a mudança pela versão. É altamente recomendável definir pelo menos um desses valores. Tipo de dados: cadeia de caracteres |
| campos_criptografia | Lista de campos separados por vírgula para criptografar. Esses campos são criptografados antes de serem armazenados no registro associado. Quando especificado, o endpoint chama o método GlideRecord setDisplayValue(), em vez de chamar o método setValue(). Por isso, você também pode usar este parâmetro para passar valores de exibição para campos não criptografados, como campos de referência ou de opção, em vez de passar sys_ids ou valores. Tipo de dados: cadeia de caracteres |
| tipo | Nome do tipo de solicitação de mudança listado na tabela Opções [sys_choice]. Se o chg_model também estiver preenchido, este campo será usado somente como uma categorização de mudança. Fornecido no seguinte formato: Para obter mais informações, consulte Adicionar um novo tipo de solicitação de mudança. Nota: Não fornecer o modelo de mudança (chg_model) ou o valor type resulta em uma configuração padrão que está sujeita a mudança pela versão. É altamente recomendável definir pelo menos um desses valores. Tipo de dados: cadeia de caracteres |
| Nome | Descrição |
|---|---|
| Objeto | Pares de nome-valor que representam os campos a serem atualizados na solicitação de mudança associada. Por exemplo, para atualizar o arquivo de descrição resumida, insira um par de nome-valor semelhante ao seguinte: --data "{"short_description": "my short desc" }" \. As mesmas propriedades podem ser definidas como parâmetros de consulta.Tipo de dados: cadeia de caracteres |
| Objeto.chg_model | Nome de um modelo de mudança listado na tabela Modelo de mudança [chg_model]. Fornecido como um par de nome-valor no seguinte formato: Para obter mais informações, consulte Modelos de mudança. Nota: Não fornecer o modelo de mudança (chg_model) ou o valor type resulta em uma configuração padrão que está sujeita a mudança pela versão. É altamente recomendável definir pelo menos um desses valores. Tipo de dados: cadeia de caracteres |
| Objeto.campos_criptografados | Lista de campos separados por vírgula para criptografar. Esses campos são criptografados antes de serem armazenados no registro associado. Quando especificado, o endpoint chama o método GlideRecord setDisplayValue(), em vez de chamar o método setValue(). Por isso, você também pode usar este parâmetro para passar valores de exibição para campos não criptografados, como campos de referência ou de opção, em vez de passar sys_ids ou valores. Tipo de dados: cadeia de caracteres |
| Objeto.tipo | Nome do tipo de solicitação de mudança listado na tabela Opções [sys_choice]. Se o chg_model também estiver preenchido, este campo será usado somente como uma categorização de mudança. Fornecido como um par de nome-valor no seguinte formato: Para obter mais informações, consulte Adicionar um novo tipo de solicitação de mudança. Nota: Não fornecer o modelo de mudança (chg_model) ou o valor type resulta em uma configuração padrão que está sujeita a mudança pela versão. É altamente recomendável definir pelo menos um desses valores. Tipo de dados: cadeia de caracteres |
Cabeçalhos
Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.
| Cabeçalho | Descrição |
|---|---|
| Aceitar | Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json |
| Tipo de conteúdo | Formato de dados do corpo da solicitação. Tipos compatíveis: application/json ou application/xml. Padrão: application/json |
| Cabeçalho | Descrição |
|---|---|
| Nenhum(a) |
Códigos de status
Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.
| Código de status | Descrição |
|---|---|
| 200 | Solicitação concluída com sucesso. |
| 400 | Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada. |
| 401 | Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas. |
| 404 | Não encontrado. Não foi possível encontrar o registro especificado. |
| 500 | Erro Interno do Servidor. Ocorreu um erro de lógica no código do lado do servidor. |
Parâmetros do corpo da resposta (JSON ou XML)
| Nome | Descrição |
|---|---|
| resultado | Novo registro de solicitação de mudança. Os elementos deste objeto correspondem ao formato de registro na tabela Solicitação de mudança [change_request]. Todos os valores não especificados na solicitação são definidos como padrões ou estão vazios/nulos. Tipo de dados: objeto |
Solicitação de cURL
O exemplo a seguir mostra como criar um registro de solicitação de mudança com base no modelo de mudança padrão e no tipo padrão. Neste exemplo, a Solicitação de Mudança é orientada pelo modelo e o campo de tipo é usado somente como uma categorização.
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
\"chg_model\" : \"Standard\",
\"description\" : \"Describes the change request.\",
\"short_description\" : \"My change request\",
\"type\" : \"Standard\"
}" \
--user "username":"password"Os resultados mostram que o registro foi adicionado com sucesso à tabela Solicitação de mudança [change_request] com o valor CHG0030022.
{
"result":
"upon_reject": {
"display_value": "Cancel all future Tasks",
"value": "cancel"
},
"sys_updated_on": {
"display_value": "2022-12-08 17:18:57",
"value": "2022-12-09 01:18:57",
"display_value_internal": "2022-12-08 17:18:57"
},
"type": {
"display_value": "Standard",
"value": "standard"
}
"number": {
"display_value": "CHG0030022",
"value": "CHG0030022"
},
"is_bulk": {
"display_value": "false",
"value": false
}
"ci_class": {
"display_value": "cmdb_ci",
"value": "cmdb_ci"
},
"state": {
"display_value": "New",
"value": -5
},
"sys_created_by": {
"display_value": "admin",
"value": "admin"
},
"knowledge": {
"display_value": "false",
"value": false
},
"phase": {
"display_value": "Requested",
"value": "requested"
}
"impact": {
"display_value": "3 - Low",
"value": 3
},
"active": {
"display_value": "true",
"value": true
},
"priority": {
"display_value": "4 - Low",
"value": 4
},
"sys_domain_path": {
"display_value": "/",
"value": "/"
},
"production_system": {
"display_value": "false",
"value": false
},
"requested_by": {
"display_value": "System Administrator",
"value": "6816f79cc0a8016401c5a33be04be441"
}
"short_description": {
"display_value": "My change request",
"value": "My change request"
},
"sys_class_name": {
"display_value": "Change Request",
"value": "change_request"
},
"reassignment_count": {
"display_value": "0",
"value": 0
},
"variables": {
"display_value": "variable_pool",
"value": "variable_pool"
},
"sla_due": {
"display_value": "UNKNOWN",
"value": "",
"display_value_internal": ""
},
"escalation": {
"display_value": "Normal",
"value": 0
},
"upon_approval": {
"display_value": "Proceed to Next Task",
"value": "proceed"
},
"conflict_status": {
"display_value": "Not Run",
"value": "Not Run"
},
"task_effective_number": {
"display_value": "CHG0030022",
"value": "CHG0030022"
},
"sys_updated_by": {
"display_value": "admin",
"value": "admin"
},
"opened_by": {
"display_value": "System Administrator",
"value": "6816f79cc0a8016401c5a33be04be441"
},
"sys_created_on": {
"display_value": "2022-12-08 17:18:57",
"value": "2022-12-09 01:18:57",
"display_value_internal": "2022-12-08 17:18:57"
},
"sys_domain": {
"display_value": "global",
"value": "global"
},
"chg_model": {
"display_value": "Standard",
"value": "e55d0bfec343101035ae3f52c1d3ae49"
},
"opened_at": {
"display_value": "2022-12-08 17:18:57",
"value": "2022-12-09 01:18:57",
"display_value_internal": "2022-12-08 17:18:57"
},
"description": {
"display_value": "Describes the change request.",
"value": "Describes the change request."
},
"sys_id": {
"display_value": "2ac52dd77c6b1510f877be3b096e64fe",
"value": "2ac52dd77c6b1510f877be3b096e64fe"
},
"cab_required": {
"display_value": "false",
"value": false
},
"urgency": {
"display_value": "3 - Low",
"value": 3
},
"scope": {
"display_value": "Medium",
"value": 3
},
"activity_due": {
"display_value": "UNKNOWN",
"value": "",
"display_value_internal": ""
},
"approval": {
"display_value": "Not Yet Requested",
"value": "not requested"
},
}
}Solicitação de cURL
O exemplo a seguir mostra como passar campos criptografados no corpo da solicitação.
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
\"encrypted_fields\":\"short_description,description\",
\"short_description\":\"my short desc\",
\"description\":\"my desc\"
}" \
--user "username":"password"Solicitação de cURL
O exemplo a seguir mostra como passar campos criptografados como parâmetros de consulta.
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change?encrypted_fields=short_description%2Cdescription&short_description=my%20short%20desc&description=my%20desc" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{}" \
--user "username":"password"Gestão de mudanças - POST /sn_chg_rest/change/{sys_id}/ci
Cria a associação entre uma solicitação de mudança e Configuration Management Database (CMDB) itens de configuração (IC).
A criação da associação é feita de forma assíncrona, o que significa que uma resposta é fornecida imediatamente e contém detalhes para o trabalhador. O trabalhador faz o trabalho real após a resposta.
Formato da URL
URL com controle de versões: /api/sn_chg_rest/{api_version}/change/{sys_id}/ci
URL padrão: /api/sn_chg_rest/change/{sys_id}/ci
Parâmetros de solicitação compatíveis
| Nome | Descrição |
|---|---|
| api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres |
| sys_id | Sys_id da solicitação de mudança a ser associada ao IC do CMDB. Tipo de dados: cadeia de caracteres |
| Nome | Descrição |
|---|---|
| Nenhum(a) |
| Nome | Descrição |
|---|---|
| tipo_associação | Obrigatório. Tipo de associação entre o IC do CMDB e a solicitação de mudança. Valores válidos:
Tipo de dados: cadeia de caracteres |
| cmdb_ci_sys_ids | Obrigatório. Lista de sys_ids de IC do CMDB a serem associados à solicitação de mudança. Tipo de dados: matriz ou cadeia de caracteres separada por vírgulas |
| atualizar_impacted_services | Sinalizador usado quandoassociation_type=affected para preencher serviços afetados com base na lista de ICs afetados.Valores válidos:
Tipo de dados: booliano Padrão: falso |
Cabeçalhos
Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.
| Cabeçalho | Descrição |
|---|---|
| Aceitar | Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json |
| Tipo de conteúdo | Formato de dados do corpo da solicitação. Tipos compatíveis: application/json ou application/xml. Padrão: application/json |
| Cabeçalho | Descrição |
|---|---|
| Nenhum(a) |
Códigos de status
Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.
| Código de status | Descrição |
|---|---|
| 202 | Aceito. A solicitação foi aceita para processamento. |
| 400 | Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada. A resposta de erro contém mensagens pertinentes para ajudar a solucionar o problema. |
| 401 | Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas. |
| 404 | Não encontrado. O item solicitado não foi encontrado. |
| 500 | Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro. |
Parâmetros do corpo da resposta (JSON ou XML)
| Nome | Descrição |
|---|---|
| mensagens | Informações da mensagem. Tipo de dados: objeto |
| mensagens.MensagensDeErro | Mensagens de erro encontradas ao processar a solicitação. Por exemplo: sys_id de CMDB_CI fornecido inválido Tipo de dados: matriz |
| mensagens.infoMensagens | Mensagens informativas encontradas durante o processamento da solicitação. Por exemplo: O sys_id do CMDB_CI já está associado ao fornecido. Tipo de dados: matriz |
| mensagens.avisosMensagens | Mensagens de aviso encontradas durante o processamento da solicitação. Por exemplo: sys_id do CMDB_CI fornecido inválido. Tipo de dados: matriz |
| solicitação | Solicitação de endpoint original. Tipo de dados: cadeia de caracteres |
| estado | Informações sobre o estado atual do trabalhador. |
| estado.display_value | Valor de exibição do estado do trabalhador. Esses valores estão diretamente correlacionados ao elemento state.value. Valores possíveis:
Tipo de dados: cadeia de caracteres |
| estado.valor | Valor numérico do estado do trabalhador. Valores possíveis:
Tipo de dados: número |
| tipo | Tipo de associação entre o IC do CMDB e a solicitação de mudança. Tipo de dados: cadeia de caracteres |
| trabalhador | Informações sobre o trabalhador associado. Tipo de dados: objeto |
| trabalhador.link | URL para recuperar o status do trabalhador associado e outras informações pertinentes ao trabalhador. Tipo de dados: cadeia de caracteres |
| trabalhador.sysId | Sys_id do trabalhador associado à solicitação de mudança. Tipo de dados: cadeia de caracteres |
Solicitação de cURL
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/c286d61347c12200e0ef563dbb9a71df/ci" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{cmdb_ci_sys_ids:'caf043a3b7fb23000999e4f6ee11a9c0,06f043a3b7fb23000999e4f6ee11a9c1', association_type:'affected'}" \
--user "username":"password"
{
"result": {
"worker": {
"sysId": "f490f4c6dbac330084f07ffdbf961952",
"link": "instance.service-now.com/api/sn_chg_rest/change/worker/f490f4c6dbac330084f07ffdbf961952"
},
"request": "{\"cmdb_ci_sys_ids\":[\"caf043a3b7fb23000999e4f6ee11a9c0\",\"06f043a3b7fb23000999e4f6ee11a9c1\"],\"association_type\":\"affected\",\"task\":\"c286d61347c12200e0ef563dbb9a71df\"}",
"state": {
"value": 1,
"display_value": "Waiting"
},
"type": "affected",
"messages": {
"errorMessages": [],
"warningMessages": [],
"infoMessages": []
}
}
}Gestão de mudanças - POST /sn_chg_rest/change/{sys_id}/conflict
Inicia um processo de verificação de conflitos de solicitação de mudança para a solicitação de mudança especificada (sys_id).
Formato da URL
URL com controle de versão: /api/sn_chg_rest/{api_version}/change/{sys_id}/conflict
URL padrão: /api/sn_chg_rest/change/{sys_id}/conflict
Parâmetros de solicitação compatíveis
| Nome | Descrição |
|---|---|
| api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres |
| sys_id | Sys_id da solicitação de gestão de mudanças para a qual o processo de verificação de conflitos será iniciado. Localizado na tabela Solicitação de mudança [change_request]. Para obter informações adicionais sobre o processo de verificação de conflitos, consulte Detecção de conflitos. Tipo de dados: cadeia de caracteres |
| Nome | Descrição |
|---|---|
| Nenhum(a) |
| Nome | Descrição |
|---|---|
| Nenhum(a) |
Cabeçalhos
Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.
| Cabeçalho | Descrição |
|---|---|
| Aceitar | Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json |
| Cabeçalho | Descrição |
|---|---|
| Nenhum(a) |
Códigos de status
Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.
| Código de status | Descrição |
|---|---|
| 200 | Bem-sucedido. A solicitação foi processada com sucesso. |
| 400 | Solicitação Incorreta. Não foi possível iniciar a solicitação devido a erros não resolvidos. A mensagem retornada pode fornecer detalhes adicionais. |
| 401 | Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas. |
| 404 | Não encontrado. O item solicitado não foi encontrado. |
| 500 | Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro. |
Parâmetros do corpo da resposta (JSON ou XML)
| Nome | Descrição |
|---|---|
| resultado | Sys_id do processo de verificação de conflitos de solicitação de mudança. Tipo de dados: cadeia de caracteres |
Solicitação de cURL
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/0f4ac6c4b750230096c3e4f6ee11a9fe/conflict" \
--request POST \
--header "Accept:application/json" \
--user "username":"password"
{
result: "c0b5afe4b710230096c3e4f6ee11a93f"
}Gestão de mudanças - POST /sn_chg_rest/change/emergency
Cria uma solicitação de mudança de emergência com base no registro de solicitação de mudança de emergência padrão. Não há suporte para várias criações de solicitação de mudança de emergência em uma única chamada.
Formato da URL
URL com controle de versão: /api/sn_chg_rest/{api_version}/change/emergency
URL padrão: /api/sn_chg_rest/change/emergency
Parâmetros de solicitação compatíveis
| Nome | Descrição |
|---|---|
| api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres |
| Nome | Descrição |
|---|---|
| pares de chave-valor | Pares de chave-valor de campos a serem modificados ao criar a solicitação. A chave é o nome do campo no modelo e o valor são as informações a serem preenchidas no campo. Campos que não podem ser modificados e serão ignorados se passados:
Tipo de dados: cadeia de caracteres |
| Nome | Descrição |
|---|---|
| Nenhum(a) |
Cabeçalhos
Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.
| Cabeçalho | Descrição |
|---|---|
| Aceitar | Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json |
| Cabeçalho | Descrição |
|---|---|
| Nenhum(a) |
Códigos de status
Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.
| Código de status | Descrição |
|---|---|
| 200 | Solicitação concluída com sucesso. |
| 400 | Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada. |
| 401 | Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas. |
| 500 | Erro Interno do Servidor. Ocorreu um erro de lógica no código do lado do servidor. |
Parâmetros do corpo da resposta (JSON ou XML)
| Nome | Descrição |
|---|---|
| pares de nome-valor | Pares de nome-valor dos campos que foram criados na solicitação de mudança de emergência. Tipo de dados: objeto |
| estado | Estado da solicitação de mudança antes da exclusão. Tipo de dados: objeto |
| estado.display_value | Estado a ser exibido em uma IU. O valor é sempre "Novo". Tipo de dados: cadeia de caracteres |
| estado.valor | Valor do estado interno. O valor é sempre "-5". Tipo de dados: cadeia de caracteres |
| sys_id | Sys_id da solicitação de mudança de emergência recém-criada. Tipo de dados: cadeia de caracteres |
| tipo | Tipo de solicitação de mudança Tipo de dados: objeto |
| tipo.exibição_valor | Mude o tipo para exibir em uma IU. O valor é sempre "Emergência". Tipo de dados: cadeia de caracteres |
| tipo.valor | Valor de tipo interno. O valor é sempre "emergência". Tipo de dados: cadeia de caracteres |
| __meta.ignoredFields | Pares de chave-valor que foram passados na chamada, mas não foram aplicados à solicitação de mudança porque não existem no registro base ou os campos são somente leitura. Tipo de dados: matriz |
Solicitação de cURL
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/emergency?no_such_field=something&description=test&short_description=Reboot server" \
--request POST \
--header "Accept:application/json" \
--user "username":"password"{
result: [
{
sys_id: "b0dbda5347c12200e0ef563dbb9a718f",
state: {
value: "-5",
display_value: "New"
},
type: {
value: "emergency",
display_value: "Emergency"
},
..., // all valid fields in record, example below
short_description: {
value: "Reboot server",
display_value: "Reboot server"
}
__meta: {
ignoredFields: ["no_such_field"]
}
}
]
}Gestão de mudanças - POST /sn_chg_rest/change/normal
Cria uma solicitação de mudança normal com base no registro de solicitação de mudança normal padrão. Não há suporte para várias criações de solicitação de mudança normais em uma única chamada.
Formato da URL
URL com controle de versões: /api/sn_chg_rest/{api_version}/change/normal
URL padrão: /api/sn_chg_rest/change/normal
Parâmetros de solicitação compatíveis
| Nome | Descrição |
|---|---|
| api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres |
| Nome | Descrição |
|---|---|
| pares de chave-valor | Campos a serem modificados ao criar a solicitação. A chave é o nome do campo no modelo e o valor são as informações a serem preenchidas no campo. Campos que não podem ser modificados e serão ignorados se passados:
Tipo de dados: cadeia de caracteres |
| Nome | Descrição |
|---|---|
| Nenhum(a) |
Cabeçalhos
Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.
| Cabeçalho | Descrição |
|---|---|
| Aceitar | Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json |
| Cabeçalho | Descrição |
|---|---|
| Nenhum(a) |
Códigos de status
Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.
| Código de status | Descrição |
|---|---|
| 200 | Solicitação concluída com sucesso. |
| 400 | Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada. |
| 401 | Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas. |
| 500 | Erro Interno do Servidor. Ocorreu um erro de lógica no código do lado do servidor. |
Parâmetros do corpo da resposta (JSON ou XML)
| Nome | Descrição |
|---|---|
| pares de nome-valor | Valores para todos os campos na solicitação de mudança associada. Tipo de dados: objeto |
| estado | Estado da solicitação de mudança recém-criada. Tipo de dados: objeto |
| estado.display_value | Estado a ser exibido em uma IU. O valor é sempre "Novo". Tipo de dados: cadeia de caracteres |
| estado.valor | Valor do estado interno. O valor é sempre "-5". Tipo de dados: cadeia de caracteres |
| sys_id | Sys_id da solicitação de mudança normal recém-criada. Tipo de dados: cadeia de caracteres |
| tipo | Tipo de solicitação de mudança Tipo de dados: objeto |
| tipo.exibição_valor | Mude o tipo para exibir em uma IU. O valor é sempre "Normal". Tipo de dados: cadeia de caracteres |
| tipo.valor | Valor de tipo interno. O valor é sempre "normal". Tipo de dados: cadeia de caracteres |
| __meta.ignoredFields | Pares de chave-valor que foram passados na chamada, mas não foram aplicados à solicitação de mudança porque não existem no registro base ou os campos são somente leitura. Tipo de dados: matriz |
Solicitação de cURL
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/normal?no_such_field=something&description=test&short_description=Remove server" \
--request POST \
--header "Accept:application/json" \
--user "username":"password"
{
result: [
{
sys_id: "b0dbda5347c12200e0ef563dbb9a718f",
state: {
value: "-5",
display_value: "New"
},
type: {
value: "normal",
display_value: "Normal"
},
..., // all valid fields in record, example below
short_description: {
value: "Remove server",
display_value: "Remove server"
}
__meta: {
ignoredFields: ["no_such_field"]
}
}
]
}Gestão de mudanças - POST /sn_chg_rest/change/{sys_id}/refresh_impacted_services
Preenche a lista relacionada de serviços/itens de configuração (ICs) afetados com base no IC primário.
O IC primário aparece no formulário de solicitação de mudança e na lista relacionada de ICs afetados.
Formato da URL
URL com controle de versão: /api/sn_chg_rest/{api_version}/change/{sys_id}/refresh_impacted_services
URL padrão: /api/sn_chg_rest/change/{sys_id}/refresh_impacted_services
Parâmetros de solicitação compatíveis
| Nome | Descrição |
|---|---|
| api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres |
| sys_id | Sys_id da solicitação de mudança a ser usada para atualizar os serviços afetados. Tipo de dados: cadeia de caracteres |
| Nome | Descrição |
|---|---|
| Nenhum(a) |
| Nome | Descrição |
|---|---|
| Nenhum(a) |
Cabeçalhos
Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.
| Cabeçalho | Descrição |
|---|---|
| Aceitar | Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json |
| Tipo de conteúdo | Formato de dados do corpo da solicitação. Tipos compatíveis: application/json ou application/xml. Padrão: application/json |
| Cabeçalho | Descrição |
|---|---|
| Nenhum(a) |
Códigos de status
Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.
| Código de status | Descrição |
|---|---|
| 200 | Bem-sucedido. A solicitação foi processada com sucesso. |
| 401 | Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas. |
| 404 | Não encontrado. Não foi possível encontrar o registro especificado. |
| 500 | Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro. |
Parâmetros do corpo da resposta (JSON ou XML)
| Nome | Descrição |
|---|---|
| mensagens | Informações da mensagem. Tipo de dados: objeto |
| mensagens.MensagensDeErro | Mensagens de erro encontradas ao processar a solicitação. Por exemplo: sys_id de CMDB_CI fornecido inválido Tipo de dados: matriz |
| mensagens.infoMensagens | Mensagens informativas encontradas durante o processamento da solicitação. Por exemplo: O sys_id do CMDB_CI já está associado ao fornecido. Tipo de dados: matriz |
| mensagens.avisosMensagens | Mensagens de aviso encontradas durante o processamento da solicitação. Por exemplo: sys_id do CMDB_CI fornecido inválido. Tipo de dados: matriz |
| solicitação | Solicitação de endpoint original. Tipo de dados: cadeia de caracteres |
| estado | Informações sobre o estado atual do trabalhador. Tipo de dados: objeto |
| estado.display_value | Valor de exibição do estado do trabalhador. Esses valores estão diretamente correlacionados ao elemento state.value. Valores possíveis:
Tipo de dados: cadeia de caracteres |
| estado.valor | Valor numérico do estado do trabalhador. Valores possíveis:
Tipo de dados: número |
| tipo | Tipo de associação entre o IC do CMDB e a solicitação de mudança. Tipo de dados: cadeia de caracteres |
| trabalhador | Informações sobre o trabalhador associado. Tipo de dados: objeto |
| trabalhador.link | URL para recuperar o status do trabalhador associado e outras informações pertinentes ao trabalhador. Tipo de dados: cadeia de caracteres |
| trabalhador.sysId | Sys_id do trabalhador associado à solicitação de mudança. Tipo de dados: cadeia de caracteres |
Solicitação de cURL
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/c286d61347c12200e0ef563dbb9a71df/refresh_impacted_services" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--user "username":"password"{
result: {
worker: {
sysId: "aa31c308b75033000999e4f6ee11a9c2",
link: "http://instance.service-now.com/api/sn_chg_rest/change/worker/aa31c308b75033000999e4f6ee11a9c2"
},
request: "",
state: {
value: 1,
display_value: "Waiting"
},
type: "impacted",
messages: {
errorMessages: [],
warningMessages: [],
infoMessages: []
}
}
} Gestão de mudanças - POST /sn_chg_rest/change/standard/{standard_change_template_id}
Cria uma solicitação de mudança padrão com base em um modelo de mudança padrão existente, conforme especificado pelo modelo passado sys_id. Não há suporte para várias criações de solicitação de mudança padrão em uma única chamada.
Formato da URL
URL com controle de versões: /api/sn_chg_rest/{api_version}/change/standard/{standard_change_template_id}
URL padrão: /api/sn_chg_rest/change/standard/{standard_change_template_id}
Parâmetros de solicitação compatíveis
| Parâmetro | Descrição |
|---|---|
| api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres |
| padrão_mudança_template_id | Sys_id do modelo de mudança padrão no qual se baseia a nova solicitação de mudança padrão. Localizado na tabela Modelo de Mudança padrão [std_change_record_producer]. Tipo de dados: cadeia de caracteres |
| Parâmetro | Descrição |
|---|---|
| pares de nome-valor | Campos no modelo de mudança padrão especificado a serem modificados ao criar a solicitação. A chave é o nome do campo no modelo e o valor são as informações a serem preenchidas no campo. Campos que não podem ser modificados e serão ignorados se passados:
Tipo de dados: cadeia de caracteres |
| Nome | Descrição |
|---|---|
| Nenhum(a) |
Cabeçalhos
Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.
| Cabeçalho | Descrição |
|---|---|
| Aceitar | Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json |
| Cabeçalho | Descrição |
|---|---|
| Nenhum(a) |
Códigos de status
Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.
| Código de status | Descrição |
|---|---|
| 200 | Solicitação concluída com sucesso. |
| 400 | Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada. |
| 401 | Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas. |
| 404 | Não encontrado. Não foi possível encontrar o registro especificado. |
| 500 | Erro Interno do Servidor. Ocorreu um erro de lógica no código do lado do servidor. |
Corpo da resposta
A API retorna esses elementos JSON ou XML no corpo da resposta.
| Elemento | Descrição |
|---|---|
| pares de nome-valor | Pares de nome-valor dos campos que foram criados na solicitação de mudança padrão. Tipo de dados: objeto |
| sys_id | Informações de Sys_id da solicitação de mudança padrão recém-criada. Tipo de dados: objeto |
| sys_id.display_value | Sys_id da solicitação de mudança padrão a ser exibida em uma IU. Tipo de dados: cadeia de caracteres |
| sys_id.value | Sys_id da solicitação de mudança padrão. Tipo de dados: cadeia de caracteres |
| __meta.ignoredFields | Pares de chave-valor que foram passados na chamada, mas não foram aplicados à solicitação de mudança porque não existem no registro base ou os campos são somente leitura. Tipo de dados: matriz |
Amostra de solicitação cURL
curl "https://instance.servicenow.com" \
--request POST \
--header "Accept:application/json" \
--user "username":"password"
{
result: [
{
sys_id: {
value: "1c87925347c12200e0ef563dbb9a7177",
display_value: "1c87925347c12200e0ef563dbb9a7177"
},
..., // all valid fields in record, example below
short_description: {
value: "Add network switch to cabinet",
display_value: "Add network switch to cabinet"
}
__meta: {
ignoredFields: ["no_such_field"]
}
}
]
}Gestão de mudanças - POST /sn_chg_rest/change/{change_sys_id}/task
Cria uma tarefa de solicitação de mudança com base no registro de tarefa de solicitação de mudança padrão e a associa à solicitação de mudança especificada. Não há suporte para várias criações de tarefa de solicitação de mudança em uma única chamada.
Formato da URL
URL com controle de versão: /api/sn_chg_rest/{api_version}/change/{change_sys_id}/task
URL padrão: /api/sn_chg_rest/change/{change_sys_id}/task
Parâmetros de solicitação compatíveis
| Nome | Descrição |
|---|---|
| api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres |
| change_sys_id | Sys_id da solicitação de mudança à qual esta tarefa será associada. Localizado na tabela Solicitação de mudança [change_request]. Tipo de dados: cadeia de caracteres |
| Nome | Descrição |
|---|---|
| pares de chave-valor | Campos a serem modificados ao criar a solicitação. A chave é o nome do campo no modelo e o valor são as informações a serem preenchidas no campo. Campos que não podem ser modificados e serão ignorados se passados:
Tipo de dados: cadeia de caracteres |
| Nome | Descrição |
|---|---|
| Nenhum(a) |
Cabeçalhos
Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.
| Cabeçalho | Descrição |
|---|---|
| Aceitar | Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json |
| Cabeçalho | Descrição |
|---|---|
| Nenhum(a) |
Códigos de status
Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.
| Código de status | Descrição |
|---|---|
| 200 | Solicitação concluída com sucesso. |
| 400 | Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada. |
| 401 | Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas. |
| 404 | Não encontrado. Não foi possível encontrar o registro especificado. |
| 500 | Erro Interno do Servidor. Ocorreu um erro de lógica no código do lado do servidor. |
Parâmetros do corpo da resposta (JSON ou XML)
| Nome | Descrição |
|---|---|
| pares de nome-valor | Pares de nome-valor dos campos que foram criados na tarefa de solicitação de mudança. Tipo de dados: objeto |
| primário | Informações da solicitação de mudança associada à tarefa. Tipo de dados: objeto |
| primário.display_value | Informações a serem exibidas na IU para a solicitação de mudança associada à tarefa. Tipo de dados: cadeia de caracteres |
| primário.valor | Sys_id da solicitação de mudança associada à tarefa. Tipo de dados: cadeia de caracteres |
| sys_id | Informações de Sys_id da tarefa de solicitação de mudança recém-criada. Tipo de dados: objeto |
| sys_id.display_value | Sys_id da tarefa de solicitação de mudança a ser exibida em uma IU. Tipo de dados: cadeia de caracteres |
| sys_id.value | Sys_id da tarefa de solicitação de mudança. Tipo de dados: cadeia de caracteres |
| __meta.ignoredFields | Pares de chave-valor que foram passados na chamada, mas não foram aplicados à solicitação de mudança porque não existem no registro base ou os campos são somente leitura. Tipo de dados: matriz |
Solicitação de cURL
curl "https://instance.servicenow.com/api/now/change/0f4ac6c4b750230096c3e4f6ee11a9fe/task?short_description=Retire node&no_such_field=test" \
--request POST \
--header "Accept:application/json" \
--user "username":"password"
{
result: [
{
sys_id: {
value: "12629ec4b750230096c3e4f6ee11a9d5",
display_value: "12629ec4b750230096c3e4f6ee11a9d5"
},
parent: {
value: "0f4ac6c4b750230096c3e4f6ee11a9fe ",
display_value: "CHG0033046 "
},
..., // all valid fields in record, example below
short_description: {
value: "Retire node",
display_value: "Retire node"
}
__meta.ignoredFields": ["no_such_field"]
}
]
}