API de serviço de aplicativos

  • Versão de lançamento: Yokohama
  • Atualizado 30 de jan. de 2025
  • 19 min. de leitura
  • . Serviço de aplicações A API fornece endpoints que permitem criar, modificar e atualizar serviços de aplicações.

    Esta API requer que o usuário tenha a função de administrador do serviço de aplicações [app_service_admin].

    Importante:
    Começando com Romeversão, o. Serviço de aplicações A API não é mais aprimorada ou compatível. Para obter detalhes, consulte o artigo Deprecation Process (Processo de descontinuação) [KB0867184] na Base de conhecimento do Now Support.

    Serviço de aplicações - OBTER /now/cmdb/app_service/

    Recupera uma lista de itens de configuração (IC) em um serviço de aplicações mapeado e os relacionamentos entre eles. Recupera apenas conteúdo de serviços que foram criados manualmente.

    Formato de URL

    URL padrão: /api/now/cmdb/app_service/sys_id/getContent

    Parâmetros de solicitação compatíveis

    Tabela 1. Parâmetros de caminho
    Nome Descrição
    sys_id Sys_id do serviço de aplicações mapeado.

    Tipo de dados: Cadeia de caracteres

    Tabela: Serviço de aplicações mapeado [cmdb_ci_service_discovered]

    Tabela 2. Parâmetros de consulta
    Nome Descrição
    Modo Quantidade de dados de relacionamento a serem retornados.
    Valores válidos:
    • Completo: Retorna atributos de IC e informações de pesquisa, além dos dados retornados no modo superficial.
    • Superficial: Retorna relacionamentos primários e secundários entre ICs em um serviço.
    Os valores não diferenciam maiúsculas de minúsculas.

    Tipo de dados: Cadeia de caracteres

    Tabela 3. Parâmetros do corpo da solicitação (XML ou JSON)
    Nome Descrição
    Nenhum(a)

    Cabeçalhos

    Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos da 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/jsonou 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 possíveis códigos de status usados na REST API, consulte REST API códigos de resposta HTTP .

    Tabela 6. Códigos de status
    Código de status Descrição
    200 Bem-sucedido. A solicitação foi processada com sucesso.
    400 Solicitação Incorreta. Um tipo de solicitação incorreto ou uma solicitação malformada foi detectada.
    401 Não autorizado. As credenciais do usuário estão incorretas ou não têm a função app_service_admin.
    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
    cmdb Lista de objetos que descrevem os ICs associados ao serviço de aplicações especificado.

    Tipo de dados: Objeto

    "cmdb": [
      {
        "items": {Object},
        "relations": [Array]
      }
    ]
    cmdb.items ICs no serviço de aplicações. Se o parâmetro de consulta completo foi passado na solicitação, esta seção incluirá atributos e informações de pesquisa para cada IC.

    Tipo de dados: Matriz

    "items": [
      {
        "className": "String",
        "values": {Object}
      }
    ]
    cmdb.items.className Nome da classe que contém o IC.

    Tipo de dados: Cadeia de caracteres

    cmdb.items.values Informações a serem usadas para localizar um IC associado.

    Tipo de dados: Objeto

    "values": {
      "name": "String",
      "sys_id": "String"
    }
    cmdb.items.values.name Nome do IC.

    Tipo de dados: Cadeia de caracteres

    cmdb.items.values.sys_id Sys_id do IC.

    Tipo de dados: Cadeia de caracteres

    cmdb.relações Dados de relacionamento para ICs associados, como hosts e seus secundários.

    Tipo de dados: Matriz

    serviço Lista de serviços relacionados ao serviço identificado.

    Tipo de dados: Matriz de objetos

    "service": [
      {
        "name": "String",
        "service_relations": [Array],
        "url": "String"
      }
    ]
    service.name Nome do serviço de aplicações.

    Tipo de dados: Cadeia de caracteres

    service.service_relations Dados de hierarquia para os ICs no serviço de aplicações. Todos os ICs formam pares com um IC primário e secundário. O IC de nível superior, conhecido como o ponto de entrada de um serviço de aplicações, não tem um IC primário.

    Tipo de dados: Matriz de objetos

    "service_relations": [
      {
        "child": "String",
        "parent": "String"
      }
    ]
    service.service_relations.child Nome de um IC secundário relacionado ao IC.

    Tipo de dados: Cadeia de caracteres

    service.service_relations.parent Nome de um IC primário relacionado ao IC.

    Tipo de dados: Cadeia de caracteres

    url.do serviço Caminho relativo para o serviço de aplicações.

    Tipo de dados: Cadeia de caracteres

    Solicitação de curl de amostra

    curl "https://instance.servicenow.com/api/now/cmdb/app_service/2fce42d80a0a0bb4004af34d7e3984c8/getContent?mode=shallow" \
    --request GET \
    --header "Accept:application/json" \
    --user 'username':'password'
    {
      "service": {
        "name": "PeopleSoft Portals",
        "url": "/api/now/table/cmdb_ci_service_discovered/2fce42d80a0a0bb4004af34d7e3984c8",
        "service_relations": [
          {
            "parent": "",
            "child": "3a2810c20a0a0bb400268337d6e942ca"
          },
          {
            "parent": "3a27f1520a0a0bb400ecd6ff7afcf036",
            "child": "3a5dd3dbc0a8ce0100655f1ec66ed42c"
          },
          {
            "parent": "3a290cc60a0a0bb400000bdb386af1cf",
            "child": "3a307c930a0a0bb400353965d0b8861f"
          },
          {
            "parent": "3a172e820a0a0bb40034228e9f65f1be",
            "child": "3a27d4370a0a0bb4006316812bf45439"
          },
          {
            "parent": "",
            "child": "3a172e820a0a0bb40034228e9f65f1be"
          },
          {
            "parent": "",
            "child": "3a27f1520a0a0bb400ecd6ff7afcf036"
          },
          {
            "parent": "3a2810c20a0a0bb400268337d6e942ca",
            "child": "3a290cc60a0a0bb400000bdb386af1cf"
          }
        ]
      },
      "cmdb": {
        "relations": [],
        "items": [
          {
            "values": {
              "sys_id": "3a172e820a0a0bb40034228e9f65f1be",
              "name": "PS LoadBal01"
            },
            "className": "cmdb_ci_win_server"
          },
          {
            "values": {
              "sys_id": "3a2810c20a0a0bb400268337d6e942ca",
              "name": "PS Apache03"
            },
            "className": "cmdb_ci_web_server"
          },
          {
            "values": {
              "sys_id": "55b35562c0a8010e01cff22378e0aea9",
              "name": "ny8500-nbxs08"
            },
            "className": "cmdb_ci_netgear"
          },
          {
            "values": {
              "sys_id": "3a27f1520a0a0bb400ecd6ff7afcf036",
              "name": "PS Apache02"
            },
            "className": "cmdb_ci_web_server"
          },
          {
            "values": {
              "sys_id": "3a307c930a0a0bb400353965d0b8861f",
              "name": "PS ORA01"
            },
            "className": "cmdb_ci_database"
          }
        ]
      }
    }

    Serviço de aplicações - OBTER /now/cmdb/csdm/app_service/find_service

    Retorna informações básicas sobre um serviço de aplicações especificado e seu contexto de negócios associado.

    Nota:
    Este endpoint foi descontinuado, use SG Services – POST /sg_services/app_service/findem vez disso.

    Formato de URL

    URL padrão: /api/now/cmdb/csdm/app_service/find_service

    Parâmetros de solicitação compatíveis

    Tabela 7. Parâmetros de caminho
    Nome Descrição
    Nenhum(a)
    Tabela 8. Parâmetros de consulta
    Nome Descrição
    nome Necessário, se numbernão foi aprovado. Nome do serviço para o qual retornar informações.

    Tipo de dados: Cadeia de caracteres

    Tabela: Instância de serviço [cmdb_ci_service_auto]

    número Necessário, se namenão foi aprovado. Número exclusivo que identifica o serviço de aplicações para o qual retornar informações.

    Tipo de dados: Cadeia de caracteres

    Tabela: Instância de serviço [cmdb_ci_service_auto]

    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 da REST API compatíveis .

    Tabela 10. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. Suporta somente 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 possíveis códigos de status usados na REST API, consulte REST API códigos de resposta HTTP .

    Tabela 12. Códigos de status
    Código de status Descrição
    200 Bem-sucedido. A solicitação foi processada com sucesso.
    400 Solicitação Incorreta. Um tipo de solicitação incorreto ou uma solicitação malformada foi detectada.
    401 Não autorizado. As credenciais do usuário estão incorretas ou não têm a função app_service_admin.
    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 Descreve um erro encontrado.

    Tipo de dados: Objeto

    "error": {
      "details": "String",
      "message": "String"
    }
    error.details Informações adicionais sobre o erro.

    Tipo de dados: Cadeia de caracteres

    mensagem.erro Mensagem descrevendo o erro.

    Tipo de dados: Cadeia de caracteres

    serviços Matriz de objetos, cada objeto contendo detalhes de serviços associados ao serviço de aplicações especificado.

    Tipo de dados: Matriz

    "services": [
      {
        "environment": "String",
        "name": "String",
        "number": "String",
        "relationships": {Object},
        "sys_id": "String",
        "version": "String"
      }
    ]
    services.environment Ambiente no qual o serviço de aplicações é implantado, como "Produção" ou "Laboratório de testes 2". Este pode ser qualquer valor que faça sentido para o implementador.

    Tipo de dados: Cadeia de caracteres

    Comprimento máximo: 40

    Padrão: Nulo

    services.name Necessário. Nome do serviço de aplicações. Deve ser um nome exclusivo de todos os outros serviços de aplicações.

    Tipo de dados: Cadeia de caracteres

    Comprimento máximo: 255

    número.services Número exclusivo que identifica o serviço de aplicações. Este valor é gerado inicialmente pelo endpoint.

    Tipo de dados: Cadeia de caracteres

    relacionamentos.serviços Tipos de serviço associados ao serviço de aplicações.

    Tipo de dados: Objeto

    "relationships": {
      "business_app": [Array],
      "business_service_offering": [Array],
      "technical_service_offering": [Array]
    }
    relationships.business_app Lista de sys_ids das aplicações de negócios relacionadas ao serviço de aplicações.

    Tipo de dados: Matriz

    relationships.technical_service_offering Lista de sys_ids das ofertas de gestão de tecnologia (anteriormente ofertas de serviço técnico) relacionadas ao serviço de aplicações.

    Tipo de dados: Matriz

    relationships.business_service_offering Lista de sys_ids das ofertas de serviço de negócio relacionadas ao serviço de aplicações.

    Tipo de dados: Matriz

    sys_id.services.sys_id Sys_id do serviço de aplicações.

    Tipo de dados: Cadeia de caracteres

    services.version Número da versão do serviço de aplicações.

    Tipo de dados: Cadeia de caracteres

    Comprimento máximo: 40

    Formato: Definível pelo usuário

    Padrão: Nulo

    Solicitação de curl de amostra

    curl -X GET \
      https://instance.servicenow.com/api/now/cmdb/csdm/app_service/find_service?name=Email_East&number=SNSVC0001018 \
      -H 'Accept: application/json' \
      -u 'username':'password'
    
    {
    "result": {
      "services": [
        {
          "name": "Email_East",
          "number": "SNSVC0001018",
          "sys_id": "f809cb60db94101037740f95ca96190f",
          "environment": "Production",
          "version": "1.1.1",
          "relationships": {
            "business_app": [
              "658c7620db54101037740f95ca9619f2"
            ],
            "technical_service_offering": [],
            "business_service_offering": [
              "069c7e20db54101037740f95ca9619bf"
            ]
          }
        }
      ]
     }
    }

    Serviço de aplicações - POST /now/cmdb/app_service/create

    Cria um serviço de aplicações ou atualiza um serviço de aplicações existente.

    Formato de URL

    URL padrão: /api/now/cmdb/app_service/create

    Parâmetros de solicitação compatíveis

    Tabela 13. Parâmetros
    Parâmetro 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 da REST API compatíveis .

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

    Padrão: application/json

    Tipo de conteúdo Formato de dados do corpo da solicitação. Tipos compatíveis: application/jsonou application/xml.

    Padrão: application/json

    Tabela 15. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum(a)

    Códigos de status

    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 da REST API compatíveis .

    Tabela 16. Códigos de status
    Código de status Descrição
    200 Bem-sucedido. A solicitação foi processada com sucesso.
    400 Solicitação Incorreta. Um tipo de solicitação incorreto ou uma solicitação malformada foi detectada.
    401 Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas.

    Corpo da solicitação

    A API aceita esses elementos JSON no corpo da solicitação. Além disso, você pode adicionar qualquer campo da tabela Serviço de aplicações mapeado [cmdb_ci_service_discovered] para passar dados para o registro de serviço de aplicações. Por exemplo, para adicionar conteúdo ao campo Comentários, adicione "Comentários": "Passando dados para o campo Comentários" Para a solicitação JSON.

    Tabela 17. Elementos aceitos no corpo da solicitação
    Elemento Descrição
    nome Nome do serviço de aplicações que você deseja criar ou atualizar.
    service_relations Informações sobre ICs e a hierarquia que eles formam. Todos os ICs formam pares com um IC primário e um IC secundário. O IC de nível superior, conhecido como o ponto de entrada de um serviço de aplicações, não tem um IC primário.
    primário Sys_ id do IC cuja conexão de saída se une a este IC com o IC no nível inferior na hierarquia de mapa.
    secundário(a) Sys_ id do IC cuja conexão de entrada se une a este IC com o IC localizado no nível superior na hierarquia de mapa.

    Corpo da resposta

    A API retorna esses elementos JSON no corpo da resposta.

    Tabela 18. Elementos retornados no corpo da resposta
    Elemento Descrição
    URL URL da API REST da tabela padrão para mostrar o sys_id de um registro de serviço de aplicações.

    Este elemento aparecerá somente se o endpoint for bem-sucedido.

    Tipo de dados: Cadeia de caracteres

    ContentUrl Caminho da REST API para obter o conteúdo do serviço de aplicações.

    Este elemento aparecerá somente se o endpoint for bem-sucedido.

    Tipo de dados: Cadeia de caracteres

    informações Número de ICs adicionados ao serviço de aplicações.

    Este elemento aparecerá somente se o endpoint for bem-sucedido.

    Tipo de dados: Cadeia de caracteres

    erro Detalhes da mensagem de erro.

    Este elemento aparece somente se o endpoint falhar.

    Tipo de dados: Objeto

    mensagem Mensagem de erro que descreve a natureza da falha.

    Este elemento aparece somente se o endpoint falhar.

    Tipo de dados: Cadeia de caracteres

    status Indica "Falha" se a REST API falhar.

    Este elemento aparece somente se o endpoint falhar.

    Tipo de dados: Cadeia de caracteres

    Solicitação de curl de amostra

    curl "http://<instance.servicenow.com>/api/now/cmdb/app_service/create" \
    --request POST \
    --header "Accept:application/json" \
    --header "Content-Type:application/json" \
    --data "{
    \"name\": \"myTestAppService\",
    \"comments\": \"Passing data to the Comments field\",
    \"service_relations\": [
    { \"parent\": \"\",
    \"child\": \"3a70f789c0a8ce010091b0ea635b982a\"
    },{ \"parent\": \"3a70f789c0a8ce010091b0ea635b982a\",
    \"child\": \"b4fd7c8437201000deeabfc8bcbe5dc1\"
    },{ \"parent\": \"b4fd7c8437201000deeabfc8bcbe5dc1\",
    \"child\": \"53fdbc8437201000deeabfc8bcbe5d10\"
    }
    ]
    }" \
    --user 'admin':'admin'
    {
      "result": {
        "url": "/api/now/table/cmdb_ci_service_discovered/b1cff89fc9e19300964fcbb1ac3059a5",
        "getContentUrl": "/api/now/cmdb/app_service/b1cff89fc9e19300964fcbb1ac3059a5/getContent",
        "info": "3 CIs added to service"
      }
    }

    Serviço de aplicações - POST /now/cmdb/csdm/app_service/register_service

    Cria um stub de registro de serviço de aplicações na tabela Instância de serviço [cmdb_ci_service_auto] e preenche-o com as informações passadas.

    Antes de armazenar o registro, ele valida os parâmetros aprovados e a exclusividade do nome do serviço da aplicação. Ele também cria relacionamentos ascendentes que fornecem contexto de negócios ao serviço, associando as aplicações de negócios especificadas, ofertas de serviços de negócios e ofertas de gestão de tecnologia (anteriormente ofertas de serviços técnicos) para a aplicação de serviço. Ele não cria relacionamentos descendentes com a infraestrutura. Para definir relacionamentos descendentes, você deve chamar Serviço de aplicações - PUT /now/cmdb/csdm/app_service/ endpoint.
    Nota:
    Este endpoint foi descontinuado, use SG Services – PUBLICAR /sg_services/app_service/registerem vez disso.

    Formato de URL

    URL padrão: /api/now/cmdb/csdm/app_service/register_service

    Parâmetros de solicitação compatíveis

    Tabela 19. Parâmetros de caminho
    Nome Descrição
    Nenhum(a)
    Tabela 20. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 21. Parâmetros do corpo da solicitação
    Nome Descrição
    basic_details Necessário. Detalhes do serviço associado ao serviço de aplicações especificado.

    Tipo de dados: Objeto

    "basic_details": {
      "environment": "String",
      "name": "String",
      "version": "String"
    }
    basic_details.environment Ambiente no qual o serviço de aplicações é implantado, como "Produção" ou "Laboratório de testes 2". Este pode ser qualquer valor que faça sentido para o implementador.

    Tipo de dados: Cadeia de caracteres

    Comprimento máximo: 40

    Padrão: Nulo

    basic_details.name Necessário. Nome do serviço de aplicações. Deve ser um nome exclusivo de todos os outros serviços de aplicações.

    Tipo de dados: Cadeia de caracteres

    Comprimento máximo: 255

    basic_details.version Número da versão do serviço de aplicações.

    Tipo de dados: Cadeia de caracteres

    Comprimento máximo: 40

    Formato: Definível pelo usuário

    Padrão: Nulo

    relacionamentos Tipos de serviço ascendente (primário) a serem associados ao serviço de aplicações.

    Tipo de dados: Objeto

    "relationships": {
      "business_app": [Array],
      "business_service_offering": [Array],
      "technical_service_offering": [Array]
    }

    Tabela: Relacionamentos de IC [cmdb_rel_ci]

    relationships.business_app Lista de sys_ids das aplicações de negócios a serem relacionadas ao serviço de aplicações.

    Tipo de dados: Matriz

    business_service_offering.business_service_offering Lista de sys_ids das ofertas de serviço de negócio a serem relacionadas ao serviço de aplicações.

    Tipo de dados: Matriz

    relationships.technical_service_offering Lista de sys_ids das ofertas de serviço técnico a serem relacionadas ao serviço de aplicações.

    Tipo de dados: Matriz

    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 da REST API compatíveis .

    Tabela 22. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. Suporta somente application/json.
    Tipo de conteúdo Formato de dados do corpo da solicitação. Suporta somente 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 possíveis códigos de status usados na REST API, consulte REST API códigos de resposta HTTP .

    Tabela 24. Códigos de status
    Código de status Descrição
    201 Bem-sucedido. O serviço de aplicações foi registrado com sucesso.
    400 Solicitação Incorreta. Um tipo de solicitação incorreto ou uma solicitação malformada foi detectada.
    401 Não autorizado. As credenciais do usuário estão incorretas ou não têm a função app_service_admin.
    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 Descreve um erro encontrado.

    Tipo de dados: Objeto

    "error": {
      "details": "String",
      "message": "String"
    }
    error.details Informações adicionais sobre o erro.

    Tipo de dados: Cadeia de caracteres

    mensagem.erro Mensagem descrevendo o erro.

    Tipo de dados: Cadeia de caracteres

    número Número exclusivo que identifica o serviço de aplicações. Este número é gerado pelo endpoint.

    Tipo de dados: Cadeia de caracteres

    service_sys_id Sys_id do serviço de aplicações registrado.

    Tipo de dados: Cadeia de caracteres

    Solicitação de curl de amostra

    curl -X POST \
      https://instance.servicenow.com/api/now/cmdb/csdm/app_service/register_service \
      -H 'Accept: application/json' \
      -H 'Content-Type: application/json' \
      -u 'username':'password'
      -d '{
      "basic_details": {
        "environment": "Test Lab 2",
        "name": "Test Lab 2",
        "version": "1.1.1"
      },
      "relationships": {
        "business_app":["f07c7620db54101037740f95ca96199a"],
        "business_service_offering":["069c7e20db54101037740f95ca9619bf"]
      }
    }'
    {
      "result": {
        "service_sys_id": "80f21bbadbd410103d3a93c3e296199a",
        "number": "SNSVC0001018"    
      }
    }

    Serviço de aplicações - PUT /now/cmdb/csdm/app_service/

    Preenche o serviço de aplicações especificado com um conjunto especificado de itens de configuração (IC) downstream.

    Antes de chamar este endpoint, você deve chamar o. POST /now/cmdb/csdm/app_service/register_service endpoint para criar o serviço de aplicações.
    Nota:
    Este endpoint foi descontinuado, use SG Services – POST /sg_services/app_service/populeem vez disso.

    Formato de URL

    URL padrão: /api/now/cmdb/csdm/app_service/

    Parâmetros de solicitação compatíveis

    Tabela 25. Parâmetros de caminho
    Nome Descrição
    service_sys_id Sys_id do serviço de aplicações a ser preenchido com os ICs especificados.

    Tipo de dados: Cadeia de caracteres

    Tabela: Instância de serviço [cmdb_ci_service_auto]

    Tabela 26. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 27. Parâmetros do corpo da solicitação (XML ou JSON)
    Nome Descrição
    population_method ICs a serem associados ao serviço de aplicações especificado. Os elementos no population_methodo objeto depende do tipo de informação que está sendo preenchido, que é definido pelo typeparâmetro.

    Tipo de dados: Objeto

    Para typecmdb_group_based

    "population_method": {
      "group_id": "String",
      "type": "String"
    }
    Para typedescoberta
    Nota:
    Para usar este tipo, você deve ativar o plug-in Mapeamento de serviços (com.snc.service-mapping).
    "population_method": {
      "attributes": [Array],
      "entry_point_id": "String",
      "type": "String"
    }
    Para typetag_list
    Nota:
    Para usar este tipo, você deve ativar o plug-in Mapeamento de serviços (com.snc.service-mapping).
    "population_method": {
      "tags": [Array],
      "type": "String"
    }
    population_method.attributes Lista de atributos a serem associados ao IC, como host, porta, nome e URL.
    Nota:
    Você deve passar todos os atributos obrigatórios.

    Tipo de dados: Matriz

    "attributes": {
      "name":"String",
      "value":"String"
    }
    population_method.attributes.name Nome do atributo, como host, porta, nome e URL.

    Tipo de dados: Cadeia de caracteres

    population_method.attributes.value Valor do atributo.

    Tipo de dados: Cadeia de caracteres

    ponto_de_entrada.population_method.entry_point Necessário se population_method.typedescoberta. Ponto de entrada no serviço de aplicações. Para obter informações adicionais sobre pontos de entrada, consulte Atributos do ponto de entrada e. Crie tipos de ponto de entrada para o Mapeamento de serviços .

    Tipo de dados: Cadeia de caracteres

    population_method.group_id Necessário se population_method.typecmdb_group_based. Sys_id do grupo a ser associado ao IC.

    Tipo de dados: Cadeia de caracteres

    Grupo do cmdb [cmdb_group]

    population_method.tags Lista de marcadores a serem associados ao IC.

    Tipo de dados: Matriz de objetos

    [
      "tags": {
        "tag": "String",
        "value": "String"
      }
    ]

    Título: Valores de chave [cmdb_key_value]

    population_method.tags.tag Nome do marcador.

    Tipo de dados: Cadeia de caracteres

    population_method.tags.value Valor do marcador.

    Tipo de dados: Cadeia de caracteres

    population_method.type Necessário. Tipo de IC a ser preenchido.
    Valores válidos:
    • cmdb_group_based
    • descoberta
    • tag_list

    Tipo de dados: Cadeia de caracteres

    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 da REST API compatíveis .

    Tabela 28. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. Suporta somente application/json.
    Tipo de conteúdo Formato de dados do corpo da solicitação. Suporta somente 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 possíveis códigos de status usados na REST API, consulte REST API códigos de resposta HTTP .

    Tabela 30. Códigos de status
    Código de status Descrição
    200 Bem-sucedido. A solicitação foi processada com sucesso.
    401 Não autorizado. As credenciais do usuário estão incorretas ou não têm a função app_service_admin.
    500 Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação.

    Parâmetros do corpo da resposta (JSON ou XML)

    Nome Descrição
    erro Descreve um erro encontrado.

    Tipo de dados: Objeto

    "error": {
      "details": "String",
      "message": "String"
    }
    error.details Informações adicionais sobre o erro.

    Tipo de dados: Cadeia de caracteres

    mensagem.erro Mensagem descrevendo o erro.

    Tipo de dados: Cadeia de caracteres

    Solicitação de curl de amostra

    O exemplo de código a seguir mostra como preencher um serviço de aplicações quando o tipo de IC é cmdb_group_based.

    curl -X PUT \
      https://instance.servicenow.com/api/now/cmdb/csdm/app_service/f809cb60db94101037740f95ca96190f/populate_service \
      -H 'Accept: application/json' \
      -H 'Content-Type: application/json' \
      -u 'username':'password' \
      -d '{
      "population_method": {
        "type":"cmdb_group_based",
        "group_id": "e809cf60db94101037640f95ca961932"
      }
    }'
    {
        "result": {}
    }

    O exemplo de código a seguir mostra como preencher um serviço de aplicação de descoberta.

    curl -X PUT \
      https://instance.servicenow.com/api/now/cmdb/csdm/app_service/f809cb60db94101037740f95ca96190f/populate_service \
      -H 'Accept: application/json' \
      -H 'Content-Type: application/json' \
      -u 'username':'password' \
      -d '{
      "population_method": {
        "type":"discovery",
        "entry_point_id":"cmdb_ci_endpoint_ad_forest",
        "attributes": [
          {
            "name":"host",
            "value":"test1.com"
          },
          {
            "name":"port",
            "value":"500"
          },
          {
            "name":"protocol",
            "value":"ssh"
          }
        ]
      }
    }'
    {
        "result": {}
    }

    Serviço de aplicações - COLOQUE /now/cmdb/csdm/app_service/

    Atualiza o serviço de aplicações especificado com as informações básicas passadas.

    Ele também valida a exclusividade do serviço de aplicações verificando as informações passadas em relação às regras do mecanismo de identificação e reconciliação (IRE) definidas na classe de serviço de aplicações.
    Nota:
    Este endpoint foi descontinuado, use SG Services – PUBLICAR /sg_services/app_service/updateem vez disso.

    Formato de URL

    URL padrão: /api/now/cmdb/csdm/app_service/

    Parâmetros de solicitação compatíveis

    Tabela 31. Parâmetros de caminho
    Nome Descrição
    service_sys_id SYS_id do serviço de aplicações a ser atualizado.

    Tipo de dados: Cadeia de caracteres

    Tabela: Instância de serviço [cmdb_ci_service_auto]

    Tabela 32. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 33. Parâmetros do corpo da solicitação (XML ou JSON)
    Nome Descrição
    basic_details Detalhes do serviço associado ao serviço de aplicações especificado.

    Tipo de dados: Objeto

    "basic_details": {
      "environment": "String",
      "name": "String"
    }
    basic_details.environment Ambiente no qual o serviço de aplicações é implantado, como "Produção" ou "Laboratório de testes 2". Este pode ser qualquer valor que faça sentido para o implementador.

    Tipo de dados: Cadeia de caracteres

    Comprimento máximo: 40

    Padrão: Nulo

    basic_details.name Necessário. Nome do serviço de aplicações. Deve ser um nome exclusivo de todos os outros serviços de aplicações.

    Tipo de dados: Cadeia de caracteres

    Comprimento máximo: 255

    relacionamentos Tipos de serviço a serem associados ao serviço de aplicações. Localizado na tabela Relacionamentos de IC [cmdb_rel_ci].

    Tipo de dados: Objeto

    "relationships": {
      "business_app": [Array],
      "business_service_offering": [Array],
      "technical_service_offering": [Array]
    }
    relationships.business_app Lista de sys_ids das aplicações de negócios a serem relacionadas ao serviço de aplicações.

    Tipo de dados: Matriz

    business_service_offering.business_service_offering Lista de sys_ids das ofertas de serviço de negócio a serem relacionadas ao serviço de aplicações.

    Tipo de dados: Matriz

    relationships.technical_service_offering Lista de sys_ids das ofertas de serviço técnico a serem relacionadas ao serviço de aplicações.

    Tipo de dados: Matriz

    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 da REST API compatíveis .

    Tabela 34. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. Suporta somente application/json.
    Tipo de conteúdo Formato de dados do corpo da solicitação. Suporta somente 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 possíveis códigos de status usados na REST API, consulte REST API códigos de resposta HTTP .

    Tabela 36. Códigos de status
    Código de status Descrição
    200 Bem-sucedido. A solicitação foi processada com sucesso.
    401 Não autorizado. As credenciais do usuário estão incorretas ou não têm a função app_service_admin.

    Parâmetros do corpo da resposta (JSON ou XML)

    Nome Descrição
    erro Descreve um erro encontrado.

    Tipo de dados: Objeto

    "error": {
      "details": "String",
      "message": "String"
    }
    error.details Informações adicionais sobre o erro.

    Tipo de dados: Cadeia de caracteres

    mensagem.erro Mensagem descrevendo o erro.

    Tipo de dados: Cadeia de caracteres

    Solicitação de curl de amostra

    curl -X PUT \
      https://instance.servicenow.com/api/now/cmdb/csdm/app_service/f809cb60db94101037740f95ca96190f/service_details \
      -H 'Accept: application/json' \
      -H 'Content-Type: application/json' \
      -u 'username':'password' \
      -d '{
      "basic_details": {
        "environment": "Test Lab 2"
      },  "relationships": {
        "business_app" :["f07c7620db54101037740f95ca96199a"]
      }
    }'
    {
        "result": {}
    }