API de instância do CMDB

A API de instância do CMDB fornece endpoints para criar, ler, atualizar e excluir operações em tabelas Configuration Management Database (CMDB) existentes. Você só pode inserir, atualizar ou excluir um registro de cada vez.

Esta API requer que o usuário tenha a função ITIL.

CMDB Instância - DELETE /now/cmdb/instance/{classname}/{sys_id}/relation/{rel_sys_id}

Exclui a relação do item de configuração (IC) especificado.

Formato da URL

URL com controle de versão: /api/now/v1/cmdb/instance/{className}/{sys_id}/relation/{rel_sys_id}

URL padrão: /api/now/cmdb/instance/{className}/{sys_id}/relation/{rel_sys_id}

Parâmetros de solicitação compatíveis

Tabela 1. Parâmetros de caminho

Nome	Descrição
className	CMDB nome da classe. Este é o nome da tabela que contém os registros de IC desejados, como cmdb_ci_linux_server ou cmdb_ci_apache_web_server. Tipo de dados: cadeia de caracteres
rel_sys_id	Sys_id da relação a ser removida. Tipo de dados: cadeia de caracteres
sys_id	Sys_id do IC. Tipo de dados: cadeia de caracteres

Tabela 2. Parâmetros de consulta

Nome	Descrição
Nenhum(a)

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

Nome	Descrição
Nenhum(a)

Cabeçalhos

Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.

Tabela 4. Cabeçalhos da solicitação

Cabeçalho	Descrição
Nenhum(a)

Tabela 5. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum(a)

Códigos de status

Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de 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 não foram aprovadas.
404	Não encontrado. O item solicitado não foi encontrado.
405	Método inválido. A funcionalidade está desabilitada.
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
Nenhum(a)

Amostra de solicitação cURL

curl "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci_linux_server/0f4ac6c4b750230096c3e4f6ee11a9fe/relation/b0dbda5347c12200e0ef563dbb9a718f" \
--request DELETE \
--user 'username':'password'

CMDB Instância - GET /now/cmdb/instance/{classname}

Retorna os itens de configuração (IC) disponíveis para uma classe Configuration Management Database (CMDB) especificada (tabela).

Formato da URL

URL com controle de versões: /api/now/v1/cmdb/instance/{className}

URL padrão: /api/now/cmdb/instance/{className}

Parâmetros de solicitação compatíveis

Tabela 7. Parâmetros de caminho

Nome	Descrição
className	CMDB nome da classe. Este é o nome da tabela que contém os registros de IC desejados, como cmdb_ci_linux_server ou cmdb_ci_apache_web_server. Tipo de dados: cadeia de caracteres

Tabela 8. Parâmetros de consulta

Nome	Descrição
sysparm_limit	Número máximo de registros a serem retornados. Para solicitações que excedem esse número de registros, use o parâmetro sysparm_offset para paginar a recuperação do registro. Este limite é aplicado antes da avaliação da ACL. Se nenhum registro for retornado, incluindo os registros aos quais você tem acesso, reorganize a ordem dos registros para que os registros aos quais você tem acesso sejam retornados primeiro. Nota: Valores sysparm_limit extraordinariamente grandes podem afetar o desempenho do sistema. Tipo de dados: número Padrão: 10000
sysparm_offset	Índice de registro inicial para o qual a recuperação de registros será iniciada. Use este valor para paginar a recuperação do registro. Essa funcionalidade permite a recuperação de todos os registros, independentemente do número de registros, em pequenos blocos gerenciáveis. Por exemplo, na primeira vez que você chama este endpoint, sysparm_offset é definido como "0". Para simplesmente percorrer todos os registros disponíveis, use sysparm_offset=sysparm_offset+sysparm_limitaté chegar ao fim de todos os registros. Não passe um número negativo no parâmetro sysparm_offset. Tipo de dados: número Padrão: 0
sysparm_query	Consulta codificada usada para filtrar o conjunto de resultados. Você pode usar um filtro de IU para obter uma consulta codificada corretamente. Sintaxe: sysparm_query=<col_name><operator><value> . <col_name>: Nome da coluna da tabela para filtrar. <operator>: oferece suporte aos seguintes valores: =: Corresponde exatamente a<value> . !=: não corresponde<value> . ^: logicamente E várias declarações de consulta. ^OR: logicamente OU várias declarações de consulta. CURTIR:<col_name> contém a cadeia de caracteres especificada. Só funciona para<col_name> campos cujo tipo de dados é cadeia de caracteres. COMEÇA COM:<col_name> começa com a cadeia de caracteres especificada. Só funciona para<col_name> campos cujo tipo de dados é cadeia de caracteres. TERMINACOM:<col_name> termina com a cadeia de caracteres especificada. Só funciona para<col_name> campos cujo tipo de dados é cadeia de caracteres. <value>: valor a ser correspondido. Todos os parâmetros fazem distinção entre maiúsculas e minúsculas. As consultas podem conter mais de uma entrada, como sysparm_query=<col_name><operator><value> [ ] . Por exemplo: (sysparm_query=caller_id=javascript:gs.getUserID()^active=true) As consultas codificadas também oferecem suporte à ordem por funcionalidade. Para classificar respostas com base em determinados campos, use as cláusulas ORDERBY e ORDERBYDESC em sysparm_query. Sintaxe: ORDERBY<col_name> ORDERBYDESC<col_name> Por exemplo: sysparm_query=active=true^ORDERBYnumber^ORDERBYDESCcategory Esta consulta filtra todos os registros ativos e ordena os resultados em ordem crescente por número e, em seguida, em ordem decrescente por categoria. Se parte da consulta for inválida, por exemplo, especificando um nome de campo inválido, a instância ignorará a parte inválida. Em seguida, ele retorna linhas usando somente a parte válida da consulta. Você pode controlar esse comportamento usando a propriedade glide.invalid_query.returns_no_rows. Defina esta propriedade como verdadeira para não retornar linhas em uma consulta inválida. Nota: A propriedade glide.invalid_query.returns_no_rows controla o comportamento de todas as consultas na instância, como em listas, scripts (GlideRecord.query()) e APIs de serviço web. Tipo de dados: cadeia de caracteres

Tabela 9. Parâmetros do corpo da solicitação (XML ou JSON)

Nome	Descrição
Nenhum(a)

Cabeçalhos

Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.

Tabela 10. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json

Tabela 11. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum(a)

Códigos de status

Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de 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 não foram aprovadas.
404	Não encontrado. O item solicitado não foi encontrado.
405	Método inválido. A funcionalidade está desabilitada.
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
nome	Nome de um IC na classe especificada. Tipo de dados: cadeia de caracteres
sys_id	Sys_id do IC. Tipo de dados: cadeia de caracteres

Amostra de solicitação cURL

curl "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci_linux_server" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

"result": [
  {
    "sys_id": "3a290cc60a0a0bb400000bdb386af1cf",
    "name": "PS LinuxApp01"
  },
  {
    "sys_id": "3a5dd3dbc0a8ce0100655f1ec66ed42c",
    "name": "PS LinuxApp02"
  }
]

CMDB Instância - GET /now/cmdb/instance/{classname}/{sys_id}

Retorna atributos e informações de relacionamento para um registro de item de configuração (IC) especificado.

Formato da URL

URL com controle de versão: /api/now/{api_version}/cmdb/instance/{className}/{sys_id}

URL padrão: /api/now/cmdb/instance/{className}/{sys_id}

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. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres
className	CMDB nome da classe. Este é o nome da tabela que contém os registros de IC desejados, como cmdb_ci_linux_server ou cmdb_ci_apache_web_server. Tipo de dados: cadeia de caracteres
sys_id	Sys_id do registro de IC a ser recuperado. Tipo de dados: cadeia de caracteres

Tabela 14. Parâmetros de consulta

Nome	Descrição
Nenhum(a)

Tabela 15. Parâmetros do corpo da solicitação (XML ou JSON)

Nome	Descrição
Nenhum(a)

Cabeçalhos

Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.

Tabela 16. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json

Tabela 17. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum(a)

Códigos de status

Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de 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 não foram aprovadas.
404	Não encontrado. O item solicitado não foi encontrado.
405	Método inválido. A funcionalidade está desabilitada.
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)

Tabela 19. Parâmetros de resposta

Nome	Descrição
atributos	Atributos de dados atualmente no registro de IC. Os atributos disponíveis dependem da classe CMDB especificada. Você pode localizar os atributos disponíveis na tabela CMDB associada, que normalmente começa com "cmdb_ci", como cmdb_ci_linux_server ou cmdb_ci_mfp_printer. Tipo de dados: objeto
erro	Informações sobre erros encontrados ao processar a solicitação de endpoint. Tipo de dados: objeto "error": { "detail": "String", "message": "String" }
erro.detalhe	Informações adicionais sobre o erro. Tipo de dados: cadeia de caracteres
mensagem.erro	Mensagem que identifica o erro. Tipo de dados: cadeia de caracteres
inbound_relations	Lista de objetos que definem as relações de entrada associadas ao IC. Tipo de dados: matriz "inbound_relations": [ { "sys_id": "String", "target": {Object}, "type": {Object} } ]
inbound_relations.sys_id	Sys_id do relacionamento de IC de entrada. Localizado na tabela Relacionamento de IC [cmdb_rel_ci]. Tipo de dados: cadeia de caracteres
inbound_relations.target	Informações que descrevem a relação de entrada de destino. Tipo de dados: objeto "target": { "display_value": "String", "link": "String", "value": "String" }
inbound_relations.target.display_value	Nome da relação de entrada a ser exibida em uma interface do usuário. Tipo de dados: cadeia de caracteres
inbound_relations.target.link	CMDB URL do endpoint REST a ser usado para recuperar a relação de entrada da tabela Item de configuração [cmdb_ci]. Tipo de dados: cadeia de caracteres
inbound_relations.target.value	Sys_id do IC de entrada. Localizado na tabela Item de configuração [cmdb_ci]. Tipo de dados: cadeia de caracteres
inbound_relations.type	Informações sobre o tipo de relacionamento de entrada. Tipo de dados: objeto "type": { "display_value": "String", "link": "String", "value": "String" }
inbound_relations.type.display_value	Nome do tipo de entrada a ser exibido em uma interface do usuário. Tipo de dados: cadeia de caracteres
inbound_relations.type.link	URL do endpoint RESTda tabela a ser usado para recuperar o tipo de relação de entrada da tabela Tipo de relação de IC [cmdb_rel_type]. Tipo de dados: cadeia de caracteres
relações_de_entrada.tipo.valor	Sys_id do tipo de relacionamento de entrada. Localizado na tabela Tipo de relacionamento de IC [cmdb_rel_type]. Tipo de dados: cadeia de caracteres
relações_saídas	Lista de objetos que definem as relações de saída associadas ao IC. Tipo de dados: matriz "outbound_relations": [ { "sys_id": "String", "target": {Object}, "type": {Object} } ]
relações_saídas.sys_id	Sys_id do relacionamento de IC de saída. Localizado na tabela Relacionamento de IC [cmdb_rel_ci]. Tipo de dados: cadeia de caracteres
relações_saídas.destino	Obrigatório. Informações sobre a relação de saída de destino. Tipo de dados: objeto "target": { "display_value": "String", "link": "String", "value": "String" }
relações_saídas.target.display_value	Nome da relação de saída a ser exibida em uma interface do usuário. Tipo de dados: cadeia de caracteres
outbound_relations.target.link	CMDB URL do endpoint REST a ser usado para recuperar a relação de saída da tabela Item de configuração [cmdb_ci]. Tipo de dados: cadeia de caracteres
relações_saídas.target.value	Sys_id do IC de saída. Localizado na tabela Item de configuração [cmdb_ci]. Tipo de dados: cadeia de caracteres
relações_saídas.tipo	Informações sobre o tipo de relacionamento de saída. Tipo de dados: objeto "type": { "display_value": "String", "link": "String", "value": "String" }
relações_de_saída.tipo.valor_de_exibição	Nome do tipo de saída a ser exibido em uma interface do usuário. Tipo de dados: cadeia de caracteres
outbound_relations.type.link	URL do endpoint RESTda tabela a ser usado para recuperar a relação de saída da tabela Tipo de relacionamento de IC [cmdb_rel_type]. Tipo de dados: cadeia de caracteres
relações_de_saída.tipo.valor	Sys_id do tipo de relacionamento de saída. Localizado na tabela Tipo de relacionamento de IC [cmdb_rel_type]. Tipo de dados: cadeia de caracteres
status	Aparece somente se um erro for encontrado. Status do processamento do endpoint. Valor possível: falha Tipo de dados: cadeia de caracteres

Amostra de solicitação cURL

curl "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci_linux_server/70bc4e11c0a8210d01f074cbe6bd73b4" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

{
  "result": {
    "outbound_relations": [
      {
        "sys_id": "3a62e64ac0a8ce0100aead1e3fd5439f",
        "type": {
          "display_value": "Depends on::Used by",
          "link": "https://instance.servicenow.com/api/now/table/cmdb_rel_type/1a9cb166f1571100a92eb60da2bce5c5",
          "value": "1a9cb166f1571100a92eb60da2bce5c5"
        },
        "target": {
          "display_value": "PS ORA01",
          "link": "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci/3a307c930a0a0bb400353965d0b8861f",
          "value": "3a307c930a0a0bb400353965d0b8861f"
        }
      },
      {
        "sys_id": "3a67513fc0a8ce0100914a76cea11b02",
        "type": {
          "display_value": "Exchanges data with::Exchanges data with",
          "link": "https://instance.servicenow.com/api/now/table/cmdb_rel_type/607ad1b2c0a8010e01941856b365af90",
          "value": "607ad1b2c0a8010e01941856b365af90"
        },
        "target": {
          "display_value": "PS ORA01",
          "link": "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci/3a307c930a0a0bb400353965d0b8861f",
          "value": "3a307c930a0a0bb400353965d0b8861f"
        }
      }
    ],
    "attributes": {
      "firewall_status": "Intranet",
      "os_address_width": "",
      "attested_date": "",
      "operational_status": "1",
      "os_service_pack": "",
      "cpu_core_thread": "",
      "cpu_manufacturer": "",
      "sys_updated_on": "2020-07-08 11:16:51",
      "discovery_source": "",
      "first_discovered": "",
      "due_in": "",
      "used_for": "Production",
      "invoice_number": "",
      "gl_account": "",
      "sys_created_by": "glide.maint",
      "warranty_expiration": "",
      "ram": "2048",
      "cpu_name": "",
      "cpu_speed": "2800",
      "owned_by": "",
      "checked_out": "",
      "kernel_release": "",
      "sys_domain_path": "/",
      "classification": "Production",
      "disk_space": "40",
      "object_id": "",
      "maintenance_schedule": "",
      "cost_center": "",
      "attested_by": "",
      "dns_domain": "",
      "assigned": "2020-01-04 07:00:00",
      "purchase_date": "",
      "life_cycle_stage": "",
      "short_description": "",
      "cd_speed": "",
      "floppy": "",
      "managed_by": {
        "display_value": "Lynda Caraway",
        "link": "https://instance.service-now.com/api/now/table/sys_user/8a826bf03710200044e0bfc8bcbe5d72",
        "value": "8a826bf03710200044e0bfc8bcbe5d72"
      },
      "os_domain": "",
      "last_discovered": "",
      "can_print": "false",
      "sys_class_name": "cmdb_ci_linux_server",
      "manufacturer": {
        "display_value": "Iris",
        "link": "https://instance.servicenow.com/api/now/table/core_company/c115c2f737e3100044e0bfc8bcbe5d46",
        "value": "c115c2f737e3100044e0bfc8bcbe5d46"
      },
      "cpu_count": "1",
      "vendor": {
        "display_value": "Cloudward Inc",
        "link": "https://instance.servicenow.com/api/now/table/core_company/3efe8c4c37423000158bbfc8bcbe5d7d",
        "value": "3efe8c4c37423000158bbfc8bcbe5d7d"
      },
      "life_cycle_stage_status": "",
      "model_number": "",
      "assigned_to": "",
      "start_date": "",
      "os_version": "2.6.9-22.0.1.ELsmp",
      "serial_number": "",
      "cd_rom": "false",
      "support_group": "",
      "unverified": "false",
      "correlation_id": "",
      "attributes": "",
      "asset": {
        "display_value": "P1000091 - Iris 5875",
        "link": "https://instance.servicenow.com/api/now/table/alm_asset/0bc1ba8837f3100044e0bfc8bcbe5dbb",
        "value": "0bc1ba8837f3100044e0bfc8bcbe5dbb"
      },
      "form_factor": "",
      "cpu_core_count": "",
      "skip_sync": "false",
      "attestation_score": "",
      "sys_updated_by": "system",
      "sys_created_on": "2008-10-26 17:17:28",
      "sys_domain": {
        "display_value": "global",
        "link": "https://instance.servicenow.com/api/now/table/sys_user_group/global",
        "value": "global"
      },
      "cpu_type": "Intel",
      "install_date": "2019-08-18 08:00:00",
      "asset_tag": "P1000091",
      "dr_backup": "",
      "hardware_substatus": "",
      "fqdn": "",
      "change_control": "",
      "internet_facing": "false",
      "delivery_date": "",
      "hardware_status": "",
      "install_status": "1",
      "supported_by": "",
      "name": "PS LinuxApp01",
      "subcategory": "",
      "default_gateway": "",
      "chassis_type": "",
      "virtual": "false",
      "assignment_group": "",
      "managed_by_group": "",
      "sys_id": "3a290cc60a0a0bb400000bdb386af1cf",
      "po_number": "",
      "checked_in": "",
      "sys_class_path": "/!!/!2/!(/!!/!0",
      "mac_address": "",
      "company": {
        "display_value": "ACME Corporation",
        "link": "https://instance.servicenow.com/api/now/table/core_company/e7c1f3d53790200044e0bfc8bcbe5deb",
        "value": "e7c1f3d53790200044e0bfc8bcbe5deb"
      },
      "justification": "",
      "department": "",
      "cost": "45557.5",
      "comments": "",
      "os": "Linux Red Hat",
      "sys_mod_count": "24",
      "monitor": "false",
      "model_id": {
        "display_value": "Iris 5875",
        "link": "https://instance.servicenow.com/api/now/table/cmdb_model/5f5fbcc3c0a8010e00f3b27814f3b96b",
        "value": "5f5fbcc3c0a8010e00f3b27814f3b96b"
      },
      "ip_address": "",
      "duplicate_of": "",
      "sys_tags": "",
      "cost_cc": "USD",
      "order_date": "",
      "schedule": "",
      "environment": "",
      "due": "",
      "attested": "false",
      "location": {
        "display_value": "322 West 52nd Street, New York,NY",
        "link": "https://instance.servicenow.com/api/now/table/cmn_location/25ab9f690a0a0bb3001c5fec1d0d7bcb",
        "value": "25ab9f690a0a0bb3001c5fec1d0d7bcb"
      },
      "category": "Do not migrate to asset",
      "fault_count": "0",
      "host_name": "",
      "lease_id": ""
    },
    "inbound_relations": [
      {
        "sys_id": "3a5e4d8ac0a8ce010005145afb730818",
        "type": {
          "display_value": "Depends on::Used by",
          "link": "https://instance.servicenow.com/api/now/table/cmdb_rel_type/1a9cb166f1571100a92eb60da2bce5c5",
          "value": "1a9cb166f1571100a92eb60da2bce5c5"
        },
        "target": {
          "display_value": "PS Apache01",
          "link": "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci/3a27d4370a0a0bb4006316812bf45439",
          "value": "3a27d4370a0a0bb4006316812bf45439"
        }
      },
      {
        "sys_id": "3a5e4d9cc0a8ce010097f2f5c2f65fd8",
        "type": {
          "display_value": "Depends on::Used by",
          "link": "https://instance.servicenow.com/api/now/table/cmdb_rel_type/1a9cb166f1571100a92eb60da2bce5c5",
          "value": "1a9cb166f1571100a92eb60da2bce5c5"
        },
        "target": {
          "display_value": "PS Apache02",
          "link": "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci/3a27f1520a0a0bb400ecd6ff7afcf036",
          "value": "3a27f1520a0a0bb400ecd6ff7afcf036"
        }
      },
      {
        "sys_id": "3a5e4d9fc0a8ce0100a3754fac26fe56",
        "type": {
          "display_value": "Depends on::Used by",
          "link": "https://instance.servicenow.com/api/now/table/cmdb_rel_type/1a9cb166f1571100a92eb60da2bce5c5",
          "value": "1a9cb166f1571100a92eb60da2bce5c5"
        },
        "target": {
          "display_value": "PS Apache03",
          "link": "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci/3a2810c20a0a0bb400268337d6e942ca",
          "value": "3a2810c20a0a0bb400268337d6e942ca"
        }
      }
    ]
  }
}

CMDB Instância - POST /now/cmdb/instance/{classname}

Cria um único item de configuração (IC) com as relações de saída e de entrada especificadas na tabela Configuration Management Database (CMDB) especificada.

Nota:

Se a classe CMDB tiver uma regra de identificação dependente definida, a carga útil de entrada deverá conter o sys_id de um IC existente. Por exemplo, para outbound_relations, o parâmetro target deve conter o sys_id de um IC existente, que se torna o secundário. Para inbound_relations, ele se torna o primário.

  "depends_on": {
    "outbound_relations":
      {
        "target": "b4fd7c8437201000deeabfc8bcbe5dc1",
        "type": "60bc4e22c0a8010e01f074cbe6bd73c3"
      }
    }

Formato da URL

URL com controle de versões: /api/now/v1/cmdb/instance/{className}

URL padrão: /api/now/cmdb/instance/{className}

Parâmetros de solicitação compatíveis

Tabela 20. Parâmetros de caminho

Nome	Descrição
className	CMDB nome da classe. Este é o nome da tabela que contém os registros de IC desejados, como cmdb_ci_linux_server ou cmdb_ci_apache_web_server. Tipo de dados: cadeia de caracteres

Tabela 21. Parâmetros de consulta

Nome	Descrição
Nenhum(a)

Tabela 22. Parâmetros do corpo da solicitação (XML ou JSON)

Nome	Descrição
atributos	Atributos de dados a serem definidos no registro de IC. Os atributos disponíveis dependem da classe CMDB especificada. Você pode localizar os atributos disponíveis na tabela CMDB associada, que normalmente começa com "cmdb_ci", como cmdb_ci_linux_server ou cmdb_ci_mfp_printer. Tipo de dados: objeto
inbound_relations	Lista de objetos que definem as relações de entrada a serem associadas ao IC. Tipo de dados: matriz "inbound_relations": [ { "target": "String", "type": "String" } ]
inbound_relations.target	Obrigatório se inbound_relations for especificado. Sys_id da relação de entrada de destino a ser associada ao IC especificado. Localizado na tabela Item de configuração [cmdb_ci]. Tipo de dados: cadeia de caracteres
inbound_relations.type	Obrigatório se inbound_relations for especificado. Sys_id do tipo de relacionamento de entrada. Localizado na tabela Tipo de relacionamento de IC [cmdb_rel_type]. Tipo de dados: cadeia de caracteres Tipo de dados: cadeia de caracteres
relações_saídas	Lista de objetos que definem as relações de saída a serem associadas ao IC. Tipo de dados: matriz "outbound_relations": [ { "target": "String", "type": "String" } ]
relações_saídas.destino	Obrigatório se outbound_relations for especificado. Sys_id da relação de saída de destino. Localizado na tabela Item de configuração [cmdb_ci]. Tipo de dados: cadeia de caracteres
relações_saídas.tipo	Obrigatório se outbound_relations for especificado. Sys_id do tipo de relacionamento de saída. Localizado na tabela Tipo de relacionamento de IC [cmdb_rel_type]. Tipo de dados: cadeia de caracteres
origem	Obrigatório. Entidade que atualizou as informações. Deve ser um dos valores de opção especificados no campo discovery_source na tabela Item de configuração [cmdb_ci]. 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 23. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json
Tipo de conteúdo	Formato de dados do corpo da solicitação. Tipos compatíveis: application/json ou application/xml. Padrão: application/json

Tabela 24. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum(a)

Códigos de status

Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.

Tabela 25. 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 não foram aprovadas.
404	Não encontrado. O item solicitado não foi encontrado.
405	Método inválido. A funcionalidade está desabilitada.
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)

Tabela 26. Parâmetros de resposta

Nome	Descrição
atributos	Atributos de dados atualmente no registro de IC. Os atributos disponíveis dependem da classe CMDB especificada. Você pode localizar os atributos disponíveis na tabela CMDB associada, que normalmente começa com "cmdb_ci", como cmdb_ci_linux_server ou cmdb_ci_mfp_printer. Tipo de dados: objeto
erro	Informações sobre erros encontrados ao processar a solicitação de endpoint. Tipo de dados: objeto "error": { "detail": "String", "message": "String" }
erro.detalhe	Informações adicionais sobre o erro. Tipo de dados: cadeia de caracteres
mensagem.erro	Mensagem que identifica o erro. Tipo de dados: cadeia de caracteres
inbound_relations	Lista de objetos que definem as relações de entrada associadas ao IC. Tipo de dados: matriz "inbound_relations": [ { "sys_id": "String", "target": {Object}, "type": {Object} } ]
inbound_relations.sys_id	Sys_id do relacionamento de IC de entrada. Localizado na tabela Relacionamento de IC [cmdb_rel_ci]. Tipo de dados: cadeia de caracteres
inbound_relations.target	Informações que descrevem a relação de entrada de destino. Tipo de dados: objeto "target": { "display_value": "String", "link": "String", "value": "String" }
inbound_relations.target.display_value	Nome da relação de entrada a ser exibida em uma interface do usuário. Tipo de dados: cadeia de caracteres
inbound_relations.target.link	CMDB URL do endpoint REST a ser usado para recuperar a relação de entrada da tabela Item de configuração [cmdb_ci]. Tipo de dados: cadeia de caracteres
inbound_relations.target.value	Sys_id do IC de entrada. Localizado na tabela Item de configuração [cmdb_ci]. Tipo de dados: cadeia de caracteres
inbound_relations.type	Informações sobre o tipo de relacionamento de entrada. Tipo de dados: objeto "type": { "display_value": "String", "link": "String", "value": "String" }
inbound_relations.type.display_value	Nome do tipo de entrada a ser exibido em uma interface do usuário. Tipo de dados: cadeia de caracteres
inbound_relations.type.link	URL do endpoint RESTda tabela a ser usado para recuperar o tipo de relação de entrada da tabela Tipo de relação de IC [cmdb_rel_type]. Tipo de dados: cadeia de caracteres
relações_de_entrada.tipo.valor	Sys_id do tipo de relacionamento de entrada. Localizado na tabela Tipo de relacionamento de IC [cmdb_rel_type]. Tipo de dados: cadeia de caracteres
relações_saídas	Lista de objetos que definem as relações de saída associadas ao IC. Tipo de dados: matriz "outbound_relations": [ { "sys_id": "String", "target": {Object}, "type": {Object} } ]
relações_saídas.sys_id	Sys_id do relacionamento de IC de saída. Localizado na tabela Relacionamento de IC [cmdb_rel_ci]. Tipo de dados: cadeia de caracteres
relações_saídas.destino	Obrigatório. Informações sobre a relação de saída de destino. Tipo de dados: objeto "target": { "display_value": "String", "link": "String", "value": "String" }
relações_saídas.target.display_value	Nome da relação de saída a ser exibida em uma interface do usuário. Tipo de dados: cadeia de caracteres
outbound_relations.target.link	CMDB URL do endpoint REST a ser usado para recuperar a relação de saída da tabela Item de configuração [cmdb_ci]. Tipo de dados: cadeia de caracteres
relações_saídas.target.value	Sys_id do IC de saída. Localizado na tabela Item de configuração [cmdb_ci]. Tipo de dados: cadeia de caracteres
relações_saídas.tipo	Informações sobre o tipo de relacionamento de saída. Tipo de dados: objeto "type": { "display_value": "String", "link": "String", "value": "String" }
relações_de_saída.tipo.valor_de_exibição	Nome do tipo de saída a ser exibido em uma interface do usuário. Tipo de dados: cadeia de caracteres
outbound_relations.type.link	URL do endpoint RESTda tabela a ser usado para recuperar a relação de saída da tabela Tipo de relacionamento de IC [cmdb_rel_type]. Tipo de dados: cadeia de caracteres
relações_de_saída.tipo.valor	Sys_id do tipo de relacionamento de saída. Localizado na tabela Tipo de relacionamento de IC [cmdb_rel_type]. Tipo de dados: cadeia de caracteres
status	Aparece somente se um erro for encontrado. Status do processamento do endpoint. Valor possível: falha Tipo de dados: cadeia de caracteres

Solicitação de cURL

O exemplo de código a seguir mostra como chamar este endpoint.

curl "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci_linux_server" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json"\
--user "username":"password" \
--data {
  "outbound_relations": [
    {
      "type" : "1a9cb166f1571100a92eb60da2bce5c5",
      "target" : "3a307c930a0a0bb400353965d0b8861f"
    },
    {
      "type" : "607ad1b2c0a8010e01941856b365af90",
      "target" : "3a307c930a0a0bb400353965d0b8861f"
    }
  ],
  "attributes": {
    "name" : "lnux999",
    "firewall_status": "Intranet"
  },
  "source": "ServiceNow",
  "inbound_relations": [
    {
      "type" : "1a9cb166f1571100a92eb60da2bce5c5",
      "target" : "3a27d4370a0a0bb4006316812bf45439"
    }
  ]
}

{
    "result": {
        "outbound_relations": [
            {
                "sys_id": "403ff2641b425010593876a61a4bcb4b",
                "type": {
                    "display_value": "Depends on::Used by",
                    "link": "https://instance.servicenow.com/api/now/table/cmdb_rel_type/1a9cb166f1571100a92eb60da2bce5c5",
                    "value": "1a9cb166f1571100a92eb60da2bce5c5"
                },
                "target": {
                    "display_value": "PS ORA01",
                    "link": "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci/3a307c930a0a0bb400353965d0b8861f",
                    "value": "3a307c930a0a0bb400353965d0b8861f"
                }
            },
            {
                "sys_id": "443ff2641b425010593876a61a4bcb4c",
                "type": {
                    "display_value": "Exchanges data with::Exchanges data with",
                    "link": "https://instance.servicenow.com/api/now/table/cmdb_rel_type/607ad1b2c0a8010e01941856b365af90",
                    "value": "607ad1b2c0a8010e01941856b365af90"
                },
                "target": {
                    "display_value": "PS ORA01",
                    "link": "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci/3a307c930a0a0bb400353965d0b8861f",
                    "value": "3a307c930a0a0bb400353965d0b8861f"
                }
            }
        ],
        "attributes": {
            "firewall_status": "Intranet",
            "os_address_width": "",
            "attested_date": "",
            "operational_status": "1",
            "os_service_pack": "",
            "cpu_core_thread": "",
            "cpu_manufacturer": "",
            "sys_updated_on": "2020-07-13 20:27:28",
            "discovery_source": "ServiceNow",
            "first_discovered": "2020-07-13 20:27:28",
            "due_in": "",
            "used_for": "Production",
            "invoice_number": "",
            "gl_account": "",
            "sys_created_by": "dora.gray",
            "warranty_expiration": "",
            "ram": "",
            "cpu_name": "",
            "cpu_speed": "",
            "owned_by": "",
            "checked_out": "",
            "kernel_release": "",
            "sys_domain_path": "/",
            "classification": "Production",
            "disk_space": "",
            "object_id": "",
            "maintenance_schedule": "",
            "cost_center": "",
            "attested_by": "",
            "dns_domain": "",
            "assigned": "",
            "purchase_date": "",
            "life_cycle_stage": "",
            "short_description": "",
            "cd_speed": "",
            "floppy": "",
            "managed_by": "",
            "os_domain": "",
            "last_discovered": "2020-07-13 20:27:28",
            "can_print": "false",
            "sys_class_name": "cmdb_ci_linux_server",
            "manufacturer": "",
            "cpu_count": "",
            "vendor": "",
            "life_cycle_stage_status": "",
            "model_number": "",
            "assigned_to": "",
            "start_date": "",
            "os_version": "",
            "serial_number": "",
            "cd_rom": "false",
            "support_group": "",
            "unverified": "false",
            "correlation_id": "",
            "attributes": "",
            "asset": "",
            "form_factor": "",
            "cpu_core_count": "",
            "skip_sync": "false",
            "attestation_score": "",
            "sys_updated_by": "dora.gray",
            "sys_created_on": "2020-07-13 20:27:28",
            "sys_domain": {
                "display_value": "global",
                "link": "https://instance.servicenow.com/api/now/table/sys_user_group/global",
                "value": "global"
            },
            "cpu_type": "",
            "install_date": "",
            "asset_tag": "",
            "dr_backup": "",
            "hardware_substatus": "",
            "fqdn": "",
            "change_control": "",
            "internet_facing": "true",
            "delivery_date": "",
            "hardware_status": "installed",
            "install_status": "1",
            "supported_by": "",
            "name": "lnux299",
            "subcategory": "Computer",
            "default_gateway": "",
            "chassis_type": "",
            "virtual": "false",
            "assignment_group": "",
            "managed_by_group": "",
            "sys_id": "0c3ff2641b425010593876a61a4bcb39",
            "po_number": "",
            "checked_in": "",
            "sys_class_path": "/!!/!2/!(/!!/!0",
            "mac_address": "",
            "company": "",
            "justification": "",
            "department": "",
            "cost": "",
            "comments": "",
            "os": "",
            "sys_mod_count": "0",
            "monitor": "false",
            "model_id": "",
            "ip_address": "",
            "duplicate_of": "",
            "sys_tags": "",
            "cost_cc": "USD",
            "order_date": "",
            "schedule": "",
            "environment": "",
            "due": "",
            "attested": "false",
            "location": "",
            "category": "Hardware",
            "fault_count": "0",
            "host_name": "",
            "lease_id": ""
        },
        "inbound_relations": [
            {
                "sys_id": "c03ff2641b425010593876a61a4bcb49",
                "type": {
                    "display_value": "Depends on::Used by",
                    "link": "https://instance.servicenow.com/api/now/table/cmdb_rel_type/1a9cb166f1571100a92eb60da2bce5c5",
                    "value": "1a9cb166f1571100a92eb60da2bce5c5"
                },
                "target": {
                    "display_value": "PS Apache01",
                    "link": "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci/3a27d4370a0a0bb4006316812bf45439",
                    "value": "3a27d4370a0a0bb4006316812bf45439"
                }
            }
        ]
    }
}

Solicitação de cURL

O exemplo de código a seguir mostra como chamar este endpoint para uma classe que tem uma regra de identificação dependente definida. O outbound_relations.target deve ser incluído na carga útil e conter o sys_id de um IC existente.

curl "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci_linux_server" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json"\
--user "username":"password" \
--data {
  "attributes": {
    "name": "test",
    "sys_class_name":"cmdb_ci_db_mssql_instance",
    "instance_name":"Iname"
  },
  "source": "ServiceNow",
  "depends_on": {
    "outbound_relations":
      {
        "target": "b4fd7c8437201000deeabfc8bcbe5dc1",
        "type": "60bc4e22c0a8010e01f074cbe6bd73c3"
      }
    }
  }
}

{
  "result": {
    "outbound_relations": [
      {
        "sys_id": "505cfa3a53662110af64ddeeff7b1217",
        "type": {
          "display_value": "Runs on::Runs",
          "link": http://instance.servicenow.com/api/now/table/cmdb_rel_type/60bc4e22c0a8010e01f074cbe6bd73c3,
          "value": "60bc4e22c0a8010e01f074cbe6bd73c3"
        },
        "target": {
          "display_value": "*ANNIE-IBM",
          "link": http://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci/b4fd7c8437201000deeabfc8bcbe5dc1,
          "value": "b4fd7c8437201000deeabfc8bcbe5dc1"
        }
      }
    ],
    "attributes": {
      "attested_date": "",
      "operational_status": "1",
      "running_process_command": "",
      "sys_updated_on": "2023-05-05 21:28:24",
      "type": "",
      "running_process_key_parameters": "",
      "rp_command_hash": "",
      "discovery_source": "ServiceNow",
      "first_discovered": "2023-05-05 21:28:24",
      "due_in": "",
      "service_pack": "",
      "used_for": "Production",
      "is_clustered": "false",
      "invoice_number": "",
      "gl_account": "",
      "sys_created_by": "admin",
      "warranty_expiration": "",
      "owned_by": "",
      "checked_out": "",
      "rp_key_parameters_hash": "",
      "sys_domain_path": "/",
      "business_unit": "",
      "version": "",
      "cpu_sockets": "",
      "maintenance_schedule": "",
      "cost_center": "",
      "attested_by": "",
      "dns_domain": "",
      "assigned": "",
      "purchase_date": "",
      "life_cycle_stage": "",
      "short_description": "",
      "managed_by": "",
      "port_dynamic": "false",
      "last_discovered": "2023-05-05 21:28:24",
      "can_print": "false",
      "sys_class_name": "cmdb_ci_db_mssql_instance",
      "manufacturer": "",
      "cl_port": "",
      "vendor": "",
      "life_cycle_stage_status": "",
      "model_number": "",
      "config_file": "",
      "assigned_to": "",
      "start_date": "",
      "instance_name": "Iname",
      "serial_number": "",
      "engine_edition": "",
      "support_group": "",
      "version_name": "",
      "unverified": "false",
      "correlation_id": "",
      "attributes": "",
      "asset": "",
      "config_directory": "",
      "tcp_port": "",
      "listener_name": "",
      "skip_sync": "false",
      "pid": "",
      "attestation_score": "",
      "sys_updated_by": "admin",
      "install_directory": "",
      "sys_created_on": "2023-05-05 21:28:24",
      "sys_domain": {
        "display_value": "global",
        "link": http://instance.servicenow.com/api/now/table/sys_user_group/global,
        "value": "global"
      },
      "install_date": "",
      "asset_tag": "",
      "fqdn": "",
      "change_control": "",
      "delivery_date": "",
      "install_status": "1",
      "supported_by": "",
      "name": "test",
      "subcategory": "Database",
      "assignment_group": "",
      "edition": "",
      "managed_by_group": "",
      "sys_id": "185cba3a53662110af64ddeeff7b12af",
      "po_number": "",
      "database": "",
      "checked_in": "",
      "sys_class_path": "/!!/!(/!2/!,",
      "mac_address": "",
      "company": "",
      "justification": "",
      "department": "",
      "cost": "",
      "comments": "",
      "attestation_status": "Not Yet Reviewed",
      "sys_mod_count": "0",
      "monitor": "false",
      "model_id": "",
      "ip_address": "",
      "duplicate_of": "",
      "sys_tags": "",
      "cost_cc": "USD",
      "order_date": "",
      "schedule": "",
      "environment": "",
      "due": "",
      "attested": "false",
      "location": "",
      "category": "Resource",
      "fault_count": "0",
      "lease_id": ""
    },
    "inbound_relations": []
  }
}

Solicitação de cURL

O exemplo de código a seguir mostra o que é retornado quando um sys_id não é passado para uma classe que tem uma regra de identificação dependente definida. O mesmo resultado ocorre se o sys_id for inválido.

curl "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci_linux_server" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json"\
--user "username":"password" \
--data "{
  "attributes": {
    "name": "test",
    "sys_class_name":"cmdb_ci_db_mssql_instance",
    "instance_name":"Iname"
  },
  "source": "ServiceNow",
  "depends_on": {
    "outbound_relations": {
        "type": "60bc4e22c0a8010e01f074cbe6bd73c3"
    }
  }
}

{
  "error": {
    "detail": "Exception while executing request: null Check logs for error trace or enable glide.rest.debug property to verify REST request processing",
    "message": "Exception while executing request: null"
  },
  "status": "failure"
}

CMDB Instância - PUT /now/cmdb/instance/{classname}/{sys_id}

Atualiza o registro do item de configuração (IC) especificado com os pares de nome-valor de atributo especificados. Este endpoint não cria, atualiza ou exclui as relações associadas.

Nota:

Este endpoint não está em conformidade com as especificações HTML. Os endpoints PUT padrão são destrutivos, pois removem todos os elementos que não estão incluídos na solicitação. Este endpoint não remove elementos não especificados.

Formato da URL

URL com controle de versão: /api/now/v1/cmdb/instance/{className}/{sys_id}

URL padrão: /api/now/cmdb/instance/{className}/{sys_id}

Parâmetros de solicitação compatíveis

Tabela 27. Parâmetros de caminho

Nome	Descrição
className	CMDB nome da classe. Este é o nome da tabela que contém os registros de IC desejados, como cmdb_ci_linux_server ou cmdb_ci_apache_web_server. Tipo de dados: cadeia de caracteres
sys_id	Sys_id do registro de IC a ser atualizado. Tipo de dados: cadeia de caracteres

Tabela 28. Parâmetros de consulta

Nome	Descrição
Nenhum(a)

Tabela 29. Parâmetros do corpo da solicitação (XML ou JSON)

Nome	Descrição
atributos	Atributos de dados a serem substituídos no registro de IC. Os atributos disponíveis dependem da classe CMDB especificada. Você pode localizar os atributos disponíveis na tabela CMDB associada, que normalmente começa com "cmdb_ci", como cmdb_ci_linux_server ou cmdb_ci_mfp_printer. Tipo de dados: objeto
origem	Obrigatório. Entidade que atualizou as informações. Deve ser um dos valores de opção especificados no campo discovery_source na tabela Item de configuração [cmdb_ci]. 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 30. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json
Tipo de conteúdo	Formato de dados do corpo da solicitação. Tipos compatíveis: application/json ou application/xml. Padrão: application/json

Tabela 31. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum(a)

Códigos de status

Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.

Tabela 32. 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 não foram aprovadas.
404	Não encontrado. O item solicitado não foi encontrado.
405	Método inválido. A funcionalidade está desabilitada.
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)

Tabela 33. Parâmetros de resposta

Nome	Descrição
atributos	Atributos de dados atualmente no registro de IC. Os atributos disponíveis dependem da classe CMDB especificada. Você pode localizar os atributos disponíveis na tabela CMDB associada, que normalmente começa com "cmdb_ci", como cmdb_ci_linux_server ou cmdb_ci_mfp_printer. Tipo de dados: objeto
erro	Informações sobre erros encontrados ao processar a solicitação de endpoint. Tipo de dados: objeto "error": { "detail": "String", "message": "String" }
erro.detalhe	Informações adicionais sobre o erro. Tipo de dados: cadeia de caracteres
mensagem.erro	Mensagem que identifica o erro. Tipo de dados: cadeia de caracteres
inbound_relations	Lista de objetos que definem as relações de entrada associadas ao IC. Tipo de dados: matriz "inbound_relations": [ { "sys_id": "String", "target": {Object}, "type": {Object} } ]
inbound_relations.sys_id	Sys_id do relacionamento de IC de entrada. Localizado na tabela Relacionamento de IC [cmdb_rel_ci]. Tipo de dados: cadeia de caracteres
inbound_relations.target	Informações que descrevem a relação de entrada de destino. Tipo de dados: objeto "target": { "display_value": "String", "link": "String", "value": "String" }
inbound_relations.target.display_value	Nome da relação de entrada a ser exibida em uma interface do usuário. Tipo de dados: cadeia de caracteres
inbound_relations.target.link	CMDB URL do endpoint REST a ser usado para recuperar a relação de entrada da tabela Item de configuração [cmdb_ci]. Tipo de dados: cadeia de caracteres
inbound_relations.target.value	Sys_id do IC de entrada. Localizado na tabela Item de configuração [cmdb_ci]. Tipo de dados: cadeia de caracteres
inbound_relations.type	Informações sobre o tipo de relacionamento de entrada. Tipo de dados: objeto "type": { "display_value": "String", "link": "String", "value": "String" }
inbound_relations.type.display_value	Nome do tipo de entrada a ser exibido em uma interface do usuário. Tipo de dados: cadeia de caracteres
inbound_relations.type.link	URL do endpoint RESTda tabela a ser usado para recuperar o tipo de relação de entrada da tabela Tipo de relação de IC [cmdb_rel_type]. Tipo de dados: cadeia de caracteres
relações_de_entrada.tipo.valor	Sys_id do tipo de relacionamento de entrada. Localizado na tabela Tipo de relacionamento de IC [cmdb_rel_type]. Tipo de dados: cadeia de caracteres
relações_saídas	Lista de objetos que definem as relações de saída associadas ao IC. Tipo de dados: matriz "outbound_relations": [ { "sys_id": "String", "target": {Object}, "type": {Object} } ]
relações_saídas.sys_id	Sys_id do relacionamento de IC de saída. Localizado na tabela Relacionamento de IC [cmdb_rel_ci]. Tipo de dados: cadeia de caracteres
relações_saídas.destino	Obrigatório. Informações sobre a relação de saída de destino. Tipo de dados: objeto "target": { "display_value": "String", "link": "String", "value": "String" }
relações_saídas.target.display_value	Nome da relação de saída a ser exibida em uma interface do usuário. Tipo de dados: cadeia de caracteres
outbound_relations.target.link	CMDB URL do endpoint REST a ser usado para recuperar a relação de saída da tabela Item de configuração [cmdb_ci]. Tipo de dados: cadeia de caracteres
relações_saídas.target.value	Sys_id do IC de saída. Localizado na tabela Item de configuração [cmdb_ci]. Tipo de dados: cadeia de caracteres
relações_saídas.tipo	Informações sobre o tipo de relacionamento de saída. Tipo de dados: objeto "type": { "display_value": "String", "link": "String", "value": "String" }
relações_de_saída.tipo.valor_de_exibição	Nome do tipo de saída a ser exibido em uma interface do usuário. Tipo de dados: cadeia de caracteres
outbound_relations.type.link	URL do endpoint RESTda tabela a ser usado para recuperar a relação de saída da tabela Tipo de relacionamento de IC [cmdb_rel_type]. Tipo de dados: cadeia de caracteres
relações_de_saída.tipo.valor	Sys_id do tipo de relacionamento de saída. Localizado na tabela Tipo de relacionamento de IC [cmdb_rel_type]. Tipo de dados: cadeia de caracteres
status	Aparece somente se um erro for encontrado. Status do processamento do endpoint. Valor possível: falha Tipo de dados: cadeia de caracteres

Amostra de solicitação cURL

curl "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci_linux_server/70bc4e11c0a8210d01f074cbe6bd73b4" \
--request PUT \
--header "Accept:application/json" \
--header "Content-Type:application/json"\
--user "username":"password" \
--data {
  "attributes": {
    "firewall_status": "Extranet",
    "discovery_source": "ServiceNows",
    "name": "Linux299",
    "used_for": "Pre-production",
    "container": "Box"
  },
  "source": "ServiceNow"
}

{
    "result": {
        "outbound_relations": [
            {
                "sys_id": "403ff2641b425010593876a61a4bcb4b",
                "type": {
                    "display_value": "Depends on::Used by",
                    "link": "https://instance.service-now.com/api/now/table/cmdb_rel_type/1a9cb166f1571100a92eb60da2bce5c5",
                    "value": "1a9cb166f1571100a92eb60da2bce5c5"
                },
                "target": {
                    "display_value": "PS ORA01",
                    "link": "https://instance.service-now.com/api/now/cmdb/instance/cmdb_ci/3a307c930a0a0bb400353965d0b8861f",
                    "value": "3a307c930a0a0bb400353965d0b8861f"
                }
            },
            {
                "sys_id": "443ff2641b425010593876a61a4bcb4c",
                "type": {
                    "display_value": "Exchanges data with::Exchanges data with",
                    "link": "https://instance.service-now.com/api/now/table/cmdb_rel_type/607ad1b2c0a8010e01941856b365af90",
                    "value": "607ad1b2c0a8010e01941856b365af90"
                },
                "target": {
                    "display_value": "PS ORA01",
                    "link": "https://instance.service-now.com/api/now/cmdb/instance/cmdb_ci/3a307c930a0a0bb400353965d0b8861f",
                    "value": "3a307c930a0a0bb400353965d0b8861f"
                }
            }
        ],
        "attributes": {
            "firewall_status": "Extranet",
            "os_address_width": "",
            "attested_date": "",
            "operational_status": "1",
            "os_service_pack": "",
            "cpu_core_thread": "",
            "cpu_manufacturer": "",
            "sys_updated_on": "2020-07-13 20:59:40",
            "discovery_source": "ServiceNow",
            "first_discovered": "2020-07-13 20:27:28",
            "due_in": "",
            "used_for": "Pre-production",
            "invoice_number": "",
            "gl_account": "",
            "sys_created_by": "dora.gray",
            "warranty_expiration": "",
            "ram": "",
            "cpu_name": "",
            "cpu_speed": "",
            "owned_by": "",
            "checked_out": "",
            "kernel_release": "",
            "sys_domain_path": "/",
            "classification": "Production",
            "disk_space": "",
            "object_id": "",
            "maintenance_schedule": "",
            "cost_center": "",
            "attested_by": "",
            "dns_domain": "",
            "assigned": "",
            "purchase_date": "",
            "life_cycle_stage": "",
            "short_description": "",
            "cd_speed": "",
            "floppy": "",
            "managed_by": "",
            "os_domain": "",
            "last_discovered": "2020-07-13 20:59:40",
            "can_print": "false",
            "sys_class_name": "cmdb_ci_linux_server",
            "manufacturer": "",
            "cpu_count": "",
            "vendor": "",
            "life_cycle_stage_status": "",
            "model_number": "",
            "assigned_to": "",
            "start_date": "",
            "os_version": "",
            "serial_number": "",
            "cd_rom": "false",
            "support_group": "",
            "unverified": "false",
            "correlation_id": "",
            "attributes": "",
            "asset": {
                "display_value": "Unknown",
                "link": "https://instance.service-now.com/api/now/table/alm_asset/21cfba641b425010593876a61a4bcb52",
                "value": "21cfba641b425010593876a61a4bcb52"
            },
            "form_factor": "",
            "cpu_core_count": "",
            "skip_sync": "false",
            "attestation_score": "",
            "sys_updated_by": "dora.gray",
            "sys_created_on": "2020-07-13 20:27:28",
            "sys_domain": {
                "display_value": "global",
                "link": "https://instance.service-now.com/api/now/table/sys_user_group/global",
                "value": "global"
            },
            "cpu_type": "",
            "install_date": "",
            "asset_tag": "",
            "dr_backup": "",
            "hardware_substatus": "",
            "fqdn": "",
            "change_control": "",
            "internet_facing": "true",
            "delivery_date": "",
            "hardware_status": "installed",
            "install_status": "1",
            "supported_by": "",
            "name": "Linux299",
            "subcategory": "Computer",
            "default_gateway": "",
            "chassis_type": "",
            "virtual": "false",
            "assignment_group": "",
            "managed_by_group": "",
            "sys_id": "0c3ff2641b425010593876a61a4bcb39",
            "po_number": "",
            "checked_in": "",
            "sys_class_path": "/!!/!2/!(/!!/!0",
            "mac_address": "",
            "company": "",
            "justification": "",
            "department": "",
            "cost": "",
            "comments": "",
            "os": "",
            "sys_mod_count": "3",
            "monitor": "false",
            "model_id": {
                "display_value": "Unknown",
                "link": "https://instance.service-now.com/api/now/table/cmdb_model/0ce0a2681b4e1010593876a61a4bcba6",
                "value": "0ce0a2681b4e1010593876a61a4bcba6"
            },
            "ip_address": "",
            "duplicate_of": "",
            "sys_tags": "",
            "cost_cc": "USD",
            "order_date": "",
            "schedule": "",
            "environment": "",
            "due": "",
            "attested": "false",
            "location": "",
            "category": "Hardware",
            "fault_count": "0",
            "host_name": "",
            "lease_id": ""
        },
        "inbound_relations": [
            {
                "sys_id": "c03ff2641b425010593876a61a4bcb49",
                "type": {
                    "display_value": "Depends on::Used by",
                    "link": "https://instance.service-now.com/api/now/table/cmdb_rel_type/1a9cb166f1571100a92eb60da2bce5c5",
                    "value": "1a9cb166f1571100a92eb60da2bce5c5"
                },
                "target": {
                    "display_value": "PS Apache01",
                    "link": "https://instance.service-now.com/api/now/cmdb/instance/cmdb_ci/3a27d4370a0a0bb4006316812bf45439",
                    "value": "3a27d4370a0a0bb4006316812bf45439"
                }
            }
        ]
    }
}

CMDB Instância - POST /now/cmdb/instance/{classname}/{sys_id}/relation

Adiciona uma relação de entrada e/ou saída ao item de configuração (IC) especificado. O IC especificado é o primário.

Formato da URL

URL com controle de versão: /api/now/v1/cmdb/instance/{className}/{sys_id}/relation

URL padrão: /api/now/cmdb/instance/{className}/{sys_id}/relation

Parâmetros de solicitação compatíveis

Tabela 34. Parâmetros de caminho

Nome	Descrição
className	CMDB nome da classe. Este é o nome da tabela que contém os registros de IC desejados, como cmdb_ci_linux_server ou cmdb_ci_apache_web_server. Tipo de dados: cadeia de caracteres
sys_id	Sys_id do registro de IC a ser atualizado. Tipo de dados: cadeia de caracteres

Tabela 35. Parâmetros de consulta

Nome	Descrição
Nenhum(a)

Tabela 36. Parâmetros do corpo da solicitação (XML ou JSON)

Nome	Descrição
inbound_relations	Lista de objetos que definem as relações de entrada a serem associadas ao IC. Tipo de dados: matriz "inbound_relations": [ { "target": "String", "type": "String" } ]
inbound_relations.target	Obrigatório se inbound_relations for especificado. Sys_id da relação de entrada de destino a ser associada ao IC especificado. Localizado na tabela Item de configuração [cmdb_ci]. Tipo de dados: cadeia de caracteres
inbound_relations.type	Obrigatório se inbound_relations for especificado. Sys_id do tipo de relacionamento de entrada. Localizado na tabela Tipo de relacionamento de IC [cmdb_rel_type]. Tipo de dados: cadeia de caracteres Tipo de dados: cadeia de caracteres
relações_saídas	Lista de objetos que definem as relações de saída a serem associadas ao IC. Tipo de dados: matriz "outbound_relations": [ { "target": "String", "type": "String" } ]
relações_saídas.destino	Obrigatório se outbound_relations for especificado. Sys_id da relação de saída de destino. Localizado na tabela Item de configuração [cmdb_ci]. Tipo de dados: cadeia de caracteres
relações_saídas.tipo	Obrigatório se outbound_relations for especificado. Sys_id do tipo de relacionamento de saída. Localizado na tabela Tipo de relacionamento de IC [cmdb_rel_type]. Tipo de dados: cadeia de caracteres
origem	Obrigatório. Entidade que atualizou as informações. Deve ser um dos valores de opção especificados no campo discovery_source na tabela Item de configuração [cmdb_ci]. 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 37. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json
Tipo de conteúdo	Formato de dados do corpo da solicitação. Tipos compatíveis: application/json ou application/xml. Padrão: application/json

Tabela 38. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum(a)

Códigos de status

Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.

Tabela 39. 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 não foram aprovadas.
404	Não encontrado. O item solicitado não foi encontrado.
405	Método inválido. A funcionalidade está desabilitada.
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)

Tabela 40. Parâmetros de resposta

Nome	Descrição
atributos	Atributos de dados atualmente no registro de IC. Os atributos disponíveis dependem da classe CMDB especificada. Você pode localizar os atributos disponíveis na tabela CMDB associada, que normalmente começa com "cmdb_ci", como cmdb_ci_linux_server ou cmdb_ci_mfp_printer. Tipo de dados: objeto
erro	Informações sobre erros encontrados ao processar a solicitação de endpoint. Tipo de dados: objeto "error": { "detail": "String", "message": "String" }
erro.detalhe	Informações adicionais sobre o erro. Tipo de dados: cadeia de caracteres
mensagem.erro	Mensagem que identifica o erro. Tipo de dados: cadeia de caracteres
inbound_relations	Lista de objetos que definem as relações de entrada associadas ao IC. Tipo de dados: matriz "inbound_relations": [ { "sys_id": "String", "target": {Object}, "type": {Object} } ]
inbound_relations.sys_id	Sys_id do relacionamento de IC de entrada. Localizado na tabela Relacionamento de IC [cmdb_rel_ci]. Tipo de dados: cadeia de caracteres
inbound_relations.target	Informações que descrevem a relação de entrada de destino. Tipo de dados: objeto "target": { "display_value": "String", "link": "String", "value": "String" }
inbound_relations.target.display_value	Nome da relação de entrada a ser exibida em uma interface do usuário. Tipo de dados: cadeia de caracteres
inbound_relations.target.link	CMDB URL do endpoint REST a ser usado para recuperar a relação de entrada da tabela Item de configuração [cmdb_ci]. Tipo de dados: cadeia de caracteres
inbound_relations.target.value	Sys_id do IC de entrada. Localizado na tabela Item de configuração [cmdb_ci]. Tipo de dados: cadeia de caracteres
inbound_relations.type	Informações sobre o tipo de relacionamento de entrada. Tipo de dados: objeto "type": { "display_value": "String", "link": "String", "value": "String" }
inbound_relations.type.display_value	Nome do tipo de entrada a ser exibido em uma interface do usuário. Tipo de dados: cadeia de caracteres
inbound_relations.type.link	URL do endpoint RESTda tabela a ser usado para recuperar o tipo de relação de entrada da tabela Tipo de relação de IC [cmdb_rel_type]. Tipo de dados: cadeia de caracteres
relações_de_entrada.tipo.valor	Sys_id do tipo de relacionamento de entrada. Localizado na tabela Tipo de relacionamento de IC [cmdb_rel_type]. Tipo de dados: cadeia de caracteres
relações_saídas	Lista de objetos que definem as relações de saída associadas ao IC. Tipo de dados: matriz "outbound_relations": [ { "sys_id": "String", "target": {Object}, "type": {Object} } ]
relações_saídas.sys_id	Sys_id do relacionamento de IC de saída. Localizado na tabela Relacionamento de IC [cmdb_rel_ci]. Tipo de dados: cadeia de caracteres
relações_saídas.destino	Obrigatório. Informações sobre a relação de saída de destino. Tipo de dados: objeto "target": { "display_value": "String", "link": "String", "value": "String" }
relações_saídas.target.display_value	Nome da relação de saída a ser exibida em uma interface do usuário. Tipo de dados: cadeia de caracteres
outbound_relations.target.link	CMDB URL do endpoint REST a ser usado para recuperar a relação de saída da tabela Item de configuração [cmdb_ci]. Tipo de dados: cadeia de caracteres
relações_saídas.target.value	Sys_id do IC de saída. Localizado na tabela Item de configuração [cmdb_ci]. Tipo de dados: cadeia de caracteres
relações_saídas.tipo	Informações sobre o tipo de relacionamento de saída. Tipo de dados: objeto "type": { "display_value": "String", "link": "String", "value": "String" }
relações_de_saída.tipo.valor_de_exibição	Nome do tipo de saída a ser exibido em uma interface do usuário. Tipo de dados: cadeia de caracteres
outbound_relations.type.link	URL do endpoint RESTda tabela a ser usado para recuperar a relação de saída da tabela Tipo de relacionamento de IC [cmdb_rel_type]. Tipo de dados: cadeia de caracteres
relações_de_saída.tipo.valor	Sys_id do tipo de relacionamento de saída. Localizado na tabela Tipo de relacionamento de IC [cmdb_rel_type]. Tipo de dados: cadeia de caracteres
status	Aparece somente se um erro for encontrado. Status do processamento do endpoint. Valor possível: falha Tipo de dados: cadeia de caracteres

Amostra de solicitação cURL

curl "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci_linux_server/3a290cc60a0a0bb400000bdb386af1cf/relation" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json"\
--user "username":"password" \
--data {
  "outbound_relations": [
    {
      "type" : "1a9cb166f1571100a92eb60da2bce5c5",
      "target" : "3a307c930a0a0bb400353965d0b8861f"
    },
    {
      "type" : "607ad1b2c0a8010e01941856b365af90",
      "target" : "3a307c930a0a0bb400353965d0b8861f"
    }
  ],
  "source": "ServiceNow",
  "inbound_relations": [
    {
      "type" : "1a9cb166f1571100a92eb60da2bce5c5",
      "target" : "3a27d4370a0a0bb4006316812bf45439"
    }
  ]
}

{
    "result": {
        "outbound_relations": [
            {
                "sys_id": "403ff2641b425010593876a61a4bcb4b",
                "type": {
                    "display_value": "Depends on::Used by",
                    "link": "https://instance.servicenow.com/api/now/table/cmdb_rel_type/1a9cb166f1571100a92eb60da2bce5c5",
                    "value": "1a9cb166f1571100a92eb60da2bce5c5"
                },
                "target": {
                    "display_value": "PS ORA01",
                    "link": "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci/3a307c930a0a0bb400353965d0b8861f",
                    "value": "3a307c930a0a0bb400353965d0b8861f"
                }
            },
            {
                "sys_id": "443ff2641b425010593876a61a4bcb4c",
                "type": {
                    "display_value": "Exchanges data with::Exchanges data with",
                    "link": "https://instance.servicenow.com/api/now/table/cmdb_rel_type/607ad1b2c0a8010e01941856b365af90",
                    "value": "607ad1b2c0a8010e01941856b365af90"
                },
                "target": {
                    "display_value": "PS ORA01",
                    "link": "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci/3a307c930a0a0bb400353965d0b8861f",
                    "value": "3a307c930a0a0bb400353965d0b8861f"
                }
            }
        ],
        "attributes": {
            "firewall_status": "Active",
            "os_address_width": "",
            "attested_date": "",
            "operational_status": "1",
            "os_service_pack": "",
            "cpu_core_thread": "",
            "cpu_manufacturer": "",
            "sys_updated_on": "2020-07-13 21:24:05",
            "discovery_source": "ServiceNow",
            "first_discovered": "2020-07-13 20:27:28",
            "due_in": "",
            "used_for": "Production",
            "invoice_number": "",
            "gl_account": "",
            "sys_created_by": "dora.gray",
            "warranty_expiration": "",
            "ram": "",
            "cpu_name": "",
            "cpu_speed": "",
            "owned_by": "",
            "checked_out": "",
            "kernel_release": "",
            "sys_domain_path": "/",
            "classification": "Production",
            "disk_space": "",
            "object_id": "",
            "maintenance_schedule": "",
            "cost_center": "",
            "attested_by": "",
            "dns_domain": "",
            "assigned": "",
            "purchase_date": "",
            "life_cycle_stage": "",
            "short_description": "",
            "cd_speed": "",
            "floppy": "",
            "managed_by": "",
            "os_domain": "",
            "last_discovered": "2020-07-13 21:24:05",
            "can_print": "false",
            "sys_class_name": "cmdb_ci_linux_server",
            "manufacturer": "",
            "cpu_count": "",
            "vendor": "",
            "life_cycle_stage_status": "",
            "model_number": "",
            "assigned_to": "",
            "start_date": "",
            "os_version": "",
            "serial_number": "",
            "cd_rom": "false",
            "support_group": "",
            "unverified": "false",
            "correlation_id": "",
            "attributes": "",
            "asset": {
                "display_value": "Unknown",
                "link": "https://instance.servicenow.com/api/now/table/alm_asset/21cfba641b425010593876a61a4bcb52",
                "value": "21cfba641b425010593876a61a4bcb52"
            },
            "form_factor": "",
            "cpu_core_count": "",
            "skip_sync": "false",
            "attestation_score": "",
            "sys_updated_by": "dora.gray",
            "sys_created_on": "2020-07-13 20:27:28",
            "sys_domain": {
                "display_value": "global",
                "link": "https://instance.servicenow.com/api/now/table/sys_user_group/global",
                "value": "global"
            },
            "cpu_type": "",
            "install_date": "",
            "asset_tag": "",
            "dr_backup": "",
            "hardware_substatus": "",
            "fqdn": "",
            "change_control": "",
            "internet_facing": "true",
            "delivery_date": "",
            "hardware_status": "installed",
            "install_status": "1",
            "supported_by": "",
            "name": "Linux299",
            "subcategory": "Computer",
            "default_gateway": "",
            "chassis_type": "",
            "virtual": "false",
            "assignment_group": "",
            "managed_by_group": "",
            "sys_id": "0c3ff2641b425010593876a61a4bcb39",
            "po_number": "",
            "checked_in": "",
            "sys_class_path": "/!!/!2/!(/!!/!0",
            "mac_address": "",
            "company": "",
            "justification": "",
            "department": "",
            "cost": "",
            "comments": "",
            "os": "",
            "sys_mod_count": "4",
            "monitor": "false",
            "model_id": {
                "display_value": "Unknown",
                "link": "https://instance.servicenow.com/api/now/table/cmdb_model/0ce0a2681b4e1010593876a61a4bcba6",
                "value": "0ce0a2681b4e1010593876a61a4bcba6"
            },
            "ip_address": "",
            "duplicate_of": "",
            "sys_tags": "",
            "cost_cc": "USD",
            "order_date": "",
            "schedule": "",
            "environment": "",
            "due": "",
            "attested": "false",
            "location": "",
            "category": "Hardware",
            "fault_count": "0",
            "host_name": "",
            "lease_id": ""
        },
        "inbound_relations": [
            {
                "sys_id": "c03ff2641b425010593876a61a4bcb49",
                "type": {
                    "display_value": "Depends on::Used by",
                    "link": "https://instance.servicenow.com/api/now/table/cmdb_rel_type/1a9cb166f1571100a92eb60da2bce5c5",
                    "value": "1a9cb166f1571100a92eb60da2bce5c5"
                },
                "target": {
                    "display_value": "PS Apache01",
                    "link": "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci/3a27d4370a0a0bb4006316812bf45439",
                    "value": "3a27d4370a0a0bb4006316812bf45439"
                }
            }
        ]
    }
}

CMDB Instância - PATCH /now/cmdb/instance/{classname}/{sys_id}

Substitui os atributos no registro de item de configuração (IC) especificado pelos pares de nome-valor especificados. Este endpoint não cria, atualiza ou exclui as relações associadas.

Formato da URL

URL com controle de versão: /api/now/v1/cmdb/instance/{className}/{sys_id}

URL padrão: /api/now/cmdb/instance/{className}/{sys_id}

Parâmetros de solicitação compatíveis

Tabela 41. Parâmetros de caminho

Nome	Descrição
className	CMDB nome da classe. Este é o nome da tabela que contém os registros de IC desejados, como cmdb_ci_linux_server ou cmdb_ci_apache_web_server. Tipo de dados: cadeia de caracteres
sys_id	Sys_id do registro de IC a ser atualizado. Tipo de dados: cadeia de caracteres

Tabela 42. Parâmetros de consulta

Nome	Descrição
Nenhum(a)

Tabela 43. Parâmetros do corpo da solicitação (XML ou JSON)

Nome	Descrição
atributos	Atributos de dados a serem substituídos no registro de IC. Os atributos disponíveis dependem da classe CMDB especificada. Você pode localizar os atributos disponíveis na tabela CMDB associada, que normalmente começa com "cmdb_ci", como cmdb_ci_linux_server ou cmdb_ci_mfp_printer. Tipo de dados: objeto
origem	Obrigatório. Entidade que atualizou as informações. Deve ser um dos valores de opção especificados no campo discovery_source na tabela Item de configuração [cmdb_ci]. 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 44. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json
Tipo de conteúdo	Formato de dados do corpo da solicitação. Tipos compatíveis: application/json ou application/xml. Padrão: application/json

Tabela 45. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum(a)

Códigos de status

Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.

Tabela 46. 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 não foram aprovadas.
404	Não encontrado. O item solicitado não foi encontrado.
405	Método inválido. A funcionalidade está desabilitada.
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)

Tabela 47. Parâmetros de resposta

Nome	Descrição
atributos	Atributos de dados atualmente no registro de IC. Os atributos disponíveis dependem da classe CMDB especificada. Você pode localizar os atributos disponíveis na tabela CMDB associada, que normalmente começa com "cmdb_ci", como cmdb_ci_linux_server ou cmdb_ci_mfp_printer. Tipo de dados: objeto
erro	Informações sobre erros encontrados ao processar a solicitação de endpoint. Tipo de dados: objeto "error": { "detail": "String", "message": "String" }
erro.detalhe	Informações adicionais sobre o erro. Tipo de dados: cadeia de caracteres
mensagem.erro	Mensagem que identifica o erro. Tipo de dados: cadeia de caracteres
inbound_relations	Lista de objetos que definem as relações de entrada associadas ao IC. Tipo de dados: matriz "inbound_relations": [ { "sys_id": "String", "target": {Object}, "type": {Object} } ]
inbound_relations.sys_id	Sys_id do relacionamento de IC de entrada. Localizado na tabela Relacionamento de IC [cmdb_rel_ci]. Tipo de dados: cadeia de caracteres
inbound_relations.target	Informações que descrevem a relação de entrada de destino. Tipo de dados: objeto "target": { "display_value": "String", "link": "String", "value": "String" }
inbound_relations.target.display_value	Nome da relação de entrada a ser exibida em uma interface do usuário. Tipo de dados: cadeia de caracteres
inbound_relations.target.link	CMDB URL do endpoint REST a ser usado para recuperar a relação de entrada da tabela Item de configuração [cmdb_ci]. Tipo de dados: cadeia de caracteres
inbound_relations.target.value	Sys_id do IC de entrada. Localizado na tabela Item de configuração [cmdb_ci]. Tipo de dados: cadeia de caracteres
inbound_relations.type	Informações sobre o tipo de relacionamento de entrada. Tipo de dados: objeto "type": { "display_value": "String", "link": "String", "value": "String" }
inbound_relations.type.display_value	Nome do tipo de entrada a ser exibido em uma interface do usuário. Tipo de dados: cadeia de caracteres
inbound_relations.type.link	URL do endpoint RESTda tabela a ser usado para recuperar o tipo de relação de entrada da tabela Tipo de relação de IC [cmdb_rel_type]. Tipo de dados: cadeia de caracteres
relações_de_entrada.tipo.valor	Sys_id do tipo de relacionamento de entrada. Localizado na tabela Tipo de relacionamento de IC [cmdb_rel_type]. Tipo de dados: cadeia de caracteres
relações_saídas	Lista de objetos que definem as relações de saída associadas ao IC. Tipo de dados: matriz "outbound_relations": [ { "sys_id": "String", "target": {Object}, "type": {Object} } ]
relações_saídas.sys_id	Sys_id do relacionamento de IC de saída. Localizado na tabela Relacionamento de IC [cmdb_rel_ci]. Tipo de dados: cadeia de caracteres
relações_saídas.destino	Obrigatório. Informações sobre a relação de saída de destino. Tipo de dados: objeto "target": { "display_value": "String", "link": "String", "value": "String" }
relações_saídas.target.display_value	Nome da relação de saída a ser exibida em uma interface do usuário. Tipo de dados: cadeia de caracteres
outbound_relations.target.link	CMDB URL do endpoint REST a ser usado para recuperar a relação de saída da tabela Item de configuração [cmdb_ci]. Tipo de dados: cadeia de caracteres
relações_saídas.target.value	Sys_id do IC de saída. Localizado na tabela Item de configuração [cmdb_ci]. Tipo de dados: cadeia de caracteres
relações_saídas.tipo	Informações sobre o tipo de relacionamento de saída. Tipo de dados: objeto "type": { "display_value": "String", "link": "String", "value": "String" }
relações_de_saída.tipo.valor_de_exibição	Nome do tipo de saída a ser exibido em uma interface do usuário. Tipo de dados: cadeia de caracteres
outbound_relations.type.link	URL do endpoint RESTda tabela a ser usado para recuperar a relação de saída da tabela Tipo de relacionamento de IC [cmdb_rel_type]. Tipo de dados: cadeia de caracteres
relações_de_saída.tipo.valor	Sys_id do tipo de relacionamento de saída. Localizado na tabela Tipo de relacionamento de IC [cmdb_rel_type]. Tipo de dados: cadeia de caracteres
status	Aparece somente se um erro for encontrado. Status do processamento do endpoint. Valor possível: falha Tipo de dados: cadeia de caracteres

Amostra de solicitação cURL

curl "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_class_sw/70bc4e11c0a8210d01f074cbe6bd73b4" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type:application/json"\
--user "username":"password"\
--data {
    "attributes": {
      "firewall_status": "Active",
      "name": "Linux299",
      "used_for": "Production"
    },
    "source": "ServiceNow"
}

{
  "result": {
    "outbound_relations": [
      {
        "sys_id": "403ff2641b425010593876a61a4bcb4b",
        "type": {
          "display_value": "Depends on::Used by",
          "link": "https://instance.servicenow.com/api/now/table/cmdb_rel_type/1a9cb166f1571100a92eb60da2bce5c5",
          "value": "1a9cb166f1571100a92eb60da2bce5c5"
        },
        "target": {
          "display_value": "PS ORA01",
          "link": "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci/3a307c930a0a0bb400353965d0b8861f",
          "value": "3a307c930a0a0bb400353965d0b8861f"
        }
      },
      {
        "sys_id": "443ff2641b425010593876a61a4bcb4c",
        "type": {
          "display_value": "Exchanges data with::Exchanges data with",
          "link": "https://instance.servicenow.com/api/now/table/cmdb_rel_type/607ad1b2c0a8010e01941856b365af90",
          "value": "607ad1b2c0a8010e01941856b365af90"
        },
        "target": {
          "display_value": "PS ORA01",
          "link": "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci/3a307c930a0a0bb400353965d0b8861f",
          "value": "3a307c930a0a0bb400353965d0b8861f"
        }
      }
    ],
    "attributes": {
      "firewall_status": "Active",
      "os_address_width": "",
      "attested_date": "",
      "operational_status": "1",
      "os_service_pack": "",
      "cpu_core_thread": "",
      "cpu_manufacturer": "",
      "sys_updated_on": "2020-07-13 21:24:05",
      "discovery_source": "ServiceNow",
      "first_discovered": "2020-07-13 20:27:28",
      "due_in": "",
      "used_for": "Production",
      "invoice_number": "",
      "gl_account": "",
      "sys_created_by": "dora.gray",
      "warranty_expiration": "",
      "ram": "",
      "cpu_name": "",
      "cpu_speed": "",
      "owned_by": "",
      "checked_out": "",
      "kernel_release": "",
      "sys_domain_path": "/",
      "classification": "Production",
      "disk_space": "",
      "object_id": "",
      "maintenance_schedule": "",
      "cost_center": "",
      "attested_by": "",
      "dns_domain": "",
      "assigned": "",
      "purchase_date": "",
      "life_cycle_stage": "",
      "short_description": "",
      "cd_speed": "",
      "floppy": "",
      "managed_by": "",
      "os_domain": "",
      "last_discovered": "2020-07-13 21:24:05",
      "can_print": "false",
      "sys_class_name": "cmdb_ci_linux_server",
      "manufacturer": "",
      "cpu_count": "",
      "vendor": "",
      "life_cycle_stage_status": "",
      "model_number": "",
      "assigned_to": "",
      "start_date": "",
      "os_version": "",
      "serial_number": "",
      "cd_rom": "false",
      "support_group": "",
      "unverified": "false",
      "correlation_id": "",
      "attributes": "",
      "asset": {
        "display_value": "Unknown",
        "link": "https://instance.servicenow.com/api/now/table/alm_asset/21cfba641b425010593876a61a4bcb52",
        "value": "21cfba641b425010593876a61a4bcb52"
      },
      "form_factor": "",
      "cpu_core_count": "",
      "skip_sync": "false",
      "attestation_score": "",
      "sys_updated_by": "dora.gray",
      "sys_created_on": "2020-07-13 20:27:28",
      "sys_domain": {
        "display_value": "global",
        "link": "https://instance.servicenow.com/api/now/table/sys_user_group/global",
        "value": "global"
      },
      "cpu_type": "",
      "install_date": "",
      "asset_tag": "",
      "dr_backup": "",
      "hardware_substatus": "",
      "fqdn": "",
      "change_control": "",
      "internet_facing": "true",
      "delivery_date": "",
      "hardware_status": "installed",
      "install_status": "1",
      "supported_by": "",
      "name": "Linux299",
      "subcategory": "Computer",
      "default_gateway": "",
      "chassis_type": "",
      "virtual": "false",
      "assignment_group": "",
      "managed_by_group": "",
      "sys_id": "0c3ff2641b425010593876a61a4bcb39",
      "po_number": "",
      "checked_in": "",
      "sys_class_path": "/!!/!2/!(/!!/!0",
      "mac_address": "",
      "company": "",
      "justification": "",
      "department": "",
      "cost": "",
      "comments": "",
      "os": "",
      "sys_mod_count": "4",
      "monitor": "false",
      "model_id": {
        "display_value": "Unknown",
        "link": "https://instance.servicenow.com/api/now/table/cmdb_model/0ce0a2681b4e1010593876a61a4bcba6",
        "value": "0ce0a2681b4e1010593876a61a4bcba6"
      },
      "ip_address": "",
      "duplicate_of": "",
      "sys_tags": "",
      "cost_cc": "USD",
      "order_date": "",
      "schedule": "",
      "environment": "",
      "due": "",
      "attested": "false",
      "location": "",
      "category": "Hardware",
      "fault_count": "0",
      "host_name": "",
      "lease_id": ""
    },
    "inbound_relations": [
      {
        "sys_id": "c03ff2641b425010593876a61a4bcb49",
         "type": {
           "display_value": "Depends on::Used by",
            "link": "https://instance.servicenow.com/api/now/table/cmdb_rel_type/1a9cb166f1571100a92eb60da2bce5c5",
            "value": "1a9cb166f1571100a92eb60da2bce5c5"
          },
          "target": {
            "display_value": "PS Apache01",
            "link": "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci/3a27d4370a0a0bb4006316812bf45439",
            "value": "3a27d4370a0a0bb4006316812bf45439"
          }
        }
      ]
    }
}