SG Services API
. SG Services A API 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 cumulativas de notas de versão para todos os aplicativos lançados, consulte Notas de versão da ServiceNow Store .
Esta API só pode ser usada quando a API da aplicação CMDB e o plug-in CLI (sn_service_graph) estão ativados. Esta API é usada no sn_service_graph namespace.
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 que a CLI da aplicação do CMDB e a aplicação da loja de APIs fornecem em vez de usar a interface do usuário. A ILC da aplicação do CMDB e a aplicação da loja de APIs 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.
- Registrar e criar um serviço de aplicações e estabelecer relacionamentos ascendentes
- Obtendo detalhes de um determinado serviço de aplicação e seus relacionamentos ascendentes
- Conectar construções de nível superior, como aplicações de negócios e ofertas de serviços de negócios
- Preenchendo um serviço de aplicações com um determinado tipo de preenchimento
- Alterando o estado de um serviço de aplicações
Para obter a solução de linha de comando, consulte CLI da aplicação CMDB e comandos disponíveis da API .
SG Services - POST /sg_services/app_service/convert
Converte um serviço de aplicações do tipo manual ou vazio em um serviço de aplicações calculado. Durante a conversão, o registro de serviço da aplicação é movido para a tabela [cmdb_ci_service_calculated] com a classe recém-atribuída.
- Sys_id - Se sys_id, o sistema usará somente o sys_id e ignorará todos os valores adicionais.
- Número - Se fornecido sem o sys_id, o sistema usará somente o número e ignorará todos os valores adicionais.
- Nome do campo IRE - O sistema só usa esses valores se o sys_id ou o número não forem fornecidos.
Formato de URL
URL com controle de versão: /api/sn_service_graph//sg_services/app_service/convert
URL padrão: /api/sn_service_graph/sg_services/app_service/convert
Parâmetros de solicitação compatíveis
| Nome | Descrição |
|---|---|
| api_version | Opcional. Versão do endpoint a ser acessado. 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 |
| Nome | Descrição |
|---|---|
| Nenhum(a) |
| Nome | Descrição |
|---|---|
| IRE field name> | Um ou mais campos de IRE que identificam o serviço de aplicações. 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 aplicações. Tipo de dados: Cadeia de caracteres |
| sys_id | SYS_id do serviço de aplicações listado na tabela Instância de serviç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 .
| Cabeçalho | Descrição |
|---|---|
| Aceitar | Formato de dados do corpo da resposta. Oferece suporte somente a application/json. |
| Cabeçalho | Descrição |
|---|---|
| Nenhum(a) |
Códigos de status
Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da REST API .
| Código do status | Descrição |
|---|---|
| 200 | Bem-sucedido. A solicitação foi processada com sucesso. |
| 400 | Solicitação Incorreta. Um tipo de solicitação incorreto ou uma solicitação malformada foi detectada. |
| 401 | Não autorizado. As credenciais do usuário estão incorretas ou 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 em um serviço de aplicativos calculado.
{
"result": {
"status": "success"
}
}
SG Services - POST /sg_services/app_service/delete
Exclui um serviço de aplicações.
- Sys_id - Se sys_id, o sistema usará somente o sys_id e ignorará todos os valores adicionais.
- Número - Se fornecido sem o sys_id, o sistema usará somente o número e ignorará todos os valores adicionais.
- Nome do campo IRE - O sistema só usa esses valores se o sys_id ou o número não forem fornecidos.
Formato de URL
URL com controle de versão: /api/sn_service_graph//sg_services/app_service/delete
URL padrão: /api/sn_service_graph/sg_services/app_service/delete
Parâmetros de solicitação compatíveis
| Nome | Descrição |
|---|---|
| api_version | Opcional. Versão do endpoint a ser acessado. 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 |
| Nome | Descrição |
|---|---|
| Nenhum(a) |
| Nome | Descrição |
|---|---|
| IRE field name> | Um ou mais campos de IRE que identificam o serviço de aplicações. Por exemplo, nome ou versão. Tipo de dados: Cadeia de caracteres |
| número | Número exclusivo que identifica o serviço de aplicações. Tipo de dados: Cadeia de caracteres |
| sys_id | SYS_id do serviço de aplicações listado na tabela Instância de serviç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 .
| Cabeçalho | Descrição |
|---|---|
| Aceitar | Formato de dados do corpo da resposta. Oferece suporte somente a application/json. |
| Cabeçalho | Descrição |
|---|---|
| Nenhum(a) |
Códigos de status
Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da REST API .
| Código do status | Descrição |
|---|---|
| 200 | Bem-sucedido. A solicitação foi processada com sucesso. |
| 400 | Solicitação Incorreta. Um tipo de solicitação incorreto ou uma solicitação malformada foi detectada. |
| 401 | Não autorizado. As credenciais do usuário estão incorretas ou 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 aplicações e seus relacionamentos ascendentes.
Usuários com a função app_service_user podem usar esta API, mas os resultados são restritos aos serviços de aplicações no status operacional. A função app_service_admin fornece exibição ilimitada de serviços de aplicações.
- Sys_id - Se sys_id, o sistema usará somente o sys_id e ignorará todos os valores adicionais.
- Número - Se fornecido sem o sys_id, o sistema usará somente o número e ignorará todos os valores adicionais.
- Nome do campo IRE - O sistema só usa esses valores se o sys_id ou o número não forem fornecidos.
Formato de URL
URL com controle de versão: /api/sn_service_graph//sg_services/app_service/find
URL padrão: /api/sn_service_graph/sg_services/app_service/find
Parâmetros de solicitação compatíveis
| Nome | Descrição |
|---|---|
| api_version | Opcional. Versão do endpoint a ser acessado. 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 |
| Nome | Descrição |
|---|---|
| Nenhum(a) |
| Nome | Descrição |
|---|---|
| <IRE fields> | Um ou mais campos de IRE que identificam o serviço de aplicações. Por exemplo, nome ou versão. Tipo de dados: Cadeia de caracteres |
| número | Número exclusivo que identifica o serviço de aplicações. Tipo de dados: Cadeia de caracteres |
| sys_id | SYS_id do serviço de aplicações listado na tabela Instância de serviç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 .
| Cabeçalho | Descrição |
|---|---|
| Aceitar | Formato de dados do corpo da resposta. Oferece suporte somente a application/json. |
| Cabeçalho | Descrição |
|---|---|
| Nenhum(a) |
Códigos de status
Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da REST API .
| Código do status | Descrição |
|---|---|
| 200 | Bem-sucedido. A solicitação foi processada com sucesso. |
| 400 | Solicitação Incorreta. Um tipo de solicitação incorreto ou uma solicitação malformada foi detectada. |
| 401 | Não autorizado. As credenciais do usuário estão incorretas ou 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 de IRE que identificam o serviço de aplicações. Por exemplo, nome ou versão. Tipo de dados: Cadeia de caracteres |
| número | Número exclusivo que identifica o serviço de aplicações. Tipo de dados: Cadeia de caracteres |
| operational_status | Status operacional do serviço de aplicações. Por exemplo, ativo. Tipo de dados: Cadeia de caracteres |
| relacionamentos | Lista de objetos que definem os relacionamentos ascendentes do serviço de aplicações. Tipo de dados: Matriz |
| relationships.class_name | Nome da classe que contém o serviço de aplicações. 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 aplicações listado na tabela Instância de serviço [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 aplicações 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/popule
Preenche um serviço de aplicações com um método de preenchimento de serviço.
- Sys_id - Se sys_id, o sistema usará somente o sys_id e ignorará todos os valores adicionais.
- Número - Se fornecido sem o sys_id, o sistema usará somente o número e ignorará todos os valores adicionais.
- Nome do campo IRE - O sistema só usa esses valores se o sys_id ou o número não forem fornecidos.
Formato de URL
URL com controle de versão: /api/sn_service_graph//sg_services/app_service/popule
URL padrão: /api/sn_service_graph/sg_services/app_service/popule
Parâmetros de solicitação compatíveis
| Nome | Descrição |
|---|---|
| api_version | Opcional. Versão do endpoint a ser acessado. 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 |
| Nome | Descrição |
|---|---|
| Nenhum(a) |
| Nome | Descrição |
|---|---|
| IRE field name> | Um ou mais campos de IRE que identificam o serviço de aplicações. Por exemplo, nome ou versão. Tipo de dados: Cadeia de caracteres |
| número | Número exclusivo que identifica o serviço de aplicações. Tipo de dados: Cadeia de caracteres |
| population_method | Necessário. Identifica o método de preenchimento e sua propriedade que o acompanha para identificar o conteúdo para preenchimento. Apenas um objeto acompanhante é válido por tipo. Tipo de dados: Objeto |
| population_method.group_id | ID do grupo do grupo cmdb configurado com o tipo de preenchimento cmdb_group. Tipo de dados: "Cadeia de caracteres"
Tipo de população associado: cmdb_group |
| population_method.levels | Número de níveis a serem usados na criação do serviço. Se o valor de nível não for fornecido, o sistema verificará sys_property para o valor. Se svc.manual.convert.levels.default_value não estiver preenchido, será usado um valor padrão de 3. Tipo de dados: Número
Tipo de população associado: Dynamic_service Padrão: 3 se nenhum valor de nível for definido para sys_property |
| population_method.service_candidate | Identificador exclusivo do candidato ao serviço. Tipo de dados: Cadeia de caracteres
Tipo de população associado: Tag_based_service_family |
| population_method.service_relations | Lista de objetos que contêm dados de hierarquia para os ICs no serviço de aplicações. Todos os ICs formam pares com um IC primário e secundário. O IC de nível superior, conhecido como o ponto de entrada de um serviço de aplicações, não tem um IC primário. Tipo de dados: Matriz
Tipo de população associado: Service_hierarchy |
| population_method.service_relations.child | Nome de um IC secundário relacionado ao IC. Tipo de dados: Cadeia de caracteres |
| population_method.service_relations.parent | Nome de um IC primário relacionado ao IC. Tipo de dados: Cadeia de caracteres |
| population_method.tags | Lista de objetos que contêm marcadores a serem associados ao IC. Essas informações estão localizadas na tabela Valores de chave [cmdb_key_value]. Tipo de dados: Matriz
Tipo de população associado: Tag_list |
| population_method.tags.tag | Nome do marcador. Tipo de dados: Cadeia de caracteres |
| population_method.tags.value | Valor do marcador. Tipo de dados: Cadeia de caracteres |
| population_method.type | Necessário. Tipo de população a ser adicionado ao serviço de aplicações. Tipo de dados: Objeto Valores válidos:
|
| sys_id | SYS_id do serviço de aplicações listado na tabela Instância de serviç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 .
| Cabeçalho | Descrição |
|---|---|
| Aceitar | Formato de dados do corpo da resposta. Oferece suporte somente a application/json. |
| Cabeçalho | Descrição |
|---|---|
| Nenhum(a) |
Códigos de status
Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da REST API .
| Código do status | Descrição |
|---|---|
| 200 | Bem-sucedido. A solicitação foi processada com sucesso. |
| 400 | Solicitação Incorreta. Um tipo de solicitação incorreto ou uma solicitação malformada foi detectada. |
| 401 | Não autorizado. As credenciais do usuário estão incorretas ou 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 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 aplicações.
{
"result": {
"status": "success"
}
}
SG Services - PUBLICAR /sg_services/app_service/register
Cria um serviço de aplicações, marcadores e constrói relacionamentos ascendentes, como aplicações de negócios, ofertas de serviços de negócios e outros serviços de aplicações.
- Sys_id - Se sys_id, o sistema usará somente o sys_id e ignorará todos os valores adicionais.
- Número - Se fornecido sem o sys_id, o sistema usará somente o número e ignorará todos os valores adicionais.
- Nome do campo IRE - O sistema só usa esses valores se o sys_id ou o número não forem fornecidos.
Formato de URL
URL com controle de versão: /api/sn_service_graph//sg_services/app_service/register
URL padrão: /api/sn_service_graph/sg_services/app_service/register
Parâmetros de solicitação compatíveis
| Nome | Descrição |
|---|---|
| api_version | Opcional. Versão do endpoint a ser acessado. 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 |
| Nome | Descrição |
|---|---|
| Nenhum(a) |
| Nome | Descrição |
|---|---|
| IRE field name> | Um ou mais campos de IRE que identificam o serviço de aplicações. Por exemplo, nome ou versão. Tipo de dados: Cadeia de caracteres |
| número | Número exclusivo que identifica o serviço de aplicações. Tipo de dados: Cadeia de caracteres |
| relacionamentos | Relacionamentos ascendentes categorizados por tipo. Tipo de dados: Objeto
O número máximo de relacionamentos é 25. |
| relationships.business_app | Lista de objetos que representam os 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.
Tipo de dados: Matriz |
| relationships.business_service_offering | Lista de objetos que representam tipos de relacionamento da oferta de serviço de negócio. Esses valores podem ser definidos usando os seguintes itens como pares de chave-valor.
Tipo de dados: Matriz |
| relationships.parent_app_service | Lista de objetos que representam tipos de relacionamento de serviço de aplicações. Esses valores podem ser definidos usando os seguintes itens como pares de chave-valor.
Tipo de dados: Matriz |
| relationships.technical_service_offering | Lista de objetos que representam a oferta de gestão de tecnologia (anteriormente oferta de serviço técnico) tipos de relacionamento. Esses valores podem ser definidos usando os seguintes itens como pares de chave-valor.
Tipo de dados: Matriz |
| sys_id | SYS_id do serviço de aplicações listado na tabela Instância de serviço [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.
Tipo de dados: Matriz |
| tags.key | Nome da categoria de 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 .
| Cabeçalho | Descrição |
|---|---|
| Aceitar | Formato de dados do corpo da resposta. Oferece suporte somente a application/json. |
| Cabeçalho | Descrição |
|---|---|
| nenhum |
Códigos de status
Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da REST API .
| Código do status | Descrição |
|---|---|
| 200 | Bem-sucedido. A solicitação foi processada com sucesso. |
| 400 | Solicitação Incorreta. Um tipo de solicitação incorreto ou uma solicitação malformada foi detectada. |
| 401 | Não autorizado. As credenciais do usuário estão incorretas ou 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)
| Cabeçalho | Descrição |
|---|---|
| app_service | Detalhes do serviço de aplicações. Tipo de dados: Objeto |
| app_service.name | Nome do serviço de aplicações. Tipo de dados: Cadeia de caracteres |
| app_service.number | Número exclusivo que identifica o serviço de aplicações. Tipo de dados: Cadeia de caracteres |
| app_service.sys_id | SYS_id do serviço de aplicações listado na tabela Instância de serviço [cmdb_ci_service_auto]. Tipo de dados: Cadeia de caracteres |
| mensagem | Mensagem descrevendo o status. Valores possíveis:
Tipo de dados: Cadeia de caracteres |
| status | Status que indica se o serviço foi registrado. Valores possíveis:
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ços de negócios e outros serviços de aplicações.
Esta API cria um relacionamento, obtendo entrada com um único primário e um objeto secundário correspondente.
- Sys_id - Se sys_id, o sistema usará somente o sys_id e ignorará todos os valores adicionais.
- Número - Se fornecido sem o sys_id, o sistema usará somente o número e ignorará todos os valores adicionais.
- Nome do campo IRE - O sistema só usa esses valores se o sys_id ou o número não forem fornecidos.
Formato de URL
URL com controle de versão: /api/sn_service_graph//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
| Nome | Descrição |
|---|---|
| api_version | Opcional. Versão do endpoint a ser acessado. 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 |
| Nome | Descrição |
|---|---|
| Nenhum(a) |
| Nome | Descrição |
|---|---|
| secundário | Informações que identificam o serviço de aplicações secundário com o qual criar um relacionamento. Um grupo de IC dinâmico pode ser adicionado como secundário, mas não pode ser primário. Tipo de dados: Objeto Tabela: Instância de serviço [cmdb_ci_service_auto] |
| child.<service_app_identifier> | Detalhes que identificam o serviço de aplicações secundário com o qual criar um relacionamento. Apenas uma opção é necessária. Cada opção é listada por precedência de processamento:
Tipo de dados: Cadeia de caracteres |
| primário | Detalhes que identificam o serviço de aplicações primário com o qual criar um relacionamento. Tipo de dados: Objeto |
| parent.<service_app_identifier> | Informações que identificam o serviço de aplicações. Apenas uma opção é necessária. Cada opção é listada por precedência de processamento:
Tipo de dados: Cadeia de caracteres |
| parent.class_name | Nome da classe que contém o serviço de aplicações. O nome da classe primária deve ser de uma das seguintes tabelas:
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 .
| Cabeçalho | Descrição |
|---|---|
| Aceitar | Formato de dados do corpo da resposta. Oferece suporte somente a application/json. |
| Cabeçalho | Descrição |
|---|---|
| Nenhum(a) |
Códigos de status
Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da REST API .
| Código do status | Descrição |
|---|---|
| 200 | Bem-sucedido. A solicitação foi processada com sucesso. |
| 400 | Solicitação Incorreta. Um tipo de solicitação incorreto ou uma solicitação malformada foi detectada. |
| 401 | Não autorizado. As credenciais do usuário estão incorretas ou 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 do serviço de aplicações.
- Sys_id - Se sys_id, o sistema usará somente o sys_id e ignorará todos os valores adicionais.
- Número - Se fornecido sem o sys_id, o sistema usará somente o número e ignorará todos os valores adicionais.
- Nome do campo IRE - O sistema só usa esses valores se o sys_id ou o número não forem fornecidos.
Formato de URL
URL com controle de versão: /api/sn_service_graph//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
| Nome | Descrição |
|---|---|
| api_version | Opcional. Versão do endpoint a ser acessado. 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 |
| Nome | Descrição |
|---|---|
| Nenhum(a) |
| 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 |
| Nome do campo IRE | Um ou mais campos de IRE que identificam o serviço de aplicações secundário. Por exemplo, nome ou versão. Tipo de dados: Cadeia de caracteres |
| número.secundário | Número exclusivo que identifica o serviço de aplicações secundário. Tipo de dados: Cadeia de caracteres |
| sys_id.child.sys_id | Sys_id do serviço de aplicações secundário listado na Instância de serviço [cmdb_ci_service_auto]. Tipo de dados: Cadeia de caracteres |
| primário | Detalhes que identificam o serviço de aplicações primário do qual remover um relacionamento. Tipo de dados: Objeto |
| Nome do campo IRE | Um ou mais campos de IRE que identificam o serviço de aplicações. Por exemplo, nome ou versão. Tipo de dados: Cadeia de caracteres |
| número.primário | Número exclusivo que identifica o serviço de aplicações. Tipo de dados: Cadeia de caracteres |
| parent.sys_id | SYS_id do serviço de aplicações listado na tabela Instância de serviço [cmdb_ci_service_auto]. Tipo de dados: Cadeia de caracteres |
| parent.class_name | Nome da classe que contém o serviço de aplicações. O nome da classe primária deve ser de uma das seguintes tabelas:
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 .
| Cabeçalho | Descrição |
|---|---|
| Aceitar | Formato de dados do corpo da resposta. Oferece suporte somente a application/json. |
| Cabeçalho | Descrição |
|---|---|
| Nenhum(a) |
Códigos de status
Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da REST API .
| Código do status | Descrição |
|---|---|
| 200 | Bem-sucedido. A solicitação foi processada com sucesso. |
| 400 | Solicitação Incorreta. Um tipo de solicitação incorreto ou uma solicitação malformada foi detectada. |
| 401 | Não autorizado. As credenciais do usuário estão incorretas ou 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
Muda o estado do ciclo de vida do serviço da aplicação para ativar, desativar ou descontinuar.
- Sys_id - Se sys_id, o sistema usará somente o sys_id e ignorará todos os valores adicionais.
- Número - Se fornecido sem o sys_id, o sistema usará somente o número e ignorará todos os valores adicionais.
- Nome do campo IRE - O sistema só usa esses valores se o sys_id ou o número não forem fornecidos.
Formato de URL
URL com controle de versão: /api/sn_service_graph//sg_services/app_service/state
URL padrão: /api/sn_service_graph/sg_services/app_service/state
Parâmetros de solicitação compatíveis
| Nome | Descrição |
|---|---|
| api_version | Opcional. Versão do endpoint a ser acessado. 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 |
| Nome | Descrição |
|---|---|
| Nenhum(a) |
| Nome | Descrição |
|---|---|
| IRE field name> | Um ou mais campos de IRE que identificam o serviço de aplicações. Por exemplo, nome ou versão. Tipo de dados: Cadeia de caracteres |
| número | Número exclusivo que identifica o serviço de aplicações. Tipo de dados: Cadeia de caracteres |
| estado | Obrigatório. Estado do ciclo de vida do serviço de aplicações. Valores válidos:
Tipo de dados: Cadeia de caracteres Armazenado em: Instância de serviço [cmdb_ci_service_auto] |
| sys_id | SYS_id do serviço de aplicações listado na tabela Instância de serviç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 .
| Cabeçalho | Descrição |
|---|---|
| Aceitar | Formato de dados do corpo da resposta. Oferece suporte somente a application/json. |
| Cabeçalho | Descrição |
|---|---|
| Nenhum(a) |
Códigos de status
Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da REST API .
| Código do status | Descrição |
|---|---|
| 200 | Bem-sucedido. A solicitação foi processada com sucesso. |
| 400 | Solicitação Incorreta. Um tipo de solicitação incorreto ou uma solicitação malformada foi detectada. |
| 401 | Não autorizado. As credenciais do usuário estão incorretas ou 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 o estado do ciclo de vida de um serviço de aplicações 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 - PUBLICAR /sg_services/app_service/update
Atualiza um serviço de aplicações existente fornecido e cria marcadores para o serviço de aplicações fornecido.
- Sys_id - Se sys_id, o sistema usará somente o sys_id e ignorará todos os valores adicionais.
- Número - Se fornecido sem o sys_id, o sistema usará somente o número e ignorará todos os valores adicionais.
- Nome do campo IRE - O sistema só usa esses valores se o sys_id ou o número não forem fornecidos.
Formato de URL
URL com controle de versão: /api/sn_service_graph//sg_services/app_service/update
URL padrão: /api/sn_service_graph/sg_services/app_service/update
Parâmetros de solicitação compatíveis
| Nome | Descrição |
|---|---|
| api_version | Opcional. Versão do endpoint a ser acessado. 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 |
| Nome | Descrição |
|---|---|
| campos ou marcadores a serem atualizados | Use pares de chave-valor para identificar cada campo ou marcador a ser atualizado. Somente as 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 de IRE que identificam o serviço de aplicações. Por exemplo, nome ou versão. Você pode enviar o sys_id, number ou IRE para identificar um serviço de aplicações; no entanto, nenhum desses campos pode ser atualizado quando usado como identificador. Para atualizar os campos 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 aplicações. Tipo de dados: Cadeia de caracteres |
| sys_id | SYS_id do serviço de aplicações listado na tabela Instância de serviç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 .
| Cabeçalho | Descrição |
|---|---|
| Aceitar | Formato de dados do corpo da resposta. Oferece suporte somente a application/json. |
| Cabeçalho | Descrição |
|---|---|
| Nenhum(a) |
Códigos de status
Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da REST API .
| Código do status | Descrição |
|---|---|
| 200 | Bem-sucedido. A solicitação foi processada com sucesso. |
| 400 | Solicitação Incorreta. Um tipo de solicitação incorreto ou uma solicitação malformada foi detectada. |
| 401 | Não autorizado. As credenciais do usuário estão incorretas ou 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 de IRE que identificam o serviço de aplicações. Por exemplo, nome ou versão. Tipo de dados: Cadeia de caracteres |
| número | Número exclusivo que identifica o serviço de aplicações. Tipo de dados: Cadeia de caracteres |
| sys_id | SYS_id do serviço de aplicações listado na tabela Instância de serviço [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 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 aplicações e campos atualizados.
{
"result": {
"sys_id": "123456",
"number": "SVCKji0w9e",
"name": "Test Register",
"environment": "Test",
"version": "1.0"
}
}