Instalar API de item-base

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

    • A API Item-base de instalação fornece endpoints para acessar e gerenciar registros de itens-base de instalação em uma instância ServiceNow.

    Um item-base de instalação representa uma instância de um produto que foi configurado para um cliente. Os itens-base de instalação permitem rastrear todas as compras feitas por um cliente.

    Você também pode executar operações CRUD na lista relacionada Partes relacionadas à base de instalação usando esta API. Além disso, você pode ler registros em outras listas relacionadas a itens-base de instalação, como casos, contratos, direitos, planos de manutenção, produtos vendidos e ordens de serviço.

    Para acessar esta API, você deve ter a função sn_install_base.ib_api_write ou sn_install_base.ib_api_read, dependendo do tipo de ação CRUD que está tentando executar.

    Para acessar os vários endpoints nesta API, os seguintes plug-ins devem ser instalados:
    • Gestão da base de instalação do Atendimento ao cliente (com.snc.install_base)
    • Gestão de trabalho planejado (sn_fsm_planned_wm) se você quiser recuperar dados do plano de manutenção e da ordem de serviço.

    Esta API é executada no namespace sn_install_base.

    Nota:
    Esta API retorna somente campos não vazios nas respostas do endpoint. Além disso, nenhum dos campos de nível de sistema (aqueles precedidos por "sys_") é retornado, exceto o campo sys_id.

    Para obter informações adicionais sobre itens-base de instalação, consulte Create an install base item.

    Item-base de instalação - DELETE /sn_install_base/integrations/installbaseitems/{id}/relatedparties/{related_party_sys_id}

    Desassocia um registro de partes relacionadas especificado de um registro de item-base de instalação especificado.

    Formato da URL

    URL com controle de versão: /api/sn_install_base/{api_version}/integrations/installbaseitems/{id}/relatedparties/{related_party_sys_id}

    URL padrão: /api/sn_install_base/integrations/installbaseitems/{id}/relatedparties/{related_party_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 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
    id Sys_id do registro do item-base de instalação.

    Tipo de dados: cadeia de caracteres

    Tabela: item-base de instalação [sn_install_base_item]
    related_party_sys_id Sys_id do registro de parte relacionada.

    Tipo de dados: cadeia de caracteres

    Tabela: Parte relacionada à base de instalação [sn_install_base_related_party]
    Tabela 2. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    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.
    403 Proibido. O usuário não tem direitos de acesso ao registro especificado.
    404 Não encontrado. O item solicitado não foi encontrado.
    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
    erro Detalhes sobre o erro que ocorreu ao tentar processar a solicitação.

    Tipo de dados: objeto

    "error": {
  "detail": "String",
  "message": "String"
}
    erro.detalhe Detalhes adicionais sobre o erro associado.

    Tipo de dados: cadeia de caracteres
    mensagem.erro Mensagem de erro que descreve o problema que ocorreu ao tentar executar a solicitação.

    Tipo de dados: cadeia de caracteres
    resultado Descrição dos resultados do endpoint.

    Tipo de dados: objeto
    resultado.status Status da solicitação de endpoint.

    Valores possíveis:

    • SUCESSO
    • FALHA

    Tipo de dados: cadeia de caracteres

    Solicitação de cURL

    O exemplo de código a seguir mostra como chamar este endpoint.

    curl "https://instance.servicenow.com/api/sn_install_base/integrations/installbaseitems/f77c7542b7343300ece839a6ee11a991/relatedparties/2a42dfae872521100b6afc86dabb356b" \
--request DELETE \
--header "Accept:application/json" \
--user 'username':'password'

    Retornar resultados:

    {
  "result": {
    "status": "SUCCESS"
  }
}

    Item-base de instalação - GET /sn_install_base/integrations/installbaseitems

    Retorna todos os itens-base de instalação. Você pode passar parâmetros na chamada para filtrar os resultados de retorno.

    Formato da URL

    URL com controle de versões: /api/sn_install_base/{api_version}/integrations/installbaseitems

    URL padrão: /api/sn_install_base/integrations/installbaseitems

    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
    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 8. Parâmetros de consulta
    Nome Descrição
    pares de nome-valor de campo Pares de campo-valor a serem usados para filtrar os registros do item-base de instalação. Se você especificar uma tabela diferente em sys_class_name, especifique os campos nessa tabela.

    Você pode passar um ou mais pares de valores de campo para filtrar os resultados retornados.

    Por exemplo, para retornar somente registros em que o campo de estado está definido como "in_use" e o campo de status está definido como "replacement", passe o seguinte: &state=in_use&status=replacement.

    Tipo de dados: cadeia de caracteres

    Padrão: todos os campos

    Tabela: item-base de instalação [sn_istall_base_item]
    relacionado_parte Sys_id de um registro de parte relacionada.

    Filtra os registros do item-base de instalação com base na parte relacionada especificada. Uma parte relacionada pode ser vinculada a um item-base de instalação ou a um produto vendido.

    Valores válidos:
    • sys_id da conta: localizado na tabela Conta [customer_account].
    • sys_id do consumidor: localizado na tabela Consumidor [csm_consumer].
    • sys_id do contato: localizado na tabela Contato [contato-do-cliente].
    • sys_id da organização de serviço: localizado na tabela Organização de serviço [sn_customer_service_organization].
    • sys_id do usuário: localizado na tabela Usuário [sys-user].

    Tipo de dados: cadeia de caracteres

    Tabela: Parte relacionada à base de instalação [sn_install_base_related_party]
    responsabilidade Sys_id do registro de responsabilidade associado. Este registro define o nível de acesso às informações da base de instalação.

    Este parâmetro só será válido se o campo related_party também for especificado. Se especificado, ele retornará somente os itens-base de instalação que correspondam aos parâmetros related_party e responsibility.

    Para obter informações adicionais, confira Configure related parties for items received.

    Tipo de dados: cadeia de caracteres
    sys_class_name Se os registros desejados estiverem em uma tabela que estende a tabela Itens-base de instalação [sn_install_base_item], o nome da tabela estendida a ser consultada.

    Tipo de dados: cadeia de caracteres
    sysparm_limit Número máximo de registros a serem retornados. Para solicitações que excedem esse número de registros, use o parâmetro sysparm_offset para paginar a recuperação do registro.

    Este limite é aplicado antes da avaliação da ACL. Se nenhum registro for retornado, incluindo os registros aos quais você tem acesso, reorganize a ordem dos registros para que os registros aos quais você tem acesso sejam retornados primeiro.

    Nota:
    Valores sysparm_limit extraordinariamente grandes podem afetar o desempenho do sistema.

    Tipo de dados: número

    Padrão: 20

    Máximo: 100
    sysparm_offset Índice de registro inicial para o qual a recuperação de registros será iniciada. Use este valor para paginar a recuperação do registro. Essa funcionalidade permite a recuperação de todos os registros, independentemente do número de registros, em pequenos blocos gerenciáveis.

    Por exemplo, na primeira vez que você chama este endpoint, sysparm_offset é definido como "0". Para simplesmente percorrer todos os registros disponíveis, use sysparm_offset=sysparm_offset+sysparm_limitaté chegar ao fim de todos os registros.

    Não passe um número negativo no parâmetro sysparm_offset.

    Tipo de dados: número

    Padrão: 0
    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.
    400 Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada.
    403 Proibido. O usuário não tem direitos de acesso ao registro especificado.
    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)

    Os resultados de retorno a seguir descrevem somente os valores de retorno dos registros retornados da tabela Itens-base de instalação [sn_install_base_items].

    Nome Descrição
    erro Detalhes sobre o erro que ocorreu ao tentar processar a solicitação.

    Tipo de dados: objeto

    "error": {
  "detail": "String",
  "message": "String"
}
    erro.detalhe Detalhes adicionais sobre o erro associado.

    Tipo de dados: cadeia de caracteres
    mensagem.erro Mensagem de erro que descreve o problema que ocorreu ao tentar executar a solicitação.

    Tipo de dados: cadeia de caracteres
    tem_mais Sinalizador que indica se há mais registros na tabela a serem retornados.
    Valores possíveis:
    • verdadeiro: mais registros a serem retornados.
    • falso: não há mais registros a serem retornados.

    Tipo de dados: cadeia de caracteres booliana
    itens Lista dos itens-base de instalação que corresponderam aos resultados do filtro especificados.

    Tipo de dados: matriz de objetos

    "items":[
  {
    "account": {Object},
    "active": "String",
    "asset": {Object},
    "configuration_item": {Object},
    "consumer": {Object},
    "consumer_profile": {Object},
    "contact": {Object},
    "health_status": {Object},
    "health_status_last_updated": "String",
    "household": {Object},
    "install_date": {Object},
    "location": {Object},
    "name": "String",
    "number": "String",
    "parent": {Object},
    "product": {Object},
    "service_context": {Object},
    "service_organization" {Object},
    "sys_class_name": "String",
    "sys_id": "String",
    "sys_mod_count": "String",
    "state": {Object},
    "status": {Object},
    "uninstall_date": "String"
  }
]
    itens.conta Detalhes sobre a conta do cliente associada ao registro do item-base de instalação.

    Tipo de dados: objeto

    "account": {
  "display_value": "String",
  "sys_id": "String"
}
    itens.conta.display_value Nome de texto da conta do cliente associada ao registro do item-base de instalação. Use este valor para exibir o nome da conta do cliente na IU.

    Tipo de dados: cadeia de caracteres
    itens.conta.sys_id Sys_id do registro de conta do cliente associado ao registro do item-base de instalação.

    Tipo de dados: cadeia de caracteres
    itens.ativos Sinalizador que indica se o item-base de instalação está ativo.
    Valores possíveis:
    • verdadeiro: o item-base de instalação está ativo.
    • falso: o item-base de instalação está inativo.

    Tipo de dados: cadeia de caracteres booliana
    itens.ativo Detalhes sobre o ativo associado ao registro do item-base de instalação.

    Tipo de dados: objeto

    "asset": {
  "display_value": "String",
  "sys_id": "String"
}
    itens.ativo.display_value Nome de texto do ativo associado ao registro do item-base de instalação. Use este valor para exibir o nome do ativo na IU.

    Tipo de dados: cadeia de caracteres
    itens.asset.sys_id Sys_id do registro de ativo associado ao registro do item-base de instalação.

    Tipo de dados: cadeia de caracteres
    itens.item_de_configuração Detalhes sobre o item de configuração associado ao registro do item-base de instalação.

    Tipo de dados: objeto

    "configuration_item": {
  "display_value": "String",
  "sys_id": "String"
}
    itens.configuration_item.display_value Nome de texto do item de configuração associado ao registro do item-base de instalação. Use este valor para exibir o nome do item de configuração na IU.

    Tipo de dados: cadeia de caracteres
    itens.configuration_item.sys_id Sys_id do registro do item de configuração associado ao registro do item-base de instalação.

    Tipo de dados: cadeia de caracteres
    itens.consumidor Detalhes sobre o consumidor associado ao registro do item-base de instalação.
    Nota:
    O campo do consumidor só estará disponível se o plug-in B2B2C estiver instalado.

    Tipo de dados: objeto

    "consumer": {
  "display_value": "String",
  "sys_id": "String"
}
    itens.consumidor.display_value Nome em texto do consumidor associado ao registro do item-base de instalação. Use este valor para exibir o nome do consumidor na IU.

    Tipo de dados: cadeia de caracteres
    itens.consumer.sys_id Sys_id do registro do consumidor associado ao registro do item-base de instalação.

    Tipo de dados: cadeia de caracteres
    itens.consumer_profile Detalhes sobre o perfil do consumidor associado ao registro do item-base de instalação.
    Nota:
    O campo de perfil do consumidor só estará disponível se o plug-in B2B2C estiver instalado.

    Tipo de dados: objeto

    "consumer_profile": {
  "display_value": "String",
  "sys_id": "String"
}
    itens.consumer_profile.display_value Nome de texto do perfil do consumidor associado ao registro do item-base de instalação. Use este valor para exibir o nome do perfil do consumidor na IU.

    Tipo de dados: cadeia de caracteres
    itens.consumer_profile.sys_id Sys_id do registro de perfil do consumidor associado ao registro do item-base de instalação.

    Tipo de dados: cadeia de caracteres
    itens.contato Detalhes sobre o contato da conta responsável pelo registro do item-base de instalação.

    Tipo de dados: objeto

    "contact": {
  "display_value": "String",
  "sys_id": "String"
}
    itens.contato.display_value Nome de texto do contato da conta associado ao registro do item-base de instalação. Use este valor para exibir o nome do contato da conta na IU.

    Tipo de dados: cadeia de caracteres
    itens.contato.sys_id Sys_id do registro de contato da conta associado ao registro do item-base de instalação.

    Tipo de dados: cadeia de caracteres
    itens.status_de_saúde Detalhes sobre o status de integridade atual do item-base de instalação. Retornado somente se o plug-in Operações proativas de atendimento ao cliente (com.snc.proactive_cs_itom) estiver instalado.

    Tipo de dados: objeto

    "health_status": {
  "display_value": "String",
  "value": "String"
}
    itens.status_de_saúde.valor_de_display Cadeia de caracteres de texto do status de integridade atual do item-base de instalação. Use este valor para exibir o status de integridade na IU.

    Tipo de dados: cadeia de caracteres
    itens.status_de_saúde.valor Valor interno do status de integridade do item-base de instalação.

    Tipo de dados: cadeia de caracteres
    itens.status_de_saúde_último_atualizado Data e hora em que o status de integridade foi atualizado pela última vez para o item-base de instalação.

    Tipo de dados: cadeia de caracteres
    itens.residência Detalhes sobre a residência associada ao registro do item-base de instalação. Retornado somente se o plug-in Residência do Atendimento ao cliente (com.snc.household) estiver instalado.

    Tipo de dados: objeto

    "household": {
  "display_value": "String",
  "sys_id": "String"
}
    itens.household.display_value Nome em texto da residência associada ao registro do item-base de instalação. Use este valor para exibir o nome da residência na IU.

    Tipo de dados: cadeia de caracteres
    itens.household.sys_id Sys_id da residência associada ao registro do item-base de instalação.

    Tipo de dados: cadeia de caracteres
    itens.install_date Detalhes sobre a data em que o item-base de instalação se tornou ativo.

    Tipo de dados: objeto

    "install_date": {
  "display_value": "String",
  "value": "String"
}
    itens.install_date.display_value Data de instalação de texto. Use este valor para exibir a data de instalação na IU.

    Tipo de dados: cadeia de caracteres
    itens.install_date.value Valor interno da data de instalação.

    Tipo de dados: cadeia de caracteres
    itens.local Detalhes sobre o local do item-base de instalação.

    Tipo de dados: objeto

    "location": {
  "display_value": "String",
  "sys_id": "String"
}
    itens.local.display_value Nome de texto do local do item-base de instalação. Use este valor para exibir o nome do local na IU.

    Tipo de dados: cadeia de caracteres
    itens.local.sys_id Sys_id do registro de local associado ao registro do item-base de instalação.

    Tipo de dados: cadeia de caracteres
    items.name Nome do item-base de instalação.

    Tipo de dados: cadeia de caracteres
    itens.número ID exclusivo do item-base de instalação.

    Tipo de dados: cadeia de caracteres
    itens.primário Detalhes sobre o registro primário do registro do item-base de instalação.

    Tipo de dados: objeto

    "parent": {
  "display_value": "String",
  "sys_id": "String"
}
    itens.primário.display_value Nome de texto do registro primário associado ao registro do item-base de instalação. Use este valor para exibir o nome primário na IU.

    Tipo de dados: cadeia de caracteres
    itens.parent.sys_id Sys_id do registro primário associado ao registro do item-base de instalação.

    Tipo de dados: cadeia de caracteres
    itens.produto Detalhes sobre o modelo de produto associado ao registro do item-base de instalação. Use essas informações para identificar os serviços associados a qualquer modelo de produto.

    Tipo de dados: objeto

    "product": {
  "display_value": "String",
  "sys_id": "String"
}
    itens.produto.display_value Nome de texto do modelo de produto associado ao registro do item-base de instalação. Use este valor para exibir o nome do produto na IU.

    Tipo de dados: cadeia de caracteres
    itens.produto.sys_id Sys_id do registro do modelo do produto associado ao registro do item-base de instalação.

    Tipo de dados: cadeia de caracteres
    itens.service_context Detalhes sobre o contexto de serviço associado ao registro do item-base de instalação.

    Tipo de dados: objeto

    "service_context": {
  "display_value": "String",
  "sys_id": "String"
}
    itens.service_context.display_value Nome de texto do contexto de serviço associado ao registro do item-base de instalação. Use este valor para exibir o nome do contexto de serviço na IU.

    Tipo de dados: cadeia de caracteres
    itens.service_context.sys_id Sys_id do registro de contexto de serviço associado ao registro do item-base de instalação.

    Tipo de dados: cadeia de caracteres
    itens.serviço_organização Detalhes sobre a organização de serviço associada ao registro do item-base de instalação. Retornado somente se o plug-in Organização de serviço (com.snc.service_organization) estiver instalado.

    Tipo de dados: objeto

    "service_organization": {
  "display_value": "String",
  "sys_id": "String"
}
    itens.service_organization.display_value Nome de texto da organização de serviço associada ao registro do item-base de instalação. Use este valor para exibir o nome da organização de serviço na IU.

    Tipo de dados: cadeia de caracteres
    itens.service_organization.sys_id Sys_id do registro da organização de serviço associado ao registro do item-base de instalação.

    Tipo de dados: cadeia de caracteres
    itens.sys_class_name Tabela que contém o registro do item-base de instalação.

    Tipo de dados: cadeia de caracteres
    itens.sys_id Sys_id do registro do item-base de instalação. Localizado na tabela especificada no parâmetro sys_class_name.

    Tipo de dados: cadeia de caracteres
    itens.sys_mod_count Número de vezes em que o registro do item-base de instalação associado foi modificado.

    Tipo de dados: cadeia de caracteres
    itens.estado Detalhes sobre o estado atual do item-base de instalação.

    Tipo de dados: objeto

    "state": {
  "display_value": "String",
  "value": "String"
}
    itens.estado.display_value Cadeia de caracteres de texto do estado atual do item-base de instalação. Use este valor para exibir o estado na IU.

    Tipo de dados: cadeia de caracteres
    itens.estado.valor Valor interno do estado do item-base de instalação.

    Tipo de dados: cadeia de caracteres
    itens.status Detalhes sobre o status do item-base de instalação.

    Tipo de dados: objeto

    "status": {
  "display_value": "String",
  "value": "String"
}
    itens.status.display_value Cadeia de caracteres de texto do status do item-base de instalação. Use este valor para exibir o status na IU.

    Tipo de dados: cadeia de caracteres
    itens.status.valor Valor interno do status do item-base de instalação.

    Tipo de dados: cadeia de caracteres
    itens.uninstall_date Detalhes sobre a data em que o item-base de instalação se tornou inativo.

    Tipo de dados: objeto

    "uninstall_date": {
  "display_value": "String",
  "value": "String"
}
    itens.uninstall_date.display_value Data de desinstalação de texto. Use este valor para exibir a data de desinstalação na IU.

    Tipo de dados: cadeia de caracteres
    itens.uninstall_date.value Valor interno da data de desinstalação.

    Tipo de dados: cadeia de caracteres
    status Status da chamada do endpoint.

    Tipo de dados: cadeia de caracteres
    sysparm_profundidade Número de níveis de profundidade em que o item-base de instalação secundário retornado está na hierarquia.

    Tipo de dados: inteiro
    sysparm_limit Número de registros retornados. Se este valor não for especificado na solicitação original, ele usará o valor padrão.

    Tipo de dados: número
    sysparm_offset Deslocamento (ponto de partida) na tabela associada da qual os registros foram avaliados e recuperados.

    Tipo de dados: cadeia de caracteres

    Solicitação de cURL

    O exemplo de código a seguir mostra uma chamada simples que retorna somente um único registro que começa no deslocamento 5.

    curl "https://instance.servicenow.com/api/sn_install_base/v1/integrations/installbaseitems?sysparm_limit=1&sysparm_offset=5" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

    Retornar resultados:

    {
  "result": {
    "sysparm_offset": "5",
    "sysparm_limit": 1,
    "has_more": true,
    "items": [
      {
        "sys_class_name": "sn_install_base_item",
        "number": "IBITM001100",
        "sys_id": "181df7ff530a1110539dddeeff7b12f4",
        "state": {
          "value": "in_use",
          "display_value": "In Use"
        },
        "sys_mod_count": "2",
        "active": "true",
        "configuration_item": {
          "sys_id": "62446ae8535e5510539dddeeff7b12db",
          "display_value": "boxeoproderp"
        },
        "name": "boxeoproderp",
        "account": {
          "sys_id": "86837a386f0331003b3c498f5d3ee4ca",
          "display_value": "Boxeo"
        }
      }
    ],
    "status": "SUCCESS"
  }
}

    Solicitação de cURL

    O exemplo de código a seguir mostra como pesquisar os campos state = "in_use" e status = "replacement" na tabela Item-base de instalação.

    curl "https://instance.servicenow.com/api/sn_install_base/integrations/installbaseitems?state=in_use&status=replacement" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

    Retornar resultados:

    {
  "result": {
    "sysparm_offset": "0",
    "sysparm_limit": "10",
    "has_more": false,
    "items": [
      {
        "parent": {
          "sys_id": "ffd023f453de9910539dddeeff7b1264",
          "display_value": "Point of Sale System"
        },
        "sys_class_name": "sn_install_base_item",
        "number": "IBITM001140",
        "sys_id": "a1a123745312d910539dddeeff7b127b",
        "state": {
          "value": "in_use",
          "display_value": "In Use"
        },
        "install_date": {
          "value": "2018-12-14 07:00:00",
          "display_value": "2018-12-13 23:00:00"
        },
        "product": {
          "sys_id": "2dd1e7b753421110539dddeeff7b12d1",
          "display_value": "Stand"
        },
        "active": "true",
        "name": "Stand",
        "service_organization": {
          "sys_id": "42b51f5ab3401010700b4d43c6a8dc5a",
          "display_value": "LA City Center - West"
        },
        "status": {
          "value": "replacement",
          "display_value": "Replacement"
        }
      },
      {
        "parent": {
          "sys_id": "ffd023f453de9910539dddeeff7b1264",
          "display_value": "Point of Sale System"
        },
        "sys_class_name": "sn_install_base_item",
        "number": "IBITM001139",
        "sys_id": "d0916bb05312d910539dddeeff7b1232",
        "state": {
          "value": "in_use",
          "display_value": "In Use"
        },
        "install_date": {
          "value": "2018-12-14 07:00:00",
          "display_value": "2018-12-13 23:00:00"
        },
        "product": {
          "sys_id": "dfc127b753421110539dddeeff7b12ac",
          "display_value": "Register"
        },
        "active": "true",
        "name": "Register",
        "service_organization": {
          "sys_id": "42b51f5ab3401010700b4d43c6a8dc5a",
          "display_value": "LA City Center - West"
        },
        "status": {
          "value": "replacement",
          "display_value": "Replacement"
        }
      },
      {
        "parent": {
          "sys_id": "ffd023f453de9910539dddeeff7b1264",
          "display_value": "Point of Sale System"
        },
        "sys_class_name": "sn_install_base_item",
        "number": "IBITM001141",
        "sys_id": "ffb123745312d910539dddeeff7b12cb",
        "state": {
          "value": "in_use",
          "display_value": "In Use"
        },
        "install_date": {
          "value": "2018-12-14 07:00:00",
          "display_value": "2018-12-13 23:00:00"
        },
        "product": {
          "sys_id": "59e1e7b753421110539dddeeff7b12cc",
          "display_value": "Terminal"
        },
        "active": "true",
        "name": "Terminal",
        "service_organization": {
          "sys_id": "42b51f5ab3401010700b4d43c6a8dc5a",
          "display_value": "LA City Center - West"
        },
        "status": {
          "value": "replacement",
          "display_value": "Replacement"
        }
      }
    ],
    "status": "SUCCESS"
  }
}

    Solicitação de cURL

    O exemplo de código a seguir mostra como filtrar os resultados retornados usando os parâmetros de consulta related_party e responsibility.

    curl "https://instance.servicenow.com/api/sn_install_base/integrations/installbaseitems?related_party=dc0185d94f341200025ba3618110c77c&responsibility=c009bbedb3730010700b4d43c6a8dce" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

    Retornar resultados:

    {
  "result": {
    "sysparm_offset": "0",
    "sysparm_limit": "10",
    "has_more": false,
    "items": [
      {
        "sys_class_name": "sn_install_base_item",
        "number": "IBITM0001004",
        "sys_id": "3ea014a778de1110f877d304c76fdd0d",
        "state": {
          "value": "in_use",
          "display_value": "In Use"
        },
        "consumer": {
          "sys_id": "feb5139ab3401010700b4d43c6a8dc43",
          "display_value": "Kenny Smith"
        },
        "product": {
          "sys_id": "63c8bc9778921110f877d304c76fdd34",
          "display_value": "X4 Sport Utility 4D"
        },
        "active": "true",
        "name": "X4 Sport Utility 4D",
        "status": {
          "value": "original",
          "display_value": "Original"
        }
      },
      {
        "sys_class_name": "sn_install_base_item",
        "number": "IBITM001003",
        "sys_id": "6e94e3c853500010df5dddeeff7b1234",
        "contact": {
          "sys_id": "4d147a386f0331003b3c498f5d3ee437",
          "display_value": "Julie Lewis"
        },
        "active": "true",
        "configuration_item": {
          "sys_id": "a96a570453500010df5dddeeff7b1206",
          "display_value": "boxeosandbox"
        },
        "name": "Boxeo - Sandbox",
        "account": {
          "sys_id": "86837a386f0331003b3c498f5d3ee4ca",
          "display_value": "Boxeo"
        }
      },
      {
        "sys_class_name": "sn_install_base_item",
        "number": "IBITM0001010",
        "sys_id": "83332fde87e5a1105d0055373cbb3567",
        "contact": {
          "sys_id": "ddce70866f9331003b3c498f5d3ee417",
          "display_value": "George Warren"
        },
        "state": {
          "value": "in_use",
          "display_value": "In Use"
        },
        "install_date": {
          "value": "2023-02-26 18:59:52",
          "display_value": "2023-02-26 10:59:52"
        },
        "health_status": {
          "value": "not_available",
          "display_value": "Not Available"
        },
        "product": {
          "sys_id": "a9a2d0c3c6112276010db16c5ddd3461",
          "display_value": "Lenovo ThinkStation S20"
        },
        "active": "true",
        "configuration_item": {
          "sys_id": "affd3c8437201000deeabfc8bcbe5dc3",
          "display_value": "*BETH-IBM"
        },
        "name": "IB B2B",
        "location": {
          "sys_id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
          "display_value": "100 South Charles Street, Baltimore,MD"
        },
        "asset": {
          "sys_id": "bfc1fa8837f3100044e0bfc8bcbe5ddf",
          "display_value": "P1000228 - Lenovo ThinkStation S20"
        },
        "account": {
          "sys_id": "86837a386f0331003b3c498f5d3ee4ca",
          "display_value": "Boxeo"
        },
        "status": {
          "value": "original",
          "display_value": "Original"
        }
      },
      {
        "sys_class_name": "sn_install_base_item",
        "number": "IBITM0001011",
        "sys_id": "9d766f168729a1105d0055373cbb3597",
        "health_status": {
          "value": "not_available",
          "display_value": "Not Available"
        },
        "product": {
          "sys_id": "8583ce8237732000158bbfc8bcbe5dd9",
          "display_value": "Fujitsu 1TB Hybrid Solid State Drive"
        },
        "active": "true",
        "name": "IBA",
        "account": {
          "sys_id": "86837a386f0331003b3c498f5d3ee4ca",
          "display_value": "Boxeo"
        }
      },
      {
        "sys_class_name": "sn_install_base_item",
        "number": "IBITM0001013",
        "sys_id": "bd955a2687ada1100b6afc86dabb35fb",
        "health_status": {
          "value": "not_available",
          "display_value": "Not Available"
        },
        "consumer": {
          "sys_id": "59e788fbdb1b1200b6075200cf9619d2",
          "display_value": "Gilly Parker"
        },
        "product": {
          "sys_id": "1a13974053500010df5dddeeff7b122c",
          "display_value": "12000XHD Digital Press"
        },
        "active": "true",
        "name": "IBConsumer"
      },
      {
        "sys_class_name": "sn_install_base_item",
        "number": "IBITM0000901",
        "sys_id": "f77c7542b7343300ece839a6ee11a991",
        "product": {
          "sys_id": "8583ce8237732000158bbfc8bcbe5dd9",
          "display_value": "Fujitsu 1TB Hybrid Solid State Drive"
        },
        "active": "true",
        "name": "KX Series - KX5001",
        "account": {
          "sys_id": "86837a386f0331003b3c498f5d3ee4ca",
          "display_value": "Boxeo"
        }
      }
    ],
    "status": "SUCCESS"
  }
}

    Item-base de instalação - GET /sn_install_base/integrations/installbaseitem/{id}

    Retorna um registro de item-base de instalação especificado e sua hierarquia secundária.

    Formato da URL

    URL com controle de versões: /api/sn_install_base/{api_version}/integrations/installbaseitem/{id}

    URL padrão: /api/sn_install_base/integrations/installbaseitem/{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
    id Sys_id do registro do item-base de instalação.

    Tipo de dados: cadeia de caracteres

    Tabela: item-base de instalação [sn_install_base_item]
    Tabela 14. Parâmetros de consulta
    Nome Descrição
    sys_class_name Se o registro pretendido estiver em uma tabela que estende a tabela Itens-base de instalação [sn_install_base_item], o nome da tabela estendida a ser consultada. Esta tabela deve estender a tabela sn_install_base_item.

    Tipo de dados: cadeia de caracteres
    sysparm_profundidade Profundidade máxima da hierarquia do item-base de instalação secundário a retornar.

    Tipo de dados: inteiro

    Padrão: 7

    Máximo: 10
    sysparm_limit Número máximo de registros a serem retornados em cada hierarquia secundária.

    Tipo de dados: inteiro

    Padrão: 10

    Máximo: 100
    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.
    400 Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada.
    403 Proibido. O usuário não tem direitos de acesso ao registro especificado.
    404 Não encontrado. O item solicitado não foi encontrado.
    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
    childinstallbase Lista de registros de itens-base de instalação secundários associados ao item-base de instalação especificado.

    Tipo de dados: objeto

    "childinstallbase": {
  "items": [Array],
  "sysparm_depth": Integer
}
    childinstallbase.itens Itens-base de instalação secundários associados ao item-base de instalação especificado.

    Os valores nesta matriz são definidos na matriz items[] mais abaixo nesta seção.
    childinstallbase.sysparm_profundidade Nível secundário do item-base de instalação.

    Tipo de dados: inteiro
    erro Detalhes sobre o erro que ocorreu ao tentar processar a solicitação.

    Tipo de dados: objeto

    "error": {
  "detail": "String",
  "message": "String"
}
    erro.detalhe Detalhes adicionais sobre o erro associado.

    Tipo de dados: cadeia de caracteres
    mensagem.erro Mensagem de erro que descreve o problema que ocorreu ao tentar executar a solicitação.

    Tipo de dados: cadeia de caracteres
    tem_filhos Sinalizador que indica se o registro do item-base de instalação solicitado tem registros de item-base de instalação secundários.
    • verdadeiro: tem registros de item-base de instalação secundário.
    • falso: não tem registros de item-base de instalação secundário.

    Tipo de dados: booliano
    item Item-base de instalação que correspondeu aos resultados do filtro especificados.

    Tipo de dados: objeto

    "item": {
  "account": {Object},
  "active": "String",
  "asset": {Object},
  "configuration_item": {Object},
  "consumer": {Object},
  "consumer_profile": {Object},
  "contact": {Object},
  "health_status": "Object",
  "health_status_last_updated": "String",
  "household": {Object},
  "install_date": {Object},
  "location": {Object},
  "name": "String",
  "number": "String",
  "parent": {Object},
  "product": {Object},
  "service_context": {Object},
  "service_organization" {Object},
  "sys_class_name": "String",
  "sys_id": "String",
  "state": {Object},
  "status": {Object},
  "uninstall_date": "String"
}
    item.conta Detalhes sobre a conta do cliente associada ao registro do item-base de instalação.

    Tipo de dados: objeto

    "account": {
  "display_value": "String",
  "sys_id": "String"
}
    item.account.display_value Nome de texto da conta do cliente associada ao registro do item-base de instalação. Use este valor para exibir o nome da conta do cliente na IU.

    Tipo de dados: cadeia de caracteres
    item.account.sys_id Sys_id do registro de conta do cliente associado ao registro do item-base de instalação.

    Tipo de dados: cadeia de caracteres
    item.ativo Sinalizador que indica se o item-base de instalação está ativo.
    Valores possíveis:
    • verdadeiro: o item-base de instalação está ativo.
    • falso: o item-base de instalação está inativo.

    Tipo de dados: cadeia de caracteres booliana
    item.ativo Detalhes sobre o ativo associado ao registro do item-base de instalação.

    Tipo de dados: objeto

    "asset": {
  "display_value": "String",
  "sys_id": "String"
}
    item.ativo.display_value Nome de texto do ativo associado ao registro do item-base de instalação. Use este valor para exibir o nome do ativo na IU.

    Tipo de dados: cadeia de caracteres
    item.asset.sys_id Sys_id do registro de ativo associado ao registro do item-base de instalação.

    Tipo de dados: cadeia de caracteres
    item.item_de_configuração Detalhes sobre o item de configuração associado ao registro do item-base de instalação.

    Tipo de dados: objeto

    "configuration_item": {
  "display_value": "String",
  "sys_id": "String"
}
    item.configuration_item.display_value Nome de texto do item de configuração associado ao registro do item-base de instalação. Use este valor para exibir o nome do item de configuração na IU.

    Tipo de dados: cadeia de caracteres
    item.configuration_item.sys_id Sys_id do registro do item de configuração associado ao registro do item-base de instalação.

    Tipo de dados: cadeia de caracteres
    item.consumidor Detalhes sobre o consumidor associado ao registro do item-base de instalação.
    Nota:
    O campo do consumidor só estará disponível se o plug-in B2B2C estiver instalado.

    Tipo de dados: objeto

    "consumer": {
  "display_value": "String",
  "sys_id": "String"
}
    item.consumidor.display_value Nome em texto do consumidor associado ao registro do item-base de instalação. Use este valor para exibir o nome do consumidor na IU.

    Tipo de dados: cadeia de caracteres
    item.consumer.sys_id Sys_id do registro do consumidor associado ao registro do item-base de instalação.

    Tipo de dados: cadeia de caracteres
    item.consumer_profile Detalhes sobre o perfil do consumidor associado ao registro do item-base de instalação.
    Nota:
    O campo de perfil do consumidor só estará disponível se o plug-in B2B2C estiver instalado.

    Tipo de dados: objeto

    "consumer_profile": {
  "display_value": "String",
  "sys_id": "String"
}
    item.consumer_profile.display_value Nome de texto do perfil do consumidor associado ao registro do item-base de instalação. Use este valor para exibir o nome do perfil do consumidor na IU.

    Tipo de dados: cadeia de caracteres
    item.consumer_profile.sys_id Sys_id do registro de perfil do consumidor associado ao registro do item-base de instalação.

    Tipo de dados: cadeia de caracteres
    item.contato Detalhes sobre o contato da conta responsável pelo registro do item-base de instalação.

    Tipo de dados: objeto

    "contact": {
  "display_value": "String",
  "sys_id": "String"
}
    item.contact.display_value Nome de texto do contato da conta associado ao registro do item-base de instalação. Use este valor para exibir o nome do contato da conta na IU.

    Tipo de dados: cadeia de caracteres
    item.contact.sys_id Sys_id do registro de contato da conta associado ao registro do item-base de instalação.

    Tipo de dados: cadeia de caracteres
    item.status_de_saúde Detalhes sobre o status de integridade atual do item-base de instalação. Retornado somente se o plug-in Operações proativas de atendimento ao cliente (com.snc.proactive_cs_itom) estiver instalado.

    Tipo de dados: objeto

    "health_status": {
  "display_value": "String",
  "value": "String"
}
    item.status_de_saúde.display_value Cadeia de caracteres de texto do status de integridade atual do item-base de instalação. Use este valor para exibir o status de integridade na IU.

    Tipo de dados: cadeia de caracteres
    item.status_de_saúde.valor Valor interno do status de integridade do item-base de instalação.

    Tipo de dados: cadeia de caracteres
    item.status_health_last_updated Data e hora em que o status de integridade foi atualizado pela última vez para o item-base de instalação.

    Tipo de dados: cadeia de caracteres
    item.household Detalhes sobre a residência associada ao registro do item-base de instalação. Retornado somente se o plug-in Residência do Atendimento ao cliente (com.snc.household) estiver instalado.

    Tipo de dados: objeto

    "household": {
  "display_value": "String",
  "sys_id": "String"
}
    item.household.display_value Nome em texto da residência associada ao registro do item-base de instalação. Use este valor para exibir o nome da residência na IU.

    Tipo de dados: cadeia de caracteres
    item.household.sys_id Sys_id da residência associada ao registro do item-base de instalação.

    Tipo de dados: cadeia de caracteres
    item.install_date Detalhes sobre a data em que o item-base de instalação se tornou ativo.

    Tipo de dados: objeto

    "install_date": {
  "display_value": "String",
  "value": "String"
}
    item.install_date.display_value Data de instalação de texto. Use este valor para exibir a data de instalação na IU.

    Tipo de dados: cadeia de caracteres
    item.install_date.value Valor interno da data de instalação.

    Tipo de dados: cadeia de caracteres
    item.location Detalhes sobre o local do item-base de instalação.

    Tipo de dados: objeto

    "location": {
  "display_value": "String",
  "sys_id": "String"
}
    item.location.display_value Nome de texto do local do item-base de instalação. Use este valor para exibir o nome do local na IU.

    Tipo de dados: cadeia de caracteres
    item.location.sys_id Sys_id do registro de local associado ao registro do item-base de instalação.

    Tipo de dados: cadeia de caracteres
    item_name Nome do item-base de instalação.

    Tipo de dados: cadeia de caracteres
    item.número ID exclusivo do item-base de instalação.

    Tipo de dados: cadeia de caracteres
    item.primário Detalhes sobre o registro primário do registro do item-base de instalação.

    Tipo de dados: objeto

    "parent": {
  "display_value": "String",
  "sys_id": "String"
}
    item.primário.display_value Nome de texto do registro primário associado ao registro do item-base de instalação. Use este valor para exibir o nome primário na IU.

    Tipo de dados: cadeia de caracteres
    item.parent.sys_id Sys_id do registro primário associado ao registro do item-base de instalação.

    Tipo de dados: cadeia de caracteres
    item.produto Detalhes sobre o modelo de produto associado ao registro do item-base de instalação. Use essas informações para identificar os serviços associados a qualquer modelo de produto.

    Tipo de dados: objeto

    "product": {
  "display_value": "String",
  "sys_id": "String"
}
    item.produto.display_value Nome de texto do modelo de produto associado ao registro do item-base de instalação. Use este valor para exibir o nome do produto na IU.

    Tipo de dados: cadeia de caracteres
    item.product.sys_id Sys_id do registro do modelo do produto associado ao registro do item-base de instalação.

    Tipo de dados: cadeia de caracteres
    item.service_context Detalhes sobre o contexto de serviço associado ao registro do item-base de instalação.

    Tipo de dados: objeto

    "service_context": {
  "display_value": "String",
  "sys_id": "String"
}
    item.service_context.display_value Detalhes sobre o contexto de serviço associado ao registro do item-base de instalação.

    Tipo de dados: objeto

    "service_context": {
  "display_value": "String",
  "sys_id": "String"
}
    item.service_context.sys_id Sys_id do registro de contexto de serviço associado ao registro do item-base de instalação.

    Tipo de dados: cadeia de caracteres
    item.serviço_organização Detalhes sobre a organização de serviço associada ao registro do item-base de instalação. Retornado somente se o plug-in Organização de serviço (com.snc.service_organization) estiver instalado.

    Tipo de dados: objeto

    "service_organization": {
  "display_value": "String",
  "sys_id": "String"
}
    item.service_organization.display_value Nome de texto da organização de serviço associada ao registro do item-base de instalação. Use este valor para exibir o nome da organização de serviço na IU.

    Tipo de dados: cadeia de caracteres
    item.service_organization.sys_id Sys_id do registro da organização de serviço associado ao registro do item-base de instalação.

    Tipo de dados: cadeia de caracteres
    item.sys_class_name Tabela que contém o registro do item-base de instalação.

    Tipo de dados: cadeia de caracteres
    item.sys_id Sys_id do registro do item-base de instalação. Localizado na tabela especificada no parâmetro sys_class_name.

    Tipo de dados: cadeia de caracteres
    item.sys_mod_count Número de vezes em que o registro do item-base de instalação associado foi modificado.

    Tipo de dados: cadeia de caracteres
    item.estado Detalhes sobre o estado atual do item-base de instalação.

    Tipo de dados: objeto

    "state": {
  "display_value": "String",
  "value": "String"
}
    item.state.display_value Cadeia de caracteres de texto do estado atual do item-base de instalação. Use este valor para exibir o estado na IU.

    Tipo de dados: cadeia de caracteres
    item.estado.valor Valor interno do estado do item-base de instalação.

    Tipo de dados: cadeia de caracteres
    item.status Detalhes sobre o status do item-base de instalação.

    Tipo de dados: objeto

    "status": {
  "display_value": "String",
  "value": "String"
}
    item.status.display_value Cadeia de caracteres de texto do status do item-base de instalação. Use este valor para exibir o status na IU.

    Tipo de dados: cadeia de caracteres
    item.status.value Valor interno do status do item-base de instalação.

    Tipo de dados: cadeia de caracteres
    item.uninstall_date Detalhes sobre a data em que o item-base de instalação se tornou inativo.

    Tipo de dados: objeto

    "uninstall_date": {
  "display_value": "String",
  "value": "String"
}
    item.uninstall_date.display_value Data de desinstalação de texto. Use este valor para exibir a data de desinstalação na IU.

    Tipo de dados: cadeia de caracteres
    item.uninstall_date.value Valor interno da data de desinstalação.

    Tipo de dados: cadeia de caracteres
    status Status da chamada do endpoint.

    Tipo de dados: cadeia de caracteres

    Solicitação de cURL

    O exemplo de código a seguir mostra como chamar este endpoint. O item-base de instalação associado não tem secundários.

    curl "https://instance.servicenow.com/api/sn_install_base/integrations/installbaseitem/f77c7542b7343300ece839a6ee11a991" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

    Retornar resultados:

    {
  "result": {
    "status": "SUCCESS",
    "item": {
      "sys_class_name": "sn_install_base_item",
      "number": "IBITM0000901",
      "sys_id": "f77c7542b7343300ece839a6ee11a991",
      "product": {
        "sys_id": "8583ce8237732000158bbfc8bcbe5dd9",
        "display_value": "Fujitsu 1TB Hybrid Solid State Drive"
      },
      "active": "true",
      "name": "KX Series - KX5001",
      "account": {
        "sys_id": "86837a386f0331003b3c498f5d3ee4ca",
        "display_value": "Boxeo"
      }
    },
    "hasChildren": "false"
  }
}

    Solicitação de cURL

    O exemplo de código a seguir mostra como chamar este endpoint especificando uma profundidade máxima de quatro níveis secundários.

    curl "https://instance.servicenow.com/api/sn_install_base/integrations/installbaseitems/e0a80e4b87b521100b6afc86dabb3565?depth=4" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

    Retornar resultados:

    {
  "result": {
    "status": "SUCCESS",
    "item": {
      "sys_class_name": "sn_install_base_item",
      "number": "IBITM0001073",
      "sys_id": "e0a80e4b87b521100b6afc86dabb3565",
      "health_status": {
        "value": "not_available",
        "display_value": "Not Available"
      },
      "active": "true",
      "name": "parent",
      "account": {
        "sys_id": "86837a386f0331003b3c498f5d3ee4ca",
        "display_value": "Boxeo"
      }
    },
    "hasChildren": "true",
    "childinstallbase": {
      "sysparm_depth": 2,
      "items": [
        {
          "parent": {
            "sys_id": "e0a80e4b87b521100b6afc86dabb3565",
            "display_value": "parent"
          },
          "sys_class_name": "sn_install_base_item",
          "number": "IBITM0001074",
          "sys_id": "6db80e4b87b521100b6afc86dabb356b",
          "state": {
            "value": "in_use",
            "display_value": "In Use"
          },
          "health_status": {
            "value": "not_available",
            "display_value": "Not Available"
          },
          "active": "true",
          "name": "child1",
          "account": {
            "sys_id": "86837a386f0331003b3c498f5d3ee4ca",
            "display_value": "Boxeo"
          },
          "hasChildren": "true",
          "items": {
            "sysparm_depth": 3,
            "items": [
              {
                "parent": {
                  "sys_id": "6db80e4b87b521100b6afc86dabb356b",
                  "display_value": "child1"
                },
                "sys_class_name": "sn_install_base_item",
                "number": "IBITM0001075",
                "sys_id": "36ecce4b87b521100b6afc86dabb3503",
                "health_status": {
                  "value": "not_available",
                  "display_value": "Not Available"
                },
                "active": "true",
                "name": "childL2",
                "account": {
                  "sys_id": "86837a386f0331003b3c498f5d3ee4ca",
                  "display_value": "Boxeo"
                },
                "hasChildren": "false"
              }
            ]
          }
        }
      ]
    }
  }
}

    Item-base de instalação - GET /sn_install_base/integrations/installbaseitems/{id}/cases

    Retorna os casos associados a um registro de item-base de instalação especificado.

    Formato da URL

    URL com controle de versão: /api/sn_install_base/{api_version}/integrations/installbaseitems/{id}/cases

    URL padrão: /api/sn_install_base/integrations/installbaseitems/{id}/cases

    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
    id Sys_id do registro do item-base de instalação.

    Tipo de dados: cadeia de caracteres

    Tabela: item-base de instalação [sn_install_base_item]
    Tabela 20. Parâmetros de consulta
    Nome Descrição
    pares de nome-valor de campo Pares de campo-valor a serem usados para filtrar os registros de caso. Se você especificar uma tabela diferente em sys_class_name, especifique os campos nessa tabela.

    Você pode passar um ou mais pares de valores de campo para filtrar os resultados retornados.

    Por exemplo, para retornar somente registros em que o campo de aprovação está definido como "rejeitado" e o campo de categoria está definido como "2", passe o seguinte: &approval=rejected&category=2.

    Tipo de dados: cadeia de caracteres

    Tabela: caso [sn_customerservice_case]

    Padrão: todos os campos
    sys_class_name Se estiver usando uma tabela de casos estendidos (não sn_customerservice_case), o nome da tabela estendida a ser consultada.

    Tipo de dados: cadeia de caracteres

    Padrão: sn_customerservice_case
    sysparm_limit Número máximo de registros a serem retornados. Para solicitações que excedem esse número de registros, use o parâmetro sysparm_offset para paginar a recuperação do registro.

    Este limite é aplicado antes da avaliação da ACL. Se nenhum registro for retornado, incluindo os registros aos quais você tem acesso, reorganize a ordem dos registros para que os registros aos quais você tem acesso sejam retornados primeiro.

    Nota:
    Valores sysparm_limit extraordinariamente grandes podem afetar o desempenho do sistema.

    Tipo de dados: número

    Padrão: 20

    Máximo: 100
    sysparm_offset Índice de registro inicial para o qual a recuperação de registros será iniciada. Use este valor para paginar a recuperação do registro. Essa funcionalidade permite a recuperação de todos os registros, independentemente do número de registros, em pequenos blocos gerenciáveis.

    Por exemplo, na primeira vez que você chama este endpoint, sysparm_offset é definido como "0". Para simplesmente percorrer todos os registros disponíveis, use sysparm_offset=sysparm_offset+sysparm_limitaté chegar ao fim de todos os registros.

    Não passe um número negativo no parâmetro sysparm_offset.

    Tipo de dados: número

    Padrão: 0
    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.
    400 Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada.
    403 Proibido. O usuário não tem direitos de acesso ao registro especificado.
    404 Não encontrado. O item solicitado não foi encontrado.
    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)

    Elemento Descrição
    casos Lista de casos associados ao registro do item-base de instalação especificado.

    Tipo de dados: matriz de objetos

    "cases": [
  {
    "account": "String",
    "active": Boolean,
    "active_account_escalation": "String",
    "active_escalation": "String",
    "activity_due": "String",
    "additional_assignee_list": "String",
    "approval": "String",
    "approval_history": "String",
    "approval_set": "String",
    "asset": "String",
    "assigned_on": "String",
    "assigned_to": "String",
    "assignment_group": "String",
    "auto_close": Boolean,
    "business_duration": "String",
    "business_impact": "String",
    "business_service": "String",
    "calendar_duration": "String",
    "case": "String",
    "case_report": "String",
    "category": Number,
    "cause": "String",
    "caused_by": "String",
    "change": "String",
    "child_case_creation_progress": Boolean,
    "closed_at": "String",
    "closed_by": "String",
    "close_notes: "String",
    "cmdb_ci": "String",
    "comments": "String",
    "comments_and_work_notes": "String",
    "company": "String",
    "consumer": "String",
    "contact": "String",
    "contact_local_time: "String",
    "contact_time_zone": "String",
    "contact_type": "String",
    "contract": "String",
    "contributor_groups": "String",
    "contributor_users": "String",
    "correlation_display": "String",
    "correlation_id": "String",
    "delivery_plan": "String",
    "delivery_task": "String",
    "description": "string",
    "due_date": "String",
    "entitlement": "String",
    "escalation": Number,
    "expected_start": "String",
    "first_response_time": "String",
    "follow_the_sun": Boolean,
    "follow_up": "String",
    "group_list": [Array],
    "impact": Number,
    "internal_user": "String",
    "initiated_as_request": Boolean,
    "knowledge": Boolean,
    "location": "String",
    "made_sla": Boolean,
    "major_case_state": "String",
    "needs_attention": Boolean,
    "notes_to_comments": Boolean,
    "notify": Number,
    "number": "String",
    "opened_at": "String",
    "opened_by": "String",
    "order": Number,
    "parent": "String",
    "partner": "String",
    "partner_contact": "String",
    "priority": Number,
    "proactive": Boolean,
    "probable_cause": "String",
    "problem": "String",
    "product": "String",
    "reassignment_count": Number,
    "recipient_list": "String",
    "rejection_goto": "String",
    "resolution_code": "String",
    "resolved_at": "String",
    "resolved_by": "String",
    "route_reason": "String",
    "service_offering": "String",
    "short_description": "String",
    "skills": "String",
    "sla_due": "String",
    "sn_app_cs_social_social_profile": "String",
    "sold_product": "String",
    "stage": "String",
    "state": Number,
    "subcategory": Number,
    "support_manager" "String",
    "sync_driver": Boolean,
    "sys_class_name": "String",
    "sys_domain": "String",
    "sys_domain_path": "String",
    "sys_id": "String",
    "task_effective_number": "String",
    "time_worked": "String",
    "universal_request": "String",
    "upon_approval": "String",
    "upon_reject": "String",
    "urgency": Number,
    "user_input": "String",
    "variables":  "String",
    "watch_list": [Array],
    "wf_activity": "String",
    "work_end": "String",
    "work_notes": "String",
    "work_notes_list": [Array],
    "work_start": "String"
    casos.conta
    Sys_id do registro de conta associado ao caso.

    Tipo de dados: cadeia de caracteres

    Tabela: Conta [customer_account]
    casos.ativos Sinalizador que indica se o caso está aberto e ativo.

    Valores possíveis:

    • verdadeiro: o caso está ativo
    • falso: o caso está encerrado

    Tipo de dados: booliano

    Padrão: verdadeiro
    casos.conta_ativa_escalação Sys_id do registro de escalação de conta ativa associado ao caso.

    Tipo de dados: cadeia de caracteres

    Tabela: escalação [sn_customerservice_escalation]
    casos.escala_ativa Sys_id do registro de escalação ativo associado ao caso.

    Tipo de dados: cadeia de caracteres

    Tabela: escalação [sn_customerservice_escalation]
    casos.atividade_vencimento Data em que o caso associado deve ser concluído.

    Tipo de dados: cadeia de caracteres
    cases.additional_assignee_list Lista dos sys_ids das pessoas adicionais (que não sejam o atribuído primário) que foram atribuídos à conta.

    Tipo de dados: matriz

    Máximo: 4.000

    Tabela: usuário [sys_user]
    casos.aprovação Cadeia de caracteres que descreve o tipo de aprovação necessária.

    Valores possíveis:

    • aprovado
    • cancelado(a)
    • duplicado
    • not_required
    • não solicitado
    • rejeitado
    • solicitado

    Tipo de dados: cadeia de caracteres

    Máximo de caracteres: 40

    Padrão: não solicitado
    casos.approval_history Lista de todas as aprovações associadas ao caso.

    Tipo de dados: cadeia de caracteres

    Máximo de caracteres: 4.000
    casos.approval_set Data e hora em que a ação associada foi aprovada.

    Tipo de dados: cadeia de caracteres
    casos.ativo Sys_id do registro de ativo associado ao caso.

    Tipo de dados: cadeia de caracteres

    Tabela: ativo [alm_asset]
    casos.atribuídos_em Data e hora em que o caso foi atribuído à pessoa identificada no parâmetro assigned_to.

    Tipo de dados: cadeia de caracteres (data)

    Tamanho máximo: 40
    casos.atribuídos_a
    Sys_id da pessoa atribuída ao caso.

    Tabela: usuário [sys_user]

    Tipo de dados: cadeia de caracteres
    casos.atribuição_grupo Sys_id do grupo de agentes de atendimento ao cliente atribuído ao caso.

    Tipo de dados: cadeia de caracteres

    Tabela: Grupo [sys_user_group]
    casos.auto_close Sinalizador que indica se o caso foi encerrado automaticamente.

    Valores possíveis:

    • verdadeiro: o caso foi encerrado automaticamente
    • falso: o caso não foi encerrado automaticamente

    Tipo de dados: booliano

    Padrão: falso
    casos.duração_de_negócios Duração em horas de trabalho do calendário, dias úteis e semanas de trabalho necessários para concluir o caso.

    Tipo de dados: cadeia de caracteres
    casos.impacto_de_negócios Impacto do problema no cliente associado.

    Tipo de dados: cadeia de caracteres

    Máximo de caracteres: 4.000
    casos.serviço_de_negócios Sys_id do registro de serviço associado ao caso.

    Tipo de dados: cadeia de caracteres

    Tabela: Serviço [cmdb_ci_service]
    casos.calendar_duração Duração em horas, dias e semanas de calendário que levou para concluir o caso.

    Tipo de dados: cadeia de caracteres (Duração)

    Tamanho máximo: 40
    casos.caso Descrição resumida do caso e número do caso.

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 300
    casos.relatório_do_caso Sys_id do relatório de caso associado.

    Tipo de dados: cadeia de caracteres

    Tabela: relatório de caso [sn_customerservice_case_report]
    casos.categoria Categoria de caso.

    Valores possíveis:

    • 0: pergunta
    • 1: Problema
    • 2: Recurso

    Tipo de dados: número (inteiro)

    Padrão: 1
    casos.causa Detalhes sobre a causa do problema.

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 4.000
    casos.causados_por Sys_id da solicitação de mudança que causou a criação do caso.

    Tipo de dados: cadeia de caracteres

    Tabela: solicitação de mudança [change_request]
    casos.mudança Sys_id da solicitação de mudança que causou a criação do caso.

    Tipo de dados: cadeia de caracteres

    Tabela: solicitação de mudança [change_request]
    casos.child_case_creation_progress Sinalizador que indica se o caso é um caso secundário criado a partir de um caso principal.

    Valores possíveis:

    • verdadeiro: caso secundário criado a partir de um caso principal
    • falso: não é um caso secundário

    Tipo de dados: booliano
    casos.encerrado_em Data e hora em que o caso foi encerrado.

    Tipo de dados: cadeia de caracteres
    casos.encerrados_por Sys_id do usuário que encerrou o caso.

    Tipo de dados: cadeia de caracteres

    Tabela: usuário [sys_user]
    casos.close_notes Anotações feitas quando o caso foi encerrado.

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 4.000
    casos.cmdb_ci Sys_id do item de configuração associado ao caso.

    Tipo de dados: cadeia de caracteres

    Tabela: item de configuração [cmdb_ci]
    casos.comentários Comentários adicionais sobre o caso.

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 4.000
    casos.comentários_e_anotações_de_trabalho Comentários e anotações de trabalho inseridos para o caso.

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 4.000
    casos.empresa Sys_id da empresa associada ao caso.

    Tipo de dados: cadeia de caracteres

    Tabela: Empresa [core_company]
    casos.consumidor Somente casos de empresa para consumidor. Sys_id da pessoa a ser contatada em relação a este caso.

    Tipo de dados: cadeia de caracteres

    Tabela: consumidor [csm_consumer]
    casos.contato Somente casos baseados em empresa para empresa. Sys_id da pessoa a ser contatada em relação a este caso.

    Tipo de dados: cadeia de caracteres

    Tabela: Contato [customer_contact]
    casos.contato_local_hora Horário local de contato.

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 70
    casos.contact_time_zone Fuso horário do contato associado ao caso.

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 40
    casos.contato_tipo Método pelo qual o caso foi relatado inicialmente.
    Valores possíveis:
    • bate-papo
    • e-mail
    • telefone
    • social
    • web

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 40
    casos.contrato Sys_id do contrato associado ao caso. Este contrato contém informações sobre o tipo de suporte fornecido à empresa associada ao caso. Um contrato pode incluir uma empresa e um contato e os ativos específicos que estão cobertos. Um contrato também pode incluir vários direitos de serviço e ANSs.

    Tipo de dados: cadeia de caracteres

    Tabela: Contrato [ast_contract]
    casos.contributor_groups Lista de sys_ids dos grupos de usuários que contribuíram para o caso.

    Tipo de dados: cadeia de caracteres

    Tabela: Grupo [sys_user_group]
    casos.colaborador_usuários Lista de sys_ids dos usuários que contribuíram para o caso.

    Tipo de dados: cadeia de caracteres

    Tabela: usuário [sys_user]
    casos.correlação_display Exibição de correlação.

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 100
    casos.correlation_id Identificador de correlação.

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 100
    casos.plano_de_entrega Sys_id do plano de execução primário para este caso.

    Tipo de dados: cadeia de caracteres

    Tabela: plano de execução [sc_cat_item_delivery_plan]
    casos.tarefa_de_entrega Sys_id da tarefa do plano de execução.

    Tipo de dados: cadeia de caracteres

    Tabela: Tarefa do plano de execução [sc_cat_item_delivery_task]
    casos.descrição Descrição detalhada do problema associado ao caso.

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 4.000
    casos.due_date Data em que o caso deve ser encerrado.

    Tipo de dados: cadeia de caracteres
    casos.direito Sys_id do registro de direito associado ao caso. Os direitos definem o tipo de suporte que um cliente recebe, bem como os canais de comunicação compatíveis. Um direito pode ser associado a um produto, um ativo, uma conta ou um contrato.

    Tipo de dados: cadeia de caracteres

    Tabela: direito [service_entitlement]
    casos.escalação Nível de escalação atual.

    Valores possíveis:

    • 0: Normal
    • 1: Moderado
    • 2: Alto
    • 3: atrasado

    Tipo de dados: número (inteiro)

    Padrão: 0
    casos.início_expectado Data e hora em que o trabalho está programado para começar no caso.

    Tipo de dados: cadeia de caracteres
    casos.first_response_time Data e hora em que a primeira ação foi realizada no caso.

    Tipo de dados: cadeia de caracteres
    casos.follow_the_sun Sinalizador que indica se o caso deve ser entregue para acompanhamento global.

    Se um cliente inserir comentários adicionais em um caso de Prioridade 1 - Crítico ou Prioridade 2 - Alta, ou se o caso for escalado, o sinalizador será definido automaticamente como verdadeiro.

    Valores possíveis:

    • verdadeiro: o caso deve ser entregue para acompanhamento global
    • falso: o caso não deve ser entregue para acompanhamento global

    Tipo de dados: booliano

    Padrão: falso
    casos.acompanhamento Data e hora da próxima ação de acompanhamento.

    Tipo de dados: cadeia de caracteres
    casos.lista_grupo Lista de sys_ids dos registros de grupo associados ao caso.

    Tipo de dados: matriz

    Tabela: Grupo [sys_user_group]
    casos.impacto Impacto no cliente.

    Valores possíveis:

    • 1: Alto
    • 2: médio
    • 3: Baixo

    Tipo de dados: número (inteiro)

    Padrão: 3
    casos.usuário_interno Sys_id do usuário interno deste caso.

    Tipo de dados: cadeia de caracteres

    Tabela: usuário [sys_user]
    casos.iniciados_como_solicitação Sinalizador que indica se esta consulta foi iniciada como uma solicitação pelo cliente.

    Valores possíveis:

    • verdadeiro: consulta iniciada pelo cliente.
    • falso: a consulta não foi iniciada pelo cliente.

    Tipo de dados: booliano

    Padrão: falso
    casos.conhecimento Sinalizador que indica se há um artigo da base de conhecimento disponível para o problema especificado.

    Valores possíveis:

    • verdadeiro: o artigo da base de conhecimento está disponível para este problema
    • falso: o artigo da base de conhecimento não está disponível para este problema

    Tipo de dados: booliano

    Padrão: falso
    casos.local Sys_id do registro que descreve o local da empresa.

    Tipo de dados: cadeia de caracteres

    Tabela: local [cmn_location]
    casos.feito_ANS Sinalizador que indica se o caso foi resolvido de acordo com o acordo de nível de serviço associado.

    Valores possíveis:

    • verdadeiro: o caso foi resolvido de acordo com o ANS
    • falso: o caso não foi resolvido de acordo com o ANS

    Tipo de dados: booliano

    Padrão: verdadeiro
    casos.principal_caso_estado Estado atual do caso principal.

    Valores possíveis:

    • aceito: estado inicial quando um gerente cria um caso principal ou quando um gerente promove um caso candidato.
    • cancelled: o caso foi cancelado.
    • proposto: estado inicial quando um agente ou gerente cria ou propõe um caso candidato.
    • rejeitado: caso de candidato rejeitado pelo gerente.

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 40
    precisa_atenção Sinalizador que indica se o caso precisa de atenção.

    Valores possíveis:

    • verdadeiro: o caso precisa de atenção adicional
    • falso: o caso não precisa de atenção adicional

    Tipo de dados: booliano

    Padrão: falso
    casos.anotações_para_comentários Sinalizador que indica se as anotações de resolução devem ser adicionadas aos comentários.

    Valores possíveis:

    • verdadeiro: anotações de resolução, quando adicionadas, também são adicionadas aos comentários
    • falso: as anotações de resolução nos comentários não são necessárias

    Tipo de dados: booliano
    casos.notify Método a ser usado para notificar o contato/consumidor.

    Valores possíveis:

    • 1: Não notificar
    • 2: Enviar e-mail
    • 3: Telefone

    Tipo de dados: número (inteiro)

    Padrão: 1
    casos.número Número do caso.

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 40
    casos.abertos_em Data e hora em que o caso foi aberto.

    Tipo de dados: cadeia de caracteres
    casos.abertos_por Sys_id da pessoa que abriu o caso inicialmente.

    Tipo de dados: cadeia de caracteres

    Tabela: usuário [sys_user]
    casos.ordem Ordem do caso.

    Tipo de dados: número (inteiro)
    casos.primário Sys_id do caso primário ao qual este caso (secundário) está associado.

    Tipo de dados: cadeia de caracteres

    Tabela: Tarefa [task]
    casos.parceiro Sys_id do parceiro associado ao caso.

    Tipo de dados: cadeia de caracteres

    Tabela: Conta [customer_account]
    casos.partner_contact Sys_id do contato do parceiro associado ao caso.

    Tipo de dados: cadeia de caracteres

    Tabela: Contato [customer_contact]
    casos.prioridade Prioridade do caso.
    Valores possíveis:
    • 1: Crítico
    • 2: Alto
    • 3: Moderado
    • 4: Baixo

    Tipo de dados: número (inteiro)

    Padrão: 4
    casos.proativo Sinalizador que indica se a consulta está sendo monitorada proativamente.

    Valores possíveis:

    • verdadeiro: sendo monitorado proativamente.
    • falso: não está sendo monitorado.

    Tipo de dados: booliano

    Padrão: falso
    casos.causa_provável Possível causa do problema associado ao caso.

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 4.000
    casos.problema Sys_id do problema que o cliente está encontrando.

    Tipo de dados: cadeia de caracteres

    Tabela: problema [problema]
    casos.produto Sys_id do modelo de produto do ativo associado ao caso. Um modelo é uma versão ou configuração específica de um ativo (por exemplo, Apple Mac Book Pro).

    Tipo de dados: cadeia de caracteres

    Tabela: modelo de produto [cmdb_model]
    casos.reatribuição_contagem Número de vezes em que o caso foi reatribuído a uma pessoa responsável por levar o caso adiante.

    Tipo de dados: número (inteiro)

    Padrão: 0
    casos.lista_destinatários Sys_id do registro que contém a lista de destinatários para comunicações sobre este caso.

    Tipo de dados: cadeia de caracteres

    Tabela: Lista de destinatários [sn_publications_recipients_list]
    casos.rejeição_ir para Sys_id da tarefa a ser executada se o caso for rejeitado.

    Tipo de dados: cadeia de caracteres

    Tabela: Tarefa [task]
    casos.resolução_código Estado de resolução do caso, como "Resolvido - Corrigido pelo Suporte/Orientação fornecida".

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 40
    casos.resolvido_em Data e hora em que o caso foi resolvido.

    Tipo de dados: cadeia de caracteres
    casos.resolvidos_por Sys_id da pessoa que resolveu o caso.

    Tipo de dados: cadeia de caracteres

    Tabela: usuário [sys_user]
    casos.route_reason Motivo pelo qual o caso foi roteado para um designado diferente.

    Tipo de dados: número (inteiro)

    Tamanho máximo: 40
    casos.oferta_de_serviço Sys_id da oferta de serviço associada à consulta de pagamento. As ofertas de serviço definem exclusivamente o nível de serviço em termos de disponibilidade, escopo, preço e opções de pacote.

    Tipo de dados: cadeia de caracteres

    Tabela: Oferta de serviço [service_offering]
    casos.short_description Descrição concisa do caso.

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 160
    casos.habilidades Lista dos identificadores exclusivos (sys_id) das habilidades necessárias para concluir o caso.

    Tipo de dados: cadeia de caracteres

    Tabela: habilidade [cmn_skill]
    casos.sla_due Data/hora em que o caso deve ser encerrado com base no acordo de nível de serviço associado.

    Tipo de dados: cadeia de caracteres
    casos.sn_app_cs_social_social_profile Sys_id do perfil de mídia social associado ao caso.

    Tipo de dados: cadeia de caracteres

    Tabela: perfil social [sn_app_cs_social_social_profile]
    casos.produto_vendido Sys_id do produto associado.

    Tipo de dados: cadeia de caracteres

    Tabela: produto vendido [sn_install_base_sold_product]
    casos.fase Fase da consulta, como Encerrado concluído, Encerrado rejeitado, Verificação de documento, Autorização e assim por diante.

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 40
    casos.estado Estado atual do caso.

    Valores possíveis:

    • 1: Novo
    • 3: Encerrado
    • 6: Resolvido
    • 10: Aberto
    • 18: Aguardando informações

    Tipo de dados: número (inteiro)

    Padrão: 1
    casos.subcategoria Subcategoria de caso.

    Valores possíveis:

    0: pergunta

    Tipo de dados: número (inteiro)

    Padrão: 0
    casos.suporte_manager Sys_id do gerente do CSM atribuído ao caso.

    Tipo de dados: cadeia de caracteres

    Tabela: usuário [sys_user]
    casos.sync_driver Sinalizador que indica se há sincronização de driver.

    Valores possíveis:

    • verdadeiro: o driver está sincronizado
    • falso: o driver não está sincronizado

    Tipo de dados: booliano
    casos.sys_class_name Tabela que contém o registro de caso.

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 80
    casos.sys_domain Domínio associado ao caso.

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 32

    Padrão: global
    casos.sys_domain_path Caminho do domínio.

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 255

    Padrão: /
    casos.sys_id Identificador exclusivo do caso.

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 32
    casos.tarefa_eficaz_número Número de identificação.

    Se a tarefa tiver uma Solicitação universal associada a ela, será o número de UR. Caso contrário, será o número da tarefa atual.

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 40
    casos.tempo_trabalhado Quantidade total de tempo trabalhado no caso.

    Tipo de dados: cadeia de caracteres
    casos.solicitação_universal Sys_id de uma tarefa universal da qual esta consulta faz parte.

    Tipo de dados: cadeia de caracteres

    Tabela: Tarefa [task]
    casos.upon_approval Ação a ser tomada se o caso for aprovado.

    Valores possíveis:

    • fazer_nada
    • prosseguir

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 40

    Padrão: prosseguir
    casos.upon_reject Ação a ser tomada se o caso for rejeitado.

    Valores possíveis:

    • Cancelar
    • goto

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 40

    Padrão: cancelar
    casos.urgência Urgência do caso.

    Valores possíveis:

    • 1: Alto
    • 2: médio
    • 3: Baixo

    Tipo de dados: número (inteiro)

    Padrão: 3
    casos.user_input Entrada adicional do usuário.

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 4.000
    casos.variáveis Pares de nome-valor de variáveis associadas ao caso.

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 40
    casos.lista_de_observação Lista de sys_ids dos usuários que recebem notificações sobre este caso quando comentários adicionais são adicionados ou se o estado de um caso é alterado para Resolvido ou Encerrado.

    Tipo de dados: matriz

    Tabela: usuário [sys_user]
    casos.wf_atividade Sys_id do registro de atividade de fluxo de trabalho associado ao caso.

    Tipo de dados: cadeia de caracteres

    Tabela: atividade de fluxo de trabalho [wf_activity]
    casos.work_end Data e hora em que o trabalho foi encerrado no caso.

    Tipo de dados: cadeia de caracteres
    casos.anotações_de_trabalho Informações sobre como resolver o caso ou as medidas tomadas para resolvê-lo.

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 4.000
    casos.lista_de_anotações_de_trabalho Lista de sys_ids dos usuários internos que recebem notificações sobre este caso quando anotações de trabalho são adicionadas.

    Tipo de dados: matriz

    Tabela: usuário [sys_user]
    casos.trabalho_início Data e hora em que o trabalho começou no caso.

    Tipo de dados: cadeia de caracteres
    tem_mais Sinalizador que indica se há mais registros na tabela a serem retornados.
    Valores possíveis:
    • verdadeiro: mais registros a serem retornados.
    • falso: não há mais registros a serem retornados.

    Tipo de dados: cadeia de caracteres booliana
    status Status da chamada do endpoint.

    Tipo de dados: cadeia de caracteres
    sysparm_limit
    Número máximo de registros a serem retornados. Para solicitações que excedem esse número de registros, use o parâmetro sysparm_offset para paginar a recuperação do registro.

    Na resposta, o parâmetro booliano hasMore é retornado. Indica se há mais registros a serem retornados que atendam aos critérios de filtro.

    Tipo de dados: número

    Padrão: 10
    sysparm_offset
    Índice de registro inicial para o qual a recuperação de registros será iniciada. Use este valor para paginar a recuperação do registro. Essa funcionalidade permite a recuperação de todos os registros, independentemente do número de registros, em pequenos blocos gerenciáveis.

    Por exemplo, na primeira vez que você chama este endpoint, sysparm_offset é definido como "0". Para simplesmente percorrer todos os registros disponíveis, use sysparm_offset=sysparm_offset+sysparm_limitaté chegar ao fim de todos os registros.

    Não passe um número negativo no parâmetro sysparm_offset.

    Tipo de dados: número

    Padrão: 0

    Solicitação de cURL

    O exemplo de código a seguir mostra como chamar este endpoint.

    curl "https://instance.servicenow.com/api/sn_install_base/integrations/installbaseitems/1474a3c853500010df5dddeeff7b12ec/cases" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

    Retornar resultados:

    {
  "result": {
    "sysparm_offset": 0,
    "sysparm_limit": 10,
    "has_more": false,
    "cases": [
      {
        "upon_reject": {
          "value": "cancel",
          "display_value": "Cancel all future Tasks"
        },
        "number": "CS0001034",
        "initiated_as_request": "0",
        "state": "1",
        "case": "Performance is impacted with latest update​CS0001034",
        "knowledge": "0",
        "impact": "3",
        "contract": {
          "sys_id": "495e16b96f0731003b3c498f5d3ee4af",
          "display_value": "CNTR0000603"
        },
        "active": "1",
        "auto_created_case": "0",
        "priority": "4",
        "sys_domain_path": "/",
        "child_case_creation_progress": "0",
        "sync_driver": "0",
        "needs_attention": "0",
        "short_description": "Performance is impacted with latest update",
        "notify": "1",
        "sys_class_name": "sn_customerservice_case",
        "reassignment_count": "0",
        "notes_to_comments": "0",
        "hierarchical_variables": "variable_pool",
        "escalation": "0",
        "upon_approval": {
          "value": "proceed",
          "display_value": "Proceed to Next Task"
        },
        "made_sla": "1",
        "task_effective_number": "CS0001034",
        "opened_by": {
          "sys_id": "ddce70866f9331003b3c498f5d3ee417",
          "display_value": "George Warren"
        },
        "contact": {
          "sys_id": "ddce70866f9331003b3c498f5d3ee417",
          "display_value": "George Warren"
        },
        "follow_the_sun": "0",
        "entitlement": {
          "sys_id": "1eb7893a6f1b31003b3c498f5d3ee4dd",
          "display_value": "24x7 Customer Support"
        },
        "opened_at": {
          "value": "2023-03-20 14:53:51",
          "display_value": "2023-03-20 07:53:51"
        },
        "case_report": {
          "sys_id": "85e8604c87f521100b6afc86dabb35b9",
          "display_value": "CSR0010014"
        },
        "subcategory": "0",
        "install_base": {
          "sys_id": "1474a3c853500010df5dddeeff7b12ec",
          "display_value": "Boxeo - Development"
        },
        "proactive": "0",
        "auto_close": "0",
        "sys_id": "92c8684087b521105d0055373cbb357e",
        "contact_type": {
          "value": "web",
          "display_value": "Web"
        },
        "urgency": "3",
        "approval": {
          "value": "not requested",
          "display_value": "Not Yet Requested"
        },
        "category": "1",
        "account": {
          "sys_id": "86837a386f0331003b3c498f5d3ee4ca",
          "display_value": "Boxeo"
        }
      },
      {
        "upon_reject": {
          "value": "cancel",
          "display_value": "Cancel all future Tasks"
        },
        "number": "CS0001008",
        "initiated_as_request": "0",
        "state": "1",
        "case": "Test Alert​CS0001008",
        "knowledge": "0",
        "impact": "3",
        "active": "1",
        "auto_created_case": "0",
        "priority": "1",
        "sys_domain_path": "/",
        "child_case_creation_progress": "0",
        "sync_driver": "0",
        "needs_attention": "1",
        "short_description": "Test Alert",
        "notify": "1",
        "sys_class_name": "sn_customerservice_case",
        "reassignment_count": "0",
        "notes_to_comments": "0",
        "hierarchical_variables": "variable_pool",
        "escalation": "0",
        "upon_approval": {
          "value": "proceed",
          "display_value": "Proceed to Next Task"
        },
        "made_sla": "1",
        "task_effective_number": "CS0001008",
        "opened_by": {
          "sys_id": "08c83021acbe7300964fca436af2bb97",
          "display_value": "noc_operator "
        },
        "follow_the_sun": "0",
        "opened_at": {
          "value": "2023-03-15 08:02:58",
          "display_value": "2023-03-15 01:02:58"
        },
        "case_report": {
          "sys_id": "a4fa9d9a872d61105d0055373cbb356e",
          "display_value": "CSR0010005"
        },
        "subcategory": "0",
        "proactive": "1",
        "auto_close": "0",
        "sys_id": "60ea199a872d61105d0055373cbb35c9",
        "contact_type": {
          "value": "proactive",
          "display_value": "Alert"
        },
        "alert": {
          "sys_id": "506a559a872d61105d0055373cbb3581",
          "display_value": "Alert0010008"
        },
        "urgency": "3",
        "action_status": "4",
        "approval": {
          "value": "not requested",
          "display_value": "Not Yet Requested"
        },
        "category": "1"
      },
      {
        "upon_reject": {
          "value": "cancel",
          "display_value": "Cancel all future Tasks"
        },
        "number": "CS0001033",
        "initiated_as_request": "0",
        "state": "1",
        "case": "System is down​CS0001033",
        "knowledge": "0",
        "impact": "3",
        "contract": {
          "sys_id": "495e16b96f0731003b3c498f5d3ee4af",
          "display_value": "CNTR0000603"
        },
        "active": "1",
        "auto_created_case": "0",
        "priority": "4",
        "sys_domain_path": "/",
        "child_case_creation_progress": "0",
        "sync_driver": "0",
        "needs_attention": "0",
        "short_description": "System is down",
        "notify": "1",
        "sys_class_name": "sn_customerservice_case",
        "reassignment_count": "0",
        "notes_to_comments": "0",
        "hierarchical_variables": "variable_pool",
        "escalation": "0",
        "upon_approval": {
          "value": "proceed",
          "display_value": "Proceed to Next Task"
        },
        "made_sla": "1",
        "task_effective_number": "CS0001033",
        "opened_by": {
          "sys_id": "ddce70866f9331003b3c498f5d3ee417",
          "display_value": "George Warren"
        },
        "contact": {
          "sys_id": "ddce70866f9331003b3c498f5d3ee417",
          "display_value": "George Warren"
        },
        "follow_the_sun": "0",
        "entitlement": {
          "sys_id": "1eb7893a6f1b31003b3c498f5d3ee4dd",
          "display_value": "24x7 Customer Support"
        },
        "opened_at": {
          "value": "2023-03-20 14:52:48",
          "display_value": "2023-03-20 07:52:48"
        },
        "case_report": {
          "sys_id": "64b86c0c87f521100b6afc86dabb35fc",
          "display_value": "CSR0010013"
        },
        "subcategory": "0",
        "install_base": {
          "sys_id": "1474a3c853500010df5dddeeff7b12ec",
          "display_value": "Boxeo - Development"
        },
        "proactive": "0",
        "auto_close": "0",
        "sys_id": "7c98a04087b521105d0055373cbb352e",
        "contact_type": {
          "value": "web",
          "display_value": "Web"
        },
        "urgency": "3",
        "approval": {
          "value": "not requested",
          "display_value": "Not Yet Requested"
        },
        "category": "1",
        "account": {
          "sys_id": "86837a386f0331003b3c498f5d3ee4ca",
          "display_value": "Boxeo"
        }
      },
      {
        "upon_reject": {
          "value": "cancel",
          "display_value": "Cancel all future Tasks"
        },
        "number": "CS0001048",
        "initiated_as_request": "0",
        "state": "1",
        "case": "AIB with Single account​CS0001048",
        "knowledge": "0",
        "impact": "3",
        "active": "1",
        "auto_created_case": "0",
        "priority": "4",
        "sys_domain_path": "/",
        "child_case_creation_progress": "0",
        "sync_driver": "0",
        "needs_attention": "1",
        "short_description": "AIB with Single account",
        "notify": "1",
        "sys_class_name": "sn_customerservice_case",
        "reassignment_count": "0",
        "notes_to_comments": "0",
        "hierarchical_variables": "variable_pool",
        "escalation": "0",
        "upon_approval": {
          "value": "proceed",
          "display_value": "Proceed to Next Task"
        },
        "made_sla": "1",
        "task_effective_number": "CS0001048",
        "opened_by": {
          "sys_id": "08c83021acbe7300964fca436af2bb97",
          "display_value": "noc_operator "
        },
        "contact": {
          "sys_id": "4d147a386f0331003b3c498f5d3ee437",
          "display_value": "Julie Lewis"
        },
        "follow_the_sun": "0",
        "opened_at": {
          "value": "2023-03-24 03:28:58",
          "display_value": "2023-03-23 20:28:58"
        },
        "case_report": {
          "sys_id": "4082be81877161100b6afc86dabb35fe",
          "display_value": "CSR0010023"
        },
        "subcategory": "0",
        "proactive": "1",
        "auto_close": "0",
        "sys_id": "6a723e81877161100b6afc86dabb35cf",
        "contact_type": {
          "value": "proactive",
          "display_value": "Alert"
        },
        "alert": {
          "sys_id": "6b227681877161100b6afc86dabb35d5",
          "display_value": "Alert0010094"
        },
        "urgency": "3",
        "action_status": "4",
        "approval": {
          "value": "not requested",
          "display_value": "Not Yet Requested"
        },
        "category": "1",
        "account": {
          "sys_id": "86837a386f0331003b3c498f5d3ee4ca",
          "display_value": "Boxeo"
        }
      }
    ],
    "status": "SUCCESS"
  }
}

    Item-base de instalação - GET /sn_install_base/integrations/installbaseitems/{id}/childinstallbaseitems

    Retorna os itens-base de instalação secundários associados a um registro de item-base de instalação especificado.

    Formato da URL

    URL com controle de versão: /api/sn_install_base/{api_version}/integrations/installbaseitems/{id}/childinstallbaseitems

    URL padrão: /api/sn_install_base/integrations/installbaseitems/{id}/childinstallbaseitems

    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
    id Sys_id do registro do item-base de instalação.

    Tipo de dados: cadeia de caracteres

    Tabela: item-base de instalação [sn_install_base_item]
    Tabela 26. Parâmetros de consulta
    Nome Descrição
    pares de nome-valor de campo Pares de campo-valor a serem usados para filtrar os registros do item-base de instalação secundário. Se você especificar uma tabela diferente em sys_class_name, especifique os campos nessa tabela.

    Você pode passar um ou mais pares de valores de campo para filtrar os resultados retornados.

    Por exemplo, para retornar somente registros em que o campo de estado está definido como "in_use" e o campo de status está definido como "replacement", passe o seguinte: &state=in_use&status=replacement.

    Tipo de dados: cadeia de caracteres

    Padrão: todos os campos

    Tabela: item-base de instalação [sn_install_base_item]
    sys_class_name Se estiver usando uma tabela de itens-base de instalação estendida (não sn_install_base_item), o nome da tabela estendida a ser consultada.

    Tipo de dados: cadeia de caracteres

    Padrão: sn_install_base_item
    sysparm_limit Número máximo de registros a serem retornados. Para solicitações que excedem esse número de registros, use o parâmetro sysparm_offset para paginar a recuperação do registro.

    Este limite é aplicado antes da avaliação da ACL. Se nenhum registro for retornado, incluindo os registros aos quais você tem acesso, reorganize a ordem dos registros para que os registros aos quais você tem acesso sejam retornados primeiro.

    Nota:
    Valores sysparm_limit extraordinariamente grandes podem afetar o desempenho do sistema.

    Tipo de dados: número

    Padrão: 20

    Máximo: 100
    sysparm_offset Índice de registro inicial para o qual a recuperação de registros será iniciada. Use este valor para paginar a recuperação do registro. Essa funcionalidade permite a recuperação de todos os registros, independentemente do número de registros, em pequenos blocos gerenciáveis.

    Por exemplo, na primeira vez que você chama este endpoint, sysparm_offset é definido como "0". Para simplesmente percorrer todos os registros disponíveis, use sysparm_offset=sysparm_offset+sysparm_limitaté chegar ao fim de todos os registros.

    Não passe um número negativo no parâmetro sysparm_offset.

    Tipo de dados: número

    Padrão: 0
    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.
    400 Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada.
    403 Proibido. O usuário não tem direitos de acesso ao registro especificado.
    404 Não encontrado. O item solicitado não foi encontrado.
    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
    erro Detalhes sobre o erro que ocorreu ao tentar processar a solicitação.

    Tipo de dados: objeto

    "error": {
  "detail": "String",
  "message": "String"
}
    erro.detalhe Detalhes adicionais sobre o erro associado.

    Tipo de dados: cadeia de caracteres
    mensagem.erro Mensagem de erro que descreve o problema que ocorreu ao tentar executar a solicitação.

    Tipo de dados: cadeia de caracteres
    tem_mais Sinalizador que indica se há mais registros na tabela a serem retornados.
    Valores possíveis:
    • verdadeiro: mais registros a serem retornados.
    • falso: não há mais registros a serem retornados.

    Tipo de dados: cadeia de caracteres booliana
    itens Lista dos itens-base de instalação que corresponderam aos resultados do filtro especificados.

    Tipo de dados: matriz de objetos

    "items":[
  {
    "account": {Object},
    "active": "String",
    "asset": {Object},
    "configuration_item": {Object},
    "consumer": {Object},
    "consumer_profile": {Object},
    "contact": {Object},
    "health_status": {Object},
    "health_status_last_updated": "String",
    "household": {Object},
    "install_date": {Object},
    "location": {Object},
    "name": "String",
    "number": "String",
    "parent": {Object},
    "product": {Object},
    "service_context": {Object},
    "service_organization" {Object},
    "sys_class_name": "String",
    "sys_id": "String",
    "sys_mod_count": "String",
    "state": {Object},
    "status": {Object},
    "uninstall_date": "String"
  }
]
    itens.conta Detalhes sobre a conta do cliente associada ao registro do item-base de instalação.

    Tipo de dados: objeto

    "account": {
  "display_value": "String",
  "sys_id": "String"
}
    itens.conta.display_value Nome de texto da conta do cliente associada ao registro do item-base de instalação. Use este valor para exibir o nome da conta do cliente na IU.

    Tipo de dados: cadeia de caracteres
    itens.conta.sys_id Sys_id do registro de conta do cliente associado ao registro do item-base de instalação.

    Tipo de dados: cadeia de caracteres
    itens.ativos Sinalizador que indica se o item-base de instalação está ativo.
    Valores possíveis:
    • verdadeiro: o item-base de instalação está ativo.
    • falso: o item-base de instalação está inativo.

    Tipo de dados: cadeia de caracteres booliana
    itens.ativo Detalhes sobre o ativo associado ao registro do item-base de instalação.

    Tipo de dados: objeto

    "asset": {
  "display_value": "String",
  "sys_id": "String"
}
    itens.ativo.display_value Nome de texto do ativo associado ao registro do item-base de instalação. Use este valor para exibir o nome do ativo na IU.

    Tipo de dados: cadeia de caracteres
    itens.asset.sys_id Sys_id do registro de ativo associado ao registro do item-base de instalação.

    Tipo de dados: cadeia de caracteres
    itens.item_de_configuração Detalhes sobre o item de configuração associado ao registro do item-base de instalação.

    Tipo de dados: objeto

    "configuration_item": {
  "display_value": "String",
  "sys_id": "String"
}
    itens.configuration_item.display_value Nome de texto do item de configuração associado ao registro do item-base de instalação. Use este valor para exibir o nome do item de configuração na IU.

    Tipo de dados: cadeia de caracteres
    itens.configuration_item.sys_id Sys_id do registro do item de configuração associado ao registro do item-base de instalação.

    Tipo de dados: cadeia de caracteres
    itens.consumidor Detalhes sobre o consumidor associado ao registro do item-base de instalação.
    Nota:
    O campo do consumidor só estará disponível se o plug-in B2B2C estiver instalado.

    Tipo de dados: objeto

    "consumer": {
  "display_value": "String",
  "sys_id": "String"
}
    itens.consumidor.display_value Nome em texto do consumidor associado ao registro do item-base de instalação. Use este valor para exibir o nome do consumidor na IU.

    Tipo de dados: cadeia de caracteres
    itens.consumer.sys_id Sys_id do registro do consumidor associado ao registro do item-base de instalação.

    Tipo de dados: cadeia de caracteres
    itens.consumer_profile Detalhes sobre o perfil do consumidor associado ao registro do item-base de instalação.
    Nota:
    O campo de perfil do consumidor só estará disponível se o plug-in B2B2C estiver instalado.

    Tipo de dados: objeto

    "consumer_profile": {
  "display_value": "String",
  "sys_id": "String"
}
    itens.consumer_profile.display_value Nome de texto do perfil do consumidor associado ao registro do item-base de instalação. Use este valor para exibir o nome do perfil do consumidor na IU.

    Tipo de dados: cadeia de caracteres
    itens.consumer_profile.sys_id Sys_id do registro de perfil do consumidor associado ao registro do item-base de instalação.

    Tipo de dados: cadeia de caracteres
    itens.contato Detalhes sobre o contato da conta responsável pelo registro do item-base de instalação.

    Tipo de dados: objeto

    "contact": {
  "display_value": "String",
  "sys_id": "String"
}
    itens.contato.display_value Nome de texto do contato da conta associado ao registro do item-base de instalação. Use este valor para exibir o nome do contato da conta na IU.

    Tipo de dados: cadeia de caracteres
    itens.contato.sys_id Sys_id do registro de contato da conta associado ao registro do item-base de instalação.

    Tipo de dados: cadeia de caracteres
    itens.status_de_saúde Detalhes sobre o status de integridade atual do item-base de instalação. Retornado somente se o plug-in Operações proativas de atendimento ao cliente (com.snc.proactive_cs_itom) estiver instalado.

    Tipo de dados: objeto

    "health_status": {
  "display_value": "String",
  "value": "String"
}
    itens.status_de_saúde.valor_de_display Cadeia de caracteres de texto do status de integridade atual do item-base de instalação. Use este valor para exibir o status de integridade na IU.

    Tipo de dados: cadeia de caracteres
    itens.status_de_saúde.valor Valor interno do status de integridade do item-base de instalação.

    Tipo de dados: cadeia de caracteres
    itens.status_de_saúde_último_atualizado Data e hora em que o status de integridade foi atualizado pela última vez para o item-base de instalação.

    Tipo de dados: cadeia de caracteres
    itens.residência Detalhes sobre a residência associada ao registro do item-base de instalação. Retornado somente se o plug-in Residência do Atendimento ao cliente (com.snc.household) estiver instalado.

    Tipo de dados: objeto

    "household": {
  "display_value": "String",
  "sys_id": "String"
}
    itens.household.display_value Nome em texto da residência associada ao registro do item-base de instalação. Use este valor para exibir o nome da residência na IU.

    Tipo de dados: cadeia de caracteres
    itens.household.sys_id Sys_id da residência associada ao registro do item-base de instalação.

    Tipo de dados: cadeia de caracteres
    itens.install_date Detalhes sobre a data em que o item-base de instalação se tornou ativo.

    Tipo de dados: objeto

    "install_date": {
  "display_value": "String",
  "value": "String"
}
    itens.install_date.display_value Data de instalação de texto. Use este valor para exibir a data de instalação na IU.

    Tipo de dados: cadeia de caracteres
    itens.install_date.value Valor interno da data de instalação.

    Tipo de dados: cadeia de caracteres
    itens.local Detalhes sobre o local do item-base de instalação.

    Tipo de dados: objeto

    "location": {
  "display_value": "String",
  "sys_id": "String"
}
    itens.local.display_value Nome de texto do local do item-base de instalação. Use este valor para exibir o nome do local na IU.

    Tipo de dados: cadeia de caracteres
    itens.local.sys_id Sys_id do registro de local associado ao registro do item-base de instalação.

    Tipo de dados: cadeia de caracteres
    items.name Nome do item-base de instalação.

    Tipo de dados: cadeia de caracteres
    itens.número ID exclusivo do item-base de instalação.

    Tipo de dados: cadeia de caracteres
    itens.primário Detalhes sobre o registro primário do registro do item-base de instalação.

    Tipo de dados: objeto

    "parent": {
  "display_value": "String",
  "sys_id": "String"
}
    itens.primário.display_value Nome de texto do registro primário associado ao registro do item-base de instalação. Use este valor para exibir o nome primário na IU.

    Tipo de dados: cadeia de caracteres
    itens.parent.sys_id Sys_id do registro primário associado ao registro do item-base de instalação.

    Tipo de dados: cadeia de caracteres
    itens.produto Detalhes sobre o modelo de produto associado ao registro do item-base de instalação. Use essas informações para identificar os serviços associados a qualquer modelo de produto.

    Tipo de dados: objeto

    "product": {
  "display_value": "String",
  "sys_id": "String"
}
    itens.produto.display_value Nome de texto do modelo de produto associado ao registro do item-base de instalação. Use este valor para exibir o nome do produto na IU.

    Tipo de dados: cadeia de caracteres
    itens.produto.sys_id Sys_id do registro do modelo do produto associado ao registro do item-base de instalação.

    Tipo de dados: cadeia de caracteres
    itens.service_context Detalhes sobre o contexto de serviço associado ao registro do item-base de instalação.

    Tipo de dados: objeto

    "service_context": {
  "display_value": "String",
  "sys_id": "String"
}
    itens.service_context.display_value Nome de texto do contexto de serviço associado ao registro do item-base de instalação. Use este valor para exibir o nome do contexto de serviço na IU.

    Tipo de dados: cadeia de caracteres
    itens.service_context.sys_id Sys_id do registro de contexto de serviço associado ao registro do item-base de instalação.

    Tipo de dados: cadeia de caracteres
    itens.serviço_organização Detalhes sobre a organização de serviço associada ao registro do item-base de instalação. Retornado somente se o plug-in Organização de serviço (com.snc.service_organization) estiver instalado.

    Tipo de dados: objeto

    "service_organization": {
  "display_value": "String",
  "sys_id": "String"
}
    itens.service_organization.display_value Nome de texto da organização de serviço associada ao registro do item-base de instalação. Use este valor para exibir o nome da organização de serviço na IU.

    Tipo de dados: cadeia de caracteres
    itens.service_organization.sys_id Sys_id do registro da organização de serviço associado ao registro do item-base de instalação.

    Tipo de dados: cadeia de caracteres
    itens.sys_class_name Tabela que contém o registro do item-base de instalação.

    Tipo de dados: cadeia de caracteres
    itens.sys_id Sys_id do registro do item-base de instalação. Localizado na tabela especificada no parâmetro sys_class_name.

    Tipo de dados: cadeia de caracteres
    itens.sys_mod_count Número de vezes em que o registro do item-base de instalação associado foi modificado.

    Tipo de dados: cadeia de caracteres
    itens.estado Detalhes sobre o estado atual do item-base de instalação.

    Tipo de dados: objeto

    "state": {
  "display_value": "String",
  "value": "String"
}
    itens.estado.display_value Cadeia de caracteres de texto do estado atual do item-base de instalação. Use este valor para exibir o estado na IU.

    Tipo de dados: cadeia de caracteres
    itens.estado.valor Valor interno do estado do item-base de instalação.

    Tipo de dados: cadeia de caracteres
    itens.status Detalhes sobre o status do item-base de instalação.

    Tipo de dados: objeto

    "status": {
  "display_value": "String",
  "value": "String"
}
    itens.status.display_value Cadeia de caracteres de texto do status do item-base de instalação. Use este valor para exibir o status na IU.

    Tipo de dados: cadeia de caracteres
    itens.status.valor Valor interno do status do item-base de instalação.

    Tipo de dados: cadeia de caracteres
    itens.uninstall_date Detalhes sobre a data em que o item-base de instalação se tornou inativo.

    Tipo de dados: objeto

    "uninstall_date": {
  "display_value": "String",
  "value": "String"
}
    itens.uninstall_date.display_value Data de desinstalação de texto. Use este valor para exibir a data de desinstalação na IU.

    Tipo de dados: cadeia de caracteres
    itens.uninstall_date.value Valor interno da data de desinstalação.

    Tipo de dados: cadeia de caracteres
    status Status da chamada do endpoint.

    Tipo de dados: cadeia de caracteres
    sysparm_profundidade Número de níveis de profundidade em que o item-base de instalação secundário retornado está na hierarquia.

    Tipo de dados: inteiro
    sysparm_limit Número de registros retornados. Se este valor não for especificado na solicitação original, ele usará o valor padrão.

    Tipo de dados: número
    sysparm_offset Deslocamento (ponto de partida) na tabela associada da qual os registros foram avaliados e recuperados.

    Tipo de dados: cadeia de caracteres

    Solicitação de cURL

    O exemplo de código a seguir mostra como chamar este endpoint.

    curl "https://instance.servicenow.com/api/sn_install_base/integrations/installbaseitems/767f34d378d21110f877d304c76fdd2a/childinstallbaseitems?sysparm_limit=1" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

    Retornar resultados:

    {
  "result": {
    "sysparm_offset": 0,
    "sysparm_limit": 1,
    "has_more": true,
    "items": [
      {
        "parent": {
          "sys_id": "767f34d378d21110f877d304c76fdd2a",
          "display_value": "X5 Sport Utility 4D"
        },
        "sys_class_name": "sn_install_base_item",
        "number": "IBITM0001005",
        "sys_id": "0704dfcc39265110f87734024cfbc222",
        "state": {
          "value": "in_use",
          "display_value": "In Use"
        },
        "consumer": {
          "sys_id": "bab5139ab3401010700b4d43c6a8dc41",
          "display_value": "Charles Barkley"
        },
        "product": {
          "sys_id": "56c84f0439265110f87734024cfbc233",
          "display_value": "Electric Power-Assist Speed-Sensing Steering"
        },
        "active": "true",
        "name": "Electric Power-Assist Speed-Sensing Steering",
        "status": {
          "value": "original",
          "display_value": "Original"
        }
      }
    ],
    "status": "SUCCESS"
  }
}

    Item-base de instalação - GET /sn_install_base/integrations/installbaseitems/{id}/contracts

    Retorna os contratos associados a um registro de item-base de instalação especificado.

    Formato da URL

    URL com controle de versões: /api/sn_install_base/{api_version}/integrations/installbaseitems/{id}/contracts

    URL padrão: /api/sn_install_base/integrations/installbaseitems/{id}/contracts

    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
    id Sys_id do registro do item-base de instalação.

    Tipo de dados: cadeia de caracteres

    Tabela: item-base de instalação [sn_install_base_item]
    Tabela 32. Parâmetros de consulta
    Nome Descrição
    pares de nome-valor de campo Pares de campo-valor a serem usados para filtrar os registros de contrato. Por padrão, isso faz referência aos campos na tabela Contrato [ast_contract]. Se você especificar uma tabela diferente em sys_class_name, especifique os campos nessa tabela.

    Você pode passar um ou mais pares de valores de campo para filtrar os resultados retornados.

    Por exemplo, para retornar somente registros em que o campo renovável está definido como "verdadeiro", passe o seguinte: &renewable=true.

    Tipo de dados: cadeia de caracteres

    Padrão: todos os campos
    sys_class_name Se estiver usando uma tabela de contratos estendidos (não ast_contract), o nome da tabela estendida a ser consultada.

    Tipo de dados: cadeia de caracteres

    Padrão: ast_contract
    sysparm_limit Número máximo de registros a serem retornados. Para solicitações que excedem esse número de registros, use o parâmetro sysparm_offset para paginar a recuperação do registro.

    Este limite é aplicado antes da avaliação da ACL. Se nenhum registro for retornado, incluindo os registros aos quais você tem acesso, reorganize a ordem dos registros para que os registros aos quais você tem acesso sejam retornados primeiro.

    Nota:
    Valores sysparm_limit extraordinariamente grandes podem afetar o desempenho do sistema.

    Tipo de dados: número

    Padrão: 20

    Máximo: 100
    sysparm_offset Índice de registro inicial para o qual a recuperação de registros será iniciada. Use este valor para paginar a recuperação do registro. Essa funcionalidade permite a recuperação de todos os registros, independentemente do número de registros, em pequenos blocos gerenciáveis.

    Por exemplo, na primeira vez que você chama este endpoint, sysparm_offset é definido como "0". Para simplesmente percorrer todos os registros disponíveis, use sysparm_offset=sysparm_offset+sysparm_limitaté chegar ao fim de todos os registros.

    Não passe um número negativo no parâmetro sysparm_offset.

    Tipo de dados: número

    Padrão: 0
    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.
    400 Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada.
    403 Proibido. O usuário não tem direitos de acesso ao registro especificado.
    404 Não encontrado. O item solicitado não foi encontrado.
    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
    contracts Lista dos contratos associados ao registro do item-base de instalação especificado.

    Tipo de dados: matriz de objeto

    "contracts": [
  {
    "active": "String", 
    "approver": {Object},
    "commitment": "String",
    "consumer": {Object},
    "cost_adjustment": "String",
    "cost_adjustment_percentage": "String",
    "cost_per_unit": "String",
    "contract_composite": "String",
    "ends": "String",
    "expiration": {Object},
    "lifetime_cost": "String",
    "monthly_cost": "String",
    "number": "String",
    "payment_amount": "String",
    "payment_schedule": {Object},
    "ratecard": "String",
    "renewable": "String",
    "sales_tax": "String",
    "short_description": "String",
    "starts": "String",
    "state": {Object},
    "sub_total_cost": "String",
    "sys_class_name": "String",
    "sys_domain_path": "String",
    "sys_id": "String",
    "tax_cost": "String",
    "tax_exempt": "String",
    "tax_rate": "String",
    "total_cost": "String",
    "vendor_contract": "String",
    "yearly_cost": "String"
  }
]
    contratos.ativos Sinalizador que indica se o contrato está ativo.
    Valores possíveis:
    • verdadeiro: o contrato está ativo.
    • falso: o contrato está inativo.

    Tipo de dados: cadeia de caracteres booliana
    contratos.aprovador Detalhes sobre a pessoa autorizada a aprovar o contrato.

    Tipo de dados: objeto

    "approver": {
  "display_value": "String",
  "sys_id": "String"
}
    contratos.aprovador.display_value Nome de texto do aprovador associado ao registro de contratos. Use este valor para exibir o nome do aprovador na IU.

    Tipo de dados: cadeia de caracteres
    contratos.aprovador.sys_id Sys_id do registro do aprovador associado ao registro de contratos.

    Tipo de dados: cadeia de caracteres
    contratos.consumidor Detalhes sobre o consumidor associado ao registro de contratos.
    Nota:
    O campo do consumidor só estará disponível se o plug-in B2B2C estiver instalado.

    Tipo de dados: objeto

    "consumer": {
  "display_value": "String",
  "sys_id": "String"
}
    contratos.consumidor.display_value Nome em texto do consumidor associado ao registro de contratos. Use este valor para exibir o nome do consumidor na IU.

    Tipo de dados: cadeia de caracteres
    contratos.consumidor.sys_id Sys_id do registro do consumidor associado ao registro de contratos.

    Tipo de dados: cadeia de caracteres
    contratos.custo_ajuste Tipo de ajuste de custo aplicado ao contrato.

    Valores possíveis:

    • Fixo
    • Manual
    • CPI (índice de preços ao consumidor)

    Tipo de dados: cadeia de caracteres
    contratos.custo_ajuste_porcentagem Aumento ou diminuição da porcentagem do preço do contrato. Para indicar uma redução no preço, insira uma porcentagem negativa. Um Ajuste de custo ou Porcentagem de ajuste de custo pode ser especificado, mas não ambos.

    Tipo de dados: cadeia de caracteres
    contratos.custo_por_unidade Custo por unidade do fornecedor do produto.

    Tipo de dados: cadeia de caracteres
    contratos.término Data em que o contrato termina.

    Tipo de dados: cadeia de caracteres
    contratos.expiração Detalhes sobre o status de expiração do contrato associado.

    Tipo de dados: objeto

    "expiration": {
  "display_value": "String",
  "sys_id": "String"
}
    contratos.expiração.display_value Status de expiração do contrato associado. Use este valor para exibir o status de expiração na IU.

    Tipo de dados: cadeia de caracteres
    contratos.expiração.sys_id Sys_id do registro de expiração associado ao registro de contratos.

    Tipo de dados: cadeia de caracteres
    contratos.lifetime_cost Custo vitalício do contrato.

    Tipo de dados: cadeia de caracteres
    contratos.custo_mensal Custo mensal do contrato.

    Tipo de dados: cadeia de caracteres
    contratos.número Número do contrato.

    Tipo de dados: cadeia de caracteres
    contratos.valor_pagamento Valor que foi pago diretamente à parte receptora deste contrato.

    Tipo de dados: cadeia de caracteres
    contratos.pagamento_programação Detalhes sobre a programação de pagamento associada ao contrato.

    Tipo de dados: objeto

    "payment_schedule": {
  "display_value": "String",
  "sys_id": "String"
}
    contratos.pagamento_programação.display_value Programação de pagamento para o contrato associado. Use este valor para exibir a programação de pagamento na IU.

    Tipo de dados: cadeia de caracteres
    contratos.pagamento_programação.valor Valor interno da programação de pagamento para este contrato, como diário, semanal ou mensal.

    Tipo de dados: cadeia de caracteres
    contratos.cartãodetaxa Sinalizador que indica se há uma tabela de valores associada a este contrato.
    Valores possíveis:
    • verdadeiro: tabela de valores.
    • falso: nenhuma tabela de valores.

    Tipo de dados: cadeia de caracteres booliana

    Tabela: Taxa de cuidado [fm_contract_rate_card]
    contratos.renováveis Sinalizador que indica se o contrato é renovável.
    Valores possíveis:
    • verdadeiro: o contrato é renovável.
    • falso: o contrato não é renovável.

    Tipo de dados: cadeia de caracteres booliana
    contratos.imposto_de_vendas Sinalizador que indica se o imposto sobre vendas é cobrado para itens referenciados por este contrato.
    Valores possíveis:
    • verdadeiro: o imposto sobre vendas é cobrado.
    • falso: nenhum imposto sobre vendas é cobrado.

    Tipo de dados: cadeia de caracteres booliana
    contratos.short_description Breve descrição do contrato.

    Tipo de dados: cadeia de caracteres
    contratos.inícios Data em que o contrato começa.

    Tipo de dados: cadeia de caracteres
    contratos.estado Detalhes sobre o estado atual do contrato.

    Tipo de dados: objeto

    "state": {
  "display_value": "String",
  "value": "String"
}
    contratos.estado.exibição_valor Cadeia de caracteres de texto do estado atual do contrato. Use este valor para exibir o estado na IU.

    Tipo de dados: cadeia de caracteres
    contratos.estado.valor Valor interno ou o estado do contrato.

    Tipo de dados: cadeia de caracteres
    contratos.sub_total_custo Subtotal do custo do contrato.

    Tipo de dados: cadeia de caracteres
    contratos.sys_class_name Tabela que contém o registro do contrato.

    Tipo de dados: cadeia de caracteres
    contratos.sys_domain_path Caminho para o domínio no qual este contrato está disponível.

    Tipo de dados: cadeia de caracteres

    Padrão: "/" = domínio global
    contratos.sys_id Sys_id do registro do contrato associado.

    Tipo de dados: cadeia de caracteres
    contratos.imposto_custo Imposto total sobre o contrato.

    Este campo ficará visível somente se o campo de impostos aplicáveis estiver selecionado como Vendas.

    Tipo de dados: cadeia de caracteres
    contratos.taxa_exempt Sinalizador que indica se os itens associados a este contrato estão isentos de impostos.
    Valores possíveis:
    • verdadeiro: os itens estão isentos de impostos.
    • falso: os itens não estão isentos de impostos.

    Tipo de dados: cadeia de caracteres booliana
    contratos.taxa_taxa Taxa de imposto cobrada para itens tributáveis associados ao contrato.

    Tipo de dados: cadeia de caracteres
    contratos.custo_total Custo final do contrato após a aplicação de ajustes Se um contrato tiver uma ou mais tabelas de preços, este campo mostrará o valor combinado de todas as tabelas de preços.

    Tipo de dados: cadeia de caracteres
    contratos.fornecedor_contrato Número do contrato do fornecedor.

    Tipo de dados: cadeia de caracteres
    contratos.custo_anual Custo por ano do contrato.

    Tipo de dados: cadeia de caracteres
    erro Detalhes sobre o erro que ocorreu ao tentar processar a solicitação.

    Tipo de dados: objeto

    "error": {
  "detail": "String",
  "message": "String"
}
    erro.detalhe Detalhes adicionais sobre o erro associado.

    Tipo de dados: cadeia de caracteres
    mensagem.erro Mensagem de erro que descreve o problema que ocorreu ao tentar executar a solicitação.

    Tipo de dados: cadeia de caracteres
    tem_mais Sinalizador que indica se há mais registros na tabela a serem retornados.
    Valores possíveis:
    • verdadeiro: mais registros a serem retornados.
    • falso: não há mais registros a serem retornados.

    Tipo de dados: cadeia de caracteres booliana
    status Status da chamada do endpoint.

    Tipo de dados: cadeia de caracteres
    sysparm_limit Número de registros retornados. Se este valor não for especificado na solicitação original, ele usará o valor padrão.

    Tipo de dados: número
    sysparm_offset Deslocamento (ponto de partida) na tabela associada da qual os registros foram avaliados e recuperados.

    Tipo de dados: cadeia de caracteres

    Solicitação de cURL

    O exemplo de código a seguir mostra como chamar este endpoint.

    curl "https://instance.servicenow.com/api/sn_install_base/integrations/installbaseitems/167e96f053961910539dddeeff7b1298/contracts" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

    Retornar resultados:

    {
  "result": {
    "sysparm_offset": 0,
    "sysparm_limit": 10,
    "has_more": false,
    "contracts": [
      {
        "cost_adjustment_percentage": "0",
        "total_cost": "0",
        "cost_adjustment": "0",
        "tax_rate": "7.75",
        "number": "CNTR0000701",
        "tax_cost": "0",
        "sub_total_cost": "0",
        "state": {
          "value": "expired",
          "display_value": "Expired"
        },
        "starts": "2016-07-01",
        "contract_composite": "CoolMate KL300 1 year Limited Warranty\n\t\t​CNTR0000701",
        "tax_exempt": "false",
        "yearly_cost": "0",
        "active": "true",
        "payment_amount": "0",
        "commitment": "0",
        "sys_domain_path": "/",
        "payment_schedule": {
          "value": "Monthly",
          "display_value": "Monthly"
        },
        "renewable": "true",
        "expiration": {
          "sys_id": "c752e78ec3103000c111113e5bba8f3a",
          "display_value": "Expired"
        },
        "short_description": "CoolMate KL300 1 year Limited Warranty\n\t\t",
        "ratecard": "false",
        "sys_class_name": "ast_contract",
        "sys_id": "3f9db778c3302200e7c7d44d81d3ae0a",
        "ends": "2017-06-30",
        "consumer": {
          "sys_id": "59e788fbdb1b1200b6075200cf9619d2",
          "display_value": "Gilly Parker"
        },
        "approver": {
          "sys_id": "f2c0b27247702000cdd1706eecde27c8",
          "display_value": "Software Manager"
        },
        "monthly_cost": "0",
        "vendor_contract": "CNTR0000701",
        "lifetime_cost": "0",
        "sales_tax": "true",
        "cost_per_unit": "0"
      }
    ],
    "status": "SUCCESS"
  }
}

    Item-base de instalação - GET /sn_install_base/integrations/installbaseitems/{id}/entitlements

    Retorna os direitos associados a um registro de item-base de instalação especificado.

    Formato da URL

    URL com controle de versões: /api/sn_install_base/{api_version}/integrations/installbaseitems/{id}/entitlements

    URL padrão: /api/sn_install_base/integrations/installbaseitems/{id}/entitlements

    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
    id Sys_id do registro do item-base de instalação.

    Tipo de dados: cadeia de caracteres

    Tabela: item-base de instalação [sn_install_base_item]
    Tabela 38. Parâmetros de consulta
    Nome Descrição
    pares de nome-valor de campo Pares de campo-valor a serem usados para filtrar os registros de direitos. Por padrão, isso faz referência aos campos na tabela Direito [service_entitlement]. Se você especificar uma tabela diferente em sys_class_name, especifique os campos nessa tabela.

    Você pode passar um ou mais pares de valores de campo para filtrar os resultados retornados.

    Por exemplo, para retornar somente registros que estão ativos, passe o seguinte: &active=true.

    Tipo de dados: cadeia de caracteres

    Padrão: todos os campos
    sys_class_name Se estiver usando uma tabela de direitos estendidos (não service_entitlement), o nome da tabela estendida a ser consultada.

    Tipo de dados: cadeia de caracteres

    Padrão: service_entitlement
    sysparm_limit Número máximo de registros a serem retornados. Para solicitações que excedem esse número de registros, use o parâmetro sysparm_offset para paginar a recuperação do registro.

    Este limite é aplicado antes da avaliação da ACL. Se nenhum registro for retornado, incluindo os registros aos quais você tem acesso, reorganize a ordem dos registros para que os registros aos quais você tem acesso sejam retornados primeiro.

    Nota:
    Valores sysparm_limit extraordinariamente grandes podem afetar o desempenho do sistema.

    Tipo de dados: número

    Padrão: 20

    Máximo: 100
    sysparm_offset Índice de registro inicial para o qual a recuperação de registros será iniciada. Use este valor para paginar a recuperação do registro. Essa funcionalidade permite a recuperação de todos os registros, independentemente do número de registros, em pequenos blocos gerenciáveis.

    Por exemplo, na primeira vez que você chama este endpoint, sysparm_offset é definido como "0". Para simplesmente percorrer todos os registros disponíveis, use sysparm_offset=sysparm_offset+sysparm_limitaté chegar ao fim de todos os registros.

    Não passe um número negativo no parâmetro sysparm_offset.

    Tipo de dados: número

    Padrão: 0
    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.
    400 Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada.
    403 Proibido. O usuário não tem direitos de acesso ao registro especificado.
    404 Não encontrado. O item solicitado não foi encontrado.
    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
    direitos Lista dos direitos associados ao registro do item-base de instalação especificado.

    Tipo de dados: objeto

    "entitlements": {
  "account": {Object},
  "active": "String",
  "business_hour": {Object},
  "contract": {Object},
  "end_date": "String",
  "entitlement_name": "String",
  "install_base_item": {Object},
  "per_unit": "String",
  "start_date": "String",
  "sys_id": "String",
  "total_units": "String",
  "remaining_units": "String",
  "unit": {Object}
  }
    direitos.conta Detalhes sobre a conta associada ao registro de direitos.

    Tipo de dados: objeto

    "account": {
  "display_value": "String",
  "sys_id": "String"
}
    direitos.account.display_value Nome de texto da conta associada ao registro de direitos. Use este valor para exibir o nome da conta na IU.

    Tipo de dados: cadeia de caracteres
    direitos.account.sys_id Sys_id do registro de conta associado ao registro de direitos.

    Tipo de dados: cadeia de caracteres
    direitos.ativos Sinalizador que indica se o direito está ativo.
    Valores possíveis:
    • 0: o direito não está ativo.
    • 1: o direito está ativo.

    Tipo de dados: cadeia de caracteres

    Padrão: 1
    direitos.hora_negócios Detalhes sobre o horário comercial do registro de direitos.

    Tipo de dados: objeto

    "business_hour": {
  "display_value": "String",
  "sys_id": "String"
}
    direitos.business_hour.display_value Nome de texto do registro de horário comercial associado ao registro de direitos. Use este valor para exibir o horário comercial na IU.

    Tipo de dados: cadeia de caracteres
    direitos.business_hour.sys_id Sys_id do registro de horário comercial associado ao registro de direitos.

    Tipo de dados: cadeia de caracteres
    direitos.contrato Detalhes sobre o contrato associado ao registro de direito.

    Tipo de dados: objeto

    "contract": {
  "display_value": "String",
  "sys_id": "String"
}
    direitos.contract.display_value Nome de texto do contrato associado ao registro de direito. Use este valor para exibir o nome do contrato na IU.

    Tipo de dados: cadeia de caracteres
    direitos.contract.sys_id Sys_id do registro de contrato associado ao registro de direito.

    Tipo de dados: cadeia de caracteres
    direitos.end_date Data de término do direito.

    Tipo de dados: cadeia de caracteres
    direitos.direito_nome Nome do direito.

    Tipo de dados: cadeia de caracteres
    direitos.install_base_item Detalhes sobre o item-base de instalação associado ao registro de direitos.

    Tipo de dados: objeto

    "install_base_item": {
  "display_value": "String",
  "sys_id": "String"
}
    direitos.install_base_item.display_value Nome de texto do item-base de instalação associado ao registro de direitos. Use este valor para exibir o nome do item-base de instalação na IU.

    Tipo de dados: cadeia de caracteres
    direitos.install_base_item.sys_id Sys_id do registro do item-base de instalação associado ao registro de direitos.

    Tipo de dados: cadeia de caracteres
    direitos.por_unidade Número de produtos em uma unidade. Por exemplo, se o unit for caso, este valor será 12 se houver 12 itens por caso.

    Tipo de dados: cadeia de caracteres
    direitos.data_início Data de início do direito.

    Tipo de dados: cadeia de caracteres
    direitos.sys_id Sys_id do registro de direitos associados.

    Tipo de dados: cadeia de caracteres
    direitos.total_units Número de unidades que estavam disponíveis originalmente.

    Tipo de dados: cadeia de caracteres
    direitos.remaining_units Número de unidades restantes.

    Tipo de dados: cadeia de caracteres
    direitos.unidade Detalhes sobre a unidade do item associado ao registro de direitos.

    Tipo de dados: objeto

    "unit": {
  "display_value": "String",
  "value": "String"
}
    direitos.unidade.display_value Nome de texto da unidade do item associado ao registro de direitos. Use este valor para exibir o nome da unidade na IU.

    Tipo de dados: cadeia de caracteres
    direitos.unidade.valor Nome interno da unidade do item associado ao registro de direitos.

    Tipo de dados: cadeia de caracteres
    erro Detalhes sobre o erro que ocorreu ao tentar processar a solicitação.

    Tipo de dados: objeto

    "error": {
  "detail": "String",
  "message": "String"
}
    erro.detalhe Detalhes adicionais sobre o erro associado.

    Tipo de dados: cadeia de caracteres
    mensagem.erro Mensagem de erro que descreve o problema que ocorreu ao tentar executar a solicitação.

    Tipo de dados: cadeia de caracteres
    tem_mais Sinalizador que indica se há mais registros na tabela a serem retornados.
    Valores possíveis:
    • verdadeiro: mais registros a serem retornados.
    • falso: não há mais registros a serem retornados.

    Tipo de dados: cadeia de caracteres booliana
    status Status da chamada do endpoint.

    Tipo de dados: cadeia de caracteres
    sysparm_limit Número de registros retornados. Se este valor não for especificado na solicitação original, ele usará o valor padrão.

    Tipo de dados: número
    sysparm_offset Deslocamento (ponto de partida) na tabela associada da qual os registros foram avaliados e recuperados.

    Tipo de dados: cadeia de caracteres

    Solicitação de cURL

    O exemplo de código a seguir mostra como chamar este endpoint.

    curl "https://instance.servicenow.com/api/sn_install_base/integrations/installbaseitems/42746a3b876121100b6afc86dabb3597/entitlements" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

    Retornar resultados:

    {
  "result": {
    "sysparm_offset": 0,
    "sysparm_limit": 10,
    "has_more": false,
    "entitlements": [
      {
        "end_date": "2023-04-28",
        "remaining_units": "4978",
        "business_hour": {
          "sys_id": "08fcd0830a0a0b2600079f56b1adb9ae",
          "display_value": "8-5 weekdays"
        },
        "entitlement_name": "Entitlement",
        "sys_id": "7206095d87f121105d0055373cbb3504",
        "total_units": "5000",
        "start_date": "2023-03-27",
        "contract": {
          "sys_id": "495e16b96f0731003b3c498f5d3ee4af",
          "display_value": "CNTR0000603"
        },
        "active": "1",
        "install_base_item": {
          "sys_id": "42746a3b876121100b6afc86dabb3597",
          "display_value": "KX Series - KX5000"
        },
        "unit": {
          "value": "cases",
          "display_value": "Cases"
        },
        "per_unit": "0",
        "account": {
          "sys_id": "86837a386f0331003b3c498f5d3ee4ca",
          "display_value": "Boxeo"
        }
      }
    ],
    "status": "SUCCESS"
  }
}

    Item-base de instalação - GET /sn_install_base/integrations/installbaseitems/{id}/maintenanceplans

    Retorna os planos de manutenção associados a um registro de item-base de instalação especificado.

    Formato da URL

    URL com controle de versões: /api/sn_install_base/{api_version}/integrations/installbaseitems/{id}/maintenanceplans

    URL padrão: /api/sn_install_base/integrations/installbaseitems/{id}/maintenanceplans

    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
    id Sys_id do registro do item-base de instalação.

    Tipo de dados: cadeia de caracteres

    Tabela: item-base de instalação [sn_install_base_item]
    Tabela 44. Parâmetros de consulta
    Nome Descrição
    pares de nome-valor de campo Pares de campo-valor a serem usados para filtrar os registros do plano de manutenção. Por padrão, isso faz referência aos campos na tabela Plano de manutenção [sm_maint_plan]. Se você especificar uma tabela diferente em sys_class_name, especifique os campos nessa tabela.

    Você pode passar um ou mais pares de valores de campo para filtrar os resultados retornados.

    Por exemplo, para retornar somente os registros que estão ativos, passe o seguinte: &active=true.

    Tipo de dados: cadeia de caracteres

    Padrão: todos os campos
    sys_class_name Se estiver usando uma tabela de planos de manutenção estendida (não planos de manutenção), o nome da tabela estendida a ser consultada.

    Tipo de dados: cadeia de caracteres

    Padrão: planos de manutenção
    sysparm_limit Número máximo de registros a serem retornados. Para solicitações que excedem esse número de registros, use o parâmetro sysparm_offset para paginar a recuperação do registro.

    Este limite é aplicado antes da avaliação da ACL. Se nenhum registro for retornado, incluindo os registros aos quais você tem acesso, reorganize a ordem dos registros para que os registros aos quais você tem acesso sejam retornados primeiro.

    Nota:
    Valores sysparm_limit extraordinariamente grandes podem afetar o desempenho do sistema.

    Tipo de dados: número

    Padrão: 20

    Máximo: 100
    sysparm_offset Índice de registro inicial para o qual a recuperação de registros será iniciada. Use este valor para paginar a recuperação do registro. Essa funcionalidade permite a recuperação de todos os registros, independentemente do número de registros, em pequenos blocos gerenciáveis.

    Por exemplo, na primeira vez que você chama este endpoint, sysparm_offset é definido como "0". Para simplesmente percorrer todos os registros disponíveis, use sysparm_offset=sysparm_offset+sysparm_limitaté chegar ao fim de todos os registros.

    Não passe um número negativo no parâmetro sysparm_offset.

    Tipo de dados: número

    Padrão: 0
    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.
    400 Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada.
    403 Proibido. O usuário não tem direitos de acesso ao registro especificado.
    404 Não encontrado. O item solicitado não foi encontrado.
    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
    erro Detalhes sobre o erro que ocorreu ao tentar processar a solicitação.

    Tipo de dados: objeto

    "error": {
  "detail": "String",
  "message": "String"
}
    erro.detalhe Detalhes adicionais sobre o erro associado.

    Tipo de dados: cadeia de caracteres
    mensagem.erro Mensagem de erro que descreve o problema que ocorreu ao tentar executar a solicitação.

    Tipo de dados: cadeia de caracteres
    tem_mais Sinalizador que indica se há mais registros na tabela a serem retornados.
    Valores possíveis:
    • verdadeiro: mais registros a serem retornados.
    • falso: não há mais registros a serem retornados.

    Tipo de dados: cadeia de caracteres booliana
    planos de manutenção Lista dos planos de manutenção associados ao registro do item-base de instalação especificado.

    Tipo de dados: matriz de objeto

    "maintenanceplans": [
  {
    "active": "String",
    "apply_to_new": "String",
    "allow_future_wo": "String",
    "maintenance_override_policy": {Object},
    "model": "String",
    "name": "String",
    "number": "String",
    "propagation_flag": "String",
    "sys_class_name": "String",
    "sys_id": "String",
    "table": "String",
    "type": {Object}
  }
]
    planosdemanutenção.​​ativo Sinalizador que indica se o plano de manutenção está ativo.
    Valores possíveis:
    • verdadeiro: o plano de manutenção está ativo.
    • falso: o plano de manutenção está inativo.

    Tipo de dados: cadeia de caracteres
    planosdemanutenção.​​apply_to_new Sinalizador que indica se os cronogramas definidos para este plano de manutenção são aplicados a todos os registros que foram adicionados à tabela especificada desde a última vez em que o plano foi executado e que atendem às condições inseridas na condição de filtro.
    Valores possíveis:
    • verdadeiro: aplicado a todos os novos registros.
    • falso: não aplicado a todos os novos registros.

    Tipo de dados: cadeia de caracteres
    planosdemanutenção.​​allow_future_wo Sinalizador que indica se as ordens de serviço podem ser associadas ao plano de manutenção.
    Valores possíveis:
    • verdadeiro: novas ordens de serviço podem ser associadas.
    • falso: nenhuma nova ordem de serviço pode ser associada.

    Tipo de dados: cadeia de caracteres
    planosdemanutenção.​​maintenance_override_policy Detalhes sobre a política de substituição de manutenção para o plano de manutenção.

    Tipo de dados: objeto

    "maintenance_override_policy": {
  "display_value": "String",
  "value": "String"
}
    planosdemanutenção.​​maintenance_override_policy.​​display_value Cadeia de caracteres de texto que descreve a política de substituição. Use este valor para exibir a política de substituição na IU.

    Tipo de dados: cadeia de caracteres
    planosdemanutenção.​​maintenance_override_policy.​​value Valor interno da política de substituição.

    Tipo de dados: cadeia de caracteres
    planosdemanutenção.​​modelo Sys_id do registro do modelo associado ao plano de manutenção.

    Tipo de dados: cadeia de caracteres
    planosdemanutenção.​​número Número do plano de manutenção.

    Tipo de dados: cadeia de caracteres
    planosdemanutenção.​​propagation_flag Sinalizador que indica se o plano de manutenção pode ser propagado.
    Valores possíveis:
    • verdadeiro: o plano de manutenção pode ser propagado.
    • falso: o plano de manutenção não pode ser propagado.

    Tipo de dados: cadeia de caracteres
    planosdemanutenção.​​sys_class_name Tabela que contém o registro do plano de manutenção.

    Tipo de dados: cadeia de caracteres
    planosdemanutenção.​​sys_id Sys_id do plano de manutenção associado.

    Tipo de dados: cadeia de caracteres
    manutençãoplanos.​​tabela Tabela que contém o registro de hora da base de instalação associado.

    Tipo de dados: cadeia de caracteres
    manutençãoplanos.​​tipo Detalhes sobre o tipo de plano de manutenção.

    Tipo de dados: objeto

    "type": {
  "display_value": "String",
  "value": "String"
}
    planosdemanutenção.​​type.​​display_value Cadeia de caracteres de texto que descreve o tipo de plano de manutenção. Use este valor para exibir o tipo na IU.

    Tipo de dados: cadeia de caracteres
    planosdemanutenção.​​tipo.​​valor Valor interno do tipo de plano de manutenção.

    Tipo de dados: cadeia de caracteres
    status Status da chamada do endpoint.

    Tipo de dados: cadeia de caracteres
    sysparm_limit Número de registros retornados. Se este valor não for especificado na solicitação original, ele usará o valor padrão.

    Tipo de dados: número
    sysparm_offset Deslocamento (ponto de partida) na tabela associada da qual os registros foram avaliados e recuperados.

    Tipo de dados: cadeia de caracteres

    Solicitação de cURL

    O exemplo de código a seguir mostra como chamar este endpoint.

    curl "https://instance.servicenow.com/api/sn_install_base/integrations/installbaseitems/167e96f053961910539dddeeff7b1298/maintenanceplans" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

    Retornar resultados:

    {
  "result": {
    "sysparm_offset": 0,
    "sysparm_limit": 1,
    "has_more": true,
    "maintenanceplans": [
      {
        "propagation_flag": "false",
        "active": "true",
        "type": {
          "value": "install_base",
          "display_value": "Install base"
        },
        "maintenance_override_policy": {
          "value": "do_nothing",
          "display_value": "Leave alone"
        },
        "sys_class_name": "wm_planned_work_plan",
        "allow_future_wo": "true",
        "sys_id": "0b809d70877561105d0055373cbb357f",
        "number": "WP0001026",
        "name": "Plan 10",
        "model": "8583ce8237732000158bbfc8bcbe5dd9",
        "apply_to_new": "true",
        "table": "sn_install_base_item"
      }
    ],
    "status": "SUCCESS"
  }
}

    Item-base de instalação - GET /sn_install_base/integrations/installbaseitems/{id}/relatedparties

    Retorna as partes relacionadas associadas a um registro de item-base de instalação especificado.

    Formato da URL

    URL com controle de versões: /api/sn_install_base/{api_version}/integrations/installbaseitems/{id}/relatedparties

    URL padrão: /api/sn_install_base/integrations/installbaseitems/{id}/relatedparties

    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
    id Sys_id do registro do item-base de instalação.

    Tipo de dados: cadeia de caracteres

    Tabela: item-base de instalação [sn_install_base_item]
    Tabela 50. Parâmetros de consulta
    Nome Descrição
    pares de nome-valor de campo Pares de campo-valor a serem usados para filtrar os registros de partes relacionadas. Por padrão, isso faz referência aos campos na tabela Partes relacionadas [sn_install_base_related_party]. Se você especificar uma tabela diferente em sys_class_name, especifique os campos nessa tabela.

    Você pode passar um ou mais pares de valores de campo para filtrar os resultados retornados.

    Por exemplo, se você quiser filtrar uma conta e uma parte responsável específicas, passe os sys_ids dos dois registros: &account=86837a386f0331003b3c498f5d3ee4ca&responsibility=c009bbedb3730010700b4d43c6a8dcef.

    Tipo de dados: cadeia de caracteres

    Padrão: todos os campos
    sys_class_name Se estiver usando uma tabela de partes relacionadas estendida (não sn_install_base_related_party), o nome da tabela estendida a ser consultada.

    Tipo de dados: cadeia de caracteres

    Padrão: sn_install_base_related_party
    sysparm_limit Número máximo de registros a serem retornados. Para solicitações que excedem esse número de registros, use o parâmetro sysparm_offset para paginar a recuperação do registro.

    Este limite é aplicado antes da avaliação da ACL. Se nenhum registro for retornado, incluindo os registros aos quais você tem acesso, reorganize a ordem dos registros para que os registros aos quais você tem acesso sejam retornados primeiro.

    Nota:
    Valores sysparm_limit extraordinariamente grandes podem afetar o desempenho do sistema.

    Tipo de dados: número

    Padrão: 20

    Máximo: 100
    sysparm_offset Índice de registro inicial para o qual a recuperação de registros será iniciada. Use este valor para paginar a recuperação do registro. Essa funcionalidade permite a recuperação de todos os registros, independentemente do número de registros, em pequenos blocos gerenciáveis.

    Por exemplo, na primeira vez que você chama este endpoint, sysparm_offset é definido como "0". Para simplesmente percorrer todos os registros disponíveis, use sysparm_offset=sysparm_offset+sysparm_limitaté chegar ao fim de todos os registros.

    Não passe um número negativo no parâmetro sysparm_offset.

    Tipo de dados: número

    Padrão: 0
    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.
    400 Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada.
    403 Proibido. O usuário não tem direitos de acesso ao registro especificado.
    404 Não encontrado. O item solicitado não foi encontrado.
    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
    erro Detalhes sobre o erro que ocorreu ao tentar processar a solicitação.

    Tipo de dados: objeto

    "error": {
  "detail": "String",
  "message": "String"
}
    erro.detalhe Detalhes adicionais sobre o erro associado.

    Tipo de dados: cadeia de caracteres
    mensagem.erro Mensagem de erro que descreve o problema que ocorreu ao tentar executar a solicitação.

    Tipo de dados: cadeia de caracteres
    tem_mais Sinalizador que indica se há mais registros na tabela a serem retornados.
    Valores possíveis:
    • verdadeiro: mais registros a serem retornados.
    • falso: não há mais registros a serem retornados.

    Tipo de dados: cadeia de caracteres booliana
    partes relacionadas Lista das partes relacionadas associadas ao registro do item-base de instalação especificado.

    Tipo de dados: matriz de objetos

    "relatedparties": [
  {
    "account": {Object},
    "consumer": {Object},
    "contact": {Object},
    "install_base_item": {Object},
    "responsibility": {Object},
    "service_organization": {Object},
    "sys_class_name": "String",
    "sys_id": "String",
    "type": {Object},
    "user": {Object}
  }
]
    partes relacionadas. conta Detalhes sobre a conta associada ao registro de partes relacionadas.

    Tipo de dados: objeto

    account": {
  "display_value": "String",
  "sys_id": "String"
}
    partes_relacionadas.account.display_value Nome em texto da conta associada ao registro de partes relacionadas. Use este valor para exibir o nome da conta na IU.

    Tipo de dados: cadeia de caracteres
    partes relacionadas.conta.sys_id Sys_id do registro de conta associado ao registro de partes relacionadas.

    Tipo de dados: cadeia de caracteres
    partes relacionadas.consumidor Detalhes sobre o consumidor associado ao registro de partes relacionadas.

    Tipo de dados: objeto

    "consumer": {
  "display_value": "String",
  "sys_id": "String"
}
    partes_relacionadas.consumidor.display_value Nome em texto do consumidor associado ao registro de partes relacionadas. Use este valor para exibir o nome do consumidor na IU.

    Tipo de dados: cadeia de caracteres
    partes relacionadas.consumidor.sys_id Sys_id do registro do consumidor associado ao registro de partes relacionadas.

    Tipo de dados: cadeia de caracteres
    partesrelacionadas.contato Detalhes sobre o contato da conta responsável pelo registro de partes relacionadas.

    Tipo de dados: objeto

    "contact": {
  "display_value": "String",
  "sys_id": "String"
}
    partes_relacionadas.contato.exibição_valor Nome em texto do contato associado ao registro de partes relacionadas. Use este valor para exibir o nome do contato na IU.

    Tipo de dados: cadeia de caracteres
    partes relacionadas.contato.sys_id Sys_id do registro de contato associado ao registro de partes relacionadas.

    Tipo de dados: cadeia de caracteres

    Tabela: Contato [customer_contact]
    partes_relacionadas.install_base_item Detalhes sobre o item-base de instalação associado ao registro de partes relacionadas.

    Tipo de dados: objeto

    "install_base_item": {
  "display_value": "String",
  "sys_id": "String"
}
    partes_relacionadas.install_base_item.display_value Nome de texto do item-base de instalação associado ao registro de partes relacionadas. Use este valor para exibir o nome do item-base de instalação na IU.

    Tipo de dados: cadeia de caracteres
    partes relacionadas.install_base_item.sys_id Sys_id do registro do item-base de instalação associado ao registro de partes relacionadas.

    Tipo de dados: cadeia de caracteres
    partes relacionadas.responsabilidade Detalhes sobre o nível de acesso às informações da base de instalação.

    Tipo de dados: objeto

    "responsibility": {
  "display_value": "String",
  "sys_id": "String"
}
    partes relacionadas. responsabilidade.display_value Valor de exibição de texto para o nível de acesso às informações da base de instalação.

    Tipo de dados: cadeia de caracteres
    relatedparties.responsibility.sys_id Sys_id do registro de responsabilidade associado. Este registro define o nível de acesso às informações da base de instalação.

    Este parâmetro só será válido se o campo related_party também for especificado. Se especificado, ele retornará somente os itens-base de instalação que correspondam aos parâmetros related_party e responsibility.

    Para obter informações adicionais, consulte Configure related parties for items received

    Tipo de dados: cadeia de caracteres

    Tabela: definição de responsabilidade [sn_customerservice_responsibility_def]
    partes_relacionadas.serviço_organização Detalhes sobre a organização de serviço associada ao registro de partes relacionadas.

    Tipo de dados: objeto

    "service_organization": {
  "display_value": "String",
  "sys_id": "String"
}
    partes_relacionadas.service_organization.display_value Nome em texto da organização de serviço associada ao registro de partes relacionadas. Use este valor para exibir o nome da organização de serviço na IU.

    Tipo de dados: cadeia de caracteres
    relatedparties.service_organization.sys_id Sys_id do registro da organização de serviço associado ao registro de partes relacionadas.

    Tipo de dados: cadeia de caracteres

    Tabela: organização de serviço [sn_customer_service_organization]
    partes relacionadas. sys_class_name Tabela que contém o registro de partes relacionadas.

    Tipo de dados: cadeia de caracteres

    Padrão: sn_install_base_related_party
    partes relacionadas. sys_id Sys_id do registro de partes relacionadas associadas.

    Tipo de dados: cadeia de caracteres
    partes relacionadas.tipo Detalhes sobre o tipo de contato associado ao registro de partes relacionadas.

    Tipo de dados: objeto

    "type": {
  "display_value": "String",
  "sys_id": "String"
}
    partes_relacionadas.tipo.valor_de_exibição Nome em texto do tipo de contato associado ao registro de partes relacionadas. Use este valor para exibir o tipo de contato na IU. Para obter informações adicionais, confira Create related party configurations.
    Tipos possíveis:
    • Conta autorizada
    • Consumidor autorizado
    • Contato autorizado
    • Colaborador autorizado
    • Membro autorizado
    • Organização de serviço autorizada
    • Conta listada
    • Consumidor listado
    • Contato listado
    • Colaborador listado
    • Membro listado
    • Organização de serviço listada

    Tipo de dados: cadeia de caracteres
    partes relacionadas.tipo.sys_id Sys_id do registro de tipo associado ao registro de partes relacionadas.

    Tipo de dados: cadeia de caracteres
    partesrelacionadas.usuário Detalhes sobre o usuário associado ao registro de partes relacionadas.

    Tipo de dados: objeto

    "user": {
  "display_value": "String",
  "sys_id": "String"
}
    partes_relacionadas.usuário.valor_de_exibição Nome em texto do usuário associado ao registro de partes relacionadas. Use este valor para exibir o nome de usuário na IU.

    Tipo de dados: cadeia de caracteres
    partes relacionadas.usuário.sys_id
    Sys_id do registro do usuário associado ao registro de partes relacionadas.

    Tipo de dados: cadeia de caracteres

    Tabela: usuário [sys_user]
    status Status da chamada do endpoint.

    Tipo de dados: cadeia de caracteres
    sysparm_limit Número de registros retornados. Se este valor não for especificado na solicitação original, ele usará o valor padrão.

    Tipo de dados: número
    sysparm_offset Deslocamento (ponto de partida) na tabela associada da qual os registros foram avaliados e recuperados.

    Tipo de dados: cadeia de caracteres

    Solicitação de cURL

    O exemplo de código a seguir mostra como chamar este endpoint.

    curl "https://instance.servicenow.com/api/sn_install_base/integrations/installbaseitems/42746a3b876121100b6afc86dabb3597/relatedparties" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

    Retornar resultados:

    
  "result": {
    "sysparm_offset": 0,
    "sysparm_limit": 10,
    "has_more": false,
    "relatedparties": [
      {
        "type": {
          "sys_id": "68ec8b2965e99110f87764df53db779f",
          "display_value": "Authorized Contact"
        },
        "install_base_item": {
          "sys_id": "42746a3b876121100b6afc86dabb3597",
          "display_value": "KX Series - KX5000"
        },
        "sys_class_name": "sn_install_base_related_party",
        "sys_id": "8547774087f561100b6afc86dabb351a",
        "responsibility": {
          "sys_id": "c009bbedb3730010700b4d43c6a8dcef",
          "display_value": "Authorized Representative"
        },
        "contact": {
          "sys_id": "dc0185d94f341200025ba3618110c77c",
          "display_value": "Cindy Contact"
        },
        "account": {
          "sys_id": "86837a386f0331003b3c498f5d3ee4ca",
          "display_value": "Boxeo"
        }
      }
    ],
    "status": "SUCCESS"
  }
}

    Item-base de instalação - GET /sn_install_base/integrations/installbaseitems/{id}/soldproducts

    Retorna os registros de produtos vendidos associados a um registro de item-base de instalação especificado.

    Formato da URL

    URL com controle de versões: /api/sn_install_base/{api_version}/integrations/installbaseitems/{id}/soldproducts

    URL padrão: /api/sn_install_base/integrations/installbaseitems/{id}/soldproducts

    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
    id Sys_id do registro do item-base de instalação.

    Tipo de dados: cadeia de caracteres

    Tabela: item-base de instalação [sn_install_base_item]
    Tabela 56. Parâmetros de consulta
    Nome Descrição
    pares de nome-valor de campo Pares de campo-valor a serem usados para filtrar os registros de partes relacionadas. Por padrão, isso faz referência aos campos na tabela Produtos vendidos [sn_install_base_sold_product]. Se você especificar uma tabela diferente em sys_class_name, especifique os campos nessa tabela.

    Você pode passar um ou mais pares de valores de campo para filtrar os resultados retornados.

    Por exemplo, se você quiser filtrar os produtos vendidos para uma conta específica, passe algo semelhante ao seguinte, em que o valor passado é o sys_id da conta: &account=86837a386f0331003b3c498f5d3ee4ca.

    Tipo de dados: cadeia de caracteres

    Padrão: todos os campos
    sys_class_name Se estiver usando uma tabela estendida de produtos vendidos (não sn_install_base_sold_product), o nome da tabela estendida a ser consultada.

    Tipo de dados: cadeia de caracteres

    Padrão: sn_install_base_sold_product
    sysparm_limit Número máximo de registros a serem retornados. Para solicitações que excedem esse número de registros, use o parâmetro sysparm_offset para paginar a recuperação do registro.

    Este limite é aplicado antes da avaliação da ACL. Se nenhum registro for retornado, incluindo os registros aos quais você tem acesso, reorganize a ordem dos registros para que os registros aos quais você tem acesso sejam retornados primeiro.

    Nota:
    Valores sysparm_limit extraordinariamente grandes podem afetar o desempenho do sistema.

    Tipo de dados: número

    Padrão: 20

    Máximo: 100
    sysparm_offset Índice de registro inicial para o qual a recuperação de registros será iniciada. Use este valor para paginar a recuperação do registro. Essa funcionalidade permite a recuperação de todos os registros, independentemente do número de registros, em pequenos blocos gerenciáveis.

    Por exemplo, na primeira vez que você chama este endpoint, sysparm_offset é definido como "0". Para simplesmente percorrer todos os registros disponíveis, use sysparm_offset=sysparm_offset+sysparm_limitaté chegar ao fim de todos os registros.

    Não passe um número negativo no parâmetro sysparm_offset.

    Tipo de dados: número

    Padrão: 0
    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
    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.
    400 Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada.
    403 Proibido. O usuário não tem direitos de acesso ao registro especificado.
    404 Não encontrado. O item solicitado não foi encontrado.
    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
    erro Detalhes sobre o erro que ocorreu ao tentar processar a solicitação.

    Tipo de dados: objeto

    "error": {
  "detail": "String",
  "message": "String"
}
    erro.detalhe Detalhes adicionais sobre o erro associado.

    Tipo de dados: cadeia de caracteres
    mensagem.erro Mensagem de erro que descreve o problema que ocorreu ao tentar executar a solicitação.

    Tipo de dados: cadeia de caracteres
    tem_mais Sinalizador que indica se há mais registros na tabela a serem retornados.
    Valores possíveis:
    • verdadeiro: mais registros a serem retornados.
    • falso: não há mais registros a serem retornados.

    Tipo de dados: cadeia de caracteres booliana
    produtos vendidos Lista dos produtos vendidos associados ao registro do item-base de instalação especificado.

    Tipo de dados: matriz de objetos

    "soldproducts":[
  {
    "account": {Object},
    "contact": {Object},
    "name": "String",
    "number": "String",
    "product": {Object},
    "sys_class_name": "String",
    "sys_id": "String",
    "state": {Object}
  }
]
    produtosvendidos.conta Detalhes sobre a conta associada ao registro do produto.

    Tipo de dados: objeto

    account": {
  "display_value": "String",
  "sys_id": "String"
}
    produtos_vendidos.conta.display_value Nome em texto da conta associada ao registro do produto. Use este valor para exibir o nome da conta na IU.

    Tipo de dados: cadeia de caracteres
    produtos_vendidos.conta.sys_id Sys_id do registro de conta associado ao registro do produto.

    Tipo de dados: cadeia de caracteres
    produtosvendidos.contato Detalhes sobre o contato da conta responsável pelo produto.

    Tipo de dados: objeto

    "contact": {
  "display_value": "String",
  "sys_id": "String"
}
    produtos_vendidos.contato.exibição_valor Nome em texto do contato associado ao produto. Use este valor para exibir o nome do contato na IU.

    Tipo de dados: cadeia de caracteres
    produtos_vendidos.contato.sys_id Sys_id do registro de contato associado ao registro do produto.

    Tipo de dados: cadeia de caracteres
    soldproducts.name Nome do produto.

    Tipo de dados: cadeia de caracteres
    produtosvendidos.número Número do produto.

    Tipo de dados: cadeia de caracteres
    produtos_vendidos.sys_class_name Tabela que contém o registro do produto.

    Tipo de dados: cadeia de caracteres
    produtos_vendidos.sys_id Sys_id do produto associado.

    Tipo de dados: cadeia de caracteres
    produtosvendidos.estado Detalhes sobre o estado atual do produto.

    Tipo de dados: objeto

    "state": {
  "display_value": "String",
  "value": "String"
}
    produtos_vendidos.estado.valor_exibição Cadeia de caracteres de texto do estado atual do produto. Use este valor para exibir o estado na IU.

    Tipo de dados: cadeia de caracteres
    produtosvendidos.estado.valor Valor interno do estado do produto.

    Tipo de dados: cadeia de caracteres
    status Status da chamada do endpoint.

    Tipo de dados: cadeia de caracteres
    sysparm_limit Número de registros retornados. Se este valor não for especificado na solicitação original, ele usará o valor padrão.

    Tipo de dados: número
    sysparm_offset Deslocamento (ponto de partida) na tabela associada da qual os registros foram avaliados e recuperados.

    Tipo de dados: cadeia de caracteres

    Solicitação de cURL

    O exemplo de código a seguir mostra como chamar este endpoint.

    curl "https://instance.servicenow.com/api/sn_install_base/integrations/installbaseitems/f77c7542b7343300ece839a6ee11a991/soldproducts?sysparm_limit=1" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

    Retornar resultados:

    {
  "result": {
    "sysparm_offset": 0,
    "sysparm_limit": 1,
    "has_more": true,
    "soldproducts": [
      {
        "product": {
          "sys_id": "a9a2d0c3c6112276010db16c5ddd3461",
          "display_value": "Lenovo ThinkStation S20"
        },
        "sys_class_name": "sn_install_base_sold_product",
        "number": "SLPRD0001008",
        "sys_id": "17a3a7128729a1105d0055373cbb35fb",
        "contact": {
          "sys_id": "ddce70866f9331003b3c498f5d3ee417",
          "display_value": "George Warren"
        },
        "name": "SP B2B",
        "state": {
          "value": "active",
          "display_value": "Active"
        },
        "account": {
          "sys_id": "86837a386f0331003b3c498f5d3ee4ca",
          "display_value": "Boxeo"
        }
      }
    ],
    "status": "SUCCESS"
  }
}

    Item-base de instalação - GET /sn_install_base/integrations/installbaseitems/{id}/workorders

    Retorna as ordens de serviço associadas a um registro de item-base de instalação especificado.

    Formato da URL

    URL com controle de versões: /api/sn_install_base/{api_version}/integrations/installbaseitems/{id}/workorders

    URL padrão: /api/sn_install_base/integrations/installbaseitems/{id}/workorders

    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
    id Sys_id do registro do item-base de instalação.

    Tipo de dados: cadeia de caracteres

    Tabela: item-base de instalação [sn_install_base_item]
    Tabela 62. Parâmetros de consulta
    Nome Descrição
    pares de nome-valor de campo Pares de campo-valor a serem usados para filtrar os registros de partes relacionadas. Por padrão, isso faz referência aos campos na tabela Produtos vendidos [sn_install_base_sold_product]. Se você especificar uma tabela diferente em sys_class_name, especifique os campos nessa tabela.

    Você pode passar um ou mais pares de valores de campo para filtrar os resultados retornados.

    Por exemplo, se você quiser filtrar os produtos vendidos para uma conta específica, passe algo semelhante ao seguinte, em que o valor passado é o sys_id da conta: &account=86837a386f0331003b3c498f5d3ee4ca.

    Tipo de dados: cadeia de caracteres

    Padrão: todos os campos
    sys_class_name Se estiver usando uma tabela estendida de produtos vendidos (não sn_install_base_sold_product), o nome da tabela estendida a ser consultada.

    Tipo de dados: cadeia de caracteres

    Padrão: sn_install_base_sold_product
    sysparm_limit Número máximo de registros a serem retornados. Para solicitações que excedem esse número de registros, use o parâmetro sysparm_offset para paginar a recuperação do registro.
    Nota:
    Valores sysparm_limit extraordinariamente grandes podem afetar o desempenho do sistema.

    Tipo de dados: número

    Padrão: 10
    sysparm_offset Índice de registro inicial para o qual a recuperação de registros será iniciada. Use este valor para paginar a recuperação do registro. Essa funcionalidade permite a recuperação de todos os registros, independentemente do número de registros, em pequenos blocos gerenciáveis.

    Por exemplo, na primeira vez que você chama este endpoint, sysparm_offset é definido como "0". Para simplesmente percorrer todos os registros disponíveis, use sysparm_offset=sysparm_offset+sysparm_limitaté chegar ao fim de todos os registros.

    Não passe um número negativo no parâmetro sysparm_offset.

    Tipo de dados: número

    Padrão: 0
    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
    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.
    400 Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada.
    403 Proibido. O usuário não tem direitos de acesso ao registro especificado.
    404 Não encontrado. O item solicitado não foi encontrado.
    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
    erro Detalhes sobre o erro que ocorreu ao tentar processar a solicitação.

    Tipo de dados: objeto

    "error": {
  "detail": "String",
  "message": "String"
}
    erro.detalhe Detalhes adicionais sobre o erro associado.

    Tipo de dados: cadeia de caracteres
    mensagem.erro Mensagem de erro que descreve o problema que ocorreu ao tentar executar a solicitação.

    Tipo de dados: cadeia de caracteres
    tem_mais Sinalizador que indica se há mais registros na tabela a serem retornados.
    Valores possíveis:
    • verdadeiro: mais registros a serem retornados.
    • falso: não há mais registros a serem retornados.

    Tipo de dados: cadeia de caracteres booliana
    status Status da chamada do endpoint.

    Tipo de dados: cadeia de caracteres
    sysparm_limit Número de registros retornados. Se este valor não for especificado na solicitação original, ele usará o valor padrão.

    Tipo de dados: número
    sysparm_offset Deslocamento (ponto de partida) na tabela associada da qual os registros foram avaliados e recuperados.

    Tipo de dados: cadeia de caracteres
    ordens de serviço Lista das ordens de serviço associadas ao registro do item-base de instalação especificado.

    Tipo de dados: matriz de objetos

    "workorders":[
  {
    "active": "String",
    "approval": {Object},
    "billable": "String",
    "escalation": "String",
    "has_appointment": "String",
    "hierarchical_variables": "String",
    "impact": "String",
    "install_base_item": {Object},
    "is_catalog": "String",
    "knowledge": "String",
    "location": {Object},
    "made_sla": "String",
    "needs_attention": "String",
    "number": "String",
    "opened_at": {Object},
    "opened_by": {Object},
    "opened_for": {Object},
    "priority": "String",
    "reassignment_count": "String",
    "reschedule_maintenance_if_canceled": "String",
    "short_description": "String",
    "sla_suspended": "String",
    "state": "String",
    "sys_class_name": "String",
    "sys_domain_path": "String"
    "sys_id": "String",
    "task_created": "String",
    "task_effective_number": "String",
    "template_workflow_invoked": "String",
    "upon_approval": {Object},
    "upon_reject": {Object},
    "urgency": "String"
  }
]
    ordensdeserviço.ativo Sinalizador que indica se a ordem de serviço está ativa.
    Valores possíveis:
    • verdadeiro: a ordem de serviço está ativa.
    • falso: a ordem de serviço está inativa.

    Tipo de dados: cadeia de caracteres booliana
    ordensdeserviço.aprovação Detalhes sobre o processo de aprovação atual da ordem de serviço.

    Tipo de dados: objeto

    "approval": {
  "display_value": "String",
  "value": "String"
}
    workorders.​approval.display_value Cadeia de caracteres de texto do estado atual do processo de aprovação. Use este valor para exibir o estado de aprovação na IU.

    Tipo de dados: cadeia de caracteres
    workorders.​approval.value Valor interno do estado do processo de aprovação.

    Tipo de dados: cadeia de caracteres
    workorders.​faturável Sinalizador que indica se a ordem de serviço é faturável.
    Valores possíveis:
    • verdadeiro: a ordem de serviço é faturável.
    • falso: a ordem de serviço não é faturável

    Tipo de dados: cadeia de caracteres booliana
    workorders.​escalação Nível de escalação da ordem de serviço.

    Tipo de dados: cadeia de caracteres
    workorders.​has_appointment Sinalizador que indica se a ordem de serviço tem um compromisso programado.
    Valores possíveis:
    • verdadeiro: a ordem de serviço tem um compromisso.
    • falso: a ordem de serviço não tem um compromisso.

    Tipo de dados: cadeia de caracteres booliana
    workorders.​install_base_item Detalhes sobre o item-base de instalação associado ao registro da ordem de serviço.

    Tipo de dados: objeto

    "install_base_item": {
  "display_value": "String",
  "sys_id": "String"
}
    workorders.​install_base_item.​display_value Nome de texto do item-base de instalação associado ao registro da ordem de serviço. Use este valor para exibir o nome do item-base de instalação na IU.

    Tipo de dados: cadeia de caracteres
    workorders.​install_base_item.sys_id Sys_id do registro do item-base de instalação associado ao registro da ordem de serviço.

    Tipo de dados: cadeia de caracteres
    workorders.​is_catalog Sinalizador que indica se faz parte de um catálogo.
    Valores possíveis:
    • verdadeiro: a ordem de serviço faz parte de um catálogo.
    • falso: a ordem de serviço não faz parte de um catálogo.

    Tipo de dados: cadeia de caracteres booliana
    ordensdeserviço.conhecimento Sinalizador que indica se há um artigo da base de conhecimento disponível para o problema de ordem de serviço especificado.

    Valores possíveis:

    • verdadeiro: o artigo da base de conhecimento está disponível para este problema.
    • falso: o artigo da base de conhecimento não está disponível para este problema.

    Tipo de dados: cadeia de caracteres booliana
    ordensDeServiço.local Detalhes sobre o local do item que precisa ser trabalhado.

    Tipo de dados: objeto

    "location": {
  "display_value": "String",
  "sys_id": "String"
}
    workorders.​location.​display_value Nome de texto do local do item a ser trabalhado. Use este valor para exibir o local na IU.

    Tipo de dados: cadeia de caracteres
    workorders.​location.​sys_id Sys_id do registro de local associado ao registro da ordem de serviço.

    Tipo de dados: cadeia de caracteres
    workorders.​feito_sla Sinalizador que indica se o trabalho associado à ordem de serviço atendeu ao Acordo de nível de serviço (ANS) associado.
    Valores possíveis:
    • verdadeiro: o ANS foi atendido.
    • falso: o ANS não foi atendido.

    Tipo de dados: cadeia de caracteres booliana
    workorders.​needs_attention Sinalizador que indica se esta ordem de serviço precisa de atenção.
    Valores possíveis:
    • verdadeiro: a ordem de serviço precisa de atenção.
    • falso: a ordem de serviço não precisa de atenção.

    Tipo de dados: cadeia de caracteres booliana
    workorders.​number Número exclusivo usado para identificar a ordem de serviço.

    Tipo de dados: cadeia de caracteres
    workorders.​opened_at Detalhes sobre quando a ordem de serviço foi aberta.

    Tipo de dados: objeto

    "opened_at": {
  "display_value": "String",
  "value": "String"
}
    workorders.​opened_at.​display_value Data e hora em que a ordem de serviço foi aberta. Use este valor para exibir o valor na IU.

    Tipo de dados: cadeia de caracteres
    workorders.​opened_at.​valor Data e hora em que a ordem de serviço foi aberta.

    Tipo de dados: cadeia de caracteres
    workorders.​opened_by Detalhes sobre a pessoa que abriu a ordem de serviço.

    Tipo de dados: objeto

    "opened_by": {
  "display_value": "String",
  "sys_id": "String"
}
    workorders.​opened_by.​display_value Nome em texto da pessoa que abriu a ordem de serviço. Use este valor para exibir este nome na IU.

    Tipo de dados: cadeia de caracteres
    workorders.​opened_by.​sys_id Sys_id do registro de usuário da pessoa que abriu a ordem de serviço.

    Tipo de dados: cadeia de caracteres
    ordensDeServiço.aberto_para Detalhes sobre a pessoa para a qual a ordem de serviço foi aberta, se for diferente da pessoa opened_by.

    Tipo de dados: objeto

    "opened_for": {
  "display_value": "String",
  "sys_id": "String"
}
    workorders.​opened_for.​display_value Nome em texto da pessoa para a qual a ordem de serviço foi aberta. Use este valor para exibir este nome na IU.

    Tipo de dados: cadeia de caracteres
    workorders.​opened_for.​sys_id Sys_id do registro de usuário da pessoa para a qual a ordem de serviço foi aberta.

    Tipo de dados: cadeia de caracteres
    ordensdeserviço.prioridade Prioridade da ordem de serviço.

    Tipo de dados: cadeia de caracteres
    workorders.​reassignment_count Número de vezes em que a ordem de serviço foi reatribuída a uma pessoa responsável por mover a ordem de serviço.

    Tipo de dados: cadeia de caracteres
    workorders.​reschedule_maintenance_if_canceled Sinalizador que indica se o trabalho deve ser reprogramado se a ordem de serviço associada for cancelada.
    Valores possíveis:
    • verdadeiro: reagendar o trabalho.
    • falso: verifique antes de reprogramar o trabalho.

    Tipo de dados: cadeia de caracteres booliana
    workorders.​short_description Texto resumido que descreve o trabalho associado à ordem de serviço.

    Tipo de dados: cadeia de caracteres
    workorders.​sla_suspended Sinalizador que indica se o ANS associado à ordem de serviço foi suspenso.
    Valores válidos:
    • verdadeiro: o ANS foi suspenso.
    • falso: o ANS não foi suspenso.

    Tipo de dados: cadeia de caracteres booliana
    ordensdeserviço.estado Estado atual da ordem de serviço.

    Tipo de dados: cadeia de caracteres
    ordens de serviço.​sys_class_name Tabela que contém o registro da ordem de serviço.

    Tipo de dados: cadeia de caracteres
    workorders.​sys_domain_path Caminho do domínio.

    Tipo de dados: cadeia de caracteres
    ordensDeServiço.sys_id Sys_id do registro de ordem de serviço associado.

    Tipo de dados: cadeia de caracteres
    workorders.​task_created Sinalizador que indica se uma tarefa foi criada para esta ordem de serviço.
    Valores possíveis:
    • verdadeiro: a tarefa foi criada para esta ordem de serviço.
    • falso: a tarefa não foi criada para esta ordem de serviço.

    Tipo de dados: cadeia de caracteres booliana
    workorders.​task_quality_number Número exclusivo usado para identificar a ordem de serviço.

    Tipo de dados: cadeia de caracteres
    workorders.​template_workflow_invoked Sinalizador que indica se o fluxo de trabalho associado foi invocado para esta ordem de serviço.
    Valores possíveis:
    • verdadeiro: o fluxo de trabalho foi invocado.
    • falso: o fluxo de trabalho não foi invocado.

    Tipo de dados: cadeia de caracteres booliana
    workorders.​upon_approval Detalhes sobre a próxima ação a ser executada se a ordem de serviço for aprovada.

    Tipo de dados: objeto

    "upon_approval": {
  "display_value": "String",
  "value": "String"
}
    workorders.​upon_approval.​display_value Cadeia de caracteres de texto da ação a ser executada se a ordem de serviço for aprovada. Use este valor para exibir essas informações na IU.

    Tipo de dados: cadeia de caracteres
    workorders.​upon_approval.​value Ação a ser tomada se a ordem de serviço for aprovada.

    Valores possíveis:

    • fazer_nada
    • prosseguir

    Tipo de dados: cadeia de caracteres
    ordensDeServiço.​upon_reject Detalhes sobre a próxima ação a ser tomada se a ordem de serviço for rejeitada.

    Tipo de dados: objeto

    "upon_reject": {
  "display_value": "String",
  "value": "String"
}
    workorders.​upon_reject.​display_value Cadeia de caracteres de texto da ação a ser executada se a ordem de serviço for rejeitada. Use este valor para exibir essas informações na IU.

    Tipo de dados: cadeia de caracteres
    workorders.​upon_reject.​value Ação a ser tomada se a ordem de serviço for rejeitada.

    Valores possíveis:

    • Cancelar
    • goto

    Tipo de dados: cadeia de caracteres
    ordensDeServiço.Urgência Urgência da ordem de serviço.

    Tipo de dados: cadeia de caracteres

    Solicitação de cURL

    O exemplo de código a seguir mostra como chamar este endpoint.

    curl "https://instance.servicenow.com/api/sn_install_base/integrations/installbaseitems/f77c7542b7343300ece839a6ee11a991/workorders?sysparm_limit=1" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

    Retornar resultados:

    {
  "result": {
    "sysparm_offset": 0,
    "sysparm_limit": 10,
    "has_more": false,
    "workorders": [
      {
        "upon_reject": {
          "value": "cancel",
          "display_value": "Cancel all future Tasks"
        },
        "number": "WO0010372",
        "state": "1",
        "template_workflow_invoked": "false",
        "knowledge": "false",
        "impact": "3",
        "active": "true",
        "priority": "4",
        "sys_domain_path": "/",
        "sla_suspended": "false",
        "needs_attention": "false",
        "short_description": "Test WO1",
        "sys_class_name": "wm_order",
        "reschedule_maintenance_if_canceled": "true",
        "reassignment_count": "0",
        "hierarchical_variables": "variable_pool",
        "opened_for": {
          "sys_id": "85453c616fc331003b3c498f5d3ee4fa",
          "display_value": "Jodi Seals"
        },
        "install_base_item": {
          "sys_id": "42746a3b876121100b6afc86dabb3597",
          "display_value": "KX Series - KX5000"
        },
        "has_appointment": "false",
        "escalation": "0",
        "upon_approval": {
          "value": "proceed",
          "display_value": "Proceed to Next Task"
        },
        "spam": "false",
        "made_sla": "true",
        "is_catalog": "false",
        "task_effective_number": "WO0010372",
        "opened_by": {
          "sys_id": "85453c616fc331003b3c498f5d3ee4fa",
          "display_value": "Jodi Seals"
        },
        "opened_at": {
          "value": "2023-03-20 13:33:22",
          "display_value": "2023-03-20 06:33:22"
        },
        "task_created": "false",
        "sys_id": "19761cc087b521100b6afc86dabb352f",
        "urgency": "3",
        "approval": {
          "value": "not requested",
          "display_value": "Not Yet Requested"
        },
        "billable": "false",
        "location": {
          "sys_id": "1cd145bc23070110766713d1d7bf654f",
          "display_value": "2866 Stevens Creek Blvd,Santa Clara,CA"
        }
      }
    ],
    "status": "SUCCESS"
  }
}

    Item-base de instalação - PATCH /sn_install_base/integrations/installbaseitems/{id}

    Atualiza um registro de item-base de instalação especificado com valores de campo especificados.

    Formato da URL

    URL com controle de versões: /api/sn_install_base/{api_version}/integrations/installbaseitems/{id}

    URL padrão: /api/sn_install_base/integrations/installbaseitems/{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 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
    conta Necessário ao criar um item-base de instalação para uma conta.

    Sys_id da conta a ser associada ao item-base de instalação.

    Nota:
    Se você passar o parâmetro account, não poderá passar também o parâmetro consumer.

    Tipo de dados: cadeia de caracteres

    Tabela: Conta [customer_account]
    ativo Sinalizador que indica se o item-base de instalação está ativo.
    Valores válidos:
    • verdadeiro, "verdadeiro" ou "0": o item está ativo.
    • falso, "falso" ou "1": o item não está ativo.

    Tipo de dados: booliano

    Padrão: verdadeiro
    ativo Sys_id do ativo associado ao registro do item-base de instalação.

    Tipo de dados: cadeia de caracteres

    Tabela: ativo [alm_asset]
    child_install_base_items Lista dos itens-base de instalação secundários associados a este item-base de instalação.
    Nota:
    Os seguintes campos de item-base de instalação secundários não podem ser diferentes do primário:
    • conta
    • cliente
    • contato
    • organização de serviço

    Tipo de dados: matriz de objetos

    "child_install_base_items": [
  {
    "name": "String",
    "product": "String"
  }
]
    child_install_base_items.name Nome do item-base de instalação secundário.

    Tipo de dados: cadeia de caracteres
    child_install_base_items.product Sys_id do registro do item-base secundário associado.

    Tipo de dados: cadeia de caracteres

    Tabela: item-base de instalação [sn_install_base_item]
    configuration_item Sys_id do item de configuração associado ao registro do item-base de instalação.

    Tipo de dados: cadeia de caracteres

    Tabela: item de configuração [cmdb_ci]
    cliente Necessário ao criar um item-base de instalação para um consumidor.
    Sys_id do consumidor associado ao registro do item-base de instalação.
    Nota:
    Se você passar o parâmetro consumer, não poderá passar também o parâmetro account. Além disso, você só poderá associar um consumidor a um item-base de instalação se o plug-in B2B2C estiver instalado em sua instância.

    Tipo de dados: cadeia de caracteres

    Tabela: consumidor [csm_consumer]
    perfil_do_consumidor Sys_id do perfil do consumidor associado ao registro do item-base de instalação.

    Tipo de dados: cadeia de caracteres

    Tabela: perfil do consumidor [sn_csm_consumer_profile]
    contato
    Sys_id do registro de contato da conta que é o principal responsável pelo item-base de instalação.
    Nota:
    Os contatos só podem ser especificados para itens-base de instalação de conta.

    Tipo de dados: cadeia de caracteres

    Tabela: Contato [customer_contact]
    residência Sys_id da residência associada ao registro do item-base de instalação.
    Nota:
    Este campo só é válido quando o plug-in Residência do Atendimento ao cliente (com.snc.household) está instalado.

    Tipo de dados: cadeia de caracteres

    Tabela: Residência [csm_household]
    install_date Data em que o item-base de instalação se torna ativo.

    Tipo de dados: cadeia de caracteres

    Formato: aaaa-MM-dd HH:mm:ss
    local Sys_id do local do produto associado.

    Tipo de dados: cadeia de caracteres

    Tabela: local [cmn_location]
    nome Nome do item-base de instalação.

    Tipo de dados: cadeia de caracteres
    número Identificador exclusivo do item-base de instalação.

    Tipo de dados: cadeia de caracteres

    Padrão: gerado automaticamente pelo endpoint.
    primário Sys_id do registro primário para este registro de item-base de instalação.

    Tipo de dados: cadeia de caracteres

    Tabela: item-base de instalação [sn_install_base_item]
    product_model Sys_id do modelo de produto associado ao registro do item-base de instalação.

    Tipo de dados: cadeia de caracteres

    Tabela: modelo de produto [cmdb_model]
    quantidade Número de itens instalados.

    Tipo de dados: inteiro
    serviço_contexto Sys_id do serviço que está associado ao IC subjacente para calcular a severidade do impacto da Gestão de eventos. Para obter mais informações, consulte Service health status for install base.
    Nota:
    Este campo só será válido se o plug-in Operações proativas de atendimento ao cliente com gestão de eventos estiver instalado.

    Tipo de dados: cadeia de caracteres
    serviço_organização Necessário ao criar um item-base de instalação para uma organização de serviço.

    Sys_id do registro da organização de serviço que está envolvido na prestação de serviço ao cliente.

    Nota:
    Se você passar este parâmetro, não deverá passar também os parâmetros de conta, contato ou consumidor. O parâmetro service_organization só está disponível quando o plug-in Organização de serviço (com.snc.service_organization) está instalado na instância.

    Tipo de dados: cadeia de caracteres

    Tabela: organização de serviço [sn_customer_service_organization]
    estado Estado atual do item-base de instalação.
    Valores válidos:
    • em_uso
    • inativo

    Tipo de dados: cadeia de caracteres
    status Status do produto.
    Valores válidos:
    • original
    • substituição

    Tipo de dados: cadeia de caracteres
    sys_class_name Nome da tabela base de instalação estendida na qual o registro do item-base de instalação será atualizado.

    Tipo de dados: cadeia de caracteres
    desinstalar_data Data em que a base de instalação se torna inativa.

    Tipo de dados: cadeia de caracteres

    Formato: aaaa-MM-dd HH:mm:ss

    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.
    400 Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada.
    403 Proibido. O usuário não tem direitos de acesso ao registro especificado.
    404 Não encontrado. O item solicitado não foi encontrado.
    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
    erro Detalhes sobre o erro que ocorreu ao tentar processar a solicitação.

    Tipo de dados: objeto

    "error": {
  "detail": "String",
  "message": "String"
}
    erro.detalhe Detalhes adicionais sobre o erro associado.

    Tipo de dados: cadeia de caracteres
    mensagem.erro Mensagem de erro que descreve o problema que ocorreu ao tentar executar a solicitação.

    Tipo de dados: cadeia de caracteres
    item Detalhes sobre o item-base de instalação que foi atualizado.

    Tipo de dados: objeto

    "item": {
  "account": {Object},
  "active": Boolean,
  "name": "String",
  "number": "String",
  "state": {Object},
  "sys_class_name": {Object},
  "sys_id": "String"
}
    item.conta Detalhes sobre a conta do cliente associada ao registro do item-base de instalação.

    Tipo de dados: objeto

    "account": {
  "display_value": "String",
  "sys_id": "String"
}
    item.account.display_value Nome de texto da conta do cliente associada ao registro do item-base de instalação. Use este valor para exibir o nome da conta do cliente na IU.

    Tipo de dados: cadeia de caracteres
    item.account.sys_id Sys_id do registro de conta do cliente associado ao registro do item-base de instalação.

    Tipo de dados: cadeia de caracteres
    item.ativo Sinalizador que indica se o item-base de instalação está ativo.
    Valores possíveis:
    • verdadeiro: o item-base de instalação está ativo.
    • falso: o item-base de instalação está inativo.

    Tipo de dados: cadeia de caracteres booliana
    item_name Nome do item-base de instalação.

    Tipo de dados: cadeia de caracteres
    item.número ID exclusivo do item-base de instalação.

    Tipo de dados: cadeia de caracteres
    item.estado Detalhes sobre o estado atual do item-base de instalação.

    Tipo de dados: objeto

    "state": {
  "display_value": "String",
  "value": "String"
}
    item.state.display_value Cadeia de caracteres de texto do estado atual do item-base de instalação. Use este valor para exibir o estado na IU.

    Tipo de dados: cadeia de caracteres
    item.estado.valor Valor interno do estado do item-base de instalação.

    Tipo de dados: cadeia de caracteres
    item.sys_class_name Detalhes sobre a tabela que contém o item-base de instalação.

    Tipo de dados: objeto

    "sys_class_name": {
  "display_value": "String",
  "value": "String"
}
    item.sys_class_name.display_value Cadeia de caracteres de texto do nome da tabela que contém o item-base de instalação. Use este valor para exibir o nome da tabela na IU.

    Tipo de dados: cadeia de caracteres
    item.sys_class_name.value Valor interno da tabela que contém o item-base de instalação

    Tipo de dados: cadeia de caracteres
    item.sys_id Sys_id do registro do item-base de instalação. Localizado na tabela especificada no parâmetro sys_class_name.

    Tipo de dados: cadeia de caracteres
    status Status da chamada do endpoint.

    Tipo de dados: cadeia de caracteres

    Solicitação de cURL

    O exemplo de código a seguir mostra como atualizar o nome e os campos ativos no registro do item-base de instalação.

    curl "https://instance.servicenow.com/api/sn_install_base/integrations/installbaseitems/f77c7542b7343300ece839a6ee11a991" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
  \"name\": \"KX Series - KX5001\",
  \"active\":true
}" \
--user 'username':'password'

    Retornar resultados:

    {
  "result": {
    "status": "SUCCESS",
    "item": {
      "sys_class_name": {
        "value": "sn_install_base_item",
        "display_value": "Install Base Item"
      },
      "number": "IBITM0001001",
      "sys_id": "bc610d38cb76211050501ebfe8076d8b",
      "state": {
        "value": "inactive",
        "display_value": "Inactive"
      },
      "active": "false",
      "name": "NewTestIB",
      "account": {
        "sys_id": "8637a386f0331003b3c498f5d3ee4ca",
        "display_value": "Boxeo"
      }
    }
  }
}
      
}

    Item-base de instalação - PATCH /sn_install_base/integrations/installbaseitems/{id}/relatedparties/{related_party_sys_id}

    Atualiza o registro de parte relacionada especificado, associado a um item-base de instalação especificado, com os valores no corpo da solicitação.

    Se você precisar modificar o tipo de parte relacionada associada a um item-base de instalação, deverá remover os campos específicos do tipo de parte relacionada atual e substituí-los pelos campos específicos do tipo do novo tipo de parte relacionada. Por exemplo, para mudar de um tipo de Conta autorizada para Consumidor autorizado, passe o seguinte:

    • type = "Consumidor autorizado"
    • account = ""
    • consumer = "<sys_id of consumer record> "
    • responsibility = "<sys_id of responsibility of consumer> "

    Formato da URL

    URL com controle de versão: /api/sn_install_base/{api_version}/integrations/installbaseitems/{id}/relatedparties/{related_party_sys_id}

    URL padrão: /api/sn_install_base/integrations/installbaseitems/{id}/relatedparties/{related_party_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 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
    id Sys_id do registro do item-base de instalação.

    Tipo de dados: cadeia de caracteres

    Tabela: item-base de instalação [sn_install_base_item]
    related_party_sys_id Sys_id do registro de parte relacionada.

    Tipo de dados: cadeia de caracteres

    Tabela: Parte relacionada à base de instalação [sn_install_base_related_party]
    Tabela 74. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 75. Parâmetros do corpo da solicitação (XML ou JSON)
    Nome Descrição
    conta Obrigatório se o parâmetro type for um dos seguintes:
    • Conta autorizada
    • Contato autorizado
    • Conta listada
    • Contato listado

    Sys_id da conta a ser associada ao item-base de instalação.

    Nota:
    Se você passar o parâmetro account, não poderá passar também o parâmetro consumer.

    Tipo de dados: cadeia de caracteres

    Tabela: Conta [customer_account]
    cliente Obrigatório se o parâmetro type for Consumidor autorizado ou Consumidor listado.
    Sys_id do consumidor associado ao registro do item-base de instalação.
    Nota:
    Se você passar o parâmetro consumer, não poderá passar também o parâmetro account. Além disso, você só poderá associar um consumidor a um item-base de instalação se o plug-in B2B2C estiver instalado em sua instância.

    Tipo de dados: cadeia de caracteres

    Tabela: consumidor [csm_consumer]
    contato Sys_id do registro de contato associado ao registro de partes relacionadas.

    Tipo de dados: cadeia de caracteres

    Tabela: Contato [customer_contact]
    responsabilidade Sys_id do registro de responsabilidade associado. Este registro define o nível de acesso às informações da base de instalação.

    Este parâmetro só será válido se o campo related_party também for especificado. Se especificado, ele retornará somente os itens-base de instalação que correspondam aos parâmetros related_party e responsibility.

    Para obter informações adicionais, consulte Configure related parties for items received

    Tipo de dados: cadeia de caracteres

    Tabela: definição de responsabilidade [sn_customerservice_responsibility_def]
    serviço_organização Obrigatório se o parâmetro type for um dos seguintes:
    • Membro autorizado
    • Organização de serviço autorizada
    • Membro listado
    • Organização de serviço listada

    Sys_id do registro da organização de serviço que está envolvido na prestação de serviço ao cliente.

    Nota:
    Se você passar este parâmetro, não deverá passar também os parâmetros de conta, contato ou consumidor. O parâmetro service_organization só está disponível quando o plug-in Organização de serviço (com.snc.service_organization) está instalado na instância.

    Tipo de dados: cadeia de caracteres

    Tabela: organização de serviço [sn_customer_service_organization]
    sys_class_name Tabela que contém o registro de partes relacionadas.

    Tipo de dados: cadeia de caracteres

    Padrão: sn_install_base_related_party
    tipo Obrigatório. Sys_id do tipo de parte relacionada a ser criado.
    Tipos possíveis:
    • Conta autorizada
    • Consumidor autorizado
    • Contato autorizado
    • Colaborador autorizado
    • Membro autorizado
    • Organização de serviço autorizada
    • Conta listada
    • Consumidor listado
    • Contato listado
    • Colaborador listado
    • Membro listado
    • Organização de serviço listada

    Tipo de dados: cadeia de caracteres

    Tabela: configuração de parte relacionada [sn_customerservice_related_party_configuration]
    usuário Obrigatório se o parâmetro type for um dos seguintes tipos de partes relacionadas:
    • Colaborador autorizado
    • Membro autorizado
    • Colaborador listado
    • Membro listado
    Sys_id do registro do usuário associado ao registro de partes relacionadas.

    Tipo de dados: cadeia de caracteres

    Tabela: usuário [sys_user]

    Para Membro autorizado e Membro listado, este usuário deve estar associado ao registro service_organization especificado.

    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.
    400 Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada.
    403 Proibido. O usuário não tem direitos de acesso ao registro especificado.
    404 Não encontrado. O item solicitado não foi encontrado.
    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
    erro Detalhes sobre o erro que ocorreu ao tentar processar a solicitação.

    Tipo de dados: objeto

    "error": {
  "detail": "String",
  "message": "String"
}
    erro.detalhe Detalhes adicionais sobre o erro associado.

    Tipo de dados: cadeia de caracteres
    mensagem.erro Mensagem de erro que descreve o problema que ocorreu ao tentar executar a solicitação.

    Tipo de dados: cadeia de caracteres
    item Detalhes sobre o registro de partes relacionadas.

    Tipo de dados: matriz

    "item": {
  "account": {Object},
  "consumer": {Object},
  "contact": {Object},
  "install_base_item": {Object},
  "responsibility": {Object},
  "service_organization": {Object},
  "sys_class_name": "String",
  "sys_id": "String",
  "type": {Object},
  "user": {Object}
}
    item.conta Detalhes sobre a conta associada ao registro de partes relacionadas.

    Tipo de dados: objeto

    account": {
  "display_value": "String",
  "sys_id": "String"
}
    item.account.display_value Nome em texto da conta associada ao registro de partes relacionadas. Use este valor para exibir o nome da conta na IU.

    Tipo de dados: cadeia de caracteres
    item.account.sys_id Sys_id do registro de conta associado ao registro de partes relacionadas.

    Tipo de dados: cadeia de caracteres
    item.consumidor Detalhes sobre o consumidor associado ao registro de partes relacionadas.

    Tipo de dados: objeto

    "consumer": {
  "display_value": "String",
  "sys_id": "String"
}
    item.consumidor.display_value Nome em texto do consumidor associado ao registro de partes relacionadas. Use este valor para exibir o nome do consumidor na IU.

    Tipo de dados: cadeia de caracteres
    item.consumer.sys_id Sys_id do registro do consumidor associado ao registro de partes relacionadas.

    Tipo de dados: cadeia de caracteres
    item.contato Detalhes sobre o contato da conta responsável pelo registro de partes relacionadas.

    Tipo de dados: objeto

    "contact": {
  "display_value": "String",
  "sys_id": "String"
}
    item.contact.display_value Nome em texto do contato associado ao registro de partes relacionadas. Use este valor para exibir o nome do contato na IU.

    Tipo de dados: cadeia de caracteres
    item.contact.sys_id Sys_id do registro de contato associado ao registro de partes relacionadas.

    Tipo de dados: cadeia de caracteres

    Tabela: Contato [customer_contact]
    item.install_base_item Detalhes sobre o item-base de instalação associado ao registro de partes relacionadas.

    Tipo de dados: objeto

    "install_base_item": {
  "display_value": "String",
  "sys_id": "String"
}
    item.install_base_item.display_value Nome de texto do item-base de instalação associado ao registro de partes relacionadas. Use este valor para exibir o nome do item-base de instalação na IU.

    Tipo de dados: cadeia de caracteres
    item.install_base_item.sys_id Sys_id do registro do item-base de instalação associado ao registro de partes relacionadas.

    Tipo de dados: cadeia de caracteres
    item.responsabilidade Detalhes sobre o nível de acesso às informações da base de instalação.

    Tipo de dados: objeto

    "responsibility": {
  "display_value": "String",
  "sys_id": "String"
}
    item.responsibility.display_value Valor de exibição de texto para o nível de acesso às informações da base de instalação.

    Tipo de dados: cadeia de caracteres
    item.responsibility.sys_id Sys_id do registro de responsabilidade associado. Este registro define o nível de acesso às informações da base de instalação.

    Este parâmetro só será válido se o campo related_party também for especificado. Se especificado, ele retornará somente os itens-base de instalação que correspondam aos parâmetros related_party e responsibility.

    Para obter informações adicionais, consulte Configure related parties for items received

    Tipo de dados: cadeia de caracteres

    Tabela: definição de responsabilidade [sn_customerservice_responsibility_def]
    item.sys_class_name Tabela que contém o registro de partes relacionadas.

    Tipo de dados: cadeia de caracteres

    Padrão: sn_install_base_related_party
    item.sys_id Sys_id do registro de partes relacionadas associadas.

    Tipo de dados: cadeia de caracteres
    item.tipo Detalhes sobre o tipo de contato associado ao registro de partes relacionadas.

    Tipo de dados: objeto

    "type": {
  "display_value": "String",
  "sys_id": "String"
}
    item.type.display_value Nome em texto do tipo de contato associado ao registro de partes relacionadas. Use este valor para exibir o tipo de contato na IU. Para obter informações adicionais, confira Create related party configurations.
    Tipos possíveis:
    • Conta autorizada
    • Consumidor autorizado
    • Contato autorizado
    • Colaborador autorizado
    • Membro autorizado
    • Organização de serviço autorizada
    • Conta listada
    • Consumidor listado
    • Contato listado
    • Colaborador listado
    • Membro listado
    • Organização de serviço listada

    Tipo de dados: cadeia de caracteres
    item.type.sys_id Sys_id do registro de tipo associado ao registro de partes relacionadas.

    Tipo de dados: cadeia de caracteres
    item.usuário Detalhes sobre o usuário associado ao registro de partes relacionadas.

    Tipo de dados: objeto

    "user": {
  "display_value": "String",
  "sys_id": "String"
}
    item.usuário.display_value Nome em texto do usuário associado ao registro de partes relacionadas. Use este valor para exibir o nome de usuário na IU.

    Tipo de dados: cadeia de caracteres
    item.usuário.sys_id
    Sys_id do registro do usuário associado ao registro de partes relacionadas.

    Tipo de dados: cadeia de caracteres

    Tabela: usuário [sys_user]
    status Status da chamada do endpoint.

    Tipo de dados: cadeia de caracteres
    sysparm_limit Número de registros retornados. Se este valor não for especificado na solicitação original, ele usará o valor padrão.

    Tipo de dados: número
    sysparm_offset Deslocamento (ponto de partida) na tabela associada da qual os registros foram avaliados e recuperados.

    Tipo de dados: cadeia de caracteres

    Solicitação de cURL

    O exemplo de código a seguir mostra como chamar este endpoint para atualizar o registro de contato associado à parte relacionada.

    curl "https://instance.servicenow.com/api/sn_install_base/integrations/relatedparties/f77c7542b7343300ece839a6ee11a991" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
\"contact\": \"dc0185d94f341200025ba3618110c77c\"
}" \
--user 'username':'password'

    Retornar resultados:

    {
"result":
  {
    "type": {
      "display_value":"Authorized Contact",
      "sys_id":"68ec8b2965e99110f87764df53db779f"
    },
    "install_base_item": {
      "display_value":"KX Series - KX5000",
      "sys_id":"f77c7542b7343300ece839a6ee11a991"
    },
    "sys_class_name":"sn_install_base_related_party",
    "sys_id":"4659539814ac6910f877ae314c1fb43a",
    "responsibility": {
      "display_value":"Authorized Representative",
      "sys_id":"c009bbedb3730010700b4d43c6a8dcef"
    },
    "contact": {
      "display_value":"Cindy Contact",
      "sys_id":"dc0185d94f341200025ba3618110c77c"
    },
    "account": {
      "display_value":"Boxeo",
      "value":"86837a386f0331003b3c498f5d3ee4ca"
    },
    "status":"SUCCESS",
  }
}

    Item-base de instalação - PATCH /sn_install_base/integrations/installbaseitems/{id}/uninstall

    Desinstala o item-base de instalação especificado.

    Uma desinstalação consiste em definir o campo active como falso e definir o campo unistall_date como uma data especificada. Vazio se um valor de data não for fornecido.

    Formato da URL

    URL com controle de versão: /api/sn_install_base/{api_version}/integrations/installbaseitems/{id}/uninstall

    URL padrão: /api/sn_install_base/integrations/installbaseitems/{id}/uninstall

    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 79. 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
    id Sys_id do registro do item-base de instalação.

    Tipo de dados: cadeia de caracteres

    Tabela: item-base de instalação [sn_install_base_item]
    Tabela 80. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 81. Parâmetros do corpo da solicitação (XML ou JSON)
    Nome Descrição
    desinstalar_data Data na qual o item-base de instalação especificado será desinstalado. Se não for especificado, ele será desinstalado imediatamente.

    Tipo de dados: cadeia de caracteres

    Formato: aaaa-mm-dd hh:mm:ss

    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 82. 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 83. 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 84. Códigos de status
    Código do status Descrição
    200 Bem-sucedido. A solicitação foi processada com sucesso.
    400 Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada.
    403 Proibido. O usuário não tem direitos de acesso ao registro especificado.
    404 Não encontrado. O item solicitado não foi encontrado.
    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
    erro Detalhes sobre o erro que ocorreu ao tentar processar a solicitação.

    Tipo de dados: objeto

    "error": {
  "detail": "String",
  "message": "String"
}
    erro.detalhe Detalhes adicionais sobre o erro associado.

    Tipo de dados: cadeia de caracteres
    mensagem.erro Mensagem de erro que descreve o problema que ocorreu ao tentar executar a solicitação.

    Tipo de dados: cadeia de caracteres
    item Descrição do item desinstalado.

    Tipo de dados: objeto

    "item": {
  "account": {Object},
  "active": "String",
  "asset": {Object},
  "configuration_item": {Object},
  "consumer": {Object},
  "consumer_profile": {Object},
  "contact": {Object},
  "health_status": {Object},
  "health_status_last_updated": "String",
  "household": {Object},
  "install_date": {Object},
  "location": {Object},
  "name": "String",
  "number": "String",
  "parent": {Object},
  "product": {Object},
  "service_context": {Object},
  "service_organization" {Object},
  "sys_class_name": "String",
  "sys_id": "String",
  "state": {Object},
  "status": {Object},
  "uninstall_date": "String"
}
    item.conta Detalhes sobre a conta do cliente associada ao registro do item-base de instalação.

    Tipo de dados: objeto

    "account": {
  "display_value": "String",
  "sys_id": "String"
}
    item.account.display_value Nome de texto da conta do cliente associada ao registro do item-base de instalação. Use este valor para exibir o nome da conta do cliente na IU.

    Tipo de dados: cadeia de caracteres
    item.account.sys_id Sys_id do registro de conta do cliente associado ao registro do item-base de instalação.

    Tipo de dados: cadeia de caracteres
    item.ativo Sinalizador que indica se o item-base de instalação está ativo.
    Valores possíveis:
    • verdadeiro: o item-base de instalação está ativo.
    • falso: o item-base de instalação está inativo.

    Tipo de dados: cadeia de caracteres booliana
    item.ativo Detalhes sobre o ativo associado ao registro do item-base de instalação.

    Tipo de dados: objeto

    "asset": {
  "display_value": "String",
  "sys_id": "String"
}
    item.ativo.display_value Nome de texto do ativo associado ao registro do item-base de instalação. Use este valor para exibir o nome do ativo na IU.

    Tipo de dados: cadeia de caracteres
    item.asset.sys_id Sys_id do registro de ativo associado ao registro do item-base de instalação.

    Tipo de dados: cadeia de caracteres
    item.child_install_base_items Lista dos itens-base de instalação secundários associados a este item-base de instalação.
    Nota:
    Os seguintes campos de item-base de instalação secundários não podem ser diferentes do primário:
    • conta
    • cliente
    • contato
    • organização de serviço

    Tipo de dados: matriz de objetos

    "child_install_base_items": [
  {
    "name": "String",
    "product": "String"
  }
]
    item.child_install_base_items.name Nome do item-base de instalação secundário.

    Tipo de dados: cadeia de caracteres
    item.child_install_base_items.product Sys_id do registro do item-base secundário associado.

    Tipo de dados: cadeia de caracteres

    Tabela: item-base de instalação [sn_install_base_item]
    item.item_de_configuração Detalhes sobre o item de configuração associado ao registro do item-base de instalação.

    Tipo de dados: objeto

    "configuration_item": {
  "display_value": "String",
  "sys_id": "String"
}
    item.configuration_display_value Nome de texto do item de configuração associado ao registro do item-base de instalação. Use este valor para exibir o nome do item de configuração na IU.

    Tipo de dados: cadeia de caracteres
    item.configuration_sys_id Sys_id do registro do item de configuração associado ao registro do item-base de instalação.

    Tipo de dados: cadeia de caracteres
    item.consumidor Detalhes sobre o consumidor associado ao registro do item-base de instalação.
    Nota:
    O campo do consumidor só estará disponível se o plug-in B2B2C estiver instalado.

    Tipo de dados: objeto

    "consumer": {
  "display_value": "String",
  "sys_id": "String"
}
    item.consumidor.display_value Nome em texto do consumidor associado ao registro do item-base de instalação. Use este valor para exibir o nome do consumidor na IU.

    Tipo de dados: cadeia de caracteres
    item.consumer.sys_id Sys_id do registro do consumidor associado ao registro do item-base de instalação.

    Tipo de dados: cadeia de caracteres
    item.consumer_profile Detalhes sobre o perfil do consumidor associado ao registro do item-base de instalação.
    Nota:
    O campo de perfil do consumidor só estará disponível se o plug-in B2B2C estiver instalado.

    Tipo de dados: objeto

    "consumer_profile": {
  "display_value": "String",
  "sys_id": "String"
}
    item.consumer_profile.display_value Nome de texto do perfil do consumidor associado ao registro do item-base de instalação. Use este valor para exibir o nome do perfil do consumidor na IU.

    Tipo de dados: cadeia de caracteres
    item.consumer_profile.sys_id Sys_id do registro de perfil do consumidor associado ao registro do item-base de instalação.

    Tipo de dados: cadeia de caracteres
    item.contato Detalhes sobre o contato da conta responsável pelo registro do item-base de instalação.

    Tipo de dados: objeto

    "contact": {
  "display_value": "String",
  "sys_id": "String"
}
    item.contact.display_value Nome de texto do contato da conta associado ao registro do item-base de instalação. Use este valor para exibir o nome do contato da conta na IU.

    Tipo de dados: cadeia de caracteres
    item.contact.sys_id Sys_id do registro de contato da conta associado ao registro do item-base de instalação.

    Tipo de dados: cadeia de caracteres
    item.status_de_saúde Detalhes sobre o status de integridade atual do item-base de instalação. Retornado somente se o plug-in Operações proativas de atendimento ao cliente (com.snc.proactive_cs_itom) estiver instalado.

    Tipo de dados: objeto

    "health_status": {
  "display_value": "String",
  "value": "String"
}
    item.status_de_saúde.display_value Cadeia de caracteres de texto do status de integridade atual do item-base de instalação. Use este valor para exibir o status de integridade na IU.

    Tipo de dados: cadeia de caracteres
    item.status_de_saúde.valor Valor interno do status de integridade do item-base de instalação.

    Tipo de dados: cadeia de caracteres
    item.status_health_last_updated Data e hora em que o status de integridade foi atualizado pela última vez para o item-base de instalação.

    Tipo de dados: cadeia de caracteres
    item.household Detalhes sobre a residência associada ao registro do item-base de instalação. Retornado somente se o plug-in Residência do Atendimento ao cliente (com.snc.household) estiver instalado.

    Tipo de dados: objeto

    "household": {
  "display_value": "String",
  "sys_id": "String"
}
    item.household.display_value Nome em texto da residência associada ao registro do item-base de instalação. Use este valor para exibir o nome da residência na IU.

    Tipo de dados: cadeia de caracteres
    item.household.sys_id Sys_id da residência associada ao registro do item-base de instalação.

    Tipo de dados: cadeia de caracteres
    item.install_date Detalhes sobre a data em que o item-base de instalação se tornou ativo.

    Tipo de dados: objeto

    "install_date": {
  "display_value": "String",
  "value": "String"
}
    item.install_date.display_value Data de instalação de texto. Use este valor para exibir a data de instalação na IU.

    Tipo de dados: cadeia de caracteres
    item.install_date.value Valor interno da data de instalação.

    Tipo de dados: cadeia de caracteres
    item.location Detalhes sobre o local do item-base de instalação.

    Tipo de dados: objeto

    "location": {
  "display_value": "String",
  "sys_id": "String"
}
    item.location.display_value Nome de texto do local do item-base de instalação. Use este valor para exibir o nome do local na IU.

    Tipo de dados: cadeia de caracteres
    item.location.sys_id Sys_id do registro de local associado ao registro do item-base de instalação.

    Tipo de dados: cadeia de caracteres
    item_name Nome do item-base de instalação.

    Tipo de dados: cadeia de caracteres
    item.número ID exclusivo do item-base de instalação.

    Tipo de dados: cadeia de caracteres
    item.primário Detalhes sobre o registro primário do registro do item-base de instalação.

    Tipo de dados: objeto

    "parent": {
  "display_value": "String",
  "sys_id": "String"
}
    item.primário.display_value Nome de texto do registro primário associado ao registro do item-base de instalação. Use este valor para exibir o nome primário na IU.

    Tipo de dados: cadeia de caracteres
    item.parent.sys_id Sys_id do registro primário associado ao registro do item-base de instalação.

    Tipo de dados: cadeia de caracteres
    item.produto Detalhes sobre o modelo de produto associado ao registro do item-base de instalação. Use essas informações para identificar os serviços associados a qualquer modelo de produto.

    Tipo de dados: objeto

    "product": {
  "display_value": "String",
  "sys_id": "String"
}
    item.produto.display_value Nome de texto do modelo de produto associado ao registro do item-base de instalação. Use este valor para exibir o nome do produto na IU.

    Tipo de dados: cadeia de caracteres
    item.product.sys_id Sys_id do registro do modelo do produto associado ao registro do item-base de instalação.

    Tipo de dados: cadeia de caracteres
    item.quantidade Número de itens instalados.

    Tipo de dados: inteiro
    item.service_context Detalhes sobre o contexto de serviço associado ao registro do item-base de instalação.

    Tipo de dados: objeto

    "service_context": {
  "display_value": "String",
  "sys_id": "String"
}
    item.service_context.display_value Detalhes sobre o contexto de serviço associado ao registro do item-base de instalação.

    Tipo de dados: objeto

    "service_context": {
  "display_value": "String",
  "sys_id": "String"
}
    item.service_context.sys_id Sys_id do registro de contexto de serviço associado ao registro do item-base de instalação.

    Tipo de dados: cadeia de caracteres
    item.serviço_organização Detalhes sobre a organização de serviço associada ao registro do item-base de instalação. Retornado somente se o plug-in Organização de serviço (com.snc.service_organization) estiver instalado.

    Tipo de dados: objeto

    "service_organization": {
  "display_value": "String",
  "sys_id": "String"
}
    item.service_organization.display_value Nome de texto da organização de serviço associada ao registro do item-base de instalação. Use este valor para exibir o nome da organização de serviço na IU.

    Tipo de dados: cadeia de caracteres
    item.service_organization.sys_id Sys_id do registro da organização de serviço associado ao registro do item-base de instalação.

    Tipo de dados: cadeia de caracteres
    item.sys_class_name Tabela que contém o registro do item-base de instalação.

    Tipo de dados: cadeia de caracteres
    item.sys_id Sys_id do registro do item-base de instalação. Localizado na tabela especificada no parâmetro sys_class_name.

    Tipo de dados: cadeia de caracteres
    item.estado Detalhes sobre o estado atual do item-base de instalação.

    Tipo de dados: objeto

    "state": {
  "display_value": "String",
  "value": "String"
}
    item.state.display_value Cadeia de caracteres de texto do estado atual do item-base de instalação. Use este valor para exibir o estado na IU.

    Tipo de dados: cadeia de caracteres
    item.estado.valor Valor interno do estado do item-base de instalação.

    Tipo de dados: cadeia de caracteres
    item.status Detalhes sobre o status do item-base de instalação.

    Tipo de dados: objeto

    "status": {
  "display_value": "String",
  "value": "String"
}
    item.status.display_value Cadeia de caracteres de texto do status do item-base de instalação. Use este valor para exibir o status na IU.

    Tipo de dados: cadeia de caracteres
    item.status.value Valor interno do status do item-base de instalação.

    Tipo de dados: cadeia de caracteres
    item.uninstall_date Detalhes sobre a data em que o item-base de instalação se tornou inativo.

    Tipo de dados: objeto

    "uninstall_date": {
  "display_value": "String",
  "value": "String"
}
    item.uninstall_date.display_value Data de desinstalação de texto. Use este valor para exibir a data de desinstalação na IU.

    Tipo de dados: cadeia de caracteres
    item.uninstall_date.value Valor interno da data de desinstalação.

    Tipo de dados: cadeia de caracteres
    status Status da chamada do endpoint.

    Tipo de dados: cadeia de caracteres

    Solicitação de cURL

    O exemplo de código a seguir mostra como chamar este endpoint.

    curl "https://instance.servicenow.com/api/sn_install_base/integrations/installbaseitems/42746a3b876121100b6afc86dabb3597/uninstall" \
--request PATCH \
--header "Accept:application/json" \
--user 'username':'password'

    Retornar resultados:

    {
  "result": {
    "status": "SUCCESS",
    "item": {
      "sys_class_name": {
        "value": "sn_install_base_item",
        "display_value": "Install Base Item"
      },
      "number": "IBITM0000901",
      "sys_id": "f77c7542b7343300ece839a6ee11a991",
      "contact": {
        "sys_id": "4d147a386f0331003b3c498f5d3ee437",
        "display_value": "Julie Lewis"
      },
      "state": {
        "value": "inactive",
        "display_value": "Inactive"
      },
      "active": "false",
      "configuration_item": {
        "sys_id": "e5a28e07c30202001efd5cb981d3aedb",
        "display_value": "KX Series - KX5000"
      },
      "name": "KX Series - KX5000",
      "account": {
        "sys_id": "86837a386f0331003b3c498f5d3ee4ca",
        "display_value": "Boxeo"
      }
    }
  }
}

    Item-base de instalação - POST /sn_install_base/integrations/installbaseitems

    Cria um ou mais registros de item-base de instalação na tabela Item-base de instalação padrão ou em sua tabela estendida, se especificado, e os preenche com os valores de campo especificados.

    Ao criar um único registro de item-base de instalação, você passa um objeto no corpo da solicitação que contém todos os campos a serem incluídos no corpo da solicitação. Ao criar vários registros de item-base de instalação em uma única chamada, você passa uma matriz de objetos no corpo da solicitação que contém todos os registros a serem criados. O endpoint processa e relata individualmente cada um dos objetos de criação de registro. Se um ou mais registros não forem criados, isso não afetará a criação de outro registro.

    Formato da URL

    URL com controle de versões: /api/sn_install_base/{api_version}/integrations/installbaseitems

    URL padrão: /api/sn_install_base/integrations/installbaseitems

    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 85. 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 86. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 87. Parâmetros do corpo da solicitação (XML ou JSON)
    Nome Descrição
    conta Necessário ao criar um item-base de instalação para uma conta.

    Sys_id da conta a ser associada ao item-base de instalação.

    Nota:
    Se você passar o parâmetro account, não poderá passar também o parâmetro consumer.

    Tipo de dados: cadeia de caracteres

    Tabela: Conta [customer_account]
    ativo Sinalizador que indica se o item-base de instalação está ativo.
    Valores válidos:
    • verdadeiro, "verdadeiro" ou "0": o item está ativo.
    • falso, "falso" ou "1": o item não está ativo.

    Tipo de dados: booliano

    Padrão: verdadeiro
    ativo Sys_id do ativo associado ao registro do item-base de instalação.

    Tipo de dados: cadeia de caracteres

    Tabela: ativo [alm_asset]
    child_install_base_items Lista dos itens-base de instalação secundários associados a este item-base de instalação.
    Nota:
    Os seguintes campos de item-base de instalação secundários não podem ser diferentes do primário:
    • conta
    • cliente
    • contato
    • organização de serviço

    Tipo de dados: matriz de objetos

    "child_install_base_items": [
  {
    "name": "String",
    "product": "String"
  }
]
    child_install_base_items.name Nome do item-base de instalação secundário.

    Tipo de dados: cadeia de caracteres
    child_install_base_items.product Sys_id do registro do item-base secundário associado.

    Tipo de dados: cadeia de caracteres

    Tabela: item-base de instalação [sn_install_base_item]
    configuration_item Sys_id do item de configuração associado ao registro do item-base de instalação.

    Tipo de dados: cadeia de caracteres

    Tabela: item de configuração [cmdb_ci]
    cliente Necessário ao criar um item-base de instalação para um consumidor.
    Sys_id do consumidor associado ao registro do item-base de instalação.
    Nota:
    Se você passar o parâmetro consumer, não poderá passar também o parâmetro account. Além disso, você só poderá associar um consumidor a um item-base de instalação se o plug-in B2B2C estiver instalado em sua instância.

    Tipo de dados: cadeia de caracteres

    Tabela: consumidor [csm_consumer]
    perfil_do_consumidor Sys_id do perfil do consumidor associado ao registro do item-base de instalação.

    Tipo de dados: cadeia de caracteres

    Tabela: perfil do consumidor [sn_csm_consumer_profile]
    contato
    Sys_id do registro de contato da conta que é o principal responsável pelo item-base de instalação.
    Nota:
    Os contatos só podem ser especificados para itens-base de instalação de conta.

    Tipo de dados: cadeia de caracteres

    Tabela: Contato [customer_contact]
    residência Sys_id da residência associada ao registro do item-base de instalação.
    Nota:
    Este campo só é válido quando o plug-in Residência do Atendimento ao cliente (com.snc.household) está instalado.

    Tipo de dados: cadeia de caracteres

    Tabela: Residência [csm_household]
    install_date Data em que o item-base de instalação se torna ativo.

    Tipo de dados: cadeia de caracteres

    Formato: aaaa-MM-dd HH:mm:ss
    local Sys_id do local do produto associado.

    Tipo de dados: cadeia de caracteres

    Tabela: local [cmn_location]
    nome Nome do item-base de instalação.

    Tipo de dados: cadeia de caracteres
    número Identificador exclusivo do item-base de instalação.

    Tipo de dados: cadeia de caracteres

    Padrão: gerado automaticamente pelo endpoint.
    primário Sys_id do registro primário para este registro de item-base de instalação.

    Tipo de dados: cadeia de caracteres

    Tabela: item-base de instalação [sn_install_base_item]
    product_model Sys_id do modelo de produto associado ao registro do item-base de instalação.

    Tipo de dados: cadeia de caracteres

    Tabela: modelo de produto [cmdb_model]
    quantidade Número de itens instalados.

    Tipo de dados: inteiro
    serviço_contexto Sys_id do serviço que está associado ao IC subjacente para calcular a severidade do impacto da Gestão de eventos. Para obter mais informações, consulte Service health status for install base.
    Nota:
    Este campo só será válido se o plug-in Operações proativas de atendimento ao cliente com gestão de eventos estiver instalado.

    Tipo de dados: cadeia de caracteres
    serviço_organização Necessário ao criar um item-base de instalação para uma organização de serviço.

    Sys_id do registro da organização de serviço que está envolvido na prestação de serviço ao cliente.

    Nota:
    Se você passar este parâmetro, não deverá passar também os parâmetros de conta, contato ou consumidor. O parâmetro service_organization só está disponível quando o plug-in Organização de serviço (com.snc.service_organization) está instalado na instância.

    Tipo de dados: cadeia de caracteres

    Tabela: organização de serviço [sn_customer_service_organization]
    estado Estado atual do item-base de instalação.
    Valores válidos:
    • em_uso
    • inativo

    Tipo de dados: cadeia de caracteres
    status Status do produto.
    Valores válidos:
    • original
    • substituição

    Tipo de dados: cadeia de caracteres
    sys_class_name Nome da tabela base de instalação estendida na qual o registro do item-base de instalação será criado.

    Tipo de dados: cadeia de caracteres

    Padrão: tabela Item-base de instalação [sn_install_base_item]
    desinstalar_data Data em que a base de instalação se torna inativa.

    Tipo de dados: cadeia de caracteres

    Formato: aaaa-MM-dd HH:mm:ss

    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 88. 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 89. 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 90. Códigos de status
    Código do status Descrição
    200 Bem-sucedido. A solicitação foi processada com sucesso.
    400 Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada.
    403 Proibido. O usuário não tem direitos de acesso ao registro especificado.
    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
    erro Detalhes sobre o erro que ocorreu ao tentar processar a solicitação.

    Tipo de dados: objeto

    "error": {
  "detail": "String",
  "message": "String"
}
    erro.detalhe Detalhes adicionais sobre o erro associado.

    Tipo de dados: cadeia de caracteres
    mensagem.erro Mensagem de erro que descreve o problema que ocorreu ao tentar executar a solicitação.

    Tipo de dados: cadeia de caracteres
    item Item-base de instalação que correspondeu aos resultados do filtro especificados. Somente campos não vazios são retornados.

    Tipo de dados: matriz de objetos

    "item": {
  "account": {Object},
  "active": "String",
  "asset": {Object},
  "child_install_base_items": {Object},
  "condition": "String",
  "configuration_item": {Object},
  "consumer": {Object},
  "consumer_profile": {Object},
  "contact": {Object},
  "health_status": {Object},
  "health_status_last_updated": "String",
  "household": {Object},
  "install_date": {Object},
  "location": {Object},
  "name": "String",
  "number": "String",
  "parent": {Object},
  "product": {Object},
  "quantity": Integer,
  "service_context": {Object},
  "service_organization" {Object},
  "sys_id": "String",
  "state": {Object},
  "status": {Object},
  "uninstall_date": "String"
}
    item.conta Detalhes sobre a conta do cliente associada ao registro do item-base de instalação.

    Tipo de dados: objeto

    "account": {
  "display_value": "String",
  "sys_id": "String"
}
    item.account.display_value Nome de texto da conta do cliente associada ao registro do item-base de instalação. Use este valor para exibir o nome da conta do cliente na IU.

    Tipo de dados: cadeia de caracteres
    item.account.sys_id Sys_id do registro de conta do cliente associado ao registro do item-base de instalação.

    Tipo de dados: cadeia de caracteres
    item.ativo Sinalizador que indica se o item-base de instalação está ativo.
    Valores possíveis:
    • verdadeiro: o item-base de instalação está ativo.
    • falso: o item-base de instalação está inativo.

    Tipo de dados: cadeia de caracteres booliana
    item.ativo Detalhes sobre o ativo associado ao registro do item-base de instalação.

    Tipo de dados: objeto

    "asset": {
  "display_value": "String",
  "sys_id": "String"
}
    item.ativo.display_value Nome de texto do ativo associado ao registro do item-base de instalação. Use este valor para exibir o nome do ativo na IU.

    Tipo de dados: cadeia de caracteres
    item.asset.sys_id Sys_id do registro de ativo associado ao registro do item-base de instalação.

    Tipo de dados: cadeia de caracteres
    item.child_install_base_items Lista dos itens-base de instalação secundários associados a este item-base de instalação.
    Nota:
    Os seguintes campos de item-base de instalação secundários não podem ser diferentes do primário:
    • conta
    • cliente
    • contato
    • organização de serviço

    Tipo de dados: matriz de objetos

    "child_install_base_items": [
  {
    "name": "String",
    "product": "String"
  }
]
    item.child_install_base_items.name Nome do item-base de instalação secundário.

    Tipo de dados: cadeia de caracteres
    item.child_install_base_items.product Sys_id do registro do item-base secundário associado.

    Tipo de dados: cadeia de caracteres

    Tabela: item-base de instalação [sn_install_base_item]
    item.item_de_configuração Detalhes sobre o item de configuração associado ao registro do item-base de instalação.

    Tipo de dados: objeto

    "configuration_item": {
  "display_value": "String",
  "sys_id": "String"
}
    item.configuration_item.display_value Nome de texto do item de configuração associado ao registro do item-base de instalação. Use este valor para exibir o nome do item de configuração na IU.

    Tipo de dados: cadeia de caracteres
    item.configuration_item.sys_id Sys_id do registro do item de configuração associado ao registro do item-base de instalação.

    Tipo de dados: cadeia de caracteres
    item.consumidor Detalhes sobre o consumidor associado ao registro do item-base de instalação.
    Nota:
    O campo do consumidor só estará disponível se o plug-in B2B2C estiver instalado.

    Tipo de dados: objeto

    "consumer": {
  "display_value": "String",
  "sys_id": "String"
}
    item.consumidor.display_value Nome em texto do consumidor associado ao registro do item-base de instalação. Use este valor para exibir o nome do consumidor na IU.

    Tipo de dados: cadeia de caracteres
    item.consumer.sys_id Sys_id do registro do consumidor associado ao registro do item-base de instalação.

    Tipo de dados: cadeia de caracteres
    item.consumer_profile Detalhes sobre o perfil do consumidor associado ao registro do item-base de instalação.
    Nota:
    O campo de perfil do consumidor só estará disponível se o plug-in B2B2C estiver instalado.

    Tipo de dados: objeto

    "consumer_profile": {
  "display_value": "String",
  "sys_id": "String"
}
    item.consumer_profile.display_value Nome de texto do perfil do consumidor associado ao registro do item-base de instalação. Use este valor para exibir o nome do perfil do consumidor na IU.

    Tipo de dados: cadeia de caracteres
    item.consumer_profile.sys_id Sys_id do registro de perfil do consumidor associado ao registro do item-base de instalação.

    Tipo de dados: cadeia de caracteres
    item.contato Detalhes sobre o contato da conta responsável pelo registro do item-base de instalação.

    Tipo de dados: objeto

    "contact": {
  "display_value": "String",
  "sys_id": "String"
}
    item.contact.display_value Nome de texto do contato da conta associado ao registro do item-base de instalação. Use este valor para exibir o nome do contato da conta na IU.

    Tipo de dados: cadeia de caracteres
    item.contact.sys_id Sys_id do registro de contato da conta associado ao registro do item-base de instalação.

    Tipo de dados: cadeia de caracteres
    item.status_de_saúde Detalhes sobre o status de integridade atual do item-base de instalação. Retornado somente se o plug-in Operações proativas de atendimento ao cliente (com.snc.proactive_cs_itom) estiver instalado.

    Tipo de dados: objeto

    "health_status": {
  "display_value": "String",
  "value": "String"
}
    item.status_de_saúde.display_value Cadeia de caracteres de texto do status de integridade atual do item-base de instalação. Use este valor para exibir o status de integridade na IU.

    Tipo de dados: cadeia de caracteres
    item.status_de_saúde.valor Valor interno do status de integridade do item-base de instalação.

    Tipo de dados: cadeia de caracteres
    item.status_health_last_updated Data e hora em que o status de integridade foi atualizado pela última vez para o item-base de instalação.

    Tipo de dados: cadeia de caracteres
    item.household Detalhes sobre a residência associada ao registro do item-base de instalação. Retornado somente se o plug-in Residência do Atendimento ao cliente (com.snc.household) estiver instalado.

    Tipo de dados: objeto

    "household": {
  "display_value": "String",
  "sys_id": "String"
}
    item.household.display_value Nome em texto da residência associada ao registro do item-base de instalação. Use este valor para exibir o nome da residência na IU.

    Tipo de dados: cadeia de caracteres
    item.household.sys_id Sys_id da residência associada ao registro do item-base de instalação.

    Tipo de dados: cadeia de caracteres
    item.install_date Detalhes sobre a data em que o item-base de instalação se tornou ativo.

    Tipo de dados: objeto

    "install_date": {
  "display_value": "String",
  "value": "String"
}
    item.install_date.display_value Data de instalação de texto. Use este valor para exibir a data de instalação na IU.

    Tipo de dados: cadeia de caracteres
    item.install_date.value Valor interno da data de instalação.

    Tipo de dados: cadeia de caracteres
    item.location Detalhes sobre o local do item-base de instalação.

    Tipo de dados: objeto

    "location": {
  "display_value": "String",
  "sys_id": "String"
}
    item.location.display_value Nome de texto do local do item-base de instalação. Use este valor para exibir o nome do local na IU.

    Tipo de dados: cadeia de caracteres
    item.location.sys_id Sys_id do registro de local associado ao registro do item-base de instalação.

    Tipo de dados: cadeia de caracteres
    item_name Nome do item-base de instalação.

    Tipo de dados: cadeia de caracteres
    item.número ID exclusivo do item-base de instalação.

    Tipo de dados: cadeia de caracteres
    item.primário Detalhes sobre o registro primário do registro do item-base de instalação.

    Tipo de dados: objeto

    "parent": {
  "display_value": "String",
  "sys_id": "String"
}
    item.primário.display_value Nome de texto do registro primário associado ao registro do item-base de instalação. Use este valor para exibir o nome primário na IU.

    Tipo de dados: cadeia de caracteres
    item.parent.sys_id Sys_id do registro primário associado ao registro do item-base de instalação.

    Tipo de dados: cadeia de caracteres
    item.produto Detalhes sobre o modelo de produto associado ao registro do item-base de instalação. Use essas informações para identificar os serviços associados a qualquer modelo de produto.

    Tipo de dados: objeto

    "product": {
  "display_value": "String",
  "sys_id": "String"
}
    item.produto.display_value Nome de texto do modelo de produto associado ao registro do item-base de instalação. Use este valor para exibir o nome do produto na IU.

    Tipo de dados: cadeia de caracteres
    item.product.sys_id Sys_id do registro do modelo do produto associado ao registro do item-base de instalação.

    Tipo de dados: cadeia de caracteres
    item.quantidade Número de itens instalados.

    Tipo de dados: inteiro
    item.service_context Detalhes sobre o contexto de serviço associado ao registro do item-base de instalação.

    Tipo de dados: objeto

    "service_context": {
  "display_value": "String",
  "sys_id": "String"
}
    item.service_context.display_value Detalhes sobre o contexto de serviço associado ao registro do item-base de instalação.

    Tipo de dados: objeto

    "service_context": {
  "display_value": "String",
  "sys_id": "String"
}
    item.service_context.sys_id Sys_id do registro de contexto de serviço associado ao registro do item-base de instalação.

    Tipo de dados: cadeia de caracteres
    item.serviço_organização Detalhes sobre a organização de serviço associada ao registro do item-base de instalação. Retornado somente se o plug-in Organização de serviço (com.snc.service_organization) estiver instalado.

    Tipo de dados: objeto

    "service_organization": {
  "display_value": "String",
  "sys_id": "String"
}
    item.service_organization.display_value Nome de texto da organização de serviço associada ao registro do item-base de instalação. Use este valor para exibir o nome da organização de serviço na IU.

    Tipo de dados: cadeia de caracteres
    item.service_organization.sys_id Sys_id do registro da organização de serviço associado ao registro do item-base de instalação.

    Tipo de dados: cadeia de caracteres
    item.sys_class_name Tabela que contém o registro do item-base de instalação.

    Tipo de dados: cadeia de caracteres
    item.sys_id Sys_id do registro do item-base de instalação. Localizado na tabela especificada no parâmetro sys_class_name.

    Tipo de dados: cadeia de caracteres
    item.estado Detalhes sobre o estado atual do item-base de instalação.

    Tipo de dados: objeto

    "state": {
  "display_value": "String",
  "value": "String"
}
    item.state.display_value Cadeia de caracteres de texto do estado atual do item-base de instalação. Use este valor para exibir o estado na IU.

    Tipo de dados: cadeia de caracteres
    item.estado.valor Valor interno do estado do item-base de instalação.

    Tipo de dados: cadeia de caracteres
    item.status Detalhes sobre o status do item-base de instalação.

    Tipo de dados: objeto

    "status": {
  "display_value": "String",
  "value": "String"
}
    item.status.display_value Cadeia de caracteres de texto do status do item-base de instalação. Use este valor para exibir o status na IU.

    Tipo de dados: cadeia de caracteres
    item.status.value Valor interno do status do item-base de instalação.

    Tipo de dados: cadeia de caracteres
    item.uninstall_date Detalhes sobre a data em que o item-base de instalação se tornou inativo.

    Tipo de dados: objeto

    "uninstall_date": {
  "display_value": "String",
  "value": "String"
}
    item.uninstall_date.display_value Data de desinstalação de texto. Use este valor para exibir a data de desinstalação na IU.

    Tipo de dados: cadeia de caracteres
    item.uninstall_date.value Valor interno da data de desinstalação.

    Tipo de dados: cadeia de caracteres
    status Status da chamada do endpoint.

    Tipo de dados: cadeia de caracteres

    Solicitação de cURL

    O exemplo de código a seguir mostra como criar um único registro de item-base de instalação.

    curl "https://instance.servicenow.com/api/sn_install_base/integrations/installbaseitems" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
  \"name\":\"Base Monitor\",
  \"quantity\": 4,
  \"account\":\"86837a386f0331003b3c498f5d3ee4ca\",
  \"contact\": \"dc0185d94f341200025ba3618110c77c\",
  \"configuration_item\":\"0c43baaac61122750182c132ee74bcf0\",
  \"state\":\"in_use\"
}" \
--user 'username':'password'

    Retornar resultados: somente campos não vazios são retornados.

    {
  "result": {
    "status": "SUCCESS",
    "item": {
      "sys_class_name": "sn_install_base_item",
      "number": "IBITM0001003",
      "sys_id": "27cb093114c66910f877324710112fd6",
      "contact": {
        "sys_id": "dc0185d94f341200025ba3618110c77c",
        "display_value": "Cindy Contact"
      },
      "state": {
        "value": "in_use",
        "display_value": "In Use"
      },
      "quantity": "4",
      "active": "true",
      "configuration_item": {
        "sys_id": "0c43baaac61122750182c132ee74bcf0",
        "display_value": "3D Pinball"
      },
      "name": "Base Monitor",
      "account": {
        "sys_id": "86837a386f0331003b3c498f5d3ee4ca",
        "display_value": "Boxeo"
      }
    }
  }
}

    Solicitação de cURL

    O exemplo de código a seguir mostra como criar vários registros de item-base de instalação.

    curl "https://instance.servicenow.com/api/sn_install_base/integrations/installbaseitems" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "[
  {
    \"name\":\"AST4 Laptop\",
    \"consumer\":\"b119803fdb1b1200b6075200cf961917\",
    \"status\":\"replacement\",
    \"install_date\":\"2023-05-18 12:00:00\",
    \"uninstall_date\":\"2023-09-28 12:00:00\"
  },
{
    \"name\":\"Base Monitor\",
    \"quantity\": 4,
    \"account\":\"86837a386f0331003b3c498f5d3ee4ca\",
    \"contact\": \"dc0185d94f341200025ba3618110c77c\",
    \"configuration_item\":\"0c43baaac61122750182c132ee74bcf0\",
    \"state\":\"in_use\"
  }
]" \
--user 'username':'password'

    Retornar resultados: somente campos não vazios são retornados.

    {
  "result": {
    "status": "SUCCESS",
    "items": [
      {
        "status": "SUCCESS",
        "item": {
          "sys_class_name": "sn_install_base_item",
          "number": "IBITM0001018",
          "sys_id": "16fe91b1140a6910f877324710112f40",
          "uninstall_date": {
            "value": "2023-09-28 12:00:00",
            "display_value": "2023-09-28 05:00:00"
          },
          "install_date": {
            "value": "2023-05-18 12:00:00",
            "display_value": "2023-05-18 05:00:00"
          },
          "consumer": {
            "sys_id": "b119803fdb1b1200b6075200cf961917",
            "display_value": "Silvester Erik"
          },
          "active": "true",
          "name": "AST4 Laptop",
          "status": {
            "value": "replacement",
            "display_value": "Replacement"
          }
        }
      },
      {
        "status": "SUCCESS",
        "item": {
          "sys_class_name": "sn_install_base_item",
          "number": "IBITM0001019",
          "sys_id": "5efe91b1140a6910f877324710112f40",
          "contact": {
            "sys_id": "dc0185d94f341200025ba3618110c77c",
            "display_value": "Cindy Contact"
          },
          "state": {
            "value": "in_use",
            "display_value": "In Use"
          },
          "quantity": "4",
          "active": "true",
          "configuration_item": {
            "sys_id": "0c43baaac61122750182c132ee74bcf0",
            "display_value": "3D Pinball"
          },
          "name": "Base Monitor",
          "account": {
            "sys_id": "86837a386f0331003b3c498f5d3ee4ca",
            "display_value": "Boxeo"
          }
        }
      }
    ]
  }
}

    Item-base de instalação - POST /sn_install_base/integrations/installbaseitems/{id}/relatedparties

    Cria um registro de parte relacionada e o associa a um registro de item-base de instalação especificado. Os valores especificados nos parâmetros de solicitação são armazenados no registro de parte relacionada recém-criado.

    Formato da URL

    URL com controle de versões: /api/sn_install_base/{api_version}/integrations/installbaseitems/{id}/relatedparties

    URL padrão: /api/sn_install_base/integrations/installbaseitems/{id}/relatedparties

    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 91. 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
    id Sys_id do registro do item-base de instalação.

    Tipo de dados: cadeia de caracteres

    Tabela: item-base de instalação [sn_install_base_item]
    Tabela 92. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 93. Parâmetros do corpo da solicitação (XML ou JSON)
    Nome Descrição
    conta Obrigatório se o parâmetro type for um dos seguintes:
    • Conta autorizada
    • Contato autorizado
    • Conta listada
    • Contato listado

    Sys_id da conta a ser associada ao item-base de instalação.

    Nota:
    Se você passar o parâmetro account, não poderá passar também o parâmetro consumer.

    Tipo de dados: cadeia de caracteres

    Tabela: Conta [customer_account]
    cliente Obrigatório se o parâmetro type for Consumidor autorizado ou Consumidor listado.
    Sys_id do consumidor associado ao registro do item-base de instalação.
    Nota:
    Se você passar o parâmetro consumer, não poderá passar também o parâmetro account. Além disso, você só poderá associar um consumidor a um item-base de instalação se o plug-in B2B2C estiver instalado em sua instância.

    Tipo de dados: cadeia de caracteres

    Tabela: consumidor [csm_consumer]
    contato Sys_id do registro de contato associado ao registro de partes relacionadas.

    Tipo de dados: cadeia de caracteres

    Tabela: Contato [customer_contact]
    install_base_item Sys_id do registro do item-base de instalação associado ao registro de partes relacionadas.

    Tipo de dados: cadeia de caracteres
    responsabilidade Sys_id do registro de responsabilidade associado. Este registro define o nível de acesso às informações da base de instalação.

    Este parâmetro só será válido se o campo related_party também for especificado. Se especificado, ele retornará somente os itens-base de instalação que correspondam aos parâmetros related_party e responsibility.

    Para obter informações adicionais, consulte Configure related parties for items received

    Tipo de dados: cadeia de caracteres

    Tabela: definição de responsabilidade [sn_customerservice_responsibility_def]
    serviço_organização Obrigatório se o parâmetro type for um dos seguintes:
    • Membro autorizado
    • Organização de serviço autorizada
    • Membro listado
    • Organização de serviço listada

    Sys_id do registro da organização de serviço que está envolvido na prestação de serviço ao cliente.

    Nota:
    Se você passar este parâmetro, não deverá passar também os parâmetros de conta, contato ou consumidor. O parâmetro service_organization só está disponível quando o plug-in Organização de serviço (com.snc.service_organization) está instalado na instância.

    Tipo de dados: cadeia de caracteres

    Tabela: organização de serviço [sn_customer_service_organization]
    sys_class_name Tabela que contém o registro de partes relacionadas.

    Tipo de dados: cadeia de caracteres

    Padrão: sn_install_base_related_party
    tipo Obrigatório. Sys_id do tipo de parte relacionada a ser criado.
    Tipos possíveis:
    • Conta autorizada
    • Consumidor autorizado
    • Contato autorizado
    • Colaborador autorizado
    • Membro autorizado
    • Organização de serviço autorizada
    • Conta listada
    • Consumidor listado
    • Contato listado
    • Colaborador listado
    • Membro listado
    • Organização de serviço listada

    Tipo de dados: cadeia de caracteres

    Tabela: configuração de parte relacionada [sn_customerservice_related_party_configuration]
    usuário Obrigatório se o parâmetro type for um dos seguintes tipos de partes relacionadas:
    • Colaborador autorizado
    • Membro autorizado
    • Colaborador listado
    • Membro listado

    Para Membro autorizado e Membro listado, este usuário deve estar associado ao registro service_organization especificado.

    Sys_id do registro do usuário associado ao registro de partes relacionadas.

    Tipo de dados: cadeia de caracteres

    Tabela: usuário [sys_user]

    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 94. 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 95. 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 96. Códigos de status
    Código do status Descrição
    200 Bem-sucedido. A solicitação foi processada com sucesso.
    400 Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada.
    403 Proibido. O usuário não tem direitos de acesso ao registro especificado.
    404 Não encontrado. O item solicitado não foi encontrado.
    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
    conta Detalhes sobre a conta associada ao registro de partes relacionadas.

    Tipo de dados: objeto

    account": {
  "display_value": "String",
  "sys_id": "String"
}
    account.display_value Nome em texto da conta associada ao registro de partes relacionadas. Use este valor para exibir o nome da conta na IU.

    Tipo de dados: cadeia de caracteres
    conta.sys_id Sys_id do registro de conta associado ao registro de partes relacionadas.

    Tipo de dados: cadeia de caracteres
    cliente Detalhes sobre o consumidor associado ao registro de partes relacionadas.

    Tipo de dados: objeto

    "consumer": {
  "display_value": "String",
  "sys_id": "String"
}
    consumidor.display_value Nome em texto do consumidor associado ao registro de partes relacionadas. Use este valor para exibir o nome do consumidor na IU.

    Tipo de dados: cadeia de caracteres
    consumidor.sys_id Sys_id do registro do consumidor associado ao registro de partes relacionadas.

    Tipo de dados: cadeia de caracteres
    contato Detalhes sobre o contato da conta responsável pelo registro de partes relacionadas.

    Tipo de dados: objeto

    "contact": {
  "display_value": "String",
  "sys_id": "String"
}
    contato.display_value Nome em texto do contato associado ao registro de partes relacionadas. Use este valor para exibir o nome do contato na IU.

    Tipo de dados: cadeia de caracteres
    contato.sys_id Sys_id do registro de contato associado ao registro de partes relacionadas.

    Tipo de dados: cadeia de caracteres

    Tabela: Contato [customer_contact]
    erro Detalhes sobre o erro que ocorreu ao tentar processar a solicitação.

    Tipo de dados: objeto

    "error": {
  "detail": "String",
  "message": "String"
}
    erro.detalhe Detalhes adicionais sobre o erro associado.

    Tipo de dados: cadeia de caracteres
    mensagem.erro Mensagem de erro que descreve o problema que ocorreu ao tentar executar a solicitação.

    Tipo de dados: cadeia de caracteres
    install_base_item Detalhes sobre o item-base de instalação associado ao registro de partes relacionadas.

    Tipo de dados: objeto

    "install_base_item": {
  "display_value": "String",
  "sys_id": "String"
}
    install_base_item.display_value Nome de texto do item-base de instalação associado ao registro de partes relacionadas. Use este valor para exibir o nome do item-base de instalação na IU.

    Tipo de dados: cadeia de caracteres
    install_base_item.sys_id Sys_id do registro do item-base de instalação associado ao registro de partes relacionadas.

    Tipo de dados: cadeia de caracteres
    responsabilidade Detalhes sobre o nível de acesso às informações da base de instalação.

    Tipo de dados: objeto

    "responsibility": {
  "display_value": "String",
  "sys_id": "String"
}
    responsabilidade.display_value Valor de exibição de texto para o nível de acesso às informações da base de instalação.

    Tipo de dados: cadeia de caracteres
    responsabilidade.sys_id Sys_id do registro de responsabilidade associado. Este registro define o nível de acesso às informações da base de instalação.

    Este parâmetro só será válido se o campo related_party também for especificado. Se especificado, ele retornará somente os itens-base de instalação que correspondam aos parâmetros related_party e responsibility.

    Para obter informações adicionais, consulte Configure related parties for items received

    Tipo de dados: cadeia de caracteres

    Tabela: definição de responsabilidade [sn_customerservice_responsibility_def]
    status Status da chamada do endpoint.

    Tipo de dados: cadeia de caracteres
    sys_class_name Tabela que contém o registro de partes relacionadas.

    Tipo de dados: cadeia de caracteres

    Padrão: sn_install_base_related_party
    sys_id Sys_id do registro de partes relacionadas associadas.

    Tipo de dados: cadeia de caracteres
    sysparm_limit Número de registros retornados. Se este valor não for especificado na solicitação original, ele usará o valor padrão.

    Tipo de dados: número
    sysparm_offset Deslocamento (ponto de partida) na tabela associada da qual os registros foram avaliados e recuperados.

    Tipo de dados: cadeia de caracteres
    tipo Detalhes sobre o tipo de contato associado ao registro de partes relacionadas.

    Tipo de dados: objeto

    "type": {
  "display_value": "String",
  "sys_id": "String"
}
    type.display_value Nome em texto do tipo de contato associado ao registro de partes relacionadas. Use este valor para exibir o tipo de contato na IU. Para obter informações adicionais, confira Create related party configurations.
    Tipos possíveis:
    • Conta autorizada
    • Consumidor autorizado
    • Contato autorizado
    • Colaborador autorizado
    • Membro autorizado
    • Organização de serviço autorizada
    • Conta listada
    • Consumidor listado
    • Contato listado
    • Colaborador listado
    • Membro listado
    • Organização de serviço listada

    Tipo de dados: cadeia de caracteres
    tipo.sys_id Sys_id do registro de tipo associado ao registro de partes relacionadas.

    Tipo de dados: cadeia de caracteres
    usuário Detalhes sobre o usuário associado ao registro de partes relacionadas.

    Tipo de dados: objeto

    "user": {
  "display_value": "String",
  "sys_id": "String"
}
    usuário.display_value Nome em texto do usuário associado ao registro de partes relacionadas. Use este valor para exibir o nome de usuário na IU.

    Tipo de dados: cadeia de caracteres
    usuário.sys_id
    Sys_id do registro do usuário associado ao registro de partes relacionadas.

    Tipo de dados: cadeia de caracteres

    Tabela: usuário [sys_user]

    Solicitação de cURL

    O exemplo de código a seguir mostra como chamar este endpoint para criar um registro relacionado a uma conta autorizada e associá-lo a um item-base de instalação.

    curl "https://instance.servicenow.com/api/sn_install_base/integrations/relatedparties/f77c7542b7343300ece839a6ee11a991" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
  "contact":"0a232a0013691200042ab3173244b075",
  "type":"68ec8b2965e99110f87764df53db779f",
  "account":"86837a386f0331003b3c498f5d3ee4ca",
  "install_base_item":"f77c7542b7343300ece839a6ee11a991",
  "responsibility":"c009bbedb3730010700b4d43c6a8dcef",
  "sys_class_name":"sn_install_base_related_party"
}" \
--user 'username':'password'

    Retornar resultados:

    {
"result":
  {
    "type": {
      "display_value":"Authorized Contact",
      "sys_id":"68ec8b2965e99110f87764df53db779f"
    },
    "install_base_item": {
      "display_value":"KX Series - KX5000",
      "sys_id":"f77c7542b7343300ece839a6ee11a991"
    },
    "sys_class_name":"sn_install_base_related_party",
    "sys_id":"4659539814ac6910f877ae314c1fb43a",
    "responsibility": {
      "display_value":"Authorized Representative",
      "sys_id":"c009bbedb3730010700b4d43c6a8dcef"
    },
    "contact": {
      "display_value":"Cindy Contact",
      "sys_id":"dc0185d94f341200025ba3618110c77c"
    },
    "account": {
      "display_value":"Boxeo",
      "value":"86837a386f0331003b3c498f5d3ee4ca"
    },
    "status":"SUCCESS",
  }
}