---
sourceDocument: Referência de API do Xanadu
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/pt-BR/xanadu/api-reference
Release :
- xanadu
ft:locale :
- pt-BR
ft:publication_title :
- Referência de API do Xanadu
ft:clusterId :
- crapiref
bundleId :
- crapiref
workflow :
- Creator
---
# API de solicitação de ajuda remota
# API de solicitação de ajuda remota {#ariaid-title1}
* Versão de lançamento: Xanadu
*
* Atualizado 1 de ago. de 2024
*
*  15 min. de leitura
A API de solicitação de ajuda remota fornece endpoints para criar, exibir e buscar listas de solicitações de serviço de TI e seus detalhes de um sistema de registro médico eletrônico (EMR). Uma solicitação de serviço de TI está associada a um tipo de tarefa, como um incidente na instância ServiceNow.
Você só pode usar esta API quando o [Ajuda para prontuários médicos eletrônicos](https://www.servicenow.com/docs/access?context=emr-help&version=xanadu&pubname=xanadu-healthcare-life-sciences&ft:locale=en-US) A aplicação (sn_ind_rmt_help) está instalada a partir do ServiceNow Store. Acesse o site [ServiceNow Store](https://store.servicenow.com/sn_appstore_store.do#!/store/home) para ver todos os aplicativos disponíveis e obter informações sobre como enviar solicitações para a loja. Para obter informações sobre notas de versão cumulativa para todos os aplicativos liberados, consulte as [ServiceNow Store notas de versão do histórico de versão](https://www.servicenow.com/docs/bundle/store-release-notes/page/release-notes/store/sn-store-release-notes.html).
Função necessária para acessar os endpoints desta API: sn_ind_rmt_help.requester.
## Solicitação de ajuda remota - POST /remote_help_request/{req_defn_id} {#ariaid-title2}
Insere dados do sistema de registro médico eletrônico (EMR) nas tabelas ServiceNow correspondentes.
Você precisa especificar um [ID de definição de solicitação](https://www.servicenow.com/docs/access?context=configure-emr-help-req-def&version=xanadu&pubname=xanadu-healthcare-life-sciences&ft:locale=en-US), além dos parâmetros para a tarefa e os dados adicionais do sistema EMR persistentes na tabela de dados de solicitação associada à tarefa. Você passa dois tipos de dados para este endpoint. O primeiro são os dados da solicitação, que o endpoint insere na tabela Dados da solicitação remota \[sn_ind_rmt_help_request_data\] e suas tabelas secundárias associadas. O segundo são os parâmetros de tarefa da solicitação de serviço de TI, que o endpoint insere na tabela Parâmetro de solicitação remota \[sn_ind_rmt_help_request_param\]. Somente dados ou campos definidos nas [definições de solicitação](https://www.servicenow.com/docs/access?context=configure-emr-help-req-def&version=xanadu&pubname=xanadu-healthcare-life-sciences&ft:locale=en-US) são processados pelo endpoint. Para obter informações adicionais sobre este modelo de dados, consulte [Modelo de dados da Ajuda do EMR](https://www.servicenow.com/docs/access?context=emr-data-model&version=xanadu&pubname=xanadu-healthcare-life-sciences&ft:locale=en-US).
Os registros são identificados usando o ID de definição da solicitação.
### Formato da URL
URL com controle de versão: /api/sn_ind_rmt_help/{api_version}/remote_help_request/{req_defn_id}
URL padrão: /api/sn_ind_rmt_help/remote_help_request/{req_defn_id}
### Parâmetros de solicitação compatíveis
{#remote_help_request-POST__entry__2}{#remote_help_request-POST__version-RESTAPI}
| 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 |
| req_defn_id | ID exclusivo da definição da solicitação. Este valor corresponde à coluna ID na tabela Definição de solicitação remota \[sn_ind_rmt_help_request_defn\]. Tipo de dados: cadeia de caracteres |
[Tabela 1. Parâmetros de caminho]
{#remote_help_request-POST__entry__8}
| Nome | Descrição |
|-|-|
| Nenhum(a) | |
[Tabela 2. Parâmetros de consulta]
{#remote_help_request-POST__entry__12}
| Nome | Descrição |
|-|-|
| request_data | Obrigatório. Pares de nome-valor dos dados de solicitação do sistema EMR a serem adicionados à tabela Dados de solicitação remota \[sn_ind_rmt_help_request_data\] e suas tabelas secundárias. Por exemplo: "request_data":{ "additional_info": "String", "application": "String", "environment": "String", "issue_type": "String", "millennium_username": "String", "position": "String", "server": "String", "session_recording_id": "String", "user_is_physician": "String", "work_station": "String" } Nota: Passe somente parâmetros configurados em uma definição de solicitação no objeto request_data. Todos os outros parâmetros são ignorados. Para saber mais, consulte [Configurar definições de solicitação para sistemas EMR](https://www.servicenow.com/docs/access?context=configure-emr-help-req-def&version=xanadu&pubname=xanadu-healthcare-life-sciences&ft:locale=en-US). Tipo de dados: objeto |
| origem | Obrigatório. Nome do sistema EMR que invoca o endpoint conforme especificado em uma definição de solicitação. Por exemplo: "source":"Cerner" Tipo de dados: cadeia de caracteres |
| task_parameters | Obrigatório. Pares de nome-valor que descrevem os parâmetros de tarefa da solicitação de serviço de TI. Cada elemento no objeto corresponde a uma coluna nas tabelas de tarefas correspondentes, como a tabela Incidente \[incidente\]. Por exemplo: "task_parameters": { "caller_id": "String", "contact_type": "String", "impact": "String", "short_description": "String" } Nota: Passe somente parâmetros configurados em uma definição de solicitação no objeto task_parameters. Todos os outros parâmetros são ignorados. Para saber mais, consulte [Configurar definições de solicitação para sistemas EMR](https://www.servicenow.com/docs/access?context=configure-emr-help-req-def&version=xanadu&pubname=xanadu-healthcare-life-sciences&ft:locale=en-US). Tipo de dados: objeto |
[Tabela 3. Parâmetros do corpo da solicitação (JSON)]
### 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](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#remote_help_request-POST__table_wvv_2yf_snb__entry__2}{#remote_help_request-POST__accept-JSON-only-entry-RESTAPI}{#remote_help_request-POST__content_type-JSON-only-entry-RESTAPI}
| Cabeçalho | Descrição |
|-|-|
| Aceitar | Formato de dados do corpo da resposta. Oferece suporte somente a application/json. |
| Tipo de conteúdo | Formato de dados do corpo da solicitação. Oferece suporte somente a application/json. |
[Tabela 4. Cabeçalhos da solicitação]
{#remote_help_request-POST__table_wvv_2yf_snb} {#remote_help_request-POST__entry__26}
| Cabeçalho | Descrição |
|-|-|
| Nenhum(a) | |
[Tabela 5. Cabeçalhos de resposta]
### 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](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#remote_help_request-POST__entry__30}{#remote_help_request-POST__entry-200-status-code}{#remote_help_request-POST__entry-401-status-code}{#remote_help_request-POST__entry-500-status-code}
| 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 inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro. |
[Tabela 6. Códigos de status]
### Parâmetros do corpo da resposta (JSON)
{#remote_help_request-POST__entry__38}
| Nome | Descrição |
|-|-|
| resultado | Objeto de resultado. "result": { "code": "String", "error": "String", "errorTranslated": "String", "status": "String", "task_id": "String", "task_table": "String", "warning": "String", "warningTranslated": "String" } Tipo de dados: objeto |
| código.resultado | Código de erro da aplicação quando result.status é retornado como falha. Tipo de dados: cadeia de caracteres |
| resultado.erro | Mensagem de erro incluída se result.status for falha. Esta mensagem está somente em inglês. Tipo de dados: cadeia de caracteres |
| resultado.erroTraduzido | Mensagem de erro localizada opcional. Tipo de dados: cadeia de caracteres |
| resultado.status | Status da resposta. Valores válidos: * êxito * falha {#remote_help_request-POST__ul_awy_1dk_snb} Tipo de dados: cadeia de caracteres |
| resultado.task_id | Sys_id da tarefa criada. Tipo de dados: cadeia de caracteres |
| resultado.tarefa_tabela | Nome da tabela de tarefas na qual a tarefa foi criada conforme definido na definição da solicitação. Tipo de dados: cadeia de caracteres |
| resultado.aviso | Mensagem de aviso opcional. Pode ser incluído se result.status for bem- sucedido. Esta mensagem está somente em inglês. Tipo de dados: cadeia de caracteres |
| resultado.avisoTraduzido | Mensagem de aviso localizada opcional. Tipo de dados: cadeia de caracteres |
[ ]
### Solicitação de cURL
Insira dados de um sistema Cerner EMR.
curl "https://instance.servicenow.com/api/sn_ind_rmt_help/v1/remote_help_request/sn_it_request"
--request POST \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--data "{
"source":"Cerner",
"task_parameters":{
"short_description":"Unable to load patient data",
"caller_id":"82d4ecb4db40e8100e28aa594b96195c",
"impact":"2",
"contact_type":"email"
},
"request_data":{
"application":"Powerchart",
"server":"CTXCHSITN453",
"environment":"CTX24",
"issue_type":"Helpdesk",
"millennium_username":"JOHN JASON",
"position":"Lab Tech",
"session_recording_id":"s5ds34dd96491b959a35010651896k",
"user_is_physician":"Yes",
"work_station":"PC354FLR3STATION7",
"additional_info":"MRN 222333"
}
}" \
--user "username":"password"
A saída a seguir mostra uma resposta bem-sucedida e uma resposta de erro.
// Successful response
{
"result": {
"task_id": "75b09061db2cac100e28aa594b9619fa",
"status": "success",
"task_table": "incident",
"warning": "Ignored invalid fields on table incident : test1",
"warningTranslated": "Ignored invalid fields on table incident : test1"
}
}
// Error response
{
"result": {
"status": "failure",
"code": "1001",
"error": "Invalid request definition: test_request1",
"errorTranslated": "Invalid request definition: test_request1"
}
}
## Solicitação de ajuda remota - PUT /remote_help_request/{req_defn_id/task/{task_id} {#ariaid-title3}
Atualiza um registro na tabela de dados de solicitação remota especificada para a tarefa.
Permite que você especifique um ID de definição de solicitação além do sys_id da tarefa para atualizar uma solicitação remota que foi criada anteriormente.
### Formato da URL
URL com controle de versões: /api/sn_ind_rmt_help/{api_version}/remote_help_request/{req_defn_id/task/{task_id}
URL padrão: /api/sn_ind_rmt_help/remote_help_request/{req_defn_id/task/{task_id}
### Parâmetros de solicitação compatíveis
{#remote_help_request-PUT__entry__2}{#remote_help_request-PUT__version-RESTAPI}
| 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 |
| req_defn_id | ID exclusivo da definição da solicitação. Este valor corresponde à coluna ID na tabela Definição de solicitação remota \[sn_ind_rmt_help_request_defn\]. Tipo de dados: cadeia de caracteres |
| task_id | Sys_id da tarefa a ser atualizada. Este campo é fornecido pelo sistema EMR. Tipo de dados: cadeia de caracteres |
[Tabela 7. Parâmetros de caminho]
{#remote_help_request-PUT__entry__10}
| Nome | Descrição |
|-|-|
| Nenhum(a) | |
[Tabela 8. Parâmetros de consulta]
{#remote_help_request-PUT__entry__14}
| Nome | Descrição |
|-|-|
| request_data | Obrigatório. Pares de nome-valor dos dados da solicitação do sistema EMR para atualizar a tabela Dados da solicitação remota \[sn_ind_rmt_help_request_data\] ou sua tabela secundária. Por exemplo: "request_data": { "additional_info" : "Please contact my office for more information." } Nota: Passe somente parâmetros configurados em uma definição de solicitação no objeto request_data. Todos os outros parâmetros são ignorados. Para saber mais, consulte [Configurar definições de solicitação para sistemas EMR](https://www.servicenow.com/docs/access?context=configure-emr-help-req-def&version=xanadu&pubname=xanadu-healthcare-life-sciences&ft:locale=en-US). Tipo de dados: objeto |
| origem | Obrigatório. Nome do sistema EMR que invoca o endpoint conforme especificado em uma definição de solicitação. Por exemplo: "source":"Cerner" Tipo de dados: cadeia de caracteres |
| task_parameters | Obrigatório. Pares de nome-valor que descrevem os parâmetros de tarefa da solicitação de serviço de TI. Cada elemento no objeto corresponde a uma coluna nas tabelas de tarefas correspondentes, como a tabela Incidente \[incidente\]. Por exemplo: "task_parameters": { "impact":"1", "contact_type":"phone" } Nota: Passe somente parâmetros configurados em uma definição de solicitação no objeto task_parameters. Todos os outros parâmetros são ignorados. Para saber mais, consulte [Configurar definições de solicitação para sistemas EMR](https://www.servicenow.com/docs/access?context=configure-emr-help-req-def&version=xanadu&pubname=xanadu-healthcare-life-sciences&ft:locale=en-US). Tipo de dados: objeto |
[Tabela 9. Parâmetros do corpo da solicitação (JSON)]
### 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](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#remote_help_request-PUT__table_wvv_2yf_snb__entry__2}{#remote_help_request-PUT__accept-JSON-only-entry-RESTAPI}{#remote_help_request-PUT__content_type-JSON-only-entry-RESTAPI}
| Cabeçalho | Descrição |
|-|-|
| Aceitar | Formato de dados do corpo da resposta. Oferece suporte somente a application/json. |
| Tipo de conteúdo | Formato de dados do corpo da solicitação. Oferece suporte somente a application/json. |
[Tabela 10. Cabeçalhos da solicitação]
{#remote_help_request-PUT__table_wvv_2yf_snb} {#remote_help_request-PUT__entry__28}
| Cabeçalho | Descrição |
|-|-|
| Nenhum(a) | |
[Tabela 11. Cabeçalhos de resposta]
### 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](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#remote_help_request-PUT__entry__32}{#remote_help_request-PUT__entry-200-status-code}{#remote_help_request-PUT__entry-401-status-code}{#remote_help_request-PUT__entry-500-status-code}
| 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 inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro. |
[Tabela 12. Códigos de status]
### Parâmetros do corpo da resposta (JSON)
{#remote_help_request-PUT__entry__40}
| Nome | Descrição |
|-|-|
| resultado | Objeto de resultado. "result": { "code": "String", "error": "String", "errorTranslated": "String", "status": "String", "warning": "String", "warningTranslated": "String" } Tipo de dados: objeto |
| código.resultado | Código de erro da aplicação quando result.status é retornado como falha. Tipo de dados: cadeia de caracteres |
| resultado.erro | Mensagem de erro incluída se result.status for falha. Esta mensagem está somente em inglês. Tipo de dados: cadeia de caracteres |
| resultado.erroTraduzido | Mensagem de erro localizada opcional. Tipo de dados: cadeia de caracteres |
| resultado.status | Status da resposta. Valores válidos: * êxito * falha {#remote_help_request-PUT__ul_awy_1dk_snb} Tipo de dados: cadeia de caracteres |
| resultado.aviso | Mensagem de aviso opcional. Pode ser incluído se result.status for bem- sucedido. Esta mensagem está somente em inglês. Tipo de dados: cadeia de caracteres |
| resultado.avisoTraduzido | Mensagem de aviso localizada opcional. Tipo de dados: cadeia de caracteres |
[ ]
### Solicitação de cURL
Atualizar uma solicitação de serviço de TI criada anteriormente em um sistema Cerner EMR
curl "https://instance.servicenow.com/api/sn_ind_rmt_help/v1/remote_help_request/sn_it_request/task/207e57c1db60a410f50fdc5b4b96192e"
--request PUT \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--data "{
"source":"Cerner",
"task_parameters":{
"impact":"1",
"contact_type":"phone"
},
"request_data":{
"additional_info" : "Please contact my office for more information."
}
}" \
--user "username":"password"
A saída a seguir mostra uma resposta bem-sucedida e uma resposta de erro.
// Successful response
{
"result": {
"status": "success"
}
}
// Error response
{
{
"result": {
"status": "failure",
"code": "1018",
"error": "Record with sys_id 207e57js1db60a410f50fdc5b4b96192e does not exist in table incident",
"errorTranslated": "Record with sys_id 207e57js1db60a410f50fdc5b4b96192e incident does not exist in table incident"
}
}
}
## Solicitação de ajuda remota - GET /remote_help_request/{req_defn_id} {#ariaid-title4}
Busca uma lista de tarefas que correspondem ao ID e ao filtro de consulta especificados.
Nota:
* Os campos de referência e tipo de opção são sempre retornados como objetos JSON com o valor e display_value.
* Os campos DateTime são retornados como cadeias de caracteres e sempre em UTC.
{#remote_help_request-GET__ul_nwf_z1f_tnb}
### Formato da URL
URL com controle de versão: /api/sn_ind_rmt_help/{api_version}/remote_help_request/{req_defn_id}
URL padrão: /api/sn_ind_rmt_help/remote_help_request/{req_defn_id}
### Parâmetros de solicitação compatíveis
{#remote_help_request-GET__entry__2}{#remote_help_request-GET__version-RESTAPI}
| 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 |
| req_defn_id | ID exclusivo da definição de solicitação a ser atualizada. Este valor corresponde à coluna ID na tabela Definição de solicitação remota \[sn_ind_rmt_help_request_defn\]. Tipo de dados: cadeia de caracteres |
[Tabela 13. Parâmetros de caminho]
{#remote_help_request-GET__entry__8}
| Nome | Descrição |
|-|-|
| consulta | Obrigatório. [Consulta codificada](https://www.servicenow.com/docs/access?context=c_EncodedQueryStrings&version=xanadu&pubname=xanadu-platform-user-interface&ft:locale=en-US) usada para filtrar o conjunto de resultados. Tipo de dados: cadeia de caracteres |
[Tabela 14. Parâmetros de consulta]
{#remote_help_request-GET__entry__12}
| Nome | Descrição |
|-|-|
| Nenhum(a) | |
[Tabela 15. Parâmetros do corpo da solicitação]
### 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](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#remote_help_request-GET__table_wvv_2yf_snb__entry__2}{#remote_help_request-GET__accept-JSON-only-entry-RESTAPI}
| Cabeçalho | Descrição |
|-|-|
| Aceitar | Formato de dados do corpo da resposta. Oferece suporte somente a application/json. |
[Tabela 16. Cabeçalhos da solicitação]
{#remote_help_request-GET__table_wvv_2yf_snb} {#remote_help_request-GET__entry__20}
| Cabeçalho | Descrição |
|-|-|
| Nenhum(a) | |
[Tabela 17. Cabeçalhos de resposta]
### 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](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#remote_help_request-GET__entry__24}{#remote_help_request-GET__entry-200-status-code}{#remote_help_request-GET__entry-401-status-code}{#remote_help_request-GET__entry-500-status-code}
| 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 inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro. |
[Tabela 18. Códigos de status]
### Parâmetros do corpo da resposta (JSON)
{#remote_help_request-GET__entry__32}
| Nome | Descrição |
|-|-|
| resultado | Retornar resultados. "result": { "code": "String", "error": "String", "errorTranslated": "String", "status": "String", "task_list": [Array], "warning": "String", "warningTranslated": "String" } Tipo de dados: objeto |
| código.resultado | Código de erro da aplicação quando result.status é retornado como falha. Tipo de dados: cadeia de caracteres |
| resultado.erro | Mensagem de erro incluída se result.status for falha. Esta mensagem está somente em inglês. Tipo de dados: cadeia de caracteres |
| resultado.erroTraduzido | Mensagem de erro localizada opcional. Tipo de dados: cadeia de caracteres |
| resultado.status | Status da resposta. Valores possíveis: * falha * êxito Tipo de dados: cadeia de caracteres |
| resultado.tarefa_lista | Lista de tarefas. Tipo de dados: matriz |
| resultado.aviso | Mensagem de aviso opcional. Pode ser incluído se result.status for bem- sucedido. Esta mensagem está somente em inglês. Tipo de dados: cadeia de caracteres |
| resultado.avisoTraduzido | Mensagem de aviso localizada opcional. Tipo de dados: cadeia de caracteres |
[ ]
### Solicitação de cURL
Buscar dados de um sistema Cerner EMR
curl "https://instance.servicenow.com/api/remote_help_request/v1/sn_it_request/?query=active=true" \
--header "Accept: application/json" \
--header "Content-Type: application/json"
{
"source":"Cerner",
} \
--user "username":"password"
A saída a seguir mostra uma resposta bem-sucedida e uma resposta de erro.
// Successful response
{
"result": {
"status": "success",
"task_list": [
{
"number": "INC0010096",
"short_description": "Unable to load data - 1",
"assigned_to": {
"value": "7a381da2dbfb5410f50fdc5b4b9619f2",
"display_value": "Abel Tuter (IT agent)"
},
"opened_at": "2020-11-16 18:37:57",
"closed_at": "",
"closed_by": {},
"state": {
"value": "2",
"display_value": "In Progress"
},
"priority": {
"value": "5",
"display_value": "5 - Planning"
},
"resolved_at": "",
"resolved_by": {},
"task_id": "207e57c1db60a410f50fdc5b4b96192e"
},
{
"number": "INC0010095",
"short_description": "Application freezes intermittently 3",
"assigned_to": {},
"opened_at": "2020-11-16 18:32:05",
"closed_at": "",
"closed_by": {},
"state": {
"value": "1",
"display_value": "New"
},
"priority": {
"value": "5",
"display_value": "5 - Planning"
},
"resolved_at": "",
"resolved_by": {},
"task_id": "561d1f8ddb20a410f50fdc5b4b9619da"
}
]
}
}
// Error response
{
"result": {
"status": "failure",
"code": "1019",
"error": "Invalid query in the request for table incident",
"errorTranslated": "Invalid query in the request for table incident"
}
## Solicitação de ajuda remota - GET /remote_help_request/{req_defn_id}/task/{task_id} {#ariaid-title5}
Busca uma única tarefa conforme especificado em task_id.
Permite que você especifique um ID de definição de solicitação e um ID de tarefa e recupere os detalhes da tarefa.
Nota:
* Os campos de referência e tipo de opção são sempre retornados como objetos JSON com o valor e display_value.
* Os campos DateTime são retornados como cadeias de caracteres e sempre em UTC.
* Somente comentários adicionais são compatíveis com campos de tipo de registro.
* Comentários adicionais são passados de volta como uma matriz JSON de objetos. Cada objeto representa um comentário com campos created_on, created_bye value. Os comentários mais recentes são enviados primeiro.
{#remote_help_request-GET-task__ul_nwf_z1f_tnb}
### Formato da URL
URL com controle de versões: /api/sn_ind_rmt_help/{api_version}/remote_help_request/{req_defn_id}/task/{task_id}
URL padrão: /api/sn_ind_rmt_help/remote_help_request/{req_defn_id}/task/{task_id}
### Parâmetros de solicitação compatíveis
{#remote_help_request-GET-task__entry__2}{#remote_help_request-GET-task__version-RESTAPI}
| 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 |
| req_defn_id | ID exclusivo da definição da solicitação. Este valor corresponde à coluna ID na tabela Definição de solicitação remota \[sn_ind_rmt_help_request_defn\]. Tipo de dados: cadeia de caracteres |
| task_id | Sys_id da tarefa a retornar. Este campo é fornecido pelo sistema EMR. Tipo de dados: cadeia de caracteres |
[Tabela 19. Parâmetros de caminho]
{#remote_help_request-GET-task__table_kpn_51f_tnb__entry__2}
| Nome | Descrição |
|-|-|
| Nenhum(a) | |
[Tabela 20. Parâmetros de consulta]
{#remote_help_request-GET-task__table_kpn_51f_tnb} {#remote_help_request-GET-task__entry__14}
| Nome | Descrição |
|-|-|
| Nenhum(a) | |
[Tabela 21. Parâmetros do corpo da solicitação]
### 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](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#remote_help_request-GET-task__table_wvv_2yf_snb__entry__2}{#remote_help_request-GET-task__accept-JSON-only-entry-RESTAPI}
| Cabeçalho | Descrição |
|-|-|
| Aceitar | Formato de dados do corpo da resposta. Oferece suporte somente a application/json. |
[Tabela 22. Cabeçalhos da solicitação]
{#remote_help_request-GET-task__table_wvv_2yf_snb} {#remote_help_request-GET-task__entry__22}
| Cabeçalho | Descrição |
|-|-|
| Nenhum(a) | |
[Tabela 23. Cabeçalhos de resposta]
### 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](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#remote_help_request-GET-task__entry__26}{#remote_help_request-GET-task__entry-200-status-code}{#remote_help_request-GET-task__entry-401-status-code}{#remote_help_request-GET-task__entry-500-status-code}
| 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 inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro. |
[Tabela 24. Códigos de status]
### Parâmetros do corpo da resposta (JSON)
{#remote_help_request-GET-task__entry__34}
| Nome | Descrição |
|-|-|
| resultado | Retornar resultados. "result": { "code": "String", "error": "String", "errorTranslated": "String", "status": "String", "task_parameters": {Object}, "warning": "String", "warningTranslated": "String" } Tipo de dados: objeto |
| código.resultado | Código de erro da aplicação quando result.status é retornado como falha. Tipo de dados: cadeia de caracteres |
| resultado.erro | Mensagem de erro incluída se result.status for falha. Esta mensagem está somente em inglês. Tipo de dados: cadeia de caracteres |
| resultado.erroTraduzido | Mensagem de erro localizada opcional. Tipo de dados: cadeia de caracteres |
| resultado.status | Status da resposta. Valores possíveis: * falha * êxito Tipo de dados: cadeia de caracteres |
| resultado.task_parameters | Obrigatório. Pares de nome-valor que descrevem os parâmetros de tarefa da solicitação de serviço de TI. Cada elemento no objeto corresponde a uma coluna nas tabelas de tarefas correspondentes, como a tabela Incidente \[incidente\]. Tipo de dados: objeto |
| resultado.aviso | Mensagem de aviso opcional. Pode ser incluído se result.status for bem- sucedido. Esta mensagem está somente em inglês. Tipo de dados: cadeia de caracteres |
| resultado.avisoTraduzido | Mensagem de aviso localizada opcional. Tipo de dados: cadeia de caracteres |
[ ]
### Solicitação de cURL
Buscar dados de um sistema Cerner EMR
curl "https://instance.servicenow.com/api/sn_ind_rmt_help/v1/remote_help_request/sn_it_request/task/207e57c1db60a410f50fdc5b4b96192e"\
--request GET \
--header "Accept: application/json"\
--user "username":"password"
A saída a seguir mostra uma resposta bem-sucedida e uma resposta de erro.
// Successful response
{
"result": {
"status": "success",
"task_parameters": {
"number": "INC0010096",
"short_description": "Unable to load data - 1",
"state": {
"value": "2",
"display_value": "In Progress"
},
"assigned_to": {
"value": "7a381da2dbfb5410f50fdc5b4b9619f2",
"display_value": "Abel Tuter (IT agent)"
},
"priority": {
"value": "5",
"display_value": "5 - Planning"
},
"caller_id": {
"value": "82d4ecb4db40e8100e28aa594b96195c",
"display_value": "Abel Tuter Requester"
},
"opened_at": "2020-11-16 18:37:57",
"closed_at": "",
"closed_by": {},
"description": "",
"impact": {
"value": "1",
"display_value": "1 - High"
},
"opened_by": {
"value": "82d4ecb4db40e8100e28aa594b96195c",
"display_value": "Abel Tuter Requester"
},
"close_code": {},
"close_notes": "",
"urgency": {
"value": "3",
"display_value": "3 - Low"
},
"category": {
"value": "inquiry",
"display_value": "Inquiry / Help"
},
"resolved_at": "",
"resolved_by": {},
"comments": [
{
"created_on": "2020-11-17 18:20:04",
"created_by": "Abel Tuter Requester",
"value": "You can reach me during office hours."
},
{
"created_on": "2020-11-16 18:40:14",
"created_by": "Abel Tuter Requester",
"value": "You can reach me during office hours."
},
{
"created_on": "2020-11-16 18:38:29",
"created_by": "Abel Tuter",
"value": "Hello there\rName of app please"
}],
"task_id": "207e57c1db60a410f50fdc5b4b96192e"
}
}
}
// Error response
{
"result": {
"status": "failure",
"code": "1001",
"error": "Invalid request definition: test_request2",
"errorTranslated": "Invalid request definition: test_request2"
}
}