--- sourceDocument: Referência de API do Xanadu sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/pt-BR/xanadu/api-reference Release : - xanadu ft:locale : - pt-BR ft:publication_title : - Referência de API do Xanadu ft:clusterId : - crapiref bundleId : - crapiref workflow : - Creator --- # API de serviço de aplicativos # API de serviço de aplicativos {#ariaid-title1} * Versão de lançamento: Xanadu * * Atualizado 1 de ago. de 2024 * * ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 19 min. de leitura A API de serviço de aplicações 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 de serviço de aplicações \[app_service_admin\]. Importante: A partir da versão Rome, a API de serviço de aplicações não é mais aprimorada ou compatível. Para obter detalhes, consulte o artigo [Deprecation Process (Processo de descontinuação) \[KB0867184\]](https://support.servicenow.com/kb_view.do?sysparm_article=KB0867184) na Base de conhecimento do Now Support. ## Serviço de aplicações - GET /now/cmdb/app_service/{sys_id}/getContent {#ariaid-title2} Recupera uma lista de itens de configuração (IC) em um serviço de aplicativos mapeado e os relacionamentos entre eles. Recupera somente o conteúdo de serviços que foram criados manualmente. ### Formato da URL {#appservice-GET-getContent__section_lwf_psn_wlb} URL padrão: /api/now/cmdb/app_service/{sys_id}/getContent ### Parâmetros de solicitação compatíveis {#appservice-GET-getContent__entry__2} | Nome | Descrição | |-|-| | sys_id | Sys_id do serviço de aplicações mapeado. Localizado na tabela Serviço de aplicações mapeadas \[cmdb_ci_service_discovered\]. Tipo de dados: cadeia de caracteres | [Tabela 1. Parâmetros de caminho] {#appservice-GET-getContent__entry__6} | Nome | Descrição | |-|-| | Modo | Quantidade de dados de relacionamento a serem retornados. Valores válidos: * Raso: retorna relacionamentos primários e secundários entre ICs em um serviço. * Completo: retorna atributos de IC e informações de pesquisa, além dos dados retornados no modo superficial. {#appservice-GET-getContent__ul_mcl_cl4_ndb} Os valores não fazem distinção entre maiúsculas e minúsculas. Tipo de dados: cadeia de caracteres | [Tabela 2. Parâmetros de consulta] {#appservice-GET-getContent__entry__10} | Nome | Descrição | |-|-| | Nenhum(a) | | [Tabela 3. Parâmetros do corpo da solicitação (XML ou JSON)] ### 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](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#appservice-GET-getContent__entry__14}{#appservice-GET-getContent__accept-RESTAPI} | 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 4. Cabeçalhos da solicitação] {#appservice-GET-getContent__entry__18} | Cabeçalho | Descrição | |-|-| | Nenhum(a) | | [Tabela 5. Cabeçalhos de resposta] ### 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](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#appservice-GET-getContent__entry__22}{#appservice-GET-getContent__entry-200-status-code}{#appservice-GET-getContent__entry-400-status-code}{#appservice-GET-getContent__entry-401-appservice}{#appservice-GET-getContent__entry-500-status-code} | Código de 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. | | 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. | [Tabela 6. Códigos de status] ### Parâmetros do corpo da resposta (JSON ou XML) {#appservice-GET-getContent__table_nyj_nl4_wlb__entry__2} | Nome | Descrição | |-|-| | cmdb | Lista de objetos que descreve os ICs associados ao serviço de aplicativos especificado. Tipo de dados: objeto "cmdb": [ { "items": {Object}, "relations": [Array] } ] | | cmdb.itens | ICs no serviço de aplicativos. Se o parâmetro de consulta completo tiver sido 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.itens.valores | 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.relations | 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 "service": [ { "name": "String", "service_relations": [Array], "url": "String" } ] | | service.name | Nome do serviço de aplicativos. Tipo de dados: cadeia de caracteres | | service.service_relations | Dados de hierarquia para os ICs no serviço de aplicativos. Todos os ICs formam pares com um IC primário e um secundário. O IC de nível superior, conhecido como o ponto de entrada de um serviço de aplicativos, não tem um IC primário. Tipo de dados: matriz "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 | | serviço.url | Caminho relativo para o serviço de aplicativos. Tipo de dados: cadeia de caracteres | [ ] {#appservice-GET-getContent__table_nyj_nl4_wlb} ### Amostra de solicitação cURL 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 - GET /now/cmdb/csdm/app_service/find_service {#ariaid-title3} Retorna informações básicas sobre um serviço de aplicativos especificado e seu contexto de negócios associado. Nota: Este endpoint foi descontinuado, use [Serviços SG -- POST -- /sg_services/app_service/find](https://servicenow-prod.fluidtopics.net/geMQF~s2XnEEhDqFhdCEDg#sg_svcs-POST-find "Encontra os detalhes de um determinado serviço de aplicativos e seus relacionamentos ascendentes."). ### Formato da URL URL padrão: /api/now/cmdb/csdm/app_service/find_service ### Parâmetros de solicitação compatíveis {#appservice-GET-find_service__entry__2} | Nome | Descrição | |-|-| | Nenhum(a) | | [Tabela 7. Parâmetros de caminho] {#appservice-GET-find_service__entry__6} | Nome | Descrição | |-|-| | nome | Obrigatório, se number não for passado. Nome do serviço para o qual as informações serão retornadas. Localizado na tabela Serviço de aplicações \[cmdb_ci_service_auto\]. Tipo de dados: cadeia de caracteres | | número | Obrigatório, se name não for passado. Número exclusivo que identifica o serviço de aplicativos para o qual as informações serão retornadas. Localizado na tabela Serviço de aplicações \[cmdb_ci_service_auto\]. Tipo de dados: cadeia de caracteres | [Tabela 8. Parâmetros de consulta] {#appservice-GET-find_service__entry__12} | Nome | Descrição | |-|-| | Nenhum(a) | | [Tabela 9. Parâmetros do corpo da solicitação (XML ou JSON)] ### 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](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#appservice-GET-find_service__entry__16}{#appservice-GET-find_service__accept-JSON-only-entry-RESTAPI} | Cabeçalho | Descrição | |-|-| | Aceitar | Formato de dados do corpo da resposta. Oferece suporte somente a application/json. | [Tabela 10. Cabeçalhos da solicitação] {#appservice-GET-find_service__entry__20} | Cabeçalho | Descrição | |-|-| | Nenhum(a) | | [Tabela 11. Cabeçalhos de resposta] ### 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](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#appservice-GET-find_service__table_wwn_rhd_ct__entry__2}{#appservice-GET-find_service__entry-200-status-code}{#appservice-GET-find_service__entry-400-status-code}{#appservice-GET-find_service__entry-401-appservice}{#appservice-GET-find_service__entry-500-status-code} | Código de 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. | | 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. | [Tabela 12. Códigos de status] {#appservice-GET-find_service__table_wwn_rhd_ct} ### Parâmetros do corpo da resposta (JSON ou XML) {#appservice-GET-find_service__entry__34}{#appservice-GET-find_service__entry-error-appservice}{#appservice-GET-find_service__entry-error-details-appservice}{#appservice-GET-find_service__entry-error-message-appservice} | Nome | Descrição | |-|-| | erro | Descreve um erro encontrado. Tipo de dados: objeto "error": { "details": "String", "message": "String" } | | detalhes.erro | 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" } ] | | serviços.ambiente | Ambiente no qual o serviço de aplicações é implantado, como "Produção" ou "Lab de teste 2". Pode ser qualquer valor que faça sentido para o implementador. Tipo de dados: cadeia de caracteres Tamanho máximo: 40 Padrão: nulo | | services.name | Obrigatório. Nome do serviço de aplicativos. Deve ser um nome exclusivo de todos os outros serviços de aplicações. Tipo de dados: cadeia de caracteres Tamanho máximo: 255 | | serviços.número | Número exclusivo que identifica o serviço de aplicativos. Este valor é gerado inicialmente pelo endpoint. Tipo de dados: cadeia de caracteres | | relacionamentos.serviços | Tipos de serviço associados ao serviço de aplicativos. Tipo de dados: objeto "relationships": { "business_app": [Array], "business_service_offering": [Array], "technical_service_offering": [Array] } | | serviços.relacionamentos.aplicativo_de_negócios | Lista de sys_ids das aplicações de negócios relacionadas ao serviço de aplicações. Tipo de dados: matriz | | serviços.relacionamentos.técnico_serviço_oferta | Lista de sys_ids das ofertas de serviço de negócio relacionadas ao serviço de aplicações. Tipo de dados: matriz | | serviços.relacionamentos.negócios_serviço_oferta | Lista de sys_ids das ofertas de serviço técnico relacionadas ao serviço de aplicações. Tipo de dados: matriz | | serviços.sys_id | Sys_id do serviço de aplicações. Tipo de dados: cadeia de caracteres | | serviços.versão | Número da versão do serviço de aplicações. Tipo de dados: cadeia de caracteres Tamanho máximo: 40 Formato: definível pelo usuário Padrão: nulo | [ ] ### Amostra de solicitação cURL 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 {#ariaid-title4} Cria um serviço de aplicativos ou atualiza um serviço de aplicativos existente. ### Formato da URL URL padrão: /api/now/cmdb/app_service/create ### Parâmetros de solicitação compatíveis {#createService-POST-api-now-cmdb-app__entry__2} | Parâmetro | Descrição | |-|-| | Nenhum(a) | | [Tabela 13. Parâmetros] ### 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](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#createService-POST-api-now-cmdb-app__entry__6}{#createService-POST-api-now-cmdb-app__accept-RESTAPI}{#createService-POST-api-now-cmdb-app__content_type-RESTAPI} | 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 14. Cabeçalhos da solicitação] {#createService-POST-api-now-cmdb-app__entry__12} | Cabeçalho | Descrição | |-|-| | Nenhum(a) | | [Tabela 15. Cabeçalhos de resposta] ### 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 de REST API compatíveis](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#createService-POST-api-now-cmdb-app__table_wwn_rhd_ct__entry__2}{#createService-POST-api-now-cmdb-app__entry-200-status-code}{#createService-POST-api-now-cmdb-app__entry-400-status-code}{#createService-POST-api-now-cmdb-app__entry-401-status-code} | Código de 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. | | 401 | Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas. | [Tabela 16. Códigos de status] {#createService-POST-api-now-cmdb-app__table_wwn_rhd_ct} ### 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 mapeadas \[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"` à solicitação JSON. {#createService-POST-api-now-cmdb-app__table_rm1_yjd_kv__entry__2} | Elemento | Descrição | |-|-| | nome | Nome do serviço de aplicativos que você deseja criar ou atualizar. | | relações_de_serviço | 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 aplicativos, não tem um IC primário. | | primário | Sys_id do IC cuja conexão de saída une este IC ao IC no nível inferior na hierarquia do mapa. | | secundário | Sys_id do IC cuja conexão de entrada une este IC ao IC localizado no nível superior na hierarquia do mapa. | [Tabela 17. Elementos aceitos no corpo da solicitação] {#createService-POST-api-now-cmdb-app__table_rm1_yjd_kv} ### Corpo da resposta A API retorna esses elementos JSON no corpo da resposta. {#createService-POST-api-now-cmdb-app__table_mc1_pr1_tx__entry__2} | Elemento | Descrição | |-|-| | URL | URL da REST API de tabela padrão para mostrar o sys_id de um registro de serviço de aplicativos. Este elemento aparecerá somente se o endpoint for bem-sucedido. Tipo de dados: cadeia de caracteres | | getContentUrl | 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 aplicativos. Este elemento aparecerá somente se o endpoint for bem-sucedido. Tipo de dados: cadeia de caracteres | | erro | Detalhes da mensagem de erro. Este elemento aparecerá somente se o endpoint falhar. Tipo de dados: objeto | | mensagem | Mensagem de erro descrevendo a natureza da falha. Este elemento aparecerá somente se o endpoint falhar. Tipo de dados: cadeia de caracteres | | status | Declara "falha" se a REST API falhar. Este elemento aparecerá somente se o endpoint falhar. Tipo de dados: cadeia de caracteres | [Tabela 18. Elementos retornados no corpo da resposta] {#createService-POST-api-now-cmdb-app__table_mc1_pr1_tx} ### Amostra de solicitação cURL curl "http:///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 {#ariaid-title5} Cria um esboço de registro de serviço de aplicativos na tabela Serviço de aplicativos \[cmdb_ci_service_auto\] e o preenche com as informações passadas. Antes de armazenar o registro, ele valida os parâmetros aprovados e a exclusividade do nome do serviço de aplicativos. 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ço de negócios e ofertas de serviço técnico à aplicação de serviço. Ele não cria relacionamentos descendentes com a infraestrutura. Para definir relacionamentos descendentes, você deve chamar o serviço de aplicações - PUT /now/cmdb/csdm/app_service/{service_sys_id}/populate_service endpoint. Nota: Este endpoint foi descontinuado, use [Serviços SG -- POST -- /sg_services/app_service/register](https://servicenow-prod.fluidtopics.net/geMQF~s2XnEEhDqFhdCEDg#sg_svcs-POST-register "Cria um serviço de aplicações, marca e constrói relacionamentos ascendentes, como aplicações de negócios, ofertas de serviço de negócios e outros serviços de aplicações."). ### Formato da URL URL padrão: /api/now/cmdb/csdm/app_service/register_service ### Parâmetros de solicitação compatíveis {#appservice-POST-register_service__entry__2} | Nome | Descrição | |-|-| | Nenhum(a) | | [Tabela 19. Parâmetros de caminho] {#appservice-POST-register_service__entry__6} | Nome | Descrição | |-|-| | Nenhum(a) | | [Tabela 20. Parâmetros de consulta] {#appservice-POST-register_service__entry__10}{#appservice-POST-register_service__entry-basic_details-environment-appservice}{#appservice-POST-register_service__entry-basic_details-name-appservice}{#appservice-POST-register_service__entry-basic_details-version-appservice}{#appservice-POST-register_service__entry-relationships-bus_app-appservice}{#appservice-POST-register_service__entry-relationships-bus_srv_off-appservice}{#appservice-POST-register_service__entry-relationships-tech_srv_off-appservice} | Nome | Descrição | |-|-| | detalhes_básicos | Obrigatório. Detalhes do serviço associado ao serviço de aplicativos especificado. Tipo de dados: objeto "basic_details": { "environment": "String", "name": "String", "version": "String" } | | detalhes_básicos.ambiente | Ambiente no qual o serviço de aplicações é implantado, como "Produção" ou "Lab de teste 2". Pode ser qualquer valor que faça sentido para o implementador. Tipo de dados: cadeia de caracteres Tamanho máximo: 40 Padrão: nulo | | basic_details.name | Obrigatório. Nome do serviço de aplicativos. Deve ser um nome exclusivo de todos os outros serviços de aplicações. Tipo de dados: cadeia de caracteres Tamanho máximo: 255 | | basic_details.version | Número da versão do serviço de aplicações. Tipo de dados: cadeia de caracteres Tamanho 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 aplicativos. Esses relacionamentos são armazenados na tabela Relacionamentos de IC \[cmdb_rel_ci\]. Tipo de dados: objeto "relationships": { "business_app": [Array], "business_service_offering": [Array], "technical_service_offering": [Array] } | | relacionamentos.app_de_negócios | Lista de sys_ids das aplicações de negócios a serem relacionadas ao serviço de aplicações. Tipo de dados: matriz | | relacionamentos.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 | | relacionamentos.technical_service_offering | Lista de sys_ids das ofertas de serviço técnico a serem relacionadas ao serviço de aplicativos. Tipo de dados: matriz | [Tabela 21. Parâmetros do corpo da solicitação] ### 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](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#appservice-POST-register_service__table_hxm_cks_mlb__entry__2}{#appservice-POST-register_service__accept-JSON-only-entry-RESTAPI}{#appservice-POST-register_service__content_type-JSON-only-entry-RESTAPI} | Cabeçalho | Descrição | |-|-| | Aceitar | Formato de dados do corpo da resposta. Oferece suporte somente a application/json. | | Tipo de conteúdo | Formato de dados do corpo da solicitação. Oferece suporte somente a application/json. | [Tabela 22. Cabeçalhos da solicitação] {#appservice-POST-register_service__table_hxm_cks_mlb} {#appservice-POST-register_service__entry__34} | Cabeçalho | Descrição | |-|-| | Nenhum(a) | | [Tabela 23. Cabeçalhos de resposta] ### 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](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#appservice-POST-register_service__table_wwn_rhd_ct__entry__2}{#appservice-POST-register_service__entry-400-status-code}{#appservice-POST-register_service__entry-401-appservice}{#appservice-POST-register_service__entry-500-status-code} | Código de status | Descrição | |-|-| | 201 | Bem-sucedido. O serviço de aplicações foi registrado com sucesso. | | 400 | Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada. | | 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. | [Tabela 24. Códigos de status] {#appservice-POST-register_service__table_wwn_rhd_ct} ### Parâmetros do corpo da resposta (JSON ou XML) {#appservice-POST-register_service__entry__48}{#appservice-POST-register_service__entry-error-appservice}{#appservice-POST-register_service__entry-error-details-appservice}{#appservice-POST-register_service__entry-error-message-appservice} | Nome | Descrição | |-|-| | erro | Descreve um erro encontrado. Tipo de dados: objeto "error": { "details": "String", "message": "String" } | | detalhes.erro | 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 aplicativos. Este número é gerado pelo endpoint. | | serviço_sys_id | Sys_id do serviço de aplicações registrado. | [ ] ### Amostra de solicitação cURL 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/{service_sys_id}/populate_service {#ariaid-title6} Preenche o serviço de aplicativos especificado com um conjunto especificado de itens de configuração (IC) descendentes. Antes de chamar este endpoint, você deve chamar o endpoint [POST /now/cmdb/csdm/app_service/register_service](https://servicenow-prod.fluidtopics.net/Ey_tiXyBgL6UI_5RFoPpmQ#appservice-POST-register_service "Cria um esboço de registro de serviço de aplicativos na tabela Serviço de aplicativos [cmdb_ci_service_auto] e o preenche com as informações passadas.") para criar o serviço de aplicações. Nota: Este endpoint foi descontinuado, use [Serviços SG -- POST -- /sg_services/app_service/populate](https://servicenow-prod.fluidtopics.net/geMQF~s2XnEEhDqFhdCEDg#sg_svcs-POST-populate "Preenche um serviço de aplicativos com um método de preenchimento de serviço."). ### Formato da URL URL padrão: /api/now/cmdb/csdm/app_service/{service_sys_id}/populate_service ### Parâmetros de solicitação compatíveis {#appservice-PUT-populate_service__entry__2} | Nome | Descrição | |-|-| | serviço_sys_id | Sys_id do serviço de aplicativos a ser preenchido com os ICs especificados. Localizado na tabela Serviço de aplicações \[cmdb_ci_service_auto\]. Tipo de dados: cadeia de caracteres | [Tabela 25. Parâmetros de caminho] {#appservice-PUT-populate_service__entry__6} | Nome | Descrição | |-|-| | Nenhum(a) | | [Tabela 26. Parâmetros de consulta] {#appservice-PUT-populate_service__entry__10} | Nome | Descrição | |-|-| | método_população | ICs a serem associados ao serviço de aplicativos especificado. Os elementos no objeto populate_method dependem do tipo de informação que está sendo preenchida; definido pelo parâmetro type. Tipo de dados: objeto Para type = cmdb_group_based { "population_method": { "group_id": "String", "type": "String" } } Para type = descoberta 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 type = tag_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" } } | | população_metodo.atributos | Lista de atributos a serem associados ao IC, como host, porta, nome e URL. Para obter informações adicionais sobre pontos de entrada, consulte [Atributos de ponto de entrada](https://www.servicenow.com/docs/access?context=r_EntryPointsforBizSvcDef&version=xanadu&pubname=xanadu-it-operations-management&ft:locale=en-US). Nota: Você deve aprovar todos os atributos necessá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 | | população_metodo.atributos.valor | Valor do atributo. Tipo de dados: cadeia de caracteres | | População_method.entry_point | Obrigatório se population_method.type = descoberta. Ponto de entrada para o serviço de aplicativos. Para obter informações adicionais sobre pontos de entrada, consulte [Atributos de ponto](https://www.servicenow.com/docs/access?context=r_EntryPointsforBizSvcDef&version=xanadu&pubname=xanadu-it-operations-management&ft:locale=en-US) de entrada e [Criar tipos de ponto de entrada para Mapeamento de serviços](https://www.servicenow.com/docs/access?context=t_CreateEntryPoint&version=xanadu&pubname=xanadu-it-operations-management&ft:locale=en-US). Tipo de dados: cadeia de caracteres | | População_method.group_id | Obrigatório se population_method.type = cmdb_group_based. Sys_id do grupo a ser associado ao IC. Localizado na tabela Grupo do CMDB \[cmdb_group\]. Tipo de dados: cadeia de caracteres | | população_metodo.marcadores | Lista de marcadores a serem associados ao IC. Essas informações estão localizadas na tabela Valores de chave \[cmdb_key_value}. Tipo de dados: matriz { "tags": { "tag": "String", "value": "String" } } | | população_metodo.marcadores.marcador | Nome do marcador. Tipo de dados: cadeia de caracteres | | população_metodo.marcadores.valor | Valor do marcador. Tipo de dados: cadeia de caracteres | | População_method.type | Obrigatório. Tipo de IC a ser preenchido. Valores válidos: * cmdb_group_based * discovery * tag_list {#appservice-PUT-populate_service__ul_j42_5jm_tlb} Tipo de dados: cadeia de caracteres | [Tabela 27. Parâmetros do corpo da solicitação (XML ou JSON)] ### 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](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#appservice-PUT-populate_service__table_h3m_gh2_mlb__entry__2}{#appservice-PUT-populate_service__accept-JSON-only-entry-RESTAPI}{#appservice-PUT-populate_service__content_type-JSON-only-entry-RESTAPI} | Cabeçalho | Descrição | |-|-| | Aceitar | Formato de dados do corpo da resposta. Oferece suporte somente a application/json. | | Tipo de conteúdo | Formato de dados do corpo da solicitação. Oferece suporte somente a application/json. | [Tabela 28. Cabeçalhos da solicitação] {#appservice-PUT-populate_service__table_h3m_gh2_mlb} {#appservice-PUT-populate_service__entry__38} | Cabeçalho | Descrição | |-|-| | Nenhum(a) | | [Tabela 29. Cabeçalhos de resposta] ### 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](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#appservice-PUT-populate_service__entry__42}{#appservice-PUT-populate_service__entry-200-status-code}{#appservice-PUT-populate_service__entry-401-appservice}{#appservice-PUT-populate_service__entry-500-status-code} | 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. | [Tabela 30. Códigos de status] ### Parâmetros do corpo da resposta (JSON ou XML) {#appservice-PUT-populate_service__entry__50}{#appservice-PUT-populate_service__entry-error-appservice}{#appservice-PUT-populate_service__entry-error-details-appservice}{#appservice-PUT-populate_service__entry-error-message-appservice} | Nome | Descrição | |-|-| | erro | Descreve um erro encontrado. Tipo de dados: objeto "error": { "details": "String", "message": "String" } | | detalhes.erro | Informações adicionais sobre o erro. Tipo de dados: cadeia de caracteres | | mensagem.erro | Mensagem descrevendo o erro. Tipo de dados: cadeia de caracteres | [ ] ### Amostra de solicitação cURL O exemplo de código a seguir mostra como preencher um serviço de aplicativos 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ções 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 - PUT /now/cmdb/csdm/app_service/{service_sys_id}/service_details {#ariaid-title7} Atualiza o serviço de aplicativos especificado com as informações básicas passadas. Ele também valida a exclusividade do serviço de aplicativos 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 aplicativos. Nota: Este endpoint foi descontinuado, use [Serviços SG -- POST -- /sg_services/app_service/update](https://servicenow-prod.fluidtopics.net/geMQF~s2XnEEhDqFhdCEDg#sg_svcs-POST-update "Atualiza um serviço de aplicativos existente fornecido e cria marcadores para o serviço de aplicativos fornecido."). ### Formato da URL URL padrão: /api/now/cmdb/csdm/app_service/{service_sys_id}/service_details ### Parâmetros de solicitação compatíveis {#appservice-PUT-service_details__entry__2} | Nome | Descrição | |-|-| | serviço_sys_id | Sys_id do serviço de aplicações a ser atualizado. Localizado na tabela Serviço de aplicações \[cmdb_ci_service_auto\]. Tipo de dados: cadeia de caracteres | [Tabela 31. Parâmetros de caminho] {#appservice-PUT-service_details__entry__6} | Nome | Descrição | |-|-| | Nenhum(a) | | [Tabela 32. Parâmetros de consulta] {#appservice-PUT-service_details__entry__10}{#appservice-PUT-service_details__entry-basic_details-appservice}{#appservice-PUT-service_details__entry-basic_details-environment-appservice}{#appservice-PUT-service_details__entry-basic_details-name-appservice}{#appservice-PUT-service_details__entry-relationships-appservice}{#appservice-PUT-service_details__entry-relationships-bus_app-appservice}{#appservice-PUT-service_details__entry-relationships-bus_srv_off-appservice}{#appservice-PUT-service_details__entry-relationships-tech_srv_off-appservice} | Nome | Descrição | |-|-| | detalhes_básicos | Detalhes do serviço associado ao serviço de aplicativos especificado. Tipo de dados: objeto "basic_details": { "environment": "String", "name": "String" } | | detalhes_básicos.ambiente | Ambiente no qual o serviço de aplicações é implantado, como "Produção" ou "Lab de teste 2". Pode ser qualquer valor que faça sentido para o implementador. Tipo de dados: cadeia de caracteres Tamanho máximo: 40 Padrão: nulo | | basic_details.name | Obrigatório. Nome do serviço de aplicativos. Deve ser um nome exclusivo de todos os outros serviços de aplicações. Tipo de dados: cadeia de caracteres Tamanho máximo: 255 | | relacionamentos | Tipos de serviço a serem associados ao serviço de aplicativos. 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] } | | relacionamentos.app_de_negócios | Lista de sys_ids das aplicações de negócios a serem relacionadas ao serviço de aplicações. Tipo de dados: matriz | | relacionamentos.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 | | relacionamentos.technical_service_offering | Lista de sys_ids das ofertas de serviço técnico a serem relacionadas ao serviço de aplicativos. Tipo de dados: matriz | [Tabela 33. Parâmetros do corpo da solicitação (XML ou JSON)] ### 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](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#appservice-PUT-service_details__entry__26}{#appservice-PUT-service_details__accept-JSON-only-entry-RESTAPI}{#appservice-PUT-service_details__content_type-JSON-only-entry-RESTAPI} | Cabeçalho | Descrição | |-|-| | Aceitar | Formato de dados do corpo da resposta. Oferece suporte somente a application/json. | | Tipo de conteúdo | Formato de dados do corpo da solicitação. Oferece suporte somente a application/json. | [Tabela 34. Cabeçalhos da solicitação] {#appservice-PUT-service_details__entry__32} | Cabeçalho | Descrição | |-|-| | Nenhum(a) | | [Tabela 35. Cabeçalhos de resposta] ### 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](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles."). {#appservice-PUT-service_details__entry__36}{#appservice-PUT-service_details__entry-200-status-code}{#appservice-PUT-service_details__entry-401-appservice} | 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. | [Tabela 36. Códigos de status] ### Parâmetros do corpo da resposta (JSON ou XML) {#appservice-PUT-service_details__entry__42}{#appservice-PUT-service_details__entry-error-appservice}{#appservice-PUT-service_details__entry-error-details-appservice}{#appservice-PUT-service_details__entry-error-message-appservice} | Nome | Descrição | |-|-| | erro | Descreve um erro encontrado. Tipo de dados: objeto "error": { "details": "String", "message": "String" } | | detalhes.erro | Informações adicionais sobre o erro. Tipo de dados: cadeia de caracteres | | mensagem.erro | Mensagem descrevendo o erro. Tipo de dados: cadeia de caracteres | [ ] ### Amostra de solicitação cURL 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": {} }