API de gestão de ciclo de vida do IC

  • Versão de lançamento: Yokohama
  • Atualizado 30 de jan. de 2025
  • 36 min. de leitura

    • A API de gestão de ciclo de vida do IC fornece endpoints para manipular estados operacionais de item de configuração (IC) e aplicar ações de IC.

    As interfaces de API aderem às restrições e permissões especificadas por ações de IC não permitidas, ações de IC compatíveis e transições operacionais não permitidas. Se uma interface tentar uma operação restrita, a operação será bloqueada, um erro será registrado e uma tarefa será criada, se apropriado.

    Gestão de ciclo de vida do IC - DELETE /now/cilifecyclemgmt/actions

    Remove uma ação de item de configuração (IC) de uma lista de ICs.

    Formato da URL

    URL com controle de versão: /api/now/{api_version}/cilifecyclemgmt/actions

    URL padrão: /api/now/cilifecyclemgmt/actions

    Nota:
    As versões disponíveis são especificadas no Explorador de REST API. Para REST APIs com script, há informações adicionais sobre a versão no formulário Serviço REST com script.

    Parâmetros de solicitação compatíveis

    Tabela 1. Parâmetros de caminho
    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
    Tabela 2. Parâmetros de consulta
    Nome Descrição
    actionName Obrigatório. Nome da ação do item de configuração.

    Tipo de dados: cadeia de caracteres
    ID do solicitante Obrigatório. Sys_id de um contexto de fluxo de trabalho ou um ID de usuário do operador retornado do endpoint Gestão de ciclo de vida do IC - POST /now/cilifecyclemgmt/operators.

    Os IDs de usuário do operador estão localizados na tabela Usuários registrados do estado do IC [statemgmt_register_users].

    Tipo de dados: cadeia de caracteres
    sysIds Obrigatório. Lista separada por vírgulas de sys_ids de IC.

    Tipo de dados: cadeia de caracteres
    Tabela 3. Parâmetros do corpo da solicitação (XML ou JSON)
    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.

    Tabela 4. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml.

    Padrão: application/json
    Tabela 5. Cabeçalhos de resposta
    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.

    Tabela 6. Códigos de status
    Código do status Descrição
    200 Bem-sucedido. A solicitação foi processada com sucesso pelo endpoint.

    Revise o parâmetro do corpo da resposta result.result para verificar o resultado da operação.

    Se o endpoint encontrar erros ao processar a solicitação, os códigos e mensagens de erro serão exibidos no parâmetro do corpo da resposta result.errors.
    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
    resultado Objeto que encapsula o resultado da solicitação.

    Tipo de dados: objeto

    "result": {
  "errors": [Array],
  "result": "String"
}
    resultado.erros Lista de objetos na qual cada objeto representa um erro encontrado ao processar a solicitação.

    Tipo de dados: matriz

    "errors": [
  {
    "error": "String",
    "message": "String"
  }
]
    resultado.erros.erro Identificador de um erro de gestão de estados encontrado ao processar a solicitação.
    Valores possíveis:
    • CI_AÇÃO_JÁ_DEFINIDA
    • CI_AÇÃO_NÃO_DEFINIR
    • DUPLICATE_CI_ACTION_RECORD
    • DUPLICATE_OPS_STATE_RECORD
    • DUPLICATE_SYS_ID
    • AÇÃO_CI_INCOMPATÍVEL
    • AÇÃO_CI_INVALID
    • INVALID_DELETE
    • INVALID_INPUT_PARAMETERS
    • INVALID_LEASETTIME
    • INVALID_OPS_STATE
    • INVÁLIDA_OPS_STATE_TRANSITION
    • SOLICITADOR_INVALID
    • SOLICITADOR_INVALID_PAR_CI
    • SYS_ID_INVALID
    • MUTEX_INDISPONÍVEL
    • AÇÃO_DE_CI_NÃO_PERMITIDA
    • OPS_STATE_NOT_SET
    • UNPRIORITIZED_OPS_STATE
    • UNSUPPORTED_SYS_ID

    Tipo de dados: cadeia de caracteres
    resultado.erros.mensagem Mensagem fornecendo detalhes sobre o errorassociado.

    Tipo de dados: cadeia de caracteres
    resultado.resultado Sinalizador que indica se a ação de IC foi removida com sucesso.
    Valores possíveis:
    • verdadeiro: a ação de IC foi removida.
    • falso: a ação de IC não foi removida.

    Tipo de dados: cadeia de caracteres

    Solicitação de cURL

    Remova uma ação de IC de dois ICs.

    curl --request DELETE \
'https://instance.service-now.com/api/now/cilifecyclemgmt/actions?actionName=Patching&requestorId=621b5a09309e5010f877773aa7167c0a&sysIds=00a9a80d3790200044e0bfc8bcbe5d1c,d0fdbc8437201000deeabfc8bcbe5d33' \
--header 'Accept: application/json' \
--user "username":"password"

    O corpo da resposta confirma que a ação de IC foi removida dos ICs.

    {
  "result": {
    "result": true
  }
}

    Gestão de ciclo de vida do IC - DELETE /now/cilifecyclemgmt/operators/{req_id}

    Cancela o registro de um operador para usuários sem fluxo de trabalho.

    Formato da URL

    URL com controle de versão: /api/now/{api_version}/cilifecyclemgmt/operators/{req_id}

    URL padrão: /api/now/cilifecyclemgmt/operators/{req_id}

    Nota:
    As versões disponíveis são especificadas no Explorador de REST API. Para REST APIs com script, há informações adicionais sobre a versão no formulário Serviço REST com script.

    Parâmetros de solicitação compatíveis

    Tabela 7. Parâmetros de caminho
    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
    req_id Sys_id de um contexto de fluxo de trabalho ou um ID de usuário do operador retornado do endpoint Gestão de ciclo de vida do IC - POST /now/cilifecyclemgmt/operators.

    Os IDs de usuário do operador estão localizados na tabela Usuários registrados do estado do IC [statemgmt_register_users].

    Tipo de dados: cadeia de caracteres
    Tabela 8. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 9. Parâmetros do corpo da solicitação (XML ou JSON)
    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.

    Tabela 10. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml.

    Padrão: application/json
    Tabela 11. Cabeçalhos de resposta
    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.

    Tabela 12. Códigos de status
    Código do status Descrição
    200 Bem-sucedido. A solicitação foi processada com sucesso pelo endpoint.

    Revise o parâmetro do corpo da resposta result.result para verificar o resultado da operação.

    Se o endpoint encontrar erros ao processar a solicitação, os códigos e mensagens de erro serão exibidos no parâmetro do corpo da resposta result.errors.
    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
    resultado Objeto que encapsula o resultado da solicitação.

    Tipo de dados: objeto

    "result": {
  "errors": [Array],
  "result": "String"
}
    resultado.erros Lista de objetos na qual cada objeto representa um erro encontrado ao processar a solicitação.

    Tipo de dados: matriz

    "errors": [
  {
    "error": "String",
    "message": "String"
  }
]
    resultado.erros.erro Identificador de um erro de gestão de estados encontrado ao processar a solicitação.
    Valores possíveis:
    • CI_AÇÃO_JÁ_DEFINIDA
    • CI_AÇÃO_NÃO_DEFINIR
    • DUPLICATE_CI_ACTION_RECORD
    • DUPLICATE_OPS_STATE_RECORD
    • DUPLICATE_SYS_ID
    • AÇÃO_CI_INCOMPATÍVEL
    • AÇÃO_CI_INVALID
    • INVALID_DELETE
    • INVALID_INPUT_PARAMETERS
    • INVALID_LEASETTIME
    • INVALID_OPS_STATE
    • INVÁLIDA_OPS_STATE_TRANSITION
    • SOLICITADOR_INVALID
    • SOLICITADOR_INVALID_PAR_CI
    • SYS_ID_INVALID
    • MUTEX_INDISPONÍVEL
    • AÇÃO_DE_CI_NÃO_PERMITIDA
    • OPS_STATE_NOT_SET
    • UNPRIORITIZED_OPS_STATE
    • UNSUPPORTED_SYS_ID

    Tipo de dados: cadeia de caracteres
    resultado.erros.mensagem Mensagem fornecendo detalhes sobre o errorassociado.

    Tipo de dados: cadeia de caracteres
    resultado.resultado Sinalizador que indica se o registro do operador foi cancelado com sucesso.
    Valores possíveis:
    • verdadeiro: o registro do operador foi cancelado com sucesso.
    • falso: o registro do operador não foi cancelado com sucesso.

    Tipo de dados: cadeia de caracteres

    Solicitação de cURL

    Cancele o registro de um operador por ID de usuário.

    curl --request DELETE \
"https://instance.service-now.com/api/now/cilifecyclemgmt/operators/3cf1b3cc30121010f877773aa7167c6e" \
--header "Accept: application/json" \
--user "username":"password"

    O corpo da resposta verifica se o registro do operador foi cancelado.

    {
  "result": {
    "result": true
  }
}

    Gestão de ciclo de vida do IC - GET /now/cilifecyclemgmt/actions/{sys_id}

    Retorna uma lista de ações de item de configuração (IC) ativas para o IC especificado.

    Formato da URL

    URL com controle de versão: /api/now/{api_version}/cilifecyclemgmt/actions/{sys_id}

    URL padrão: /api/now/cilifecyclemgmt/actions/{sys_id}

    Nota:
    As versões disponíveis são especificadas no Explorador de REST API. Para REST APIs com script, há informações adicionais sobre a versão no formulário Serviço REST com script.

    Parâmetros de solicitação compatíveis

    Tabela 13. Parâmetros de caminho
    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 IC para o qual as ações de IC associadas serão retornadas.

    Tipo de dados: cadeia de caracteres
    Tabela 14. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 15. Parâmetros do corpo da solicitação (XML ou JSON)
    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.

    Tabela 16. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml.

    Padrão: application/json
    Tabela 17. Cabeçalhos de resposta
    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.

    Tabela 18. Códigos de status
    Código do status Descrição
    200 Bem-sucedido. A solicitação foi processada com sucesso pelo endpoint.

    Revise o parâmetro do corpo da resposta result.ciActions para verificar o resultado da operação.

    Se o endpoint encontrar erros ao processar a solicitação, os códigos e mensagens de erro serão exibidos no parâmetro do corpo da resposta result.errors.
    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
    resultado Objeto que encapsula o resultado da solicitação.

    Tipo de dados: objeto

    "result": {
  "errors": [Array],
  "result": "String"
}
    result.ciActions Lista separada por vírgulas de ações de IC ativas para o IC ou no_active_action se nenhuma for encontrada.

    Tipo de dados: cadeia de caracteres
    resultado.erros Lista de objetos na qual cada objeto representa um erro encontrado ao processar a solicitação.

    Tipo de dados: matriz

    "errors": [
  {
    "error": "String",
    "message": "String"
  }
]
    resultado.erros.erro Identificador de um erro de gestão de estados encontrado ao processar a solicitação.
    Valores possíveis:
    • CI_AÇÃO_JÁ_DEFINIDA
    • CI_AÇÃO_NÃO_DEFINIR
    • DUPLICATE_CI_ACTION_RECORD
    • DUPLICATE_OPS_STATE_RECORD
    • DUPLICATE_SYS_ID
    • AÇÃO_CI_INCOMPATÍVEL
    • AÇÃO_CI_INVALID
    • INVALID_DELETE
    • INVALID_INPUT_PARAMETERS
    • INVALID_LEASETTIME
    • INVALID_OPS_STATE
    • INVÁLIDA_OPS_STATE_TRANSITION
    • SOLICITADOR_INVALID
    • SOLICITADOR_INVALID_PAR_CI
    • SYS_ID_INVALID
    • MUTEX_INDISPONÍVEL
    • AÇÃO_DE_CI_NÃO_PERMITIDA
    • OPS_STATE_NOT_SET
    • UNPRIORITIZED_OPS_STATE
    • UNSUPPORTED_SYS_ID

    Tipo de dados: cadeia de caracteres
    resultado.erros.mensagem Mensagem fornecendo detalhes sobre o errorassociado.

    Tipo de dados: cadeia de caracteres
    resultado.resultado Sinalizador que indica se a lista de ações de IC ativas foi retornada para todos os ICs especificados.
    Valores possíveis:
    • verdadeiro: a lista de ações de IC ativas foi retornada.
    • falso: a lista de ações de IC ativas não foi retornada.

    Tipo de dados: cadeia de caracteres

    Solicitação de cURL

    curl --request GET \
'https://instance.service-now.com/api/now/cilifecyclemgmt/actions/00a9a80d3790200044e0bfc8bcbe5d1c' \
--header 'Accept: application/json' \
--user "username":"password"

    O corpo da resposta mostra que não há ações de IC ativas para o IC especificado.

    {
  "result": {
    "ciActions": [
      "no_active_action"
    ],
    "result": true
  }
}

    Gestão de ciclo de vida do IC - GET /now/cilifecyclemgmt/compatActions

    Determina se duas ações de item de configuração (IC) especificadas são compatíveis.

    Formato da URL

    URL com controle de versão: /api/now/{api_version}/cilifecyclemgmt/compatActions

    URL padrão: /api/now/cilifecyclemgmt/compatActions

    Nota:
    As versões disponíveis são especificadas no Explorador de REST API. Para REST APIs com script, há informações adicionais sobre a versão no formulário Serviço REST com script.

    Parâmetros de solicitação compatíveis

    Tabela 19. Parâmetros de caminho
    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
    Tabela 20. Parâmetros de consulta
    Nome Descrição
    actionName Obrigatório. Nome da ação de IC a ser comparada.

    Tipo de dados: cadeia de caracteres
    outroNomeAção Obrigatório. Nome da ação de IC a ser comparada.

    Tipo de dados: cadeia de caracteres
    Tabela 21. Parâmetros do corpo da solicitação (XML ou JSON)
    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.

    Tabela 22. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml.

    Padrão: application/json
    Tabela 23. Cabeçalhos de resposta
    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.

    Tabela 24. Códigos de status
    Código do status Descrição
    200 Bem-sucedido. A solicitação foi processada com sucesso pelo endpoint.

    Revise o parâmetro do corpo da resposta result.result para verificar o resultado da operação.

    Se o endpoint encontrar erros ao processar a solicitação, os códigos e mensagens de erro serão exibidos no parâmetro do corpo da resposta result.errors.
    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
    resultado Sinalizador que indica se as duas ações de IC especificadas são compatíveis.
    Valores possíveis:
    • verdadeiro: as ações de IC são compatíveis.
    • falso: as ações de IC não são compatíveis.

    Tipo de dados: cadeia de caracteres

    Solicitação de cURL

    Verifique a compatibilidade das ações de IC de patch e provisionamento.

    curl --request GET \
'https://instance.service-now.com/api/now/cilifecyclemgmt/compatActions?actionName=Patching&otherActionName=Provisioning' \
--header 'Accept: application/json' \
--user "username":"password"

    O corpo da resposta confirma que as duas ações de IC são compatíveis.

    {
  "result": true
}

    Gestão de ciclo de vida do IC - GET /now/cilifecyclemgmt/leases/{sys_id}/expired

    Determina se o leasing expirou para o solicitante de uma ação de item de configuração (IC) aplicada ao IC especificado.

    Formato da URL

    URL com controle de versão: /api/now/{api_version}/cilifecyclemgmt/leases/{sys_id}/expired

    URL padrão: /api/now/cilifecyclemgmt/leases/{sys_id}/expired

    Nota:
    As versões disponíveis são especificadas no Explorador de REST API. Para REST APIs com script, há informações adicionais sobre a versão no formulário Serviço REST com script.

    Parâmetros de solicitação compatíveis

    Tabela 25. Parâmetros de caminho
    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 IC que é o destino da ação de IC aplicada.

    Tipo de dados: cadeia de caracteres
    Tabela 26. Parâmetros de consulta
    Nome Descrição
    actionName Obrigatório. Nome da ação de IC aplicada ao IC especificado.

    Tipo de dados: cadeia de caracteres
    ID do solicitante Obrigatório. Sys_id de um contexto de fluxo de trabalho ou um ID de usuário do operador retornado do endpoint Gestão de ciclo de vida do IC - POST /now/cilifecyclemgmt/operators.

    Os IDs de usuário do operador estão localizados na tabela Usuários registrados do estado do IC [statemgmt_register_users].

    Tipo de dados: cadeia de caracteres
    Tabela 27. Parâmetros do corpo da solicitação (XML ou JSON)
    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.

    Tabela 28. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml.

    Padrão: application/json
    Tabela 29. Cabeçalhos de resposta
    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.

    Tabela 30. Códigos de status
    Código do status Descrição
    200 Bem-sucedido. A solicitação foi processada com sucesso pelo endpoint.

    Revise o parâmetro do corpo da resposta result.result para verificar o resultado da operação.

    Se o endpoint encontrar erros ao processar a solicitação, os códigos e mensagens de erro serão exibidos no parâmetro do corpo da resposta result.errors.
    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
    resultado Objeto que encapsula o resultado da solicitação.

    Tipo de dados: objeto

    "result": {
  "errors": [Array],
  "result": "String"
}
    resultado.erros Lista de objetos na qual cada objeto representa um erro encontrado ao processar a solicitação.

    Tipo de dados: matriz

    "errors": [
  {
    "error": "String",
    "message": "String"
  }
]
    resultado.erros.erro Identificador de um erro de gestão de estados encontrado ao processar a solicitação.
    Valores possíveis:
    • CI_AÇÃO_JÁ_DEFINIDA
    • CI_AÇÃO_NÃO_DEFINIR
    • DUPLICATE_CI_ACTION_RECORD
    • DUPLICATE_OPS_STATE_RECORD
    • DUPLICATE_SYS_ID
    • AÇÃO_CI_INCOMPATÍVEL
    • AÇÃO_CI_INVALID
    • INVALID_DELETE
    • INVALID_INPUT_PARAMETERS
    • INVALID_LEASETTIME
    • INVALID_OPS_STATE
    • INVÁLIDA_OPS_STATE_TRANSITION
    • SOLICITADOR_INVALID
    • SOLICITADOR_INVALID_PAR_CI
    • SYS_ID_INVALID
    • MUTEX_INDISPONÍVEL
    • AÇÃO_DE_CI_NÃO_PERMITIDA
    • OPS_STATE_NOT_SET
    • UNPRIORITIZED_OPS_STATE
    • UNSUPPORTED_SYS_ID

    Tipo de dados: cadeia de caracteres
    resultado.erros.mensagem Mensagem fornecendo detalhes sobre o errorassociado.

    Tipo de dados: cadeia de caracteres
    resultado.resultado Sinalizador que indica se o leasing do solicitante da ação de IC aplicada expirou.
    Valores possíveis:
    • verdadeiro: o leasing do solicitante expirou.
    • falso: o leasing do solicitante não expirou.

    Tipo de dados: cadeia de caracteres

    Solicitação de cURL

    curl --request GET \
'https://instance.service-now.com/api/now/cilifecyclemgmt/leases/00a9a80d3790200044e0bfc8bcbe5d1c/expired?actionName=Patching&requestorId=621b5a09309e5010f877773aa7167c0a' \
--header 'Accept: application/json' \
--user "username":"password"

    O corpo da resposta mostra que o leasing do solicitante da ação de IC aplicada não expirou.

    {
  "result": {
    "result": false
  }
}

    Gestão de ciclo de vida do IC - GET /now/cilifecyclemgmt/notAllowedAction

    Determina se uma ação de item de configuração (IC) especificada não é permitida para um IC de uma classe especificada quando em um estado operacional especificado.

    Formato da URL

    URL com controle de versão: /api/now/{api_version}/cilifecyclemgmt/notAllowedAction

    URL padrão: /api/now/cilifecyclemgmt/notAllowedAction

    Nota:
    As versões disponíveis são especificadas no Explorador de REST API. Para REST APIs com script, há informações adicionais sobre a versão no formulário Serviço REST com script.

    Parâmetros de solicitação compatíveis

    Tabela 31. Parâmetros de caminho
    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
    Tabela 32. Parâmetros de consulta
    Nome Descrição
    actionName Obrigatório. Nome da ação de IC a ser verificada.

    Tipo de dados: cadeia de caracteres
    ciClass Obrigatório. Classe de IC.

    Tipo de dados: cadeia de caracteres
    opsLabel Obrigatório. Estado operacional a ser verificado.

    Tipo de dados: cadeia de caracteres
    Tabela 33. Parâmetros do corpo da solicitação (XML ou JSON)
    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.

    Tabela 34. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml.

    Padrão: application/json
    Tabela 35. Cabeçalhos de resposta
    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.

    Tabela 36. Códigos de status
    Código do status Descrição
    200 Bem-sucedido. A solicitação foi processada com sucesso pelo endpoint.

    Revise o parâmetro do corpo da resposta result.result para verificar o resultado da operação.

    Se o endpoint encontrar erros ao processar a solicitação, os códigos e mensagens de erro serão exibidos no parâmetro do corpo da resposta result.errors.
    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
    resultado Sinalizador que indica se a ação de IC é restrita (não permitida) para ICs do tipo especificado quando no estado operacional especificado.
    Valores possíveis:
    • verdadeiro: a ação de IC é restrita (não permitida).
    • falso: a ação de IC é irrestrita (permitida).

    Tipo de dados: cadeia de caracteres

    Solicitação de cURL

    Verifique se a ação de IC de patch é restrita (não permitida) para computadores no estado operacional Em espera de DR.

    curl --request GET \
"https://instance.service-now.com/api/now/cilifecyclemgmt/notAllowedAction?actionName=Patching&ciClass=cmdb_ci_computer&opsLabel=DR+Standby" \
--header "Accept: application/json" \
--user "username":"password"

    O corpo da resposta confirma que esta ação é restrita (não permitida) para a classe de IC especificada quando está no estado operacional especificado.

    {
  "result": true
}

    Gestão de ciclo de vida do IC - GET /now/cilifecyclemgmt/notAllowedOpsTransition

    Determina se um item de configuração (IC) de uma classe especificada pode fazer a transição de um estado operacional especificado para um segundo estado operacional especificado.

    Formato da URL

    URL com controle de versão: /api/now/{api_version}/cilifecyclemgmt/notAllowedOpsTransition

    URL padrão: /api/now/cilifecyclemgmt/notAllowedOpsTransition

    Nota:
    As versões disponíveis são especificadas no Explorador de REST API. Para REST APIs com script, há informações adicionais sobre a versão no formulário Serviço REST com script.

    Parâmetros de solicitação compatíveis

    Tabela 37. Parâmetros de caminho
    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
    Tabela 38. Parâmetros de consulta
    Nome Descrição
    ciClass Obrigatório. Classe de IC para a qual verificar restrições de transição.

    Tipo de dados: cadeia de caracteres
    opsLabel Obrigatório. Rótulo do estado operacional do IC atual.

    Tipo de dados: cadeia de caracteres
    transiçãoOpsLabel Obrigatório. Rótulo do estado operacional que é o destino da transição.

    Tipo de dados: cadeia de caracteres
    Tabela 39. Parâmetros do corpo da solicitação (XML ou JSON)
    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.

    Tabela 40. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml.

    Padrão: application/json
    Tabela 41. Cabeçalhos de resposta
    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.

    Tabela 42. Códigos de status
    Código do status Descrição
    200 Bem-sucedido. A solicitação foi processada com sucesso pelo endpoint.

    Revise o parâmetro do corpo da resposta result.result para verificar o resultado da operação.

    Se o endpoint encontrar erros ao processar a solicitação, os códigos e mensagens de erro serão exibidos no parâmetro do corpo da resposta result.errors.
    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
    resultado Sinalizador que indica se a transição do estado operacional especificada é restrita (não permitida) para a classe de IC especificada.
    Valores possíveis:
    • verdadeiro: a transição do estado operacional é restrita (não permitida).
    • falso: a transição do estado operacional é irrestrita (permitida).

    Tipo de dados: cadeia de caracteres

    Solicitação de cURL

    Verifique se a transição do estado operacional Descontinuado para o estado operacional Em espera de DR é restrita (não permitida) para ICs de servidor Linux.

    curl --request GET \
"https://instance.service-now.com/api/now/cilifecyclemgmt/notAllowedOpsTransition?ciClass=cmdb_ci_computer&opsLabel=Retired&transitionOpsLabel=DR+Standby" \
--header "Accept: application/json" \
--user "username":"password"

    O corpo da resposta mostra que a transição do estado operacional especificada é irrestrita (permitida) para esta classe de IC.

    {
  "result": false
}

    Gestão de ciclo de vida do IC - GET /now/cilifecyclemgmt/requestors/{req_id}/valid

    Determina se o usuário de fluxo de trabalho ativo especificado ou o usuário registrado é um solicitante válido.

    Formato da URL

    URL com controle de versão: /api/now/{api_version}/cilifecyclemgmt/requestors/{req_id}/valid

    URL padrão: /api/now/cilifecyclemgmt/requestors/{req_id}/valid

    Nota:
    As versões disponíveis são especificadas no Explorador de REST API. Para REST APIs com script, há informações adicionais sobre a versão no formulário Serviço REST com script.

    Parâmetros de solicitação compatíveis

    Tabela 43. Parâmetros de caminho
    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_id Sys_id de um contexto de fluxo de trabalho ou um ID de usuário do operador retornado do endpoint Gestão de ciclo de vida do IC - POST /now/cilifecyclemgmt/operators.

    Os IDs de usuário do operador estão localizados na tabela Usuários registrados do estado do IC [statemgmt_register_users].

    Tipo de dados: cadeia de caracteres
    Tabela 44. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 45. Parâmetros do corpo da solicitação (XML ou JSON)
    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.

    Tabela 46. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml.

    Padrão: application/json
    Tabela 47. Cabeçalhos de resposta
    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.

    Tabela 48. Códigos de status
    Código do status Descrição
    200 Bem-sucedido. A solicitação foi processada com sucesso pelo endpoint.

    Revise o parâmetro do corpo da resposta result.result para verificar o resultado da operação.

    Se o endpoint encontrar erros ao processar a solicitação, os códigos e mensagens de erro serão exibidos no parâmetro do corpo da resposta result.errors.
    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
    resultado Objeto que encapsula o resultado da solicitação.

    Tipo de dados: objeto

    "result": {
  "errors": [Array],
  "result": "String"
}
    resultado.erros Lista de objetos na qual cada objeto representa um erro encontrado ao processar a solicitação.

    Tipo de dados: matriz

    "errors": [
  {
    "error": "String",
    "message": "String"
  }
]
    resultado.erros.erro Identificador de um erro de gestão de estados encontrado ao processar a solicitação.
    Valores possíveis:
    • CI_AÇÃO_JÁ_DEFINIDA
    • CI_AÇÃO_NÃO_DEFINIR
    • DUPLICATE_CI_ACTION_RECORD
    • DUPLICATE_OPS_STATE_RECORD
    • DUPLICATE_SYS_ID
    • AÇÃO_CI_INCOMPATÍVEL
    • AÇÃO_CI_INVALID
    • INVALID_DELETE
    • INVALID_INPUT_PARAMETERS
    • INVALID_LEASETTIME
    • INVALID_OPS_STATE
    • INVÁLIDA_OPS_STATE_TRANSITION
    • SOLICITADOR_INVALID
    • SOLICITADOR_INVALID_PAR_CI
    • SYS_ID_INVALID
    • MUTEX_INDISPONÍVEL
    • AÇÃO_DE_CI_NÃO_PERMITIDA
    • OPS_STATE_NOT_SET
    • UNPRIORITIZED_OPS_STATE
    • UNSUPPORTED_SYS_ID

    Tipo de dados: cadeia de caracteres
    resultado.erros.mensagem Mensagem fornecendo detalhes sobre o errorassociado.

    Tipo de dados: cadeia de caracteres
    resultado.resultado Sinalizador que indica se o usuário de fluxo de trabalho ativo especificado ou o usuário registrado é um solicitante válido.
    Valores possíveis:
    • verdadeiro: solicitante válido.
    • falso: solicitante inválido.

    Tipo de dados: cadeia de caracteres

    Solicitação de cURL

    curl --request GET \
'https://instance.service-now.com/api/now/cilifecyclemgmt/requestors/4cab9b95301a9010f877773aa7167ca9/valid' \
--header 'Accept: application/json' \
--user "username":"password"
    {
  "result": {
    "result": true
  }
}

    Gestão de ciclo de vida do IC - GET /now/cilifecyclemgmt/statuses/{sys_id}

    Retorna o estado operacional atual do item de configuração (IC) especificado.

    Formato da URL

    URL com controle de versão: /api/now/{api_version}/cilifecyclemgmt/statuses/{sys_id}

    URL padrão: /api/now/cilifecyclemgmt/statuses/{sys_id}

    Nota:
    As versões disponíveis são especificadas no Explorador de REST API. Para REST APIs com script, há informações adicionais sobre a versão no formulário Serviço REST com script.

    Parâmetros de solicitação compatíveis

    Tabela 49. Parâmetros de caminho
    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 IC.

    Tipo de dados: cadeia de caracteres
    Tabela 50. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 51. Parâmetros do corpo da solicitação (XML ou JSON)
    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.

    Tabela 52. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml.

    Padrão: application/json
    Tabela 53. Cabeçalhos de resposta
    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.

    Tabela 54. Códigos de status
    Código do status Descrição
    200 Bem-sucedido. A solicitação foi processada com sucesso pelo endpoint.

    Revise o parâmetro do corpo da resposta result.result para verificar o resultado da operação.

    Se o endpoint encontrar erros ao processar a solicitação, os códigos e mensagens de erro serão exibidos no parâmetro do corpo da resposta result.errors.
    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
    resultado Objeto que encapsula o resultado da solicitação.

    Tipo de dados: objeto

    "result": {
  "errors": [Array],
  "result": "String"
}
    resultado.erros Lista de objetos na qual cada objeto representa um erro encontrado ao processar a solicitação.

    Tipo de dados: matriz

    "errors": [
  {
    "error": "String",
    "message": "String"
  }
]
    resultado.erros.erro Identificador de um erro de gestão de estados encontrado ao processar a solicitação.
    Valores possíveis:
    • CI_AÇÃO_JÁ_DEFINIDA
    • CI_AÇÃO_NÃO_DEFINIR
    • DUPLICATE_CI_ACTION_RECORD
    • DUPLICATE_OPS_STATE_RECORD
    • DUPLICATE_SYS_ID
    • AÇÃO_CI_INCOMPATÍVEL
    • AÇÃO_CI_INVALID
    • INVALID_DELETE
    • INVALID_INPUT_PARAMETERS
    • INVALID_LEASETTIME
    • INVALID_OPS_STATE
    • INVÁLIDA_OPS_STATE_TRANSITION
    • SOLICITADOR_INVALID
    • SOLICITADOR_INVALID_PAR_CI
    • SYS_ID_INVALID
    • MUTEX_INDISPONÍVEL
    • AÇÃO_DE_CI_NÃO_PERMITIDA
    • OPS_STATE_NOT_SET
    • UNPRIORITIZED_OPS_STATE
    • UNSUPPORTED_SYS_ID

    Tipo de dados: cadeia de caracteres
    resultado.erros.mensagem Mensagem fornecendo detalhes sobre o errorassociado.

    Tipo de dados: cadeia de caracteres
    resultado.estadosoperacionais Estado operacional para o IC especificado ou desconhecido se nenhum estado for especificado.

    Tipo de dados: cadeia de caracteres

    Solicitação de cURL

    curl --request GET 'https://instance.service-now.com/api/now/cilifecyclemgmt/statuses/aac0b1213784200044e0bfc8bcbe5de3' \
--header 'Accept: application/json' \
--user "username":"password"
    {
  "result": {
    "operationalState": "Repair in Progress",
    "result": true
  }
}

    Gestão de ciclo de vida do IC - PATCH /now/cilifecyclemgmt/leases/{sys_id}

    Estende o tempo de expiração do leasing da ação do item de configuração (IC) especificado para o usuário especificado.

    Se o leasing anterior tiver expirado, o novo tempo de leasing começará imediatamente.

    Formato da URL

    URL com controle de versão: /api/now/{api_version}/cilifecyclemgmt/leases/{sys_id}

    URL padrão: /api/now/cilifecyclemgmt/leases/{sys_id}

    Nota:
    As versões disponíveis são especificadas no Explorador de REST API. Para REST APIs com script, há informações adicionais sobre a versão no formulário Serviço REST com script.

    Parâmetros de solicitação compatíveis

    Tabela 55. Parâmetros de caminho
    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 IC para o qual o leasing será estendido.

    Tipo de dados: cadeia de caracteres
    Tabela 56. Parâmetros de consulta
    Nome Descrição
    actionName Obrigatório. Nome da ação de IC associada.

    Tipo de dados: cadeia de caracteres
    leasingTime Obrigatório. Duração de tempo pela qual o leasing é válido para a ação de IC especificada em actionName.

    Tipo de dados: cadeia de caracteres

    Formato: HH:MM:SS
    ID do solicitante Obrigatório. Sys_id de um contexto de fluxo de trabalho ou um ID de usuário do operador retornado do endpoint Gestão de ciclo de vida do IC - POST /now/cilifecyclemgmt/operators.

    Os IDs de usuário do operador estão localizados na tabela Usuários registrados do estado do IC [statemgmt_register_users].

    Tipo de dados: cadeia de caracteres
    Tabela 57. Parâmetros do corpo da solicitação (XML ou JSON)
    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.

    Tabela 58. Cabeçalhos da solicitação
    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
    Tabela 59. Cabeçalhos de resposta
    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.

    Tabela 60. Códigos de status
    Código do status Descrição
    200 Bem-sucedido. A solicitação foi processada com sucesso pelo endpoint.

    Revise o parâmetro do corpo da resposta result.result para verificar o resultado da operação.

    Se o endpoint encontrar erros ao processar a solicitação, os códigos e mensagens de erro serão exibidos no parâmetro do corpo da resposta result.errors.
    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
    resultado Objeto que encapsula o resultado da solicitação.

    Tipo de dados: objeto

    "result": {
  "errors": [Array],
  "result": "String"
}
    resultado.erros Lista de objetos na qual cada objeto representa um erro encontrado ao processar a solicitação.

    Tipo de dados: matriz

    "errors": [
  {
    "error": "String",
    "message": "String"
  }
]
    resultado.erros.erro Identificador de um erro de gestão de estados encontrado ao processar a solicitação.
    Valores possíveis:
    • CI_AÇÃO_JÁ_DEFINIDA
    • CI_AÇÃO_NÃO_DEFINIR
    • DUPLICATE_CI_ACTION_RECORD
    • DUPLICATE_OPS_STATE_RECORD
    • DUPLICATE_SYS_ID
    • AÇÃO_CI_INCOMPATÍVEL
    • AÇÃO_CI_INVALID
    • INVALID_DELETE
    • INVALID_INPUT_PARAMETERS
    • INVALID_LEASETTIME
    • INVALID_OPS_STATE
    • INVÁLIDA_OPS_STATE_TRANSITION
    • SOLICITADOR_INVALID
    • SOLICITADOR_INVALID_PAR_CI
    • SYS_ID_INVALID
    • MUTEX_INDISPONÍVEL
    • AÇÃO_DE_CI_NÃO_PERMITIDA
    • OPS_STATE_NOT_SET
    • UNPRIORITIZED_OPS_STATE
    • UNSUPPORTED_SYS_ID

    Tipo de dados: cadeia de caracteres
    resultado.erros.mensagem Mensagem fornecendo detalhes sobre o errorassociado.

    Tipo de dados: cadeia de caracteres
    resultado.resultado Sinalizador que indica se o tempo de leasing foi estendido.
    Valores possíveis:
    • verdadeiro: o tempo de leasing foi estendido.
    • falso: o tempo de leasing não foi estendido.

    Tipo de dados: cadeia de caracteres

    Solicitação de cURL

    Prolongue a duração de um leasing de solicitante de ação de IC de patch em 24 horas.

    curl --request PATCH 'https://instance.service-now.com/api/now/cilifecyclemgmt/leases/affd3c8437201000deeabfc8bcbe5dc3?actionName=Patching&leaseTime=24:00:00&requestorId=e7c3402d305a9010f877773aa7167c2a' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--user "username":"password"
    {
  "result": {
    "result": true
  }
}

    Gestão de ciclo de vida do IC - POST /now/cilifecyclemgmt/actions

    Adiciona uma ação de item de configuração (IC) especificada a uma lista especificada de ICs.

    Formato da URL

    URL com controle de versão: /api/now/{api_version}/cilifecyclemgmt/actions

    URL padrão: /api/now/cilifecyclemgmt/actions

    Nota:
    As versões disponíveis são especificadas no Explorador de REST API. Para REST APIs com script, há informações adicionais sobre a versão no formulário Serviço REST com script.

    Parâmetros de solicitação compatíveis

    Tabela 61. Parâmetros de caminho
    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
    Tabela 62. Parâmetros de consulta
    Nome Descrição
    actionName Obrigatório. Nome da ação de IC a ser adicionada à lista.

    Tipo de dados: cadeia de caracteres
    leasingTime Duração de tempo pela qual o leasing é válido para a ação de IC especificada.

    Tipo de dados: cadeia de caracteres

    Formato: HH:MM:SS
    oldActionNames Lista separada por vírgulas de ações de IC antigas em que todos os ICs devem estar.

    Tipo de dados: cadeia de caracteres
    ID do solicitante Obrigatório. Sys_id de um contexto de fluxo de trabalho ou um ID de usuário do operador retornado do endpoint Gestão de ciclo de vida do IC - POST /now/cilifecyclemgmt/operators.

    Os IDs de usuário do operador estão localizados na tabela Usuários registrados do estado do IC [statemgmt_register_users].

    Tipo de dados: cadeia de caracteres
    sysIds Obrigatório. Lista separada por vírgulas de sys_ids de IC aos quais a ação de IC será adicionada.

    Tipo de dados: cadeia de caracteres
    Tabela 63. Parâmetros do corpo da solicitação (XML ou JSON)
    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.

    Tabela 64. Cabeçalhos da solicitação
    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
    Tabela 65. Cabeçalhos de resposta
    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.

    Tabela 66. Códigos de status
    Código do status Descrição
    200 Bem-sucedido. A solicitação foi processada com sucesso pelo endpoint.

    Revise o parâmetro do corpo da resposta result.result para verificar o resultado da operação.

    Se o endpoint encontrar erros ao processar a solicitação, os códigos e mensagens de erro serão exibidos no parâmetro do corpo da resposta result.errors.
    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
    resultado Objeto que encapsula o resultado da solicitação.

    Tipo de dados: objeto

    "result": {
  "errors": [Array],
  "result": "String"
}
    resultado.erros Lista de objetos na qual cada objeto representa um erro encontrado ao processar a solicitação.

    Tipo de dados: matriz

    "errors": [
  {
    "error": "String",
    "message": "String"
  }
]
    resultado.erros.erro Identificador de um erro de gestão de estados encontrado ao processar a solicitação.
    Valores possíveis:
    • CI_AÇÃO_JÁ_DEFINIDA
    • CI_AÇÃO_NÃO_DEFINIR
    • DUPLICATE_CI_ACTION_RECORD
    • DUPLICATE_OPS_STATE_RECORD
    • DUPLICATE_SYS_ID
    • AÇÃO_CI_INCOMPATÍVEL
    • AÇÃO_CI_INVALID
    • INVALID_DELETE
    • INVALID_INPUT_PARAMETERS
    • INVALID_LEASETTIME
    • INVALID_OPS_STATE
    • INVÁLIDA_OPS_STATE_TRANSITION
    • SOLICITADOR_INVALID
    • SOLICITADOR_INVALID_PAR_CI
    • SYS_ID_INVALID
    • MUTEX_INDISPONÍVEL
    • AÇÃO_DE_CI_NÃO_PERMITIDA
    • OPS_STATE_NOT_SET
    • UNPRIORITIZED_OPS_STATE
    • UNSUPPORTED_SYS_ID

    Tipo de dados: cadeia de caracteres
    resultado.erros.mensagem Mensagem fornecendo detalhes sobre o errorassociado.

    Tipo de dados: cadeia de caracteres
    resultado.resultado Sinalizador que indica se a ação de IC foi definida para todos os ICs na lista.
    Valores possíveis:
    • verdadeiro: as ações de IC foram definidas.
    • falso: as ações de IC não foram definidas.

    Tipo de dados: cadeia de caracteres

    Solicitação de cURL

    Adicione uma ação de IC de patch a dois ICs.

    curl --request POST \
"https://instance.service-now.com/api/now/cilifecyclemgmt/actions?actionName=Patching&requestorId=621b5a09309e5010f877773aa7167c0a&sysIds=00a9a80d3790200044e0bfc8bcbe5d1c,d0fdbc8437201000deeabfc8bcbe5d33" \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--user "username":"password"
    {
  "result": {
    "result": true
  }
}

    Gestão de ciclo de vida do IC - POST /now/cilifecyclemgmt/operators

    Registra um operador para um usuário sem fluxo de trabalho.

    Formato da URL

    URL com controle de versão: /api/now/{api_version}/cilifecyclemgmt/operators

    URL padrão: /api/now/cilifecyclemgmt/operators

    Nota:
    As versões disponíveis são especificadas no Explorador de REST API. Para REST APIs com script, há informações adicionais sobre a versão no formulário Serviço REST com script.

    Parâmetros de solicitação compatíveis

    Tabela 67. Parâmetros de caminho
    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
    Tabela 68. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 69. Parâmetros do corpo da solicitação (XML ou JSON)
    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.

    Tabela 70. Cabeçalhos da solicitação
    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
    Tabela 71. Cabeçalhos de resposta
    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.

    Tabela 72. Códigos de status
    Código do status Descrição
    200 Bem-sucedido. A solicitação foi processada com sucesso pelo endpoint.

    Revise o parâmetro do corpo da resposta result.result para verificar o resultado da operação.

    Se o endpoint encontrar erros ao processar a solicitação, os códigos e mensagens de erro serão exibidos no parâmetro do corpo da resposta result.errors.
    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
    resultado Objeto que encapsula o resultado da solicitação.

    Tipo de dados: objeto

    "result": {
  "errors": [Array],
  "result": "String"
}
    resultado.erros Lista de objetos na qual cada objeto representa um erro encontrado ao processar a solicitação.

    Tipo de dados: matriz

    "errors": [
  {
    "error": "String",
    "message": "String"
  }
]
    resultado.erros.erro Identificador de um erro de gestão de estados encontrado ao processar a solicitação.
    Valores possíveis:
    • CI_AÇÃO_JÁ_DEFINIDA
    • CI_AÇÃO_NÃO_DEFINIR
    • DUPLICATE_CI_ACTION_RECORD
    • DUPLICATE_OPS_STATE_RECORD
    • DUPLICATE_SYS_ID
    • AÇÃO_CI_INCOMPATÍVEL
    • AÇÃO_CI_INVALID
    • INVALID_DELETE
    • INVALID_INPUT_PARAMETERS
    • INVALID_LEASETTIME
    • INVALID_OPS_STATE
    • INVÁLIDA_OPS_STATE_TRANSITION
    • SOLICITADOR_INVALID
    • SOLICITADOR_INVALID_PAR_CI
    • SYS_ID_INVALID
    • MUTEX_INDISPONÍVEL
    • AÇÃO_DE_CI_NÃO_PERMITIDA
    • OPS_STATE_NOT_SET
    • UNPRIORITIZED_OPS_STATE
    • UNSUPPORTED_SYS_ID

    Tipo de dados: cadeia de caracteres
    resultado.erros.mensagem Mensagem fornecendo detalhes sobre o errorassociado.

    Tipo de dados: cadeia de caracteres
    result.requestorId GUID do operador registrado. Use este valor para definir ações de IC e estados operacionais.

    Tipo de dados: cadeia de caracteres
    resultado.resultado Sinalizador que indica se o operador foi registrado com sucesso.
    Valores possíveis:
    • verdadeiro: o operador foi registrado com sucesso.
    • falso: o operador não foi registrado com sucesso.

    Tipo de dados: cadeia de caracteres

    Solicitação de cURL

    curl --request POST \
"https://instance.service-now.com/api/now/cilifecyclemgmt/operators" \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--user "username":"password"
    {
  "result": {
    "result": true,
    "requestorId": "6f992b8430121010f877773aa7167c42"
  }
}

    Gestão de ciclo de vida do IC - POST /now/cilifecyclemgmt/statuses

    Define o estado operacional de uma lista especificada de itens de configuração (ICs).

    Formato da URL

    URL com controle de versões: /api/now/{api_version}/cilifecyclemgmt/statuses

    URL padrão: /api/now/cilifecyclemgmt/statuses

    Nota:
    As versões disponíveis são especificadas no Explorador de REST API. Para REST APIs com script, há informações adicionais sobre a versão no formulário Serviço REST com script.

    Parâmetros de solicitação compatíveis

    Tabela 73. Parâmetros de caminho
    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
    Tabela 74. Parâmetros de consulta
    Nome Descrição
    oldOpsLabels Lista separada por vírgulas de estados operacionais de ICs antigos na qual todos os ICs devem ser incluídos.

    Tipo de dados: cadeia de caracteres
    opsLabel Obrigatório. Rótulo do estado operacional a ser definido para os ICs especificados.

    Tipo de dados: cadeia de caracteres
    ID do solicitante Obrigatório. Sys_id de um contexto de fluxo de trabalho ou um ID de usuário do operador retornado do endpoint Gestão de ciclo de vida do IC - POST /now/cilifecyclemgmt/operators.

    Os IDs de usuário do operador estão localizados na tabela Usuários registrados do estado do IC [statemgmt_register_users].

    Tipo de dados: cadeia de caracteres
    sysIds Obrigatório. Lista separada por vírgulas de sys_ids de ICs para os quais o estado operacional deve ser definido.

    Tipo de dados: cadeia de caracteres
    Tabela 75. Parâmetros do corpo da solicitação (XML ou JSON)
    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.

    Tabela 76. Cabeçalhos da solicitação
    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
    Tabela 77. Cabeçalhos de resposta
    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.

    Tabela 78. Códigos de status
    Código do status Descrição
    200 Bem-sucedido. A solicitação foi processada com sucesso pelo endpoint.

    Revise o parâmetro do corpo da resposta result.result para verificar o resultado da operação.

    Se o endpoint encontrar erros ao processar a solicitação, os códigos e mensagens de erro serão exibidos no parâmetro do corpo da resposta result.errors.
    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
    resultado Objeto que encapsula o resultado da solicitação.

    Tipo de dados: objeto

    "result": {
  "errors": [Array],
  "result": "String"
}
    resultado.erros Lista de objetos na qual cada objeto representa um erro encontrado ao processar a solicitação.

    Tipo de dados: matriz

    "errors": [
  {
    "error": "String",
    "message": "String"
  }
]
    resultado.erros.erro Identificador de um erro de gestão de estados encontrado ao processar a solicitação.
    Valores possíveis:
    • CI_AÇÃO_JÁ_DEFINIDA
    • CI_AÇÃO_NÃO_DEFINIR
    • DUPLICATE_CI_ACTION_RECORD
    • DUPLICATE_OPS_STATE_RECORD
    • DUPLICATE_SYS_ID
    • AÇÃO_CI_INCOMPATÍVEL
    • AÇÃO_CI_INVALID
    • INVALID_DELETE
    • INVALID_INPUT_PARAMETERS
    • INVALID_LEASETTIME
    • INVALID_OPS_STATE
    • INVÁLIDA_OPS_STATE_TRANSITION
    • SOLICITADOR_INVALID
    • SOLICITADOR_INVALID_PAR_CI
    • SYS_ID_INVALID
    • MUTEX_INDISPONÍVEL
    • AÇÃO_DE_CI_NÃO_PERMITIDA
    • OPS_STATE_NOT_SET
    • UNPRIORITIZED_OPS_STATE
    • UNSUPPORTED_SYS_ID

    Tipo de dados: cadeia de caracteres
    resultado.erros.mensagem Mensagem fornecendo detalhes sobre o errorassociado.

    Tipo de dados: cadeia de caracteres
    resultado.resultado Sinalizador que indica se o estado desejado foi definido para todos os ICs incluídos na solicitação.
    Valores possíveis:
    • verdadeiro: conjunto de estados operacionais.
    • falso: estado operacional não definido.

    Tipo de dados: cadeia de caracteres

    Solicitação de cURL

    Defina o estado operacional Reparo em andamento para dois ICs.

    curl --request POST \
"https://instance.service-now.com/api/now/cilifecyclemgmt/statuses?opsLabel=Repair%20in%20Progress&requestorId=23d58bc030121010f877773aa7167c83&sysIds=affd3c8437201000deeabfc8bcbe5dc3,aac0b1213784200044e0bfc8bcbe5de3" \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--user "username":"password"

    O corpo da resposta mostra que o estado operacional desejado foi definido para ambos os ICs especificados na solicitação.

    {
  "result": {
    "result": true
  }
}