Listar incidentes do ServiceNow

Obtém uma lista de incidentes do ServiceNow usando a Table API.

Para a configuração de autenticação, consulte as ações do ServiceNow Incident.

Campo de entrada	Opcionalidade	Tipo	Descrição	Exemplo
domínio	Obrigatório	Corda	Domínio da instância do ServiceNow. Usado para construir a URL base `your-domain.service-now.com` .	`"your-domain"`
apiKey	Obrigatório	Corda	Chave de API REST do ServiceNow para autenticação. Passado como o cabeçalho da requisição `x-sn-apikey` . Deve ser fornecido como um segredo.	`"${{ :secrets:serviceNowApiKey }}"`
parâmetro	Opcional	Mapa	Parâmetros de consulta de URL opcionais para a requisição da API do ServiceNow. Controla o formato e o conteúdo da resposta da API. Consulte a tabela de referência de parâmetros abaixo.	`"{\"sysparm_fields\": \"name,short_description\", \"sysparm_exclude_reference_link\": \"true\", \"sysparm_input_display_value\": \"false\", \"sysparm_display_value\": \"true\"}"` Consulte Exportar para a especificação OpenAPI para obter uma lista de parâmetros aceitos.
seletores	Opcional	Lista		`[{\"name\": \"incidentNumber\", \"expression\": \".responseBody.result.number\"}]`

Referência de parâmetros comuns de URL

Parâmetro	Tipo	Descrição	Padrão
sysparm_fields	Corda	Lista de campos separados por vírgula a serem retornados na resposta.
sysparm_exclude_reference_link	Corda	`true` ou `false` para excluir links de referência da resposta.	`false`
sysparm_display_value	Corda	`true` , `false` ou `all` para retornar valores de exibição em vez de valores reais.	`false`
sysparm_input_display_value	Corda	`true` ou `false` . Quando `true` , define os valores dos campos usando seu valor de exibição em vez do valor real.	`false`
sysparm_suppress_auto_sys_field	Corda	`true` ou `false` . Quando `true` , suprime a geração automática de campos do sistema.	`false`
sysparm_view	Corda	Renderiza a resposta de acordo com uma visualização de interface específica. Sobrescrito por `sysparm_fields` .	`default`
sysparm_query_no_domain	Corda	`true` ou `false` . Quando `true` , permite o acesso a dados entre domínios, se autorizado.	`false`

Campo de saída	Tipo	Exemplo
response	Objeto	`{ "result": { "number": "INC0019382", "description": "The server is on fire.", "short_description": "The server is on fire.", .... .... } }`
sucesso	Boleano	`success: true \| false`
mensagem de erro	Corda	`[ { "success": false, "errorMessage": "{\"error\":{\"message\":\"User Not Authenticated\",\"detail\":\"Required to provide Auth information\"},\"status\":\"failure\"}" } ]`

Campo de saída

Tipo

Exemplo

response

Objeto

{
"result": {
    "number": "INC0019382",
    "description": "The server is on fire.",
    "short_description": "The server is on fire.",
    ....
    ....
}
}

sucesso

Boleano

success: true | false

mensagem de erro

Corda

[
  {
    "success": false,
    "errorMessage": "{\"error\":{\"message\":\"User Not Authenticated\",\"detail\":\"Required to provide Auth information\"},\"status\":\"failure\"}"
  }
]

Exemplo de fluxo de trabalho
`name: get-servicenow-incident-list description: to get list of incident from ServiceNow steps: - type: action name: listIncidents action: serviceNow.incident.list version: 1 inputs: domain: "your-domain" apiKey: "${{ :secrets:serviceNowApiKey }}" parameters: sysparm_fields: "number,short_description,description" sysparm_limit: "5" selectors: - name: incidents expression: .responseBody.result next: end`

Exemplo de fluxo de trabalho

name: get-servicenow-incident-list
description: to get list of incident from ServiceNow
steps:
  - type: action
    name: listIncidents
    action: serviceNow.incident.list
    version: 1
    inputs:
      domain: "your-domain"
      apiKey: "${{ :secrets:serviceNowApiKey }}"
      parameters:
        sysparm_fields: "number,short_description,description"
        sysparm_limit: "5"
      selectors:
        - name: incidents
          expression: .responseBody.result
    next: end

Esta tradução de máquina é fornecida para sua comodidade.

Referência de parâmetros comuns de URL