API de serviço de aplicativos
. Serviço de aplicações A API fornece endpoints que permitem criar, modificar e atualizar serviços de aplicações.
Esta API requer que o usuário tenha a função de administrador do serviço de aplicações [app_service_admin].
Serviço de aplicações - OBTER /now/cmdb/app_service/
Recupera uma lista de itens de configuração (IC) em um serviço de aplicações mapeado e os relacionamentos entre eles. Recupera somente conteúdo de serviços que foram criados manualmente.
Formato de URL
URL padrão: /api/now/cmdb/app_service/sys_id/getContent
Parâmetros de solicitação compatíveis
| Nome | Descrição |
|---|---|
| sys_id | Sys_id do serviço de aplicações mapeado. Tipo de dados: Cadeia de caracteres Tabela: Serviço de aplicações mapeado [cmdb_ci_service_discovered] |
| Nome | Descrição |
|---|---|
| Modo | Quantidade de dados de relacionamento a serem retornados. Valores válidos: Os valores não diferenciam maiúsculas de minúsculas.
Tipo de dados: Cadeia de caracteres |
| Nome | Descrição |
|---|---|
| Nenhum(a) |
Cabeçalhos
Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis .
| Cabeçalho | Descrição |
|---|---|
| Aceitar | Formato de dados do corpo da resposta. Tipos compatíveis: application/jsonou application/xml. Padrão: 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 não têm a função app_service_admin. |
| 500 | Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro. |
Parâmetros do corpo da resposta (JSON ou XML)
| Nome | Descrição |
|---|---|
| cmdb | Lista de objetos que descrevem os ICs associados ao serviço de aplicações especificado. Tipo de dados: Objeto |
| cmdb.items | ICs no serviço de aplicações. Se o parâmetro de consulta completo foi passado na solicitação, esta seção incluirá atributos e informações de pesquisa para cada IC. Tipo de dados: Matriz |
| cmdb.items.className | Nome da classe que contém o IC. Tipo de dados: Cadeia de caracteres |
| cmdb.items.values | Informações a serem usadas para localizar um IC associado. Tipo de dados: Objeto |
| cmdb.items.values.name | Nome do IC. Tipo de dados: Cadeia de caracteres |
| cmdb.items.values.sys_id | Sys_id do IC. Tipo de dados: Cadeia de caracteres |
| cmdb.relations | Dados de relacionamento para ICs associados, como hosts e seus secundários. Tipo de dados: Matriz |
| serviço | Lista de serviços relacionados ao serviço identificado. Tipo de dados: Matriz de objetos |
| service.name | Nome do serviço de aplicações. Tipo de dados: Cadeia de caracteres |
| service.service_relations | Dados de hierarquia para os ICs no serviço de aplicações. Pares de formulário Todos os ICs 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 de objetos |
| service.service_relations.child | Nome de um IC secundário relacionado ao IC. Tipo de dados: Cadeia de caracteres |
| service.service_relations.parent | Nome de um IC primário relacionado ao IC. Tipo de dados: Cadeia de caracteres |
| service.url | Caminho relativo para o serviço de aplicações. Tipo de dados: Cadeia de caracteres |
Solicitação de cURL de amostra
curl "https://instance.servicenow.com/api/now/cmdb/app_service/2fce42d80a0a0bb4004af34d7e3984c8/getContent?mode=shallow" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'
{
"service": {
"name": "PeopleSoft Portals",
"url": "/api/now/table/cmdb_ci_service_discovered/2fce42d80a0a0bb4004af34d7e3984c8",
"service_relations": [
{
"parent": "",
"child": "3a2810c20a0a0bb400268337d6e942ca"
},
{
"parent": "3a27f1520a0a0bb400ecd6ff7afcf036",
"child": "3a5dd3dbc0a8ce0100655f1ec66ed42c"
},
{
"parent": "3a290cc60a0a0bb400000bdb386af1cf",
"child": "3a307c930a0a0bb400353965d0b8861f"
},
{
"parent": "3a172e820a0a0bb40034228e9f65f1be",
"child": "3a27d4370a0a0bb4006316812bf45439"
},
{
"parent": "",
"child": "3a172e820a0a0bb40034228e9f65f1be"
},
{
"parent": "",
"child": "3a27f1520a0a0bb400ecd6ff7afcf036"
},
{
"parent": "3a2810c20a0a0bb400268337d6e942ca",
"child": "3a290cc60a0a0bb400000bdb386af1cf"
}
]
},
"cmdb": {
"relations": [],
"items": [
{
"values": {
"sys_id": "3a172e820a0a0bb40034228e9f65f1be",
"name": "PS LoadBal01"
},
"className": "cmdb_ci_win_server"
},
{
"values": {
"sys_id": "3a2810c20a0a0bb400268337d6e942ca",
"name": "PS Apache03"
},
"className": "cmdb_ci_web_server"
},
{
"values": {
"sys_id": "55b35562c0a8010e01cff22378e0aea9",
"name": "ny8500-nbxs08"
},
"className": "cmdb_ci_netgear"
},
{
"values": {
"sys_id": "3a27f1520a0a0bb400ecd6ff7afcf036",
"name": "PS Apache02"
},
"className": "cmdb_ci_web_server"
},
{
"values": {
"sys_id": "3a307c930a0a0bb400353965d0b8861f",
"name": "PS ORA01"
},
"className": "cmdb_ci_database"
}
]
}
}
Serviço de aplicações - OBTENHA /now/cmdb/csdm/app_service/find_service
Retorna informações básicas sobre um serviço de aplicativos especificado e seu contexto de negócios associado.
Formato de URL
URL padrão: /api/now/cmdb/csdm/app_service/find_service
Parâmetros de solicitação compatíveis
| Nome | Descrição |
|---|---|
| Nenhum(a) |
| Nome | Descrição |
|---|---|
| nome | Necessário, se numbernão foi passado. Nome do serviço para o qual retornar informações. Tipo de dados: Cadeia de caracteres Tabela: Instância de serviço [cmdb_ci_service_auto] |
| número | Necessário, se namenão foi passado. Número exclusivo que identifica o serviço de aplicativos para o qual as informações serão retornadas. Tipo de dados: Cadeia de caracteres Tabela: Instância de serviço [cmdb_ci_service_auto] |
| Nome | Descrição |
|---|---|
| Nenhum(a) |
Cabeçalhos
Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis .
| 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 não têm a função app_service_admin. |
| 500 | Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro. |
Parâmetros do corpo da resposta (JSON ou XML)
| Nome | Descrição |
|---|---|
| erro | Descreve um erro encontrado. Tipo de dados: Objeto |
| error.details | Informações adicionais sobre o erro. Tipo de dados: Cadeia de caracteres |
| mensagem.erro | Mensagem descrevendo o erro. Tipo de dados: Cadeia de caracteres |
| serviços | Matriz de objetos, cada objeto contendo detalhes de serviços associados ao serviço de aplicações especificado. Tipo de dados: Matriz |
| services.environment | Ambiente no qual o serviço de aplicações é implantado, como "Produção" ou "Test Lab 2". Qualquer valor que faça sentido para o implementador. Tipo de dados: Cadeia de caracteres Comprimento máximo: 40 Padrão: Nulo |
| services.name | Obrigatório. Nome do serviço de aplicações. Deve ser um nome exclusivo de todos os outros serviços de aplicações. Tipo de dados: Cadeia de caracteres Comprimento máximo: 255 |
| services.number | Número exclusivo que identifica o serviço de aplicativos. Este valor é gerado inicialmente pelo endpoint. Tipo de dados: Cadeia de caracteres |
| relacionamentos.services | Tipos de serviço associados ao serviço de aplicações. Tipo de dados: Objeto |
| services.relationships.business_app | Lista de sys_ids das aplicações de negócios relacionadas ao serviço de aplicações. Tipo de dados: Matriz |
| services.relationships.technical_service_offering | Lista de sys_ids das ofertas de gestão de tecnologia (anteriormente ofertas de serviço técnico) relacionadas ao serviço de aplicações. Tipo de dados: Matriz |
| services.relationships.business_service_offering | Lista de sys_ids das ofertas de serviço de negócio relacionadas ao serviço de aplicações. Tipo de dados: Matriz |
| services.sys_id | Sys_id do serviço de aplicações. Tipo de dados: Cadeia de caracteres |
| services.version | Número da versão do serviço de aplicações. Tipo de dados: Cadeia de caracteres Comprimento máximo: 40 Formato: Definível pelo usuário Padrão: Nulo |
Solicitação de cURL de amostra
curl -X GET \
https://instance.servicenow.com/api/now/cmdb/csdm/app_service/find_service?name=Email_East&number=SNSVC0001018 \
-H 'Accept: application/json' \
-u 'username':'password'
{
"result": {
"services": [
{
"name": "Email_East",
"number": "SNSVC0001018",
"sys_id": "f809cb60db94101037740f95ca96190f",
"environment": "Production",
"version": "1.1.1",
"relationships": {
"business_app": [
"658c7620db54101037740f95ca9619f2"
],
"technical_service_offering": [],
"business_service_offering": [
"069c7e20db54101037740f95ca9619bf"
]
}
}
]
}
}
Serviço de aplicações - POST /now/cmdb/app_service/create
Cria um serviço de aplicações ou atualiza um serviço de aplicações existente.
Formato de URL
URL padrão: /api/now/cmdb/app_service/create
Parâmetros de solicitação compatíveis
| Parâmetro | Descrição |
|---|---|
| Nenhum(a) |
Cabeçalhos
Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis .
| Cabeçalho | Descrição |
|---|---|
| Aceitar | Formato de dados do corpo da resposta. Tipos compatíveis: application/jsonou application/xml. Padrão: application/json |
| Tipo de conteúdo | Formato de dados do corpo da solicitação. Tipos compatíveis: application/jsonou application/xml. Padrão: application/json |
| Cabeçalho | Descrição |
|---|---|
| Nenhum(a) |
Códigos de status
Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis .
| 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 não foram aprovadas. |
Corpo da solicitação
A API aceita esses elementos JSON no corpo da solicitação. Além disso, você pode adicionar qualquer campo da tabela Serviço de aplicações mapeado [cmdb_ci_service_discovered] para passar dados para o registro de serviço de aplicações. Por exemplo, para adicionar conteúdo ao campo Comentários, adicione "Comentários": "Passando dados para o campo Comentários" Para a solicitação JSON.
| Elemento | Descrição |
|---|---|
| nome | Nome do serviço de aplicações que você deseja criar ou atualizar. |
| service_relations | Informações sobre ICs e a hierarquia que eles formam. Pares de formulário Todos os ICs com um IC primário e um IC secundário. O IC de nível superior, conhecido como o ponto de entrada de um serviço de aplicativos, não tem um IC primário. |
| primário | Sys_ id do IC cuja conexão de saída se une a este IC com o IC no nível inferior na hierarquia do mapa. |
| secundário | Sys_ id do IC cuja conexão de entrada se une a este IC com o IC localizado no nível superior na hierarquia de mapas. |
Corpo da resposta
A API retorna esses elementos JSON no corpo da resposta.
| Elemento | Descrição |
|---|---|
| URL | REST API da tabela padrão para mostrar o sys_id de um registro de serviço de aplicações. Este elemento aparecerá somente se o endpoint for bem-sucedido. Tipo de dados: Cadeia de caracteres |
| ObContentUrl | Caminho da REST API para obter o conteúdo do serviço de aplicações. Este elemento aparecerá somente se o endpoint for bem-sucedido. Tipo de dados: Cadeia de caracteres |
| informações | Número de ICs adicionados ao serviço de aplicações. Este elemento aparecerá somente se o endpoint for bem-sucedido. Tipo de dados: Cadeia de caracteres |
| erro | Detalhes da mensagem de erro. Este elemento aparecerá somente se o endpoint falhar. Tipo de dados: Objeto |
| mensagem | Mensagem de erro descrevendo a natureza da falha. Este elemento aparecerá somente se o endpoint falhar. Tipo de dados: Cadeia de caracteres |
| status | Informa "Falha" se a REST API falhar. Este elemento aparecerá somente se o endpoint falhar. Tipo de dados: Cadeia de caracteres |
Solicitação de cURL de amostra
curl "http://<instance.servicenow.com>/api/now/cmdb/app_service/create" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
\"name\": \"myTestAppService\",
\"comments\": \"Passing data to the Comments field\",
\"service_relations\": [
{ \"parent\": \"\",
\"child\": \"3a70f789c0a8ce010091b0ea635b982a\"
},{ \"parent\": \"3a70f789c0a8ce010091b0ea635b982a\",
\"child\": \"b4fd7c8437201000deeabfc8bcbe5dc1\"
},{ \"parent\": \"b4fd7c8437201000deeabfc8bcbe5dc1\",
\"child\": \"53fdbc8437201000deeabfc8bcbe5d10\"
}
]
}" \
--user 'admin':'admin' {
"result": {
"url": "/api/now/table/cmdb_ci_service_discovered/b1cff89fc9e19300964fcbb1ac3059a5",
"getContentUrl": "/api/now/cmdb/app_service/b1cff89fc9e19300964fcbb1ac3059a5/getContent",
"info": "3 CIs added to service"
}
}
Serviço de aplicações - POST /now/cmdb/csdm/app_service/register_service
Cria um stub de registro de serviço de aplicações na tabela Instância de serviço [cmdb_ci_service_auto] e preenche-o com as informações passadas.
Formato de URL
URL padrão: /api/now/cmdb/csdm/app_service/register_service
Parâmetros de solicitação compatíveis
| Nome | Descrição |
|---|---|
| Nenhum(a) |
| Nome | Descrição |
|---|---|
| Nenhum(a) |
| Nome | Descrição |
|---|---|
| basic_details | Obrigatório. Detalhes do serviço associado ao serviço de aplicações especificado. Tipo de dados: Objeto |
| basic_details.environment | Ambiente no qual o serviço de aplicações é implantado, como "Produção" ou "Test Lab 2". Qualquer valor que faça sentido para o implementador. Tipo de dados: Cadeia de caracteres Comprimento máximo: 40 Padrão: Nulo |
| basic_details.name | Obrigatório. Nome do serviço de aplicações. Deve ser um nome exclusivo de todos os outros serviços de aplicações. Tipo de dados: Cadeia de caracteres Comprimento máximo: 255 |
| basic_details.version | Número da versão do serviço de aplicações. Tipo de dados: Cadeia de caracteres Comprimento máximo: 40 Formato: Definível pelo usuário Padrão: Nulo |
| relacionamentos | Tipos de serviço ascendente (primário) a serem associados ao serviço de aplicações. Tipo de dados: Objeto Tabela: Relacionamentos de IC [cmdb_rel_ci] |
| relationships.business_app | Lista de sys_ids das aplicações de negócios a serem relacionadas ao serviço de aplicações. Tipo de dados: Matriz |
| relationships.business_service_offering | Lista de sys_ids das ofertas de serviço de negócio a serem relacionadas ao serviço de aplicações. Tipo de dados: Matriz |
| relationships.technical_service_offering | Lista de sys_ids das ofertas de serviço técnico a serem relacionadas ao serviço de aplicações. Tipo de dados: Matriz |
Cabeçalhos
Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis .
| Cabeçalho | Descrição |
|---|---|
| Aceitar | Formato de dados do corpo da resposta. Oferece suporte somente a application/json. |
| Tipo de conteúdo | Formato de dados do corpo da solicitação. Oferece suporte somente a application/json. |
| 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 |
|---|---|
| 201 | Bem-sucedido. O serviço de aplicações foi registrado com sucesso. |
| 400 | Solicitação Incorreta. Um tipo de solicitação incorreto ou uma solicitação malformada foi detectada. |
| 401 | Não autorizado. As credenciais do usuário estão incorretas ou não têm a função app_service_admin. |
| 500 | Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro. |
Parâmetros do corpo da resposta (JSON ou XML)
| Nome | Descrição |
|---|---|
| erro | Descreve um erro encontrado. Tipo de dados: Objeto |
| error.details | Informações adicionais sobre o erro. Tipo de dados: Cadeia de caracteres |
| mensagem.erro | Mensagem descrevendo o erro. Tipo de dados: Cadeia de caracteres |
| número | Número exclusivo que identifica o serviço de aplicativos. Este número é gerado pelo endpoint. Tipo de dados: Cadeia de caracteres |
| service_sys_id | Sys_id do serviço de aplicações registrado. Tipo de dados: Cadeia de caracteres |
Solicitação de cURL de amostra
curl -X POST \
https://instance.servicenow.com/api/now/cmdb/csdm/app_service/register_service \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-u 'username':'password'
-d '{
"basic_details": {
"environment": "Test Lab 2",
"name": "Test Lab 2",
"version": "1.1.1"
},
"relationships": {
"business_app":["f07c7620db54101037740f95ca96199a"],
"business_service_offering":["069c7e20db54101037740f95ca9619bf"]
}
}'
{
"result": {
"service_sys_id": "80f21bbadbd410103d3a93c3e296199a",
"number": "SNSVC0001018"
}
}
Serviço de aplicações - COLOQUE /now/cmdb/csdm/app_service//popule_service
Preenche o serviço de aplicações especificado com um conjunto especificado de itens de configuração (IC) downstream.
Formato de URL
URL padrão: /api/now/cmdb/csdm/app_service/
Parâmetros de solicitação compatíveis
| Nome | Descrição |
|---|---|
| service_sys_id | Sys_id do serviço de aplicações a ser preenchido com os ICs especificados. Tipo de dados: Cadeia de caracteres Tabela: Instância de serviço [cmdb_ci_service_auto] |
| Nome | Descrição |
|---|---|
| Nenhum(a) |
| Nome | Descrição |
|---|---|
| population_method | ICs a serem associados ao serviço de aplicações especificado. Os elementos em population_methodo objeto depende do tipo de informação que está sendo preenchido, que é definido pelo typeparâmetro. Tipo de dados: Objeto Para typecmdb_group_based Para typedescoberta Nota: Para usar este tipo, você deve ativar o plug-in Mapeamento de serviços (com.snc.service-mapping). Para typetag_list Nota: Para usar este tipo, você deve ativar o plug-in Mapeamento de serviços (com.snc.service-mapping). |
| population_method.attributes | Lista de atributos a serem associados ao IC, como host, porta, nome e URL. Nota: Todos os atributos obrigatórios devem ser aprovados. Tipo de dados: Matriz |
| population_method.attributes.name | Nome do atributo, como host, porta, nome e URL. Tipo de dados: Cadeia de caracteres |
| population_method.attributes.value | Valor do atributo. Tipo de dados: Cadeia de caracteres |
| population_method.entry_point | Necessário se population_method.typedescoberta. Ponto de entrada no serviço de aplicativos. Para obter informações adicionais sobre pontos de entrada, consulte Atributos do ponto de entrada e. Crie tipos de ponto de entrada para o Mapeamento de serviços . Tipo de dados: Cadeia de caracteres |
| population_method.group_id | Necessário se population_method.typecmdb_group_based. Sys_id do grupo a ser associado ao IC. Tipo de dados: Cadeia de caracteres Grupo do CMDB [cmdb_group] |
| population_method.tags | Lista de marcadores a serem associados ao IC. Tipo de dados: Matriz de objetos Valores de chave [cmdb_key_value] |
| population_method.tags.tag | Nome do marcador. Tipo de dados: Cadeia de caracteres |
| population_method.tags.value | Valor do marcador. Tipo de dados: Cadeia de caracteres |
| population_method.type | Obrigatório. Tipo de IC a ser preenchido. Valores válidos:
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. |
| Tipo de conteúdo | Formato de dados do corpo da solicitação. 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. |
| 401 | Não autorizado. As credenciais do usuário estão incorretas ou não têm a função app_service_admin. |
| 500 | Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. |
Parâmetros do corpo da resposta (JSON ou XML)
| Nome | Descrição |
|---|---|
| erro | Descreve um erro encontrado. Tipo de dados: Objeto |
| error.details | Informações adicionais sobre o erro. Tipo de dados: Cadeia de caracteres |
| mensagem.erro | Mensagem descrevendo o erro. Tipo de dados: Cadeia de caracteres |
Solicitação de cURL de amostra
O exemplo de código a seguir mostra como preencher um serviço de aplicativos quando o tipo de IC é cmdb_group_based.
curl -X PUT \
https://instance.servicenow.com/api/now/cmdb/csdm/app_service/f809cb60db94101037740f95ca96190f/populate_service \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-u 'username':'password' \
-d '{
"population_method": {
"type":"cmdb_group_based",
"group_id": "e809cf60db94101037640f95ca961932"
}
}'
{
"result": {}
}
O exemplo de código a seguir mostra como preencher um serviço de aplicações de descoberta.
curl -X PUT \
https://instance.servicenow.com/api/now/cmdb/csdm/app_service/f809cb60db94101037740f95ca96190f/populate_service \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-u 'username':'password' \
-d '{
"population_method": {
"type":"discovery",
"entry_point_id":"cmdb_ci_endpoint_ad_forest",
"attributes": [
{
"name":"host",
"value":"test1.com"
},
{
"name":"port",
"value":"500"
},
{
"name":"protocol",
"value":"ssh"
}
]
}
}'
{
"result": {}
}
Serviço de aplicações - COLOQUE /now/cmdb/csdm/app_service//service_details
Atualiza o serviço de aplicações especificado com as informações básicas aprovadas.
Formato de URL
URL padrão: /api/now/cmdb/csdm/app_service//service_sys_id
Parâmetros de solicitação compatíveis
| Nome | Descrição |
|---|---|
| service_sys_id | Sys_id do serviço de aplicações a ser atualizado. Tipo de dados: Cadeia de caracteres Tabela: Instância de serviço [cmdb_ci_service_auto] |
| Nome | Descrição |
|---|---|
| Nenhum(a) |
| Nome | Descrição |
|---|---|
| basic_details | Detalhes do serviço associado ao serviço de aplicações especificado. Tipo de dados: Objeto |
| basic_details.environment | Ambiente no qual o serviço de aplicações é implantado, como "Produção" ou "Test Lab 2". Qualquer valor que faça sentido para o implementador. Tipo de dados: Cadeia de caracteres Comprimento máximo: 40 Padrão: Nulo |
| basic_details.name | Obrigatório. Nome do serviço de aplicações. Deve ser um nome exclusivo de todos os outros serviços de aplicações. Tipo de dados: Cadeia de caracteres Comprimento máximo: 255 |
| relacionamentos | Tipos de serviço a serem associados ao serviço de aplicações. Localizado na tabela Relacionamentos de IC [cmdb_rel_ci]. Tipo de dados: Objeto |
| relationships.business_app | Lista de sys_ids das aplicações de negócios a serem relacionadas ao serviço de aplicações. Tipo de dados: Matriz |
| relationships.business_service_offering | Lista de sys_ids das ofertas de serviço de negócio a serem relacionadas ao serviço de aplicações. Tipo de dados: Matriz |
| relationships.technical_service_offering | Lista de sys_ids das ofertas de serviço técnico a serem relacionadas ao serviço de aplicações. Tipo de dados: Matriz |
Cabeçalhos
Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis .
| Cabeçalho | Descrição |
|---|---|
| Aceitar | Formato de dados do corpo da resposta. Oferece suporte somente a application/json. |
| Tipo de conteúdo | Formato de dados do corpo da solicitação. Oferece suporte somente a application/json. |
| 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. |
| 401 | Não autorizado. As credenciais do usuário estão incorretas ou não têm a função app_service_admin. |
Parâmetros do corpo da resposta (JSON ou XML)
| Nome | Descrição |
|---|---|
| erro | Descreve um erro encontrado. Tipo de dados: Objeto |
| error.details | Informações adicionais sobre o erro. Tipo de dados: Cadeia de caracteres |
| mensagem.erro | Mensagem descrevendo o erro. Tipo de dados: Cadeia de caracteres |
Solicitação de cURL de amostra
curl -X PUT \
https://instance.servicenow.com/api/now/cmdb/csdm/app_service/f809cb60db94101037740f95ca96190f/service_details \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-u 'username':'password' \
-d '{
"basic_details": {
"environment": "Test Lab 2"
}, "relationships": {
"business_app" :["f07c7620db54101037740f95ca96199a"]
}
}'
{
"result": {}
}