CMDB Meta-API

  • Freigeben Version: Xanadu
  • Aktualisiert 1. August 2024
  • 3 Minuten Lesedauer

    • Die CMDB-Meta -API stellt Endpunkte zum Abrufen von Metadaten in einer Klasse Configuration Management Database (CMDB) bereit.

    Diese API erfordert, dass der Benutzer über die ITIL-Rolle verfügt.

    CMDB Meta – GET /now/cmdb/meta/{classname}

    gibt die Metadaten für die angegebene Klasse CMDB zurück.

    URL-Format

    URL mit Versionsnummer: /api/now/{api_version}/cmdb/meta/{className}

    Standard-URL: /api/now/cmdb/meta/{className}

    Unterstützte Anforderungsparameter

    Tabelle : 1. Pfadparameter
    Name Beschreibung
    api_version Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden.

    Datentyp: Zeichenfolge
    className CMDB Klassenname Dies ist der Name der Tabelle, die die gewünschten CI-Datensätze enthält, z. B. cmdb_ci_linux_server oder cmdb_ci_apache_web_server.

    Datentyp: Zeichenfolge
    Tabelle : 2. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 3. Anforderungstextparameter (XML oder JSON)
    Name Beschreibung
    Keine

    Kopfzeilen

    Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST API-Header.

    Tabelle : 4. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml.

    Standard: application/json
    Tabelle : 5. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter HTTP-Antwortcodesder REST-API.

    Tabelle : 6. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    401 Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.
    404 Nicht gefunden. Das angeforderte Element wurde nicht gefunden.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Parameter des Antworttexts (JSON oder XML)

    Element Beschreibung
    attributes Verfügbare Felder in der angegebenen Klassentabelle.

    Datentyp: Array
    untergeordnete Elemente Liste der Klassen, die aus der angegebenen Klasse erweitert wurden.

    Datentyp: Array
    icon sys_id des Klassensymbols.

    Datentyp: Zeichenfolge
    icon_url URL des Klassensymbols.

    Datentyp: Zeichenfolge
    identification_rules Attribute, die den Identifizierungsregeln für Konfigurationselemente für die angegebene Klasse zugeordnet sind.

    Datentyp: Objekt
    is_extendable Kennzeichnung, die angibt, ob die Klasse erweitert werden kann, um andere Klassen zu erstellen.
    Mögliche Werte:
    • wahr: Klasse kann erweitert werden.
    • false: Klasse kann nicht erweitert werden.

    Datentyp: Boolesch
    label Anzeigename der angegebenen Klasse.

    Datentyp: Zeichenfolge
    name Tabellen-/Klassenname.

    Datentyp: Zeichenfolge
    übergeordnet Übergeordnete Klasse.

    Datentyp: Zeichenfolge
    relationship_rules Beziehungen zwischen der angegebenen Klasse und anderen Klassen in CMDB.

    Datentyp: Array

    Beispiel für eine cURL-Anforderung

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

    {
  "result": {
    "icon_url": "images/app.ngbsm/computer.svg",
    "is_extendable": true,
    "parent": "cmdb_ci_hardware",
    "children": [
      "cmdb_ci_ucs_blade",
      "cmdb_ci_pc_hardware",
      "cmdb_ci_ucs_rack_unit",
      "cmdb_ci_mainframe_hardware",
      "cmdb_ci_server",
      "cmdb_ci_storage_switch"
    ],
    "name": "cmdb_ci_computer",
    "icon": "c6442dd69fb00200eb3919eb552e7012",
    "attributes": [
      {
        "is_inherited": "false",
        "is_mandatory": "false",
        "is_read_only": "false",
        "default_value": null,
        "label": "OS Address Width (bits)",
        "type": "integer",
        "element": "os_address_width",
        "max_length": "40",
        "is_display": "false"
      },
      {
        "is_inherited": "true",
        "is_mandatory": "false",
        "is_read_only": "true",
        "default_value": "false",
        "label": "Skip sync",
        "type": "boolean",
        "element": "skip_sync",
        "max_length": "40",
        "is_display": "false"
      },
      {
        "is_inherited": "true",
        "is_mandatory": "false",
        "is_read_only": "false",
        "default_value": null,
        "label": "DNS Domain",
        "type": "string",
        "element": "dns_domain",
        "max_length": "255",
        "is_display": "false"
      },
      {
        "is_inherited": "true",
        "is_mandatory": "false",
        "is_read_only": "false",
        "default_value": null,
        "label": "Purchased",
        "type": "glide_date",
        "element": "purchase_date",
        "max_length": "40",
        "is_display": "false"
      },
      {
        "is_inherited": "true",
        "is_mandatory": "false",
        "is_read_only": "false",
        "default_value": null,
        "label": "Lease contract",
        "type": "string",
        "element": "lease_id",
        "max_length": "40",
        "is_display": "false"
      }
    ],
    "relationship_rules": [
      {
        "parent": "cmdb_ci_computer",
        "relation_type": "cb5592603751200032ff8c00dfbe5d17",
        "child": "dscy_route_next_hop"
      },
      {
        "parent": "cmdb_ci_computer",
        "relation_type": "cb5592603751200032ff8c00dfbe5d17",
        "child": "dscy_router_interface"
      },
      {
        "parent": "cmdb_ci_computer",
        "relation_type": "cb5592603751200032ff8c00dfbe5d17",
        "child": "dscy_route_interface"
      },
      {
        "parent": "cmdb_ci_computer",
        "relation_type": "55c95bf6c0a8010e0118ec7056ebc54d",
        "child": "cmdb_ci_storage_pool"
      },
      {
        "parent": "cmdb_ci_computer",
        "relation_type": "55c95bf6c0a8010e0118ec7056ebc54d",
        "child": "cmdb_ci_disk_partition"
      },
      {
        "parent": "cmdb_ci_computer",
        "relation_type": "55c95bf6c0a8010e0118ec7056ebc54d",
        "child": "cmdb_ci_storage_volume"
      },
      {
        "parent": "cmdb_ci_computer",
        "relation_type": "55c95bf6c0a8010e0118ec7056ebc54d",
        "child": "cmdb_ci_storage_device"
      }
    ],
    "label": "Computer",
    "identification_rules": {
      "related_rules": [
        {
          "condition": "",
          "exact_count_match": false,
          "referenced_field": "installed_on",
          "active": true,
          "attributes": "name",
          "allow_fallback": false,
          "table": "cmdb_print_queue_instance",
          "order": 100,
          "allow_null_attribute": false
        }
      ],
      "applies_to": "cmdb_ci_hardware",
      "identifiers": [
        {
          "condition": "valid=true^absent=false^EQ",
          "exact_count_match": true,
          "referenced_field": "cmdb_ci",
          "active": true,
          "attributes": "serial_number,serial_number_type",
          "allow_fallback": false,
          "table": "cmdb_serial_number",
          "order": 100,
          "allow_null_attribute": false
        },
        {
          "condition": null,
          "exact_count_match": false,
          "referenced_field": null,
          "active": true,
          "attributes": "serial_number",
          "allow_fallback": false,
          "table": null,
          "order": 200,
          "allow_null_attribute": false
        },
        {
          "condition": null,
          "exact_count_match": false,
          "referenced_field": null,
          "active": true,
          "attributes": "name",
          "allow_fallback": false,
          "table": null,
          "order": 300,
          "allow_null_attribute": false
        },
        {
          "condition": "install_status!=100^EQ",
          "exact_count_match": true,
          "referenced_field": "cmdb_ci",
          "active": true,
          "attributes": "ip_address,mac_address",
          "allow_fallback": false,
          "table": "cmdb_ci_network_adapter",
          "order": 400,
          "allow_null_attribute": false
        }
      ],
      "name": "Hardware Rule",
      "description": "Identifier for hardware.",
      "active": true,
      "is_independent": true
    }
  }
}