API de serviços do SG

  • Versão de lançamento: Washingtondc
  • Atualizado 1 de fev. de 2024
  • 31 min. de leitura

    • A API SG Services fornece endpoints para criar e gerenciar serviços de aplicações e os relacionamentos ascendentes entre eles.

    Solicitar aplicativos na Store

    Acesse o site ServiceNow Store para ver todos os aplicativos disponíveis e obter informações sobre como enviar solicitações para a loja. Para obter informações sobre notas de versão cumulativas para todos os aplicativos lançados, consulte as notas de versão da ServiceNow Store.

    Esta API só pode ser usada quando a API da aplicação do CMDB e o plug-in da CLI (sn_service_graph) estão ativados. Esta API é usada no namespace sn_service_graph.

    O uso desta API não requer detalhes sobre tabelas de origem ou tipos de relacionamento.

    Para criar scripts de operações críticas que oferecem suporte à automação em toda a empresa, você pode aproveitar APIs ou executar operações de linha de comando fornecidas pela CLI da aplicação do CMDB e pela aplicação da loja de APIs em vez de usar a interface do usuário. A CLI da aplicação do CMDB e a aplicação da loja de API fornecem uma estrutura robusta que consolida todas as APIs relacionadas aos serviços de aplicações e as linhas de comando que permitem acessar a interface dessas APIs.

    Os comandos de API e CLI da aplicação do CMDB permitem as seguintes tarefas:
    • Registrar e criar um serviço de aplicativos e estabelecer relacionamentos ascendentes
    • Obter detalhes de um determinado serviço de aplicações e seus relacionamentos ascendentes
    • Conectar construções de nível superior, como aplicações de negócios e ofertas de serviço de negócios
    • Preenchendo um serviço de aplicativos com um determinado tipo de preenchimento
    • Alterando o estado de um serviço de aplicativos

    Para obter a solução de linha de comando, consulte CLI da aplicação do CMDB e comandos disponíveis da API.

    SG Services – POST – /sg_services/app_service/convert

    Converte um serviço de aplicativos do tipo manual ou vazio em um serviço de aplicativos calculado. Durante a conversão, o registro do serviço de aplicativos é movido para a tabela [cmdb_ci_service_calculated] com a classe recém-atribuída.

    As seguintes propriedades para identificar um IC têm precedência da seguinte forma:
    1. sys_id – se for sys_id, o sistema usará somente o sys_id e ignorará quaisquer valores adicionais.
    2. número: se fornecido sem o sys_id, o sistema usará somente o número e ignorará quaisquer valores adicionais.
    3. <IRE field name>– O sistema usará esses valores somente se o sys_id ou o número não forem fornecidos.

    Formato de URL

    URL com controle de versões: /api/sn_service_graph/{api_version}/sg_services/app_service/convert

    URL padrão: /api/sn_service_graph/sg_services/app_service/convert

    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. Especifique este valor somente para usar uma versão de endpoint diferente da mais recente.

    Tipo de dados: cadeia de caracteres
    Tabela 2. Parâmetros de consulta
    Nome Descrição
    Nenhum
    Tabela 3. Parâmetros do corpo da solicitação (JSON)
    Nome Descrição
    <IRE field name> Um ou mais campos IRE que identificam o serviço de aplicativos. Por exemplo, nome ou versão.

    Tipo de dados: cadeia de caracteres
    níveis Número de níveis a serem incluídos na conversão.

    Tipo de dados: cadeia de caracteres
    número Número exclusivo que identifica o serviço de aplicativos.

    Tipo de dados: cadeia de caracteres
    sys_id Sys_id do serviço de aplicativos listado na tabela Serviço de aplicativos [cmdb_ci_service_auto].

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

    Tabela 4. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. Oferece suporte somente a application/json.
    Tabela 5. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum

    Códigos de status

    Os códigos de status a seguir 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 da REST API.

    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. 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 o usuário não tem 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)

    Nome Descrição
    status Indica sucesso ou falha.

    Tipo de dados: cadeia de caracteres

    Solicitação de cURL

    O exemplo a seguir mostra como converter um tipo de serviço de aplicativos.

    curl "https://instance.service-now.com/api/sn_service_graph/sg_services/app_service/convert" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
 \"name\": \"Test Register\",
 \"environment\": \"Test\",
 \"version\": \"1.0\",
 \"levels\" : 8
}" \
--user 'username':'password'

    Resultados que indicam uma conversão bem-sucedida para um serviço de aplicativos calculado.

    {
  "result": {
  "status": "success"
  }
}

    SG Services – POST – /sg_services/app_service/delete

    Exclui um serviço de aplicativos.

    As seguintes propriedades para identificar um IC têm precedência da seguinte forma:
    1. sys_id – se for sys_id, o sistema usará somente o sys_id e ignorará quaisquer valores adicionais.
    2. número: se fornecido sem o sys_id, o sistema usará somente o número e ignorará quaisquer valores adicionais.
    3. <IRE field name>– O sistema usará esses valores somente se o sys_id ou o número não forem fornecidos.

    Formato de URL

    URL com controle de versões: /api/sn_service_graph/{api_version}/sg_services/app_service/delete

    URL padrão: /api/sn_service_graph/sg_services/app_service/delete

    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. Especifique este valor somente 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
    Nenhum
    Tabela 9. Parâmetros do corpo da solicitação (JSON)
    Nome Descrição
    <IRE field name> Um ou mais campos IRE que identificam o serviço de aplicativos. Por exemplo, nome ou versão.

    Tipo de dados: cadeia de caracteres
    número Número exclusivo que identifica o serviço de aplicativos.

    Tipo de dados: cadeia de caracteres
    sys_id Sys_id do serviço de aplicativos listado na tabela Serviço de aplicativos [cmdb_ci_service_auto].

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

    Tabela 10. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. Oferece suporte somente a application/json.
    Tabela 11. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum

    Códigos de status

    Os códigos de status a seguir 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 da REST API.

    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. 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 o usuário não tem 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)

    Nome Descrição
    status Indica sucesso ou falha.

    Tipo de dados: cadeia de caracteres

    Solicitação de cURL

    O exemplo a seguir mostra como excluir um serviço de aplicativos.

    curl "https://instance.service-now.com/api/sn_service_graph/sg_services/app_service/delete" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
   \"name\": \"Test Register\",
   \"environment\": \"Test\",
   \"version\": \"1.0\"
}" \
--user 'username':'password'

    Resultados que indicam uma remoção bem-sucedida de um serviço de aplicativos.

    {
  "result": {
  "status": "success"
  }
}

    SG Services – POST – /sg_services/app_service/find

    Encontra os detalhes de um determinado serviço de aplicativos e seus relacionamentos ascendentes.

    Usuários com a função app_service_user podem usar essa API, mas os resultados são restritos a serviços de aplicações no status Operacional. A função app_service_admin fornece exibição ilimitada de serviços de aplicações.

    As seguintes propriedades para identificar um IC têm precedência da seguinte forma:
    1. sys_id – se for sys_id, o sistema usará somente o sys_id e ignorará quaisquer valores adicionais.
    2. número: se fornecido sem o sys_id, o sistema usará somente o número e ignorará quaisquer valores adicionais.
    3. <IRE field name>– O sistema usará esses valores somente se o sys_id ou o número não forem fornecidos.

    Formato de URL

    URL com controle de versões: /api/sn_service_graph/{api_version}/sg_services/app_service/find

    URL padrão: /api/sn_service_graph/sg_services/app_service/find

    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. Especifique este valor somente para usar uma versão de endpoint diferente da mais recente.

    Tipo de dados: cadeia de caracteres
    Tabela 14. Parâmetros de consulta
    Nome Descrição
    Nenhum
    Tabela 15. Parâmetros do corpo da solicitação (JSON)
    Nome Descrição
    <IRE fields> Um ou mais campos IRE que identificam o serviço de aplicativos. Por exemplo, nome ou versão.

    Tipo de dados: cadeia de caracteres
    número Número exclusivo que identifica o serviço de aplicativos.

    Tipo de dados: cadeia de caracteres
    sys_id Sys_id do serviço de aplicativos listado na tabela Serviço de aplicativos [cmdb_ci_service_auto].

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

    Tabela 16. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. Oferece suporte somente a application/json.
    Tabela 17. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum

    Códigos de status

    Os códigos de status a seguir 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 da REST API.

    Tabela 18. Códigos de status
    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 o usuário não tem 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)

    Nome Descrição
    <IRE field name> Um ou mais campos IRE que identificam o serviço de aplicativos. Por exemplo, nome ou versão.

    Tipo de dados: cadeia de caracteres
    número Número exclusivo que identifica o serviço de aplicativos.

    Tipo de dados: cadeia de caracteres
    operational_status Status operacional do serviço de aplicativos. Por exemplo, ativo.

    Tipo de dados: cadeia de caracteres
    relacionamentos Lista de objetos que definem os relacionamentos ascendentes do serviço de aplicativos.

    Tipo de dados: matriz

    "relationships": [
 {
    "name": "String",
    "number": "String",
    "sys_id": "String",
    "class_name": "String",
    "relationship": "String"
 }
]
    relacionamentos.class_name Nome da classe que contém o serviço de aplicativos.

    Tipo de dados: cadeia de caracteres
    relationships.name Nome do relacionamento.

    Tipo de dados: cadeia de caracteres
    relacionamentos.número Número exclusivo do relacionamento.

    Tipo de dados: cadeia de caracteres
    relacionamentos.relacionamento A regra de relacionamento.

    Tipo de dados: cadeia de caracteres
    relacionamentos.sys_id Sys_id do relacionamento.

    Tipo de dados: cadeia de caracteres
    sys_id Sys_id do serviço de aplicativos listado na tabela Serviço de aplicativos [cmdb_ci_service_auto].

    Tipo de dados: cadeia de caracteres

    Solicitação de cURL

    O exemplo a seguir mostra como encontrar detalhes de um serviço de aplicativos.

    curl "https://instance.service-now.com/api/sn_service_graph/sg_services/app_service/find" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
   \"name\": \"Test App Service1\"
 }" \
--user 'username':'password'

    O corpo da resposta inclui o serviço de aplicativos e as informações de relacionamento.

    {
  "result": {
    "aliases": null,
    "asset": null,
    "asset_tag": null,
    "assigned": "",
    "assigned_to": null,
    "assignment_group": null,
    "attestation_score": null,
    "attested": "0",
    "attested_by": null,
    "attested_date": "",
    "attributes": null,
    "bucket": null,
    "business_contact": null,
    "business_need": null,
    "business_relation_manager": null,
    "business_unit": null,
    "busines_criticality": "4 - not critical",
    "can_print": "0",
    "category": null,
    "change_control": null,
    "checked_in": "",
    "checked_out": "",
    "checkout": null,
    "comments": null,
    "company": null,
    "compatibility_dependencies": null,
    "consumer_type": "internal",
    "correlation_id": null,
    "cost": null,
    "cost_cc": "USD",
    "cost_center": null,
    "delivery_date": "",
    "delivery_manager": null,
    "department": null,
    "discovery_source": "Manual Entry",
    "dns_domain": null,
    "due": "",
    "due_in": null,
    "duplicate_of": null,
    "end_date": "",
    "environment": null,
    "fault_count": "0",
    "first_discovered": "2021-07-19 20:09:48",
    "fqdn": null,
    "gl_account": null,
    "hide_from_dashboard": "0",
    "install_date": "",
    "install_status": "1",
    "invoice_number": null,
    "ip_address": null,
    "justification": null,
    "last_discovered": "2021-07-19 20:09:48",
    "last_review_date": "",
    "layer": null,
    "lease_id": null,
    "life_cycle_stage": null,
    "life_cycle_stage_status": null,
    "location": null,
    "mac_address": null,
    "maintenance_schedule": null,
    "managed_by": null,
    "managed_by_group": null,
    "manufacturer": null,
    "model_id": null,
    "model_number": null,
    "monitor": "0",
    "monitoring_requirements": null,
    "name": "Test App Service1",
    "number": "SNSVC0001014",
    "operational_status": "2",
    "order_date": "",
    "owned_by": null,
    "parent": null,
    "portfolio_status": "pipeline",
    "po_number": null,
    "prerequisites": null,
    "price_model": "per_unit",
    "price_unit": null,
    "published_ref": null,
    "purchase_date": "",
    "schedule": null,
    "serial_number": null,
    "service_classification": "Application Service",
    "service_level_requirement": null,
    "service_owner_delegate": null,
    "service_status": "requirements",
    "severity": null,
    "short_description": null,
    "skip_sync": "0",
    "sla": null,
    "spm_service_portfolio": null,
    "spm_taxonomy_node": null,
    "stakeholders": null,
    "start_date": "",
    "state": null,
    "subcategory": null,
    "supported_by": null,
    "support_group": null,
    "sys_class_name": "cmdb_ci_service_auto",
    "sys_class_path": "/!!/!7/!(",
    "sys_created_by": "admin",
    "sys_created_on": "2021-07-19 20:09:48",
    "sys_domain": "global",
    "sys_domain_path": "/",
    "sys_id": "a2f0618040697410f87713b656474255",
    "sys_mod_count": "0",
    "sys_updated_by": "admin",
    "sys_updated_on": "2021-07-19 20:09:48",
    "unit_description": null,
    "unverified": "0",
    "used_for": "Production",
    "user_group": null,
    "vendor": null,
    "version": null,
    "view_service": "61e1cb757f23220002d31ccebefa9120",
    "warranty_expiration": "",
    "relationships": [
      {
        "name": "Test Biz App1",
        "sys_id": "0250a94040697410f87713b656474250",
        "number": "APM0001001",
        "class_name": "cmdb_ci_business_app",
        "relationship": "Consumes::Consumed by"
      },
      {
        "name": "Tech Service Offering1",
        "sys_id": "98d0ed4040697410f87713b6564742ef",
        "number": "BSN0001005",
        "class_name": "service_offering",
        "relationship": "Contains::Contained by"
      }
    ]
  }
}

    SG Services – POST – /sg_services/app_service/populate

    Preenche um serviço de aplicativos com um método de preenchimento de serviço.

    As seguintes propriedades para identificar um IC têm precedência da seguinte forma:
    1. sys_id – se for sys_id, o sistema usará somente o sys_id e ignorará quaisquer valores adicionais.
    2. número: se fornecido sem o sys_id, o sistema usará somente o número e ignorará quaisquer valores adicionais.
    3. <IRE field name>– O sistema usará esses valores somente se o sys_id ou o número não forem fornecidos.

    Formato de URL

    URL com controle de versões: /api/sn_service_graph/{api_version}/sg_services/app_service/populate

    URL padrão: /api/sn_service_graph/sg_services/app_service/populate

    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. Especifique este valor somente para usar uma versão de endpoint diferente da mais recente.

    Tipo de dados: cadeia de caracteres
    Tabela 20. Parâmetros de consulta
    Nome Descrição
    Nenhum
    Tabela 21. Parâmetros do corpo da solicitação (JSON)
    Nome Descrição
    <IRE field name> Um ou mais campos IRE que identificam o serviço de aplicativos. Por exemplo, nome ou versão.

    Tipo de dados: cadeia de caracteres
    número Número exclusivo que identifica o serviço de aplicativos.

    Tipo de dados: cadeia de caracteres
    População_método Obrigatório. Identifica o método de preenchimento e a propriedade que o acompanha para identificar o conteúdo para preenchimento.

    Somente um objeto de acompanhamento é válido por tipo.

    Tipo de dados: objeto
    População_metodo.id_do_grupo ID do grupo do CMDB configurado com o tipo de preenchimento cmdb_group.

    Tipo de dados: "Cadeia de caracteres"

    "population_method": {
  "group_id": "String",
  "type": "cmdb_group"
}

    Tipo de população associado: cmdb_group
    população_método.níveis Número de níveis a serem usados na criação do serviço. Se o valor do nível não for fornecido, o sistema verificará o valor em sys_property. Se svc.manual.convert.levels.default_value não estiver preenchido, um valor padrão de 3 será usado.

    Tipo de dados: número

    "population_method": {
  "levels": Number,
  "type": "dynamic_service"
}

    Tipo de população associado: Dynamic_service

    Padrão: 3 se nenhum valor de nível estiver definido para sys_property
    população_método.serviço_candidato

    Identificador exclusivo do candidato ao serviço.

    Tipo de dados: cadeia de caracteres

    "population_method": {
  "service_candidate": "String",
  "type": "tag_based_service_family"
}

    Tipo de população associado: tag_based_service_family
    população_método.relação_serviço Lista de objetos que contêm dados de hierarquia para os ICs no serviço de aplicativos. 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 aplicativos, não tem um IC primário.

    Tipo de dados: matriz

    "population_method": {

  "service_relations":[
     {
      "child": "String",
      "parent": "String"
     }
  ],

  "type": "service_hierarchy"   
}

    Tipo de população associado: service_hierarchy
    população_método.relação_serviço.secundário Nome de um IC secundário relacionado ao IC.

    Tipo de dados: cadeia de caracteres
    População_método.relacionamento_de_serviço.parente Nome de um IC primário relacionado ao IC.

    Tipo de dados: cadeia de caracteres
    população_método.tags Lista de objetos que contêm marcadores para associar ao IC. Essas informações estão localizadas na tabela Valores de chave [cmdb_key_value}.

    Tipo de dados: matriz

    "population_method": {

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

  "type": "tag_list"  
}

    Tipo de população associado: tag_list
    população_método.tags.tag Nome do marcador.

    Tipo de dados: cadeia de caracteres
    população_método.tags.valor Valor do marcador.

    Tipo de dados: cadeia de caracteres
    População_method.type Obrigatório. Tipo de preenchimento a ser adicionado ao serviço de aplicativos.

    Tipo de dados: objeto

    Valores válidos:
    • cmdb_group
    • service_hierarchy
    • dinâmico_serviço
    • tag_list
    • tag_based_service_family
    sys_id Sys_id do serviço de aplicativos listado na tabela Serviço de aplicativos [cmdb_ci_service_auto].

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

    Tabela 22. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. Oferece suporte somente a application/json.
    Tabela 23. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum

    Códigos de status

    Os códigos de status a seguir 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 da REST API.

    Tabela 24. Códigos de status
    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 o usuário não tem 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)

    Nome Descrição
    status Indica sucesso ou falha.

    Tipo de dados: cadeia de caracteres

    Solicitação de cURL

    O exemplo a seguir mostra como preencher um serviço de aplicativos com um tipo de Dynamic_service.

    curl "https://instance.service-now.com/api/sn_service_graph/sg_services/app_service/populate" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
  \"name\": \"Test Register\",
  \"environment\": \"Test\",
  \"version\": \"1.0\",

 \"population_method\": {
   \"type\": \"dynamic_service\",
   \"levels\" : 8
  }
}" \
--user 'username':'password'

    Resultados que indicam um preenchimento bem-sucedido de um serviço de aplicativos.

    {
  "result": {
  "status": "success"
  }
}

    SG Services – POST – /sg_services/app_service/register

    Cria um serviço de aplicativos, marca-os e constrói relacionamentos ascendentes, como aplicativos de negócios, ofertas de serviço de negócios e outros serviços de aplicativos.

    As seguintes propriedades para identificar um IC têm precedência da seguinte forma:
    1. sys_id – se for sys_id, o sistema usará somente o sys_id e ignorará quaisquer valores adicionais.
    2. número: se fornecido sem o sys_id, o sistema usará somente o número e ignorará quaisquer valores adicionais.
    3. <IRE field name>– O sistema usará esses valores somente se o sys_id ou o número não forem fornecidos.

    Formato de URL

    URL com controle de versões: /api/sn_service_graph/{api_version}/sg_services/app_service/register

    URL padrão: /api/sn_service_graph/sg_services/app_service/register

    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. Especifique este valor somente para usar uma versão de endpoint diferente da mais recente.

    Tipo de dados: cadeia de caracteres
    Tabela 26. Parâmetros de consulta
    Nome Descrição
    Nenhum
    Tabela 27. Parâmetros do corpo da solicitação (JSON)
    Nome Descrição
    <IRE field name> Um ou mais campos IRE que identificam o serviço de aplicativos. Por exemplo, nome ou versão.

    Tipo de dados: cadeia de caracteres
    número Número exclusivo que identifica o serviço de aplicativos.

    Tipo de dados: cadeia de caracteres
    relacionamentos Relacionamentos ascendentes categorizados por tipo.

    Tipo de dados: objeto

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

    O número máximo de relacionamentos é 25.
    relacionamentos.business_app
    Lista de objetos que representam tipos de relacionamento da aplicação de negócios. Esses valores podem ser definidos usando um dos itens a seguir como pares de chave-valor.
    • <IRE field name>
    • número
    • sys_id

    Tipo de dados: matriz
    relacionamentos.business_service_offering
    Lista de objetos que representam tipos de relacionamento de oferta de serviço de negócios. Esses valores podem ser definidos usando os itens a seguir como pares de chave-valor.
    • <IRE field name>
    • número
    • sys_id

    Tipo de dados: matriz
    relacionamentos.parent_app_service
    Lista de objetos que representam tipos de relacionamento de serviço de aplicações. Esses valores podem ser definidos usando os itens a seguir como pares de chave-valor.
    • <IRE field name>
    • número
    • sys_id

    Tipo de dados: matriz
    relacionamentos.technical_service_offering
    Lista de objetos que representam tipos de relacionamento de oferta de serviço técnico. Esses valores podem ser definidos usando os itens a seguir como pares de chave-valor.
    • <IRE field name>
    • número
    • sys_id

    Tipo de dados: matriz
    sys_id Sys_id do serviço de aplicativos listado na tabela Serviço de aplicativos [cmdb_ci_service_auto].

    Tipo de dados: cadeia de caracteres
    marcadores Lista de objetos que contêm definições de marcador como pares de chave-valor.
    "tags": [
 {
  "key": "String",
  "value": "String"
 }]

    Tipo de dados: matriz
    tags.key Nome da categoria do marcador.

    Tipo de dados: cadeia de caracteres
    tags.value Valor do marcador.

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

    Tabela 28. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. Oferece suporte somente a application/json.
    Tabela 29. Cabeçalhos de resposta
    cCabeçalho Descrição
    nenhum

    Códigos de status

    Os códigos de status a seguir 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 da REST API.

    Tabela 30. Códigos de status
    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 o usuário não tem 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)

    cCabeçalho Descrição
    app_service Detalhes do serviço de aplicações.

    Tipo de dados: objeto

    "app_service": {
  "name": "String",
  "number": "String",
  "sys_id": "String"
}
    app_service.name Nome do serviço de aplicativos.

    Tipo de dados: cadeia de caracteres
    app_service.number Número exclusivo que identifica o serviço de aplicativos.

    Tipo de dados: cadeia de caracteres
    app_service.sys_id Sys_id do serviço de aplicativos listado na tabela Serviço de aplicativos [cmdb_ci_service_auto].

    Tipo de dados: cadeia de caracteres
    message Mensagem que descreve o status.
    Valores possíveis:
    • O serviço já existe
    • Serviço registrado com sucesso

    Tipo de dados: cadeia de caracteres
    status Status que indica se o serviço foi registrado.
    Valores possíveis:
    • Inserir: o serviço de aplicativos foi criado com sucesso.
    • Nenhuma ação: o serviço de aplicativos já existe. Nenhuma ação realizada.

    Tipo de dados: cadeia de caracteres

    Solicitação de cURL

    O exemplo a seguir mostra como registrar um serviço de aplicativos.

    curl "instance.service-now.com/api/sn_service_graph/sg_services/app_service/register" \--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
  \"name\": \"Test Register\",
  \"environment\": \"Test\",
  \"version\": \"1.0\",
  \"number\": \" SNSVC0001014\",
  \"relationships\": {
    \"business_application\": [
      {
        \"sys_id\": \"0250a94040697410f87713b656474250\"
      },
      {
        \"number\": \"APM0001002\"
      },
      {
        \"name\": \"Test Biz App1\"
      }
    ],
    \"business_service_offering\": [
      {
        \"sys_id\": \"ed32e98040697410f87713b656474259\"
      }
    ],
    \"technical_service_offering\": [
      {
        \"sys_id\": \"80e12d8040697410f87713b65647421c\"
      },
      {
        \"number\": \"BSN0001005\"
      },
      {
        \"name\": \"Tech Service Offering2\"
      }
    ],
    \"parent_app_service\": [
      {
        \"sys_id\": \"a2f0618040697410f87713b656474255\"
      }
    ]
  },
  \"tags\": [
    {
      \"key\": \"key1\",
      \"value\": \"value1\"
    },
    {
      \"key\": \"key2\",
      \"value\": \"value2\"
    }
  ]
}" \
--user 'username':'password'

    O corpo da resposta inclui informações de ID e status.

    {
  "result": {
    "app_service": {
      "sys_id": "5780cb604061f410f87713b656474271",
      "name": "Test Register",
      "number": " SNSVC0001014"
    },
    "message": "Service registered successfully",
    "status": "INSERT"
  }
}

    SG Services – POST – /sg_services/app_service/relationship/create

    Constrói relações ascendentes, como aplicações de negócios, ofertas de serviço de negócios e outros serviços de aplicações.

    Esta API cria um relacionamento, obtendo entrada com um único objeto primário e um objeto secundário correspondente.

    As seguintes propriedades para identificar um IC têm precedência da seguinte forma:
    1. sys_id – se for sys_id, o sistema usará somente o sys_id e ignorará quaisquer valores adicionais.
    2. número: se fornecido sem o sys_id, o sistema usará somente o número e ignorará quaisquer valores adicionais.
    3. <IRE field name>– O sistema usará esses valores somente se o sys_id ou o número não forem fornecidos.

    Formato de URL

    URL com controle de versões: /api/sn_service_graph/{api_version}/sg_services/app_service/relationship/create

    URL padrão: /api/sn_service_graph/sg_services/app_service/relationship/create

    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. Especifique este valor somente para usar uma versão de endpoint diferente da mais recente.

    Tipo de dados: cadeia de caracteres
    Tabela 32. Parâmetros de consulta
    Nome Descrição
    Nenhum
    Tabela 33. Parâmetros do corpo da solicitação (JSON)
    Nome Descrição
    secundário Informações que identificam o serviço de aplicativos secundário com o qual criar um relacionamento. O secundário está localizado na tabela Serviço de aplicações [cmdb_ci_service_auto].

    Um grupo de ICs dinâmicos pode ser adicionado como secundário, mas não pode ser primário.

    Tipo de dados: objeto

    "child": {
  "<service_app_identifier>": "String"
}
    secundário.<service_app_identifier> Detalhes que identificam o serviço de aplicativos secundário com o qual criar um relacionamento.
    Somente uma opção é necessária. Cada opção é listada por precedência de processamento:
    • sys_id – SYS_ID do serviço de aplicativos secundário.
    • número – Número exclusivo que identifica o serviço de aplicativos secundário.
    • <IRE field name>– Campos IRE que identificam o serviço de aplicativos. Por exemplo, nome ou versão.

    Tipo de dados: cadeia de caracteres
    primário Detalhes que identificam o serviço de aplicativos primário com o qual criar um relacionamento.

    Tipo de dados: objeto

    "parent": {
  "<service_app_identifier>": "String",
  "class_name": "String"
}
    primário.<service_app_identifier> Informações que identificam o serviço de aplicativos.
    Somente uma opção é necessária. Cada opção é listada por precedência de processamento:
    • sys_id – Sys_id do serviço de aplicações listado no serviço de aplicações [cmdb_ci_service_auto].
    • número – Número exclusivo que identifica o serviço de aplicativos.
    • <IRE field name>– Um ou mais campos IRE que identificam o serviço de aplicativos. Por exemplo, nome ou versão.

    Tipo de dados: cadeia de caracteres
    parent.class_name Nome da classe que contém o serviço de aplicativos.
    O nome da classe primária deve ser de uma das seguintes tabelas:
    • cmdb_ci_service_auto
    • cmdb_ci_service_discovered
    • cmdb_ci_service_by_tags
    • cmdb_ci_service_calculated
    • service_offering
    • cmdb_ci_business_app

    Padrão: cmdb_ci_service_auto

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

    Tabela 34. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. Oferece suporte somente a application/json.
    Tabela 35. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum

    Códigos de status

    Os códigos de status a seguir 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 da REST API.

    Tabela 36. Códigos de status
    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 o usuário não tem 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)

    Nome Descrição
    status Indica sucesso ou falha.

    Tipo de dados: cadeia de caracteres

    Solicitação de cURL

    O exemplo a seguir mostra como criar um relacionamento a partir de um serviço de aplicativos.

    curl "https://instance.service-now.com/api/sn_service_graph/sg_services/app_service/relationship/create" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
  \"child\": {
   \"name\": \"wdfsdf\",
   \"environment\": \"Test\",
   \"version\": \"1.0\"
   },
  \"parent\": {
   \"sys_id\": \"abcdefg\",
   \"name\": \"business App1\",
   \"class_name\": \"service_offering\"
  }
}" \
--user 'username':'password'

    Resultados que indicam uma criação bem-sucedida de um relacionamento de serviço de aplicativos.

    {
  "result": {
  "status": "success"
  }
}

    SG Services – POST – /sg_services/app_service/relationship/delete

    Exclui um relacionamento ascendente de serviço de aplicativos.

    As seguintes propriedades para identificar um IC têm precedência da seguinte forma:
    1. sys_id – se for sys_id, o sistema usará somente o sys_id e ignorará quaisquer valores adicionais.
    2. número: se fornecido sem o sys_id, o sistema usará somente o número e ignorará quaisquer valores adicionais.
    3. <IRE field name>– O sistema usará esses valores somente se o sys_id ou o número não forem fornecidos.

    Formato de URL

    URL com controle de versões: /api/sn_service_graph/{api_version}/sg_services/app_service/relationship/delete

    URL padrão: /api/sn_service_graph/sg_services/app_service/relationship/delete

    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. Especifique este valor somente para usar uma versão de endpoint diferente da mais recente.

    Tipo de dados: cadeia de caracteres
    Tabela 38. Parâmetros de consulta
    Nome Descrição
    Nenhum
    Tabela 39. Parâmetros do corpo da solicitação (JSON)
    Nome Descrição
    secundário Informações que descrevem o relacionamento secundário a ser excluído da aplicação de serviço.

    Tipo de dados: objeto

    "child": {
  "<IRE field name>": "String",
  "number": "String",
  "sys_id": "String"
}
    secundário.<IRE field name> Um ou mais campos IRE que identificam o serviço de aplicações secundário. Por exemplo, nome ou versão.

    Tipo de dados: cadeia de caracteres
    secundário.número Número exclusivo que identifica o serviço de aplicativos secundário.

    Tipo de dados: cadeia de caracteres
    secundário.sys_id Sys_id do serviço de aplicações secundário listado no serviço de aplicações [cmdb_ci_service_auto].

    Tipo de dados: cadeia de caracteres
    primário Detalhes que identificam o serviço de aplicativos primário do qual um relacionamento será removido.

    Tipo de dados: objeto

    "parent": {
  "<IRE field name>": "String",
  "number": "String",
  "sys_id": "String",
  "class_name": "String"
}
    primário.<IRE field name> Um ou mais campos IRE que identificam o serviço de aplicativos. Por exemplo, nome ou versão.

    Tipo de dados: cadeia de caracteres
    primário.número Número exclusivo que identifica o serviço de aplicativos.

    Tipo de dados: cadeia de caracteres
    parent.sys_id Sys_id do serviço de aplicativos listado na tabela Serviço de aplicativos [cmdb_ci_service_auto].

    Tipo de dados: cadeia de caracteres
    parent.class_name Nome da classe que contém o serviço de aplicativos.
    O nome da classe primária deve ser de uma das seguintes tabelas:
    • cmdb_ci_service_auto
    • cmdb_ci_service_discovered
    • cmdb_ci_service_by_tags
    • cmdb_ci_service_calculated
    • service_offering
    • cmdb_ci_business_app

    Padrão: cmdb_ci_service_auto

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

    Tabela 40. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. Oferece suporte somente a application/json.
    Tabela 41. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum

    Códigos de status

    Os códigos de status a seguir 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 da REST API.

    Tabela 42. Códigos de status
    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 o usuário não tem 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)

    Nome Descrição
    status Indica sucesso ou falha.

    Tipo de dados: cadeia de caracteres

    Solicitação de cURL

    O exemplo a seguir mostra como remover um relacionamento de um serviço de aplicativos.

    curl "https://instance.service-now.com/api/sn_service_graph/sg_services/app_service/relationship/delete" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
  \"child\": {
  \"name\": \"Test Register\",
  \"environment\": \"Test\",
  \"version\": \"1.0\"

  },
  \"parent\": {
   \"sys_id\": \"abcdefg\",
   \"name\": \"business App1\",
   \"class_name\": \"service_offering\"
     }
 }" \
--user 'username':'password'

    Resultados que indicam uma remoção bem-sucedida de um relacionamento de serviço de aplicativos.

    {
  "result": {
  "status": "success"
  }
}

    SG Services – POST – /sg_services/app_service/state

    Altera o estado do ciclo de vida do serviço de aplicativos para ativar, desativar ou descontinuar.

    As seguintes propriedades para identificar um IC têm precedência da seguinte forma:
    1. sys_id – se for sys_id, o sistema usará somente o sys_id e ignorará quaisquer valores adicionais.
    2. número: se fornecido sem o sys_id, o sistema usará somente o número e ignorará quaisquer valores adicionais.
    3. <IRE field name>– O sistema usará esses valores somente se o sys_id ou o número não forem fornecidos.

    Formato de URL

    URL com controle de versões: /api/sn_service_graph/{api_version}/sg_services/app_service/state

    URL padrão: /api/sn_service_graph/sg_services/app_service/state

    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. Especifique este valor somente para usar uma versão de endpoint diferente da mais recente.

    Tipo de dados: cadeia de caracteres
    Tabela 44. Parâmetros de consulta
    Nome Descrição
    Nenhum
    Tabela 45. Parâmetros do corpo da solicitação (JSON)
    Nome Descrição
    <IRE field name> Um ou mais campos IRE que identificam o serviço de aplicativos. Por exemplo, nome ou versão.

    Tipo de dados: cadeia de caracteres
    número Número exclusivo que identifica o serviço de aplicativos.

    Tipo de dados: cadeia de caracteres
    state Obrigatório. Estado do ciclo de vida do serviço de aplicativos. Esses valores são atualizados na tabela Serviços de aplicações [cmdb_ci_service_auto].
    Valores válidos:
    • ATIVAR: o ciclo de vida está operacional e em uso.
      • operating_status=Operacional
      • life_cycle_stage=Operational
      • life_cycle_stage_status=Em uso
    • DESATIVAR: o ciclo de vida não está operacional e está na fase de design.
      • operating_status=Não operacional
      • life_cycle_stage=Design
      • life_cycle_stage_status=Criar
    • RETIRE – fim da vida útil.
      • operating_status=Descontinuado
      • life_cycle_stage=Fim da vida útil
      • life_cycle_stage_status=Descontinuado

    Tipo de dados: cadeia de caracteres
    sys_id Sys_id do serviço de aplicativos listado na tabela Serviço de aplicativos [cmdb_ci_service_auto].

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

    Tabela 46. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. Oferece suporte somente a application/json.
    Tabela 47. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum

    Códigos de status

    Os códigos de status a seguir 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 da REST API.

    Tabela 48. Códigos de status
    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 o usuário não tem 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)

    Nome Descrição
    status Indica sucesso ou falha.

    Tipo de dados: cadeia de caracteres

    Solicitação de cURL

    O exemplo a seguir mostra como mudar um estado de ciclo de vida de serviço de aplicativos para ativar.

    curl "https://instance.service-now.com/api/sn_service_graph/sg_services/app_service/state" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
  {
  \"name\": \"Test Register\",
  \"environment\": \"Test\",
  \"version\": \"1.0\",
  \"state\": \"activate\"
  }
}" \
--user 'username':'password'

    Resultados que indicam uma operação bem-sucedida.

    {
  "result": {
  "status": "success"
  }
}

    SG Services – POST – /sg_services/app_service/update

    Atualiza um serviço de aplicativos existente fornecido e cria marcadores para o serviço de aplicativos fornecido.

    As seguintes propriedades para identificar um IC têm precedência da seguinte forma:
    1. sys_id – se for sys_id, o sistema usará somente o sys_id e ignorará quaisquer valores adicionais.
    2. número: se fornecido sem o sys_id, o sistema usará somente o número e ignorará quaisquer valores adicionais.
    3. <IRE field name>– O sistema usará esses valores somente se o sys_id ou o número não forem fornecidos.

    Formato de URL

    URL com controle de versões: /api/sn_service_graph/{api_version}/sg_services/app_service/update

    URL padrão: /api/sn_service_graph/sg_services/app_service/update

    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. Especifique este valor somente para usar uma versão de endpoint diferente da mais recente.

    Tipo de dados: cadeia de caracteres
    Tabela 50. Parâmetros do corpo da solicitação (JSON)
    Nome Descrição
    <fields or tags to update> Use pares de chave-valor para identificar cada campo ou marcador a ser atualizado.

    Somente informações básicas podem ser atualizadas, nenhum relacionamento ascendente pode ser atualizado.

    Tipo de dados: cadeia de caracteres
    <IRE field name> Um ou mais campos IRE que identificam o serviço de aplicativos. Por exemplo, nome ou versão.

    Você pode enviar o sys_id, o número ou o IRE para identificar um serviço de aplicativos; no entanto, nenhum desses campos pode ser atualizado quando usado como um identificador. Para atualizar os campos de IRE, a entrada deve incluir o sys_id ou o número como um identificador.

    Tipo de dados: cadeia de caracteres
    número Número exclusivo que identifica o serviço de aplicativos.

    Tipo de dados: cadeia de caracteres
    sys_id Sys_id do serviço de aplicativos listado na tabela Serviço de aplicativos [cmdb_ci_service_auto].

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

    Tabela 51. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. Oferece suporte somente a application/json.
    Tabela 52. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum

    Códigos de status

    Os códigos de status a seguir 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 da REST API.

    Tabela 53. Códigos de status
    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 o usuário não tem 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)

    Nome Descrição
    <IRE field name> Um ou mais campos IRE que identificam o serviço de aplicativos. Por exemplo, nome ou versão.

    Tipo de dados: cadeia de caracteres
    número Número exclusivo que identifica o serviço de aplicativos.

    Tipo de dados: cadeia de caracteres
    sys_id Sys_id do serviço de aplicativos listado na tabela Serviço de aplicativos [cmdb_ci_service_auto].

    Tipo de dados: cadeia de caracteres
    <updated fields> Se a atualização for bem-sucedida, cada campo modificado enviado na carga útil será listado no corpo da resposta.

    Solicitação de cURL

    O exemplo a seguir mostra como atualizar um serviço de aplicativos usando o nome como um campo IRE.

    curl "https://instance.service-now.com/api/sn_service_graph/sg_services/app_service/update" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
  {
   \"name\": \"Test Register\",
   \"environment\": \"Test\",
   \"version\": \"1.0\"
  }
}" \
--user 'username':'password'

    A resposta inclui informações de identificação do serviço de aplicativos e campos atualizados.

    {
  "result": {
  "sys_id": "123456",
  "number": "SVCKji0w9e",
  "name": "Test Register",
  "environment": "Test",
  "version": "1.0"
  }
}