API de solicitação de ajuda remota
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 EMR Help A aplicação (sn_ind_rmt_help) é instalada do ServiceNow Store. Acesse o site ServiceNow Store 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.
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}
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, além dos parâmetros da tarefa e dos 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 de solicitação remota [sn_ind_rmt_help_request_data] e em 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 são processados pelo endpoint. Para obter informações adicionais sobre este modelo de dados, consulte Modelo de dados da Ajuda do EMR.
Os registros são identificados usando o ID de definição de solicitação.
Formato de URL
URL com controle de versões: /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
| Nome | Descrição |
|---|---|
| api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Especifique este valor somente 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 |
| Nome | Descrição |
|---|---|
| Nenhum |
| 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:
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. 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:
Tipo de dados: cadeia de caracteres |
| task_parameters | Obrigatório. Pares de nome-valor que descrevem os parâmetros da tarefa da solicitação de serviço de TI. Cada elemento no objeto corresponde a uma coluna nas tabelas de tarefa correspondentes, como a tabela Incidente [incidente]. Por exemplo:
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. Tipo de dados: objeto |
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. Oferece suporte somente a application/json. |
| Tipo de conteúdo | Formato de dados do corpo da solicitação. Oferece suporte somente a application/json. |
| Cabeçalho | Descrição |
|---|---|
| Nenhum |
Códigos de status
Os códigos de status a seguir 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 da 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 inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro. |
Parâmetros do corpo da resposta (JSON)
| Nome | Descrição |
|---|---|
| resultado | Objeto de resultado.
Tipo de dados: objeto |
| result.code | Código de erro da aplicação quando o result.status é retornado como falha. Tipo de dados: cadeia de caracteres |
| resultado.erro | Mensagem de erro incluída se o result.status for falha. Esta mensagem está em inglês. Tipo de dados: cadeia de caracteres |
| result.errorTranslated | Mensagem de erro localizada opcional. Tipo de dados: cadeia de caracteres |
| resultado.status | Status da resposta. Valores válidos:
Tipo de dados: cadeia de caracteres |
| result.task_id | Sys_id da tarefa criada. Tipo de dados: cadeia de caracteres |
| resultado.tabela_tarefa | 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 o result.status for bem- sucedido. Esta mensagem está 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}
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 de 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
| Nome | Descrição |
|---|---|
| api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Especifique este valor somente 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 |
| Nome | Descrição |
|---|---|
| Nenhum |
| Nome | Descrição |
|---|---|
| request_data | Obrigatório. Pares de nome-valor dos dados de solicitação do sistema EMR para atualizar a tabela Dados de solicitação remota [sn_ind_rmt_help_request_data] ou sua tabela secundária. Por exemplo:
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. 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:
Tipo de dados: cadeia de caracteres |
| task_parameters | Obrigatório. Pares de nome-valor que descrevem os parâmetros da tarefa da solicitação de serviço de TI. Cada elemento no objeto corresponde a uma coluna nas tabelas de tarefa correspondentes, como a tabela Incidente [incidente]. Por exemplo:
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. Tipo de dados: objeto |
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. Oferece suporte somente a application/json. |
| Tipo de conteúdo | Formato de dados do corpo da solicitação. Oferece suporte somente a application/json. |
| Cabeçalho | Descrição |
|---|---|
| Nenhum |
Códigos de status
Os códigos de status a seguir 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 da 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 inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro. |
Parâmetros do corpo da resposta (JSON)
| Nome | Descrição |
|---|---|
| resultado | Objeto de resultado.
Tipo de dados: objeto |
| result.code | Código de erro da aplicação quando o result.status é retornado como falha. Tipo de dados: cadeia de caracteres |
| resultado.erro | Mensagem de erro incluída se o result.status for falha. Esta mensagem está em inglês. Tipo de dados: cadeia de caracteres |
| result.errorTranslated | Mensagem de erro localizada opcional. Tipo de dados: cadeia de caracteres |
| resultado.status | Status da resposta. Valores válidos:
Tipo de dados: cadeia de caracteres |
| resultado.aviso | Mensagem de aviso opcional. Pode ser incluído se o result.status for bem- sucedido. Esta mensagem está 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}
Busca uma lista de tarefas que correspondem ao ID e ao filtro de consulta especificados.
- Os campos de tipo de referência e opção são sempre retornados como objetos JSON com o valor e display_value.
- Os campos Data/hora são retornados como cadeias de caracteres e sempre em UTC.
Formato de URL
URL com controle de versões: /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
| Nome | Descrição |
|---|---|
| api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Especifique este valor somente 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 |
| Nome | Descrição |
|---|---|
| consulta | Obrigatório. Consulta codificada usada para filtrar o conjunto de resultados. Tipo de dados: cadeia de caracteres |
| Nome | Descrição |
|---|---|
| Nenhum |
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. Oferece suporte somente a application/json. |
| Cabeçalho | Descrição |
|---|---|
| Nenhum |
Códigos de status
Os códigos de status a seguir 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 da 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 inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro. |
Parâmetros do corpo da resposta (JSON)
| Nome | Descrição |
|---|---|
| resultado | Retornar resultados.
Tipo de dados: objeto |
| result.code | Código de erro da aplicação quando o result.status é retornado como falha. Tipo de dados: cadeia de caracteres |
| resultado.erro | Mensagem de erro incluída se o result.status for falha. Esta mensagem está em inglês. Tipo de dados: cadeia de caracteres |
| result.errorTranslated | Mensagem de erro localizada opcional. Tipo de dados: cadeia de caracteres |
| resultado.status | Status da resposta. Valores possíveis:
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 o result.status for bem- sucedido. Esta mensagem está 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}
Busca uma única tarefa conforme especificado em task_id.
- Os campos de tipo de referência e opção são sempre retornados como objetos JSON com o valor e display_value.
- Os campos Data/hora 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 os campos created_on, created_bye value. Os comentários mais recentes são enviados primeiro.
Formato de 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
| Nome | Descrição |
|---|---|
| api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Especifique este valor somente 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 |
| Nome | Descrição |
|---|---|
| Nenhum |
| Nome | Descrição |
|---|---|
| Nenhum |
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. Oferece suporte somente a application/json. |
| Cabeçalho | Descrição |
|---|---|
| Nenhum |
Códigos de status
Os códigos de status a seguir 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 da 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 inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro. |
Parâmetros do corpo da resposta (JSON)
| Nome | Descrição |
|---|---|
| resultado | Retornar resultados.
Tipo de dados: objeto |
| result.code | Código de erro da aplicação quando o result.status é retornado como falha. Tipo de dados: cadeia de caracteres |
| resultado.erro | Mensagem de erro incluída se o result.status for falha. Esta mensagem está em inglês. Tipo de dados: cadeia de caracteres |
| result.errorTranslated | Mensagem de erro localizada opcional. Tipo de dados: cadeia de caracteres |
| resultado.status | Status da resposta. Valores possíveis:
Tipo de dados: cadeia de caracteres |
| result.task_parameters | Obrigatório. Pares de nome-valor que descrevem os parâmetros da tarefa da solicitação de serviço de TI. Cada elemento no objeto corresponde a uma coluna nas tabelas de tarefa correspondentes, como a tabela Incidente [incidente]. Tipo de dados: objeto |
| resultado.aviso | Mensagem de aviso opcional. Pode ser incluído se o result.status for bem- sucedido. Esta mensagem está 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"
}
}