ServiceDesk Plus V3

Versão da integração: 4.0

Configure o ServiceDesk Plus V3 para funcionar com o Google Security Operations

Como gerar um token de API

  1. Aceda à consola do administrador.

    ServiceDesk Plus V3
console

  2. Clique no mesmo e, de seguida, em Gerar chave da API.

    Gere a chave da API na consola do ServiceDesk Plus V3

  3. É apresentada uma caixa de diálogo com o estado de geração da chave.

    • Se já gerou a chave, certifique-se de que a guarda num local seguro. Caso contrário, tem de a regenerar.
    • Caso contrário, clique em Gerar chave e a chave da API é apresentada imediatamente.

    Volte a gerar a chave de API na consola do ServiceDesk Plus V3

Configure a integração do ServiceDesk Plus V3 no Google SecOps

Para obter instruções detalhadas sobre como configurar uma integração no Google SecOps, consulte o artigo Configure integrações.

Parâmetros de integração

Use os seguintes parâmetros para configurar a integração:

Nome a apresentar do parâmetro Tipo Valor predefinido É obrigatório Descrição
Raiz da API String http://{IP OR FQDN}:8080/api/v3/ Sim API Root do ServiceDesk Plus.
Chave da API String N/A Sim Chave da API do ServiceDesk Plus. (também denominada "chave de técnico")
Validar SSL Caixa de verificação Desmarcado Sim Se estiver ativada, verifica se o certificado SSL para a ligação ao servidor do ServiceDesk Plus é válido.

Ações

Tchim-tchim

Descrição

Teste a conetividade ao ServiceDesk Plus V3 com os parâmetros fornecidos na página de configuração da integração no separador Google Security Operations Marketplace.

Parâmetros

N/A

Exemplos de utilização

A ação é usada para testar a conetividade na página de configuração da integração no separador Google Security Operations Marketplace e pode ser executada como uma ação manual, não usada em manuais de procedimentos.

Executar em

Esta ação não é executada em entidades.

Resultados da ação

Resultado do script
Nome do resultado do script Opções de valores Exemplo
is_success Verdadeiro/Falso is_success:False
Case Wall
Tipo de resultado Valor / descrição Tipo
Mensagem de saída*

A ação não deve falhar nem parar a execução de um guia interativo:

Se tiver êxito: "Ligação ao ServiceDesk Plus V3 estabelecida com êxito com os parâmetros de ligação fornecidos!"

A ação deve falhar e parar a execução de um guia interativo:

Se for comunicado um erro crítico, como credenciais incorretas ou perda de conetividade:

"Não foi possível estabelecer ligação ao ServiceDesk Plus V3! O erro é {0}".format(exception.stacktrace)

Geral

Adicionar nota

Descrição

Adicione uma nota a um pedido.

Parâmetros

Nome a apresentar do parâmetro Tipo Valor predefinido É obrigatório Descrição
ID do pedido String N/A Sim O ID dos pedidos.
Nota String N/A Sim O conteúdo da nota.
Mostrar ao requerente Caixa de verificação Desmarcado Não Especifique se a nota deve ou não ser apresentada ao requerente.
Notificar técnico Caixa de verificação Desmarcado Não Especifique se a nota deve ou não ser apresentada ao requerente.
Marcar como primeira resposta Caixa de verificação Desmarcado Não Especifique se esta nota deve ser marcada como a primeira resposta.
Adicione aos pedidos associados Caixa de verificação Desmarcado Não Especifique se esta nota deve ser adicionada às solicitações associadas.

Executar em

Esta ação não é executada em entidades.

Resultados da ação

Resultado do script
Nome do resultado do script Opções de valores Exemplo
is_success Verdadeiro/Falso is_success:False
Resultado JSON
{
    "response_status": {
        "status_code": 2000,
        "status": "success"
    },
    "request_note": {
        "created_time": {
            "display_value": "Nov 10, 2020 01:14 AM",
            "value": "1690499678XXX"
        },
        "request": {
            "subject": "New Subject Dropdown",
            "id": "00"
        },
        "show_to_requester": false,
        "description": "New Note",
        "id": "23",
        "created_by": {
            "email_id": null,
            "name": "administrator",
            "is_vipuser": false,
            "id": "4",
            "department": null
        }
    }
}
Case Wall
Tipo de resultado Valor / descrição Tipo
Mensagem de saída*

A ação não deve falhar nem parar a execução de um guia interativo:

Se for bem-sucedido: "Successfully added note to ServiceDesk Plus request. Request ID: {ID} , note ID: {note.id}."

Se o parâmetro "ID do pedido" não for encontrado:

"Não foi possível adicionar uma nota ao pedido com o ID {ID} no ServiceDesk Plus. Motivo: não foi encontrada a solicitação com o ID {ID}."

A ação deve falhar e parar a execução de um guia interativo:

Se não for bem-sucedido: "Erro ao executar a ação "Adicionar ação de nota". Motivo: {0}''.format(error.Stacktrace)

Geral

Fechar pedido

Descrição

Feche um pedido.

Parâmetros

Nome a apresentar do parâmetro Tipo Valor predefinido É obrigatório Descrição
ID do pedido String N/A Sim O ID do pedido.
Comentário String N/A Sim Fim do comentário.
Resolução confirmada Caixa de verificação Desmarcado Não Se a resolução da solicitação foi confirmada ou não.

Executar em

Esta ação não é executada em entidades.

Resultados da ação

Resultado do script
Nome do resultado do script Opções de valores Exemplo
is_success Verdadeiro/Falso is_success:False
Resultado JSON
{
    "response_status": {
        "status_code": 2000,
        "messages": [
            {
                "status_code": 2000,
                "type": "success",
                "message": "Request(s) closed successfully."
            }
        ],
        "status": "success"
    }
}
Case Wall
Tipo de resultado Valor / descrição Tipo
Mensagem de saída*

A ação não deve falhar nem parar a execução de um guia interativo:

Se for bem-sucedido:

Imprimir "Successfully closed ServiceDesk Plus request with ID {ID} ." (O pedido do ServiceDesk Plus com o ID {ID} foi fechado com êxito.)

Se não encontrar o ID do pedido:

Imprimir "Não foi possível fechar o pedido com o ID {ID} no ServiceDesk Plus. Motivo: não foi encontrada a solicitação com o ID {ID}."

A ação deve falhar e parar a execução de um guia interativo:

Se não for bem-sucedido:

Imprime "Erro ao executar a ação "Ação de pedido de fecho". Motivo: {0}''.format(error.Stacktrace)

Geral

Adicionar nota e aguardar resposta

Descrição

Adicione uma nota a um pedido.

Parâmetros

Nome a apresentar do parâmetro Tipo Valor predefinido É obrigatório Descrição
ID do pedido String N/A Sim O ID dos pedidos.
Nota String N/A Sim O conteúdo da nota.
Mostrar ao requerente Caixa de verificação Desmarcado Não Especifique se a nota deve ou não ser apresentada ao requerente.
Notificar técnico Caixa de verificação Desmarcado Não Especifique se a nota deve ou não ser apresentada ao requerente.
Marcar como primeira resposta Caixa de verificação Desmarcado Não Especifique se esta nota deve ser marcada como primeira resposta.
Adicione aos pedidos associados Caixa de verificação Desmarcado Não Especifique se esta nota deve ser adicionada às solicitações associadas.

Executar em

Esta ação não é executada em entidades.

Resultados da ação

Resultado do script
Nome do resultado do script Opções de valores Exemplo
is_success Verdadeiro/Falso is_success:False
Resultado JSON
{
    "response_status": {
        "status": "Success",
        "statuscode": "2000"
    },
    "request_note": {
        "id": "1",
        "description": "Need more info on this topic. Please contact me.",
        "created_by": {
            "id": "4",
            "name": "administrator"
        },
        "show_to_requester": true,
        "request": {
            "id": "2"
        },
        "created_time": {
            "value": 1455520864880,
            "display_value": "Feb 15, 2016 12:51 PM"
        }
    }
}
Case Wall
Tipo de resultado Valor / descrição Tipo
Mensagem de saída*

A ação não deve falhar nem parar a execução de um guia interativo:

Se for bem-sucedido: "Nota adicionada com êxito ao pedido do ServiceDesk Plus. Request ID: {ID} , note ID: {note.id}."

Se o parâmetro "ID do pedido" não for encontrado:

"Não foi possível adicionar uma nota ao pedido com o ID {ID} no ServiceDesk Plus. Motivo: não foi encontrada a solicitação com o ID {ID}."

A ação deve falhar e parar a execução de um guia interativo:

Se não for bem-sucedido: "Erro ao executar a ação "Adicionar ação de nota". Motivo: {0}''.format(error.Stacktrace)

Geral

Criar pedido de alerta

Descrição

Crie uma solicitação relacionada com um alerta do Google SecOps.

Parâmetros

Nome a apresentar do parâmetro Tipo Valor predefinido É obrigatório Descrição
Assunto String N/A Sim O assunto da solicitação.
Requerente String Utilizador da chave da API Sim O requerente do pedido. Se não for especificado, é definido como o utilizador da chave da API.
Recursos String N/A Não Nomes dos recursos a associar ao pedido.
Estado String N/A Não O estado do pedido.
Técnico String N/A Não O nome do técnico atribuído ao pedido.
Prioridade String N/A Não A prioridade do pedido.
Urgência String N/A Não A urgência do pedido.
Categoria String N/A Não A categoria do pedido.
Modelo de pedido String N/A Não O modelo do pedido.
Tipo de pedido String N/A Não

O tipo de solicitação.

Exemplo: incidente, pedido de serviço

Tempo de vencimento (ms) String N/A Não A data de conclusão do pedido em milissegundos.
Modo String N/A Não

O modo em que este pedido é criado.

Exemplo: endereço de email

Nível String N/A Não O nível do pedido.
Site String N/A Não Indica o site ao qual este pedido pertence.
Grupo String N/A Não Grupo ao qual este pedido pertence.
Impacto String N/A Não O impacto do pedido.

Executar em

Esta ação não é executada em entidades.

Resultados da ação

Resultado do script
Nome do resultado do script Opções de valores Exemplo
is_success Verdadeiro/Falso is_success:False
Resultado JSON
{
    "request": {
        "ola_due_by_time": null,
        "subject": "Test request number 2",
        "resolution": {
            "submitted_on": {
                "display_value": "Oct 28, 2020 09:31 PM",
                "value": "1603945909120"
            },
            "submitted_by": {
                "email_id": null,
                "name": "administrator",
                "is_vipuser": false,
                "id": "4",
                "department": null
            },
            "resolution_attachments": [],
            "content": "Mail Fetching Server problem has been fixed"
        },
        "linked_to_request": null,
        "mode": null,
        "lifecycle": null,
        "reason_for_cancel": null,
        "assets": [
            {
                "name": "servicedesk.workgroup",
                "id": "24"
            }
        ],
        "is_trashed": false,
        "id": "6",
        "assigned_time": null,
        "group": null,
        "requester": {
            "email_id": null,
            "name": "administrator",
            "is_vipuser": false,
            "id": "4",
            "department": null
        },
        "cancel_requested_by": null,
        "email_to": [],
        "created_time": {
            "display_value": "Oct 28, 2020 09:31 PM",
            "value": "1603945909120"
        },
        "item": null,
        "level": null,
        "has_resolution_attachments": false,
        "approval_status": null,
        "impact": null,
        "service_category": null,
        "sla": null,
        "priority": null,
        "created_by": {
            "email_id": null,
            "name": "administrator",
            "is_vipuser": false,
            "id": "4",
            "department": null
        },
        "scheduled_end_time": null,
        "tags": [],
        "first_response_due_by_time": null,
        "last_updated_time": null,
        "has_notes": false,
        "impact_details": "Routine tasks are pending due to mail server problem",
        "subcategory": null,
        "email_cc": [],
        "status": {
            "color": "#0066ff",
            "name": "Open",
            "id": "2"
        },
        "scheduled_start_time": null,
        "template": {
            "is_service_template": false,
            "name": "Default Request",
            "id": "1"
        },
        "email_ids_to_notify": [],
        "request_type": {
            "name": "Incident",
            "id": "1"
        },
        "cancel_requested_time": null,
        "description": "I am unable to fetch mails from the mail server",
        "has_dependency": false,
        "has_conversation": false,
        "callback_url": null,
        "chat_type": 0,
        "is_service_request": false,
        "urgency": null,
        "is_shared": false,
        "cancel_requested": false,
        "has_request_initiated_change": false,
        "request_template_task_ids": [],
        "department": null,
        "is_reopened": false,
        "has_draft": false,
        "has_attachments": false,
        "has_linked_requests": false,
        "is_overdue": false,
        "technician": null,
        "has_request_caused_by_change": false,
        "has_problem": false,
        "due_by_time": null,
        "has_project": false,
        "is_first_response_overdue": false,
        "cancel_requested_is_pending": false,
        "category": null
    },
    "response_status": {
        "status_code": 2000,
        "status": "success"
    }
}
Case Wall
Tipo de resultado Valor / descrição Tipo
Mensagem de saída*

A ação não deve falhar nem parar a execução de um guia interativo:

Se for bem-sucedido: "Successfully created ServiceDesk Plus request" (Pedido do ServiceDesk Plus criado com êxito)

A ação deve falhar e parar a execução de um guia interativo:

Se não for bem-sucedido: "Erro ao executar a ação "Ação de pedido de alerta". Motivo: {0}''.format(error.Stacktrace)

Geral

Criar pedido

Descrição

Crie uma nova solicitação.

Parâmetros

Parâmetro Tipo Valor predefinido É obrigatório Descrição
Assunto String N/A Sim O assunto da solicitação.
Requerente String Utilizador da chave da API Sim O requerente do pedido. Se não for especificado, é definido como o utilizador da chave da API.
Descrição String N/A Não A descrição do pedido.
Recursos String N/A Não Nomes dos recursos a associar ao pedido.
Estado String N/A Não O estado do pedido.
Técnico String N/A Não O nome do técnico atribuído ao pedido.
Prioridade String N/A Não A prioridade do pedido.
Urgência String N/A Não A urgência do pedido.
Categoria String N/A Não A categoria do pedido.
Modelo de pedido String N/A Não O modelo do pedido.
Tipo de pedido String N/A Não

O tipo de solicitação.

Exemplo: incidente, pedido de serviço

Tempo de vencimento (ms) String N/A Não A data de conclusão do pedido em milissegundos.
Modo String N/A Não

O modo em que este pedido é criado.

Exemplo: endereço de email

Nível String N/A Não O nível do pedido.
Site String N/A Não Indica o site ao qual este pedido pertence.
Grupo String N/A Não Grupo ao qual este pedido pertence.
Impacto String N/A Não O impacto do pedido.

Executar em

Esta ação não é executada em entidades.

Resultados da ação

Resultado do script
Nome do resultado do script Opções de valores Exemplo
is_success Verdadeiro/Falso is_success:False
Case Wall
Tipo de resultado Valor / descrição Tipo
Mensagem de saída*

A ação não deve falhar nem parar a execução de um guia interativo:

Se for bem-sucedido: "Pedido do ServiceDesk Plus criado com êxito"

A ação deve falhar e parar a execução de um guia interativo:

Se não for bem-sucedido: "Erro ao executar a ação "Ação de criação de pedido". Motivo: {0}''.format(error.Stacktrace)

Geral

Receber pedido

Descrição

Obtenha informações sobre um pedido no ServiceDesk Plus.

Parâmetros

Parâmetro Tipo Valor predefinido É obrigatório Descrição
ID do pedido String N/A Sim O ID do pedido.

Executar em

Esta ação não é executada em entidades.

Resultados da ação

Resultado do script
Nome do resultado do script Opções de valores Exemplo
is_success Verdadeiro/Falso is_success:False
Case Wall
Tipo de resultado Valor / descrição Tipo
Mensagem de saída*

A ação não deve falhar nem parar a execução de um guia interativo:

Se for bem-sucedido: "Successfully fetched ServiceDesk Plus request with ID {ID} ." (Pedido do ServiceDesk Plus obtido com êxito com o ID {ID}.)

Se o parâmetro "ID do pedido" não for encontrado: "Não foi possível obter o pedido com o ID {ID} no ServiceDesk Plus. Motivo: não foi encontrada a solicitação com o ID {ID}."

A ação deve falhar e parar a execução de um guia interativo:

Se não for bem-sucedido: "Erro ao executar a ação "Get Request action". Motivo: {0}''.format(error.Stacktrace)

Geral

Aguarde a atualização do campo

Descrição

Aguarde que um campo de um pedido seja atualizado para um valor desejado.

Parâmetros

Parâmetro Tipo Valor predefinido É obrigatório Descrição
ID do pedido String N/A Sim O ID do pedido.
Nome do campo String N/A Sim O nome do campo a atualizar.
Valores String N/A Sim Valores desejados para o campo fornecido.

Executar em

Esta ação não é executada em entidades.

Resultados da ação

Resultado do script
Nome do resultado do script Opções de valores Exemplo
is_success Verdadeiro/Falso is_success:False
Case Wall
Tipo de resultado Valor / descrição Tipo
Mensagem de saída*

A ação não deve falhar nem parar a execução do guia interativo:

Se tiver criado com êxito uma tarefa de espera (ação assíncrona) para o campo: "Created analysis tasks for the field: {0}".format([fields_list]).

Se não for possível criar uma tarefa de análise para todos os campos fornecidos: "Não foram criadas tarefas de análise do ServiceDesk Plus."

Se ainda estiver a aguardar a atualização do campo: "Ação a aguardar a próxima atualização"

A ação deve falhar e parar a execução do guia interativo:

Se for comunicado um erro crítico, como credenciais incorretas ou perda de conetividade: "Não foi possível estabelecer ligação ao serviço ServiceDesk! O erro é {0}".format(exception.stacktrace)

Geral

Pedido de atualização

Descrição

Atualize um pedido do ServiceDesk Plus através do respetivo ID.

Parâmetros

Parâmetro Tipo Valor predefinido É obrigatório Descrição
ID do pedido String N/A True O ID do pedido de atualização.
Assunto String N/A Não O assunto da solicitação.
Requerente String N/A Não

O requerente do pedido.

Se não for especificado, é definido como o utilizador da chave da API.

Descrição String N/A Não A descrição do pedido.
Recursos String N/A Não

Nomes dos recursos a associar ao pedido.

O parâmetro também pode receber uma lista de strings separadas por vírgulas com os nomes dos recursos.

Estado String N/A Não O estado do pedido.
Técnico String N/A Não O nome do técnico atribuído ao pedido.
Prioridade String N/A Não A prioridade do pedido.
Urgência String N/A Não A urgência do pedido.
Categoria String N/A Não A categoria do pedido.
Modelo de pedido String N/A Não O modelo do pedido.
Tipo de pedido String N/A Não

O tipo de solicitação.

Exemplo: incidente, pedido de serviço

Tempo de vencimento (ms) String N/A Não A data de conclusão do pedido em milissegundos.
Modo String N/A Não

O modo em que este pedido é criado.

Exemplo: endereço de email

Nível String N/A Não O nível do pedido.
Site String N/A Não Indica o site ao qual este pedido pertence.
Grupo String N/A Não Grupo ao qual este pedido pertence.
Impacto String N/A Não O impacto do pedido.

Executar em

Esta ação não é executada em entidades.

Resultados da ação

Resultado do script
Nome do resultado do script Opções de valores Exemplo
is_success Verdadeiro/Falso is_success:False
Case Wall
Tipo de resultado Valor / descrição Tipo
Mensagem de saída*

A ação não deve falhar nem parar a execução de um guia interativo:

Se for bem-sucedido: "A solicitação do ServiceDesk Plus com o ID {ID} foi atualizada com êxito."

Se o parâmetro "Request ID" não for encontrado: "Não foi possível atualizar o pedido com o ID {ID} no ServiceDesk Plus. Motivo: não foi encontrada a solicitação com o ID {ID}."

A ação deve falhar e parar a execução de um guia interativo:

Se não for bem-sucedido: "Erro ao executar a ação "Ação de pedido de atualização". Motivo: {0}''.format(error.Stacktrace)

Geral

Aguarde pela atualização do estado

Descrição

Aguarde até que o estado de um pedido seja atualizado para o estado pretendido.

Parâmetros

Parâmetro Tipo Valor predefinido É obrigatório Descrição
ID do pedido String N/A Sim O ID do pedido.
Valores String N/A Sim Valores desejados para o campo fornecido.

Executar em

Esta ação não é executada em entidades.

Resultados da ação

Resultado do script
Nome do resultado do script Opções de valores Exemplo
is_success Verdadeiro/Falso is_success:False
Case Wall
Tipo de resultado Valor / descrição Tipo
Mensagem de saída*

A ação não deve falhar nem parar a execução do guia interativo:

Se tiver criado com êxito uma tarefa de espera (ação assíncrona) para o campo: "Created analysis tasks for the field: {0}".format([fields_list]).

Se não for possível criar uma tarefa de análise para todos os campos fornecidos: "Não foram criadas tarefas de análise do ServiceDesk Plus."

Se ainda estiver a aguardar a atualização do campo: "Ação a aguardar a próxima atualização"

A ação deve falhar e parar a execução do guia interativo:

Se for comunicado um erro crítico, como credenciais incorretas ou perda de conetividade: "Não foi possível estabelecer ligação ao serviço ServiceDesk! O erro é {0}".format(exception.stacktrace)

Geral

Criar pedido – Listas pendentes

Descrição

Crie uma nova solicitação.

Parâmetros

Parâmetro Tipo Valor predefinido É obrigatório Descrição
Assunto String N/A Sim O assunto da solicitação.
Requerente String N/A Não O requerente do pedido. Se não for especificado, é definido como o utilizador da chave da API.
Recursos String N/A Não

Nomes dos recursos a associar ao pedido.

O parâmetro também pode receber uma lista de strings separadas por vírgulas com nomes de recursos.

Descrição String N/A Não A descrição do pedido.
Estado LDD N/A Não O estado do pedido.
Técnico String N/A Não O nome do técnico atribuído ao pedido.
Prioridade LDD N/A Não A prioridade do pedido.
Urgência LDD N/A Não A urgência do pedido.
Categoria LDD N/A Não A categoria do pedido.
Modelo de pedido String N/A Não O modelo do pedido.
Tipo de pedido LDD N/A Não

O tipo de solicitação.

Exemplo: incidente, pedido de serviço

Tempo de vencimento (ms) String N/A Não A data de conclusão do pedido em milissegundos.
Modo LDD N/A Não

O modo em que este pedido é criado.

Exemplo: endereço de email

Nível LDD N/A Não O nível do pedido.
Site String N/A Não Indica o site ao qual este pedido pertence.
Grupo String N/A Não Grupo ao qual este pedido pertence.
Impacto LDD N/A Não O impacto do pedido.

Executar em

Esta ação não é executada em entidades.

Resultados da ação

Resultado do script
Nome do resultado do script Opções de valores Exemplo
is_success Verdadeiro/Falso is_success:False
Case Wall
Tipo de resultado Valor / descrição Tipo
Mensagem de saída*

A ação não deve falhar nem parar a execução de um guia interativo:

Se for bem-sucedido: "Pedido do ServiceDesk Plus criado com êxito"

A ação deve falhar e parar a execução de um guia interativo:

Se não for bem-sucedido: "Erro ao executar a ação "Ação de criação de pedido". Motivo: {0}''.format(error.Stacktrace)

Geral

Empregos

Sincronize pedidos fechados por etiqueta

Descrição

Sincroniza os pedidos do ServiceDesk Plus V3 criados no manual de procedimentos de casos do Google SecOps e nos casos do Google SecOps.

Parâmetros

Parâmetro Tipo Valor predefinido É obrigatório Descrição
Raiz da API String http://{IP OR FQDN}:8080/api/v3/ Sim Raiz da API da instância do ServiceDeskPlus.
Chave de API Palavra-passe N/A Sim Chave da API da instância do ServiceDeskPlus.
Máximo de horas para trás Número inteiro 24 Não Especifique o número de horas para trás para sincronizar os estados.
Validar SSL Caixa de verificação Marcado Sim Se estiver ativada, verifique se o certificado SSL para a ligação ao servidor do ServiceDeskPlus é válido.

Precisa de mais ajuda? Receba respostas de membros da comunidade e profissionais da Google SecOps.