Anwendungsservice-API

  • Freigeben Version: Australia
  • Aktualisiert 12. März 2026
  • 15 Minuten Lesedauer

    • Die Anwendungsservice Die API stellt Endpunkte bereit, mit denen Sie Anwendungsservices erstellen, ändern und aktualisieren können.

    Diese API erfordert, dass der Anwender über die Rolle „Anwendungsservice-Administrator“ [App_Service_admin] verfügt.

    Wichtig:
    Beginnend mit Rome Release, die Anwendungsservice API wird nicht mehr erweitert oder unterstützt. Weitere Informationen finden Sie im Artikel Deprecation Process [KB0867184] (Abkündigungsprozess) in der Now Support Knowledge Base.

    Anwendungsservice – RUFT /now/cmdb/App_Service/{sys_ID}/getContent AB

    Ruft eine Liste von Konfigurationselementen (CI) in einem zugeordneten Anwendungsservice und die Beziehungen zwischen ihnen ab. Ruft nur Inhalte für Services ab, die manuell erstellt wurden.

    URL-Format

    Standard-URL: /api/now/cmdb/App_Service/{sys_ID}/getContent

    Unterstützte Anforderungsparameter

    Tabelle : 1. Pfad-Parameter
    Name Beschreibung
    sys_id SYS_ID des zugeordneten Anwendungsservice.

    Datentyp: Zeichenfolge

    Tabelle: Zugeordneter Anwendungsservice [cmdb_ci_service_discovered]
    Tabelle : 2. Abfrageparameter
    Name Beschreibung
    Modus Menge der zurückzugebenden Beziehungsdaten.
    Gültige Werte:
    • Vollständig: Gibt CI-Attribute und Suchinformationen zusätzlich zu den im flachen Modus zurückgegebenen Daten zurück.
    • Flach: Gibt übergeordnete und untergeordnete Beziehungen zwischen CIs innerhalb eines Service zurück.
    Bei den Werten wird die Groß-/Kleinschreibung nicht beachtet.

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

    Header

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

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

    Standard: application/json
    Tabelle : 5. Antwortkopfzeilen
    Header 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 REST-API-HTTP-Antwortcodes .

    Tabelle : 6. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    400 Ungültige Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
    401 Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder haben nicht die Rolle „App_Service_admin“.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler.

    Antworttext-Parameter (JSON oder XML)

    Name Beschreibung
    cmdb Liste von Objekten, die die CIs beschreiben, die dem angegebenen Anwendungsservice zugeordnet sind.

    Datentyp: Objekt

    "cmdb": [
  {
    "items": {Object},
    "relations": [Array]
  }
]
    cmdb.items CIs innerhalb des Anwendungsservice. Wenn der vollständige Abfrageparameter in der Anforderung übergeben wurde, enthält dieser Abschnitt Attribute und Suchinformationen für jedes CI.

    Datentyp: Array

    "items": [
  {
    "className": "String",
    "values": {Object}
  }
]
    cmdb.items.className Name der Klasse, die das CI enthält.

    Datentyp: Zeichenfolge
    cmdb.items.values Informationen, die zum Auffinden eines zugeordneten CI verwendet werden sollen.

    Datentyp: Objekt

    "values": {
  "name": "String",
  "sys_id": "String"
}
    cmdb.items.values.name Name des CI.

    Datentyp: Zeichenfolge
    cmdb.items.values.sys_id SYS_ID des CI.

    Datentyp: Zeichenfolge
    cmdb.Beziehungen Beziehungsdaten für zugeordnete CIs, z. B. Hosts und ihre untergeordneten Elemente.

    Datentyp: Array
    service Liste der Services im Zusammenhang mit dem identifizierten Service.

    Datentyp: Array von Objekten

    "service": [
  {
    "name": "String",
    "service_relations": [Array],
    "url": "String"
  }
]
    service.name Name des Anwendungsservice.

    Datentyp: Zeichenfolge
    service.service_relations Hierarchiedaten für die CIs innerhalb des Anwendungsservice. Alle CIs bilden Paare mit einem übergeordneten und einem untergeordneten CI. Das CI der obersten Ebene, das als Einstiegspunkt eines Anwendungsservice bezeichnet wird, hat kein übergeordnetes CI.

    Datentyp: Array von Objekten

    "service_relations": [
  {
    "child": "String",
    "parent": "String"
  }
]
    service.service_relations.child Name eines untergeordneten CI, das sich auf das CI bezieht.

    Datentyp: Zeichenfolge
    service.service_relations.parent Name eines übergeordneten CI, das sich auf das CI bezieht.

    Datentyp: Zeichenfolge
    Service.url Relativer Pfad zum Anwendungsservice.

    Datentyp: Zeichenfolge

    Beispiel für Curl-Anforderung

    curl "https://instance.servicenow.com/api/now/cmdb/app_service/2fce42d80a0a0bb4004af34d7e3984c8/getContent?mode=shallow" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'
    {
  "service": {
    "name": "PeopleSoft Portals",
    "url": "/api/now/table/cmdb_ci_service_discovered/2fce42d80a0a0bb4004af34d7e3984c8",
    "service_relations": [
      {
        "parent": "",
        "child": "3a2810c20a0a0bb400268337d6e942ca"
      },
      {
        "parent": "3a27f1520a0a0bb400ecd6ff7afcf036",
        "child": "3a5dd3dbc0a8ce0100655f1ec66ed42c"
      },
      {
        "parent": "3a290cc60a0a0bb400000bdb386af1cf",
        "child": "3a307c930a0a0bb400353965d0b8861f"
      },
      {
        "parent": "3a172e820a0a0bb40034228e9f65f1be",
        "child": "3a27d4370a0a0bb4006316812bf45439"
      },
      {
        "parent": "",
        "child": "3a172e820a0a0bb40034228e9f65f1be"
      },
      {
        "parent": "",
        "child": "3a27f1520a0a0bb400ecd6ff7afcf036"
      },
      {
        "parent": "3a2810c20a0a0bb400268337d6e942ca",
        "child": "3a290cc60a0a0bb400000bdb386af1cf"
      }
    ]
  },
  "cmdb": {
    "relations": [],
    "items": [
      {
        "values": {
          "sys_id": "3a172e820a0a0bb40034228e9f65f1be",
          "name": "PS LoadBal01"
        },
        "className": "cmdb_ci_win_server"
      },
      {
        "values": {
          "sys_id": "3a2810c20a0a0bb400268337d6e942ca",
          "name": "PS Apache03"
        },
        "className": "cmdb_ci_web_server"
      },
      {
        "values": {
          "sys_id": "55b35562c0a8010e01cff22378e0aea9",
          "name": "ny8500-nbxs08"
        },
        "className": "cmdb_ci_netgear"
      },
      {
        "values": {
          "sys_id": "3a27f1520a0a0bb400ecd6ff7afcf036",
          "name": "PS Apache02"
        },
        "className": "cmdb_ci_web_server"
      },
      {
        "values": {
          "sys_id": "3a307c930a0a0bb400353965d0b8861f",
          "name": "PS ORA01"
        },
        "className": "cmdb_ci_database"
      }
    ]
  }
}

    Anwendungsservice – GET /now/cmdb/csdm/App_Service/find_Service

    Gibt grundlegende Informationen zu einem angegebenen Anwendungsservice und dem zugehörigen Geschäftskontext zurück.

    Hinweis:
    Dieser Endpunkt ist veraltet, verwenden Sie SG Services – POSTEN /sg_Services/App_Service/find Stattdessen.

    URL-Format

    Standard-URL: /api/now/cmdb/csdm/App_Service/find_Service

    Unterstützte Anforderungsparameter

    Tabelle : 7. Pfad-Parameter
    Name Beschreibung
    Keine
    Tabelle : 8. Abfrageparameter
    Name Beschreibung
    Name Erforderlich, wenn numberWird nicht übergeben. Name des Service, für den Informationen zurückgegeben werden sollen.

    Datentyp: Zeichenfolge

    Tabelle: Serviceinstanz [cmdb_ci_service_auto]
    Nummer Erforderlich, wenn nameWird nicht übergeben. Eindeutige Nummer, die den Anwendungsservice identifiziert, für den Informationen zurückgegeben werden sollen.

    Datentyp: Zeichenfolge

    Tabelle: Serviceinstanz [cmdb_ci_service_auto]
    Tabelle : 9. Anforderungstextparameter (XML oder JSON)
    Name Beschreibung
    Keine

    Header

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

    Tabelle : 10. Anforderungskopfzeilen.
    Header Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützt nur application/json.
    Tabelle : 11. Antwortkopfzeilen
    Header 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 REST-API-HTTP-Antwortcodes .

    Tabelle : 12. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    400 Ungültige Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
    401 Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder haben nicht die Rolle „App_Service_admin“.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler.

    Antworttext-Parameter (JSON oder XML)

    Name Beschreibung
    Fehler Beschreibt einen aufgetretenen Fehler.

    Datentyp: Objekt

    "error": {
  "details": "String",
  "message": "String"
}
    error.details Zusätzliche Informationen zum Fehler.

    Datentyp: Zeichenfolge
    Fehler.Nachricht Nachricht, die den Fehler beschreibt.

    Datentyp: Zeichenfolge
    -Services Array von Objekten, wobei jedes Objekt Details zu Services enthält, die dem angegebenen Anwendungsservice zugeordnet sind.

    Datentyp: Array

    "services": [
  {
    "environment": "String",
    "name": "String",
    "number": "String",
    "relationships": {Object},
    "sys_id": "String",
    "version": "String"
  }
]
    Services.Umgebung Umgebung, in der der Anwendungsservice bereitgestellt wird, z. B. „Produktion“ oder „Testlabor 2“. Dies kann ein beliebiger Wert sein, der für den Implementierer sinnvoll ist.

    Datentyp: Zeichenfolge

    Maximale Länge: 40

    Standard: Null
    services.name Erforderlich. Name des Anwendungsservice. Muss ein eindeutiger Name aus allen anderen Anwendungsservices sein.

    Datentyp: Zeichenfolge

    Maximale Länge: 255
    Services.Nummer Eindeutige Nummer, die den Anwendungsservice identifiziert. Dieser Wert wird anfänglich vom Endpunkt generiert.

    Datentyp: Zeichenfolge
    Services.Beziehungen Servicetypen, die dem Anwendungsservice zugeordnet sind.

    Datentyp: Objekt

    "relationships": {
  "business_app": [Array],
  "business_service_offering": [Array],
  "technical_service_offering": [Array]
}
    Services.Beziehungen.Business_App Liste der sys_IDs der Geschäftsanwendungen, die sich auf den Anwendungsservice beziehen.

    Datentyp: Array
    Services.Beziehungen.Technical_Service_Offering Liste der sys_IDs der Technologiemanagement-Angebote (ehemals technische Serviceangebote) im Zusammenhang mit dem Anwendungsservice.

    Datentyp: Array
    Services.Beziehungen.Business_Service_Offering Liste der sys_IDs der Business-Serviceangebote, die sich auf den Anwendungsservice beziehen.

    Datentyp: Array
    Services.sys_ID SYS_ID des Anwendungsservice.

    Datentyp: Zeichenfolge
    Services.Version Versionsnummer des Anwendungsservice.

    Datentyp: Zeichenfolge

    Maximale Länge: 40

    Format: Anwenderdefinierbar

    Standard: Null

    Beispiel für Curl-Anforderung

    curl -X GET \
  https://instance.servicenow.com/api/now/cmdb/csdm/app_service/find_service?name=Email_East&number=SNSVC0001018 \
  -H 'Accept: application/json' \
  -u 'username':'password'

    {
"result": {
  "services": [
    {
      "name": "Email_East",
      "number": "SNSVC0001018",
      "sys_id": "f809cb60db94101037740f95ca96190f",
      "environment": "Production",
      "version": "1.1.1",
      "relationships": {
        "business_app": [
          "658c7620db54101037740f95ca9619f2"
        ],
        "technical_service_offering": [],
        "business_service_offering": [
          "069c7e20db54101037740f95ca9619bf"
        ]
      }
    }
  ]
 }
}

    Anwendungsservice – POSTEN SIE /now/cmdb/App_Service/create

    Erstellt einen Anwendungsservice oder aktualisiert einen vorhandenen Anwendungsservice.

    URL-Format

    Standard-URL: /api/now/cmdb/App_Service/create

    Unterstützte Anforderungsparameter

    Tabelle : 13. Parameter
    Parameter Beschreibung
    Keine

    Header

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

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

    Standard: application/json
    Inhaltstyp Datenformat des Anforderungstexts. Unterstützte Typen: application/json oder application/xml.

    Standard: application/json
    Tabelle : 15. Antwortkopfzeilen
    Header Beschreibung
    Keine

    Statuscodes

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

    Tabelle : 16. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    400 Ungültige Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
    401 Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben.

    Anforderungstext

    Die API akzeptiert diese JSON-Elemente im Anforderungstext. Darüber hinaus können Sie ein beliebiges Feld aus der Tabelle „zugeordneter Anwendungsservice“ [cmdb_ci_service_discovered] hinzufügen, um Daten an den Anwendungsservice-Datensatz zu übergeben. Um dem Feld „Kommentare“ beispielsweise Inhalte hinzuzufügen, fügen Sie hinzu „Kommentare“: „Daten an das Kommentarfeld übergeben“ An die JSON-Anforderung.

    Tabelle : 17. Im Anforderungstext akzeptierte Elemente
    Element Beschreibung
    Name Name des Anwendungsservice, den Sie erstellen oder aktualisieren möchten.
    Service_Relations Informationen zu CIs und der Hierarchie, die sie bilden. Alle CIs bilden Paare mit einem übergeordneten CI und einem untergeordneten CI. Das CI der obersten Ebene, das als Einstiegspunkt eines Anwendungsservice bezeichnet wird, hat kein übergeordnetes CI.
    übergeordnet SYS_-ID des CI, dessen ausgehende Verbindung dieses CI mit dem CI auf der unteren Ebene in der Zuordnungshierarchie verbindet.
    child SYS_-ID des CI, dessen eingehende Verbindung mit diesem CI mit dem CI auf der höheren Ebene in der Zuordnungshierarchie verbunden ist.

    Antworttext

    Die API gibt diese JSON-Elemente im Antworttext zurück.

    Tabelle : 18. Elemente, die im Antworttext zurückgegeben werden
    Element Beschreibung
    URL URL der Standard-Tabellen-REST-API zum Anzeigen der sys_ID eines Anwendungsservice-Datensatzes.

    Dieses Element wird nur angezeigt, wenn der Endpunkt erfolgreich ist.

    Datentyp: Zeichenfolge
    GetContentUrl REST-API-Pfad zum Abrufen des Anwendungsservice-Inhalts.

    Dieses Element wird nur angezeigt, wenn der Endpunkt erfolgreich ist.

    Datentyp: Zeichenfolge
    Info Anzahl der CIs, die dem Anwendungsservice hinzugefügt wurden.

    Dieses Element wird nur angezeigt, wenn der Endpunkt erfolgreich ist.

    Datentyp: Zeichenfolge
    Fehler Fehlermeldungsdetails.

    Dieses Element wird nur angezeigt, wenn der Endpunkt fehlschlägt.

    Datentyp: Objekt
    Nachricht Fehlermeldung, die die Art des Fehlers beschreibt.

    Dieses Element wird nur angezeigt, wenn der Endpunkt fehlschlägt.

    Datentyp: Zeichenfolge
    Status Gibt „Fehler“ an, wenn die REST-API fehlschlägt.

    Dieses Element wird nur angezeigt, wenn der Endpunkt fehlschlägt.

    Datentyp: Zeichenfolge

    Beispiel für Curl-Anforderung

    curl "http://<instance.servicenow.com>/api/now/cmdb/app_service/create" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
\"name\": \"myTestAppService\",
\"comments\": \"Passing data to the Comments field\",
\"service_relations\": [
{ \"parent\": \"\",
\"child\": \"3a70f789c0a8ce010091b0ea635b982a\"
},{ \"parent\": \"3a70f789c0a8ce010091b0ea635b982a\",
\"child\": \"b4fd7c8437201000deeabfc8bcbe5dc1\"
},{ \"parent\": \"b4fd7c8437201000deeabfc8bcbe5dc1\",
\"child\": \"53fdbc8437201000deeabfc8bcbe5d10\"
}
]
}" \
--user 'admin':'admin'
    {
  "result": {
    "url": "/api/now/table/cmdb_ci_service_discovered/b1cff89fc9e19300964fcbb1ac3059a5",
    "getContentUrl": "/api/now/cmdb/app_service/b1cff89fc9e19300964fcbb1ac3059a5/getContent",
    "info": "3 CIs added to service"
  }
}

    Anwendungsservice – POSTEN SIE /now/cmdb/csdm/App_Service/Register_Service

    Erstellt einen Anwendungsservice-Datensatz-Stub in der Tabelle „Serviceinstanz“ [cmdb_ci_service_auto] und füllt ihn mit den übergebenen Informationen aus.

    Vor dem Speichern des Datensatzes werden die übergebenen Parameter und die Eindeutigkeit des Anwendungsservicenamens validiert. Außerdem werden vorgelagerte Beziehungen erstellt, die dem Service Geschäftskontext bieten, indem die angegebenen Geschäftsanwendungen, Geschäftsserviceangebote und Technologiemanagement-Angebote (früher technische Serviceangebote) zugeordnet werden. Zur Serviceanwendung. Es werden keine nachgelagerten Beziehungen zur Infrastruktur erstellt. Zum Definieren nachgelagerter Beziehungen müssen Sie aufrufen Anwendungsservice – PUT /now/cmdb/csdm/App_Service/{Service_sys_ID}/populate_Service Endpunkt.
    Hinweis:
    Dieser Endpunkt ist veraltet, verwenden Sie SG Services: /sg_Services/App_Service/Register VERÖFFENTLICHEN Stattdessen.

    URL-Format

    Standard-URL: /api/now/cmdb/csdm/App_Service/Register_Service

    Unterstützte Anforderungsparameter

    Tabelle : 19. Pfad-Parameter
    Name Beschreibung
    Keine
    Tabelle : 20. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 21. Anforderungstext-Parameter
    Name Beschreibung
    Basic_Details Erforderlich. Details des Service, der dem angegebenen Anwendungsservice zugeordnet ist.

    Datentyp: Objekt

    "basic_details": {
  "environment": "String",
  "name": "String",
  "version": "String"
}
    Basic_Details.Environment Umgebung, in der der Anwendungsservice bereitgestellt wird, z. B. „Produktion“ oder „Testlabor 2“. Dies kann ein beliebiger Wert sein, der für den Implementierer sinnvoll ist.

    Datentyp: Zeichenfolge

    Maximale Länge: 40

    Standard: Null
    basic_details.name Erforderlich. Name des Anwendungsservice. Muss ein eindeutiger Name aus allen anderen Anwendungsservices sein.

    Datentyp: Zeichenfolge

    Maximale Länge: 255
    Basic_Details.Version Versionsnummer des Anwendungsservice.

    Datentyp: Zeichenfolge

    Maximale Länge: 40

    Format: Anwenderdefinierbar

    Standard: Null
    Beziehungen Vorgelagerte (übergeordnete) Servicetypen, die dem Anwendungsservice zugeordnet werden sollen.

    Datentyp: Objekt

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

    Tabelle: CI-Beziehungen [cmdb_rel_ci]
    Beziehungen.Business_App Liste der sys_IDs der Geschäftsanwendungen, die mit dem Anwendungsservice verknüpft werden sollen.

    Datentyp: Array
    Beziehungen.Business_Service_Offering Liste der sys_IDs der Business-Serviceangebote, die mit dem Anwendungsservice verknüpft werden sollen.

    Datentyp: Array
    Beziehungen.Technical_Service_Offering Liste der sys_IDs der technischen Serviceangebote, die mit dem Anwendungsservice verknüpft werden sollen.

    Datentyp: Array

    Header

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

    Tabelle : 22. Anforderungskopfzeilen.
    Header Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützt nur application/json.
    Inhaltstyp Datenformat des Anforderungstexts. Unterstützt nur application/json.
    Tabelle : 23. Antwortkopfzeilen
    Header 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 REST-API-HTTP-Antwortcodes .

    Tabelle : 24. Statuscodes
    Statuscode Beschreibung
    201 Erfolgreich. Der Anwendungsservice wurde erfolgreich registriert.
    400 Ungültige Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
    401 Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder haben nicht die Rolle „App_Service_admin“.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler.

    Antworttext-Parameter (JSON oder XML)

    Name Beschreibung
    Fehler Beschreibt einen aufgetretenen Fehler.

    Datentyp: Objekt

    "error": {
  "details": "String",
  "message": "String"
}
    error.details Zusätzliche Informationen zum Fehler.

    Datentyp: Zeichenfolge
    Fehler.Nachricht Nachricht, die den Fehler beschreibt.

    Datentyp: Zeichenfolge
    Nummer Eindeutige Nummer, die den Anwendungsservice identifiziert. Diese Zahl wird vom Endpunkt generiert.

    Datentyp: Zeichenfolge
    Service_sys_ID SYS_ID des registrierten Anwendungsservice.

    Datentyp: Zeichenfolge

    Beispiel für Curl-Anforderung

    curl -X POST \
  https://instance.servicenow.com/api/now/cmdb/csdm/app_service/register_service \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -u 'username':'password'
  -d '{
  "basic_details": {
    "environment": "Test Lab 2",
    "name": "Test Lab 2",
    "version": "1.1.1"
  },
  "relationships": {
    "business_app":["f07c7620db54101037740f95ca96199a"],
    "business_service_offering":["069c7e20db54101037740f95ca9619bf"]
  }
}'
    {
  "result": {
    "service_sys_id": "80f21bbadbd410103d3a93c3e296199a",
    "number": "SNSVC0001018"    
  }
}

    Anwendungsservice – PUT /now/cmdb/csdm/App_Service/{Service_sys_ID}/populate_Service

    Füllt den angegebenen Anwendungsservice mit einem angegebenen Satz nachgelagerter Konfigurationselemente (CI) aus.

    Bevor Sie diesen Endpunkt aufrufen, müssen Sie aufrufen VERÖFFENTLICHEN SIE /now/cmdb/csdm/App_Service/Register_Service Endpunkt zum Erstellen des Anwendungsservice.
    Hinweis:
    Dieser Endpunkt ist veraltet, verwenden Sie SG Services: VERÖFFENTLICHEN SIE /sg_Services/App_Service/ausfüllen Stattdessen.

    URL-Format

    Standard-URL: /api/now/cmdb/csdm/App_Service/{Service_sys_ID}/populate_Service

    Unterstützte Anforderungsparameter

    Tabelle : 25. Pfad-Parameter
    Name Beschreibung
    Service_sys_ID SYS_ID des Anwendungsservice, der mit den angegebenen CIs ausgefüllt werden soll.

    Datentyp: Zeichenfolge

    Tabelle: Serviceinstanz [cmdb_ci_service_auto]
    Tabelle : 26. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 27. Anforderungstextparameter (XML oder JSON)
    Name Beschreibung
    Population_method CIs, die dem angegebenen Anwendungsservice zugeordnet werden sollen. Die Elemente in population_methodDas Objekt hängt vom Typ der auszufüllenden Informationen ab, die von definiert werden typeParameter.

    Datentyp: Objekt

    Für type= cmdb_Group_Based

    "population_method": {
  "group_id": "String",
  "type": "String"
}
    Für type= Discovery
    Hinweis:
    Zur Verwendung dieses Typs müssen Sie das Plugin „Servicezuordnung“ (com.snc.service-mapping) aktivieren.
    "population_method": {
  "attributes": [Array],
  "entry_point_id": "String",
  "type": "String"
}
    Für type= Tag_Liste
    Hinweis:
    Zur Verwendung dieses Typs müssen Sie das Plugin „Servicezuordnung“ (com.snc.service-mapping) aktivieren.
    "population_method": {
  "tags": [Array],
  "type": "String"
}
    Population_method.attributes Liste der Attribute, die dem CI zugeordnet werden sollen, z. B. Host, Port, Name und URL.
    Hinweis:
    Sie müssen alle erforderlichen Attribute übergeben.

    Datentyp: Array

    "attributes": {
  "name":"String",
  "value":"String"
}
    population_method.attributes.name Name des Attributs, z. B. Host, Port, Name und URL.

    Datentyp: Zeichenfolge
    Population_method.attributes.value Attributwert.

    Datentyp: Zeichenfolge
    Population_method.entry_Point Erforderlich, wenn population_method.type= Discovery. Einstiegspunkt in den Anwendungsservice. Weitere Informationen zu Einstiegspunkten finden Sie unter Einstiegspunkt-Attribute Und Erstellen Sie Einstiegspunkttypen für die Servicezuordnung .

    Datentyp: Zeichenfolge
    population_method.group_id Erforderlich, wenn population_method.type= cmdb_Group_Based. SYS_ID der Gruppe, die dem CI zugeordnet werden soll.

    Datentyp: Zeichenfolge

    Titel: CMDB-Gruppe [cmdb_Group]
    Population_method.Tags Liste der Tags, die dem CI zugeordnet werden sollen.

    Datentyp: Array von Objekten

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

    Titel: Schlüsselwerte [cmdb_key_value]
    Population_method.Tags.Tag Name des Tags.

    Datentyp: Zeichenfolge
    Population_method.Tags.value Tag-Wert.

    Datentyp: Zeichenfolge
    Population_method.type Erforderlich. Typ des auszufüllenden CI.
    Gültige Werte:
    • cmdb_Group_based
    • Discovery
    • Tag_Liste

    Datentyp: Zeichenfolge

    Header

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

    Tabelle : 28. Anforderungskopfzeilen.
    Header Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützt nur application/json.
    Inhaltstyp Datenformat des Anforderungstexts. Unterstützt nur application/json.
    Tabelle : 29. Antwortkopfzeilen
    Header 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 REST-API-HTTP-Antwortcodes .

    Tabelle : 30. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    401 Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder haben nicht die Rolle „App_Service_admin“.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten.

    Antworttext-Parameter (JSON oder XML)

    Name Beschreibung
    Fehler Beschreibt einen aufgetretenen Fehler.

    Datentyp: Objekt

    "error": {
  "details": "String",
  "message": "String"
}
    error.details Zusätzliche Informationen zum Fehler.

    Datentyp: Zeichenfolge
    Fehler.Nachricht Nachricht, die den Fehler beschreibt.

    Datentyp: Zeichenfolge

    Beispiel für Curl-Anforderung

    Das folgende Codebeispiel zeigt, wie ein Anwendungsservice ausgefüllt wird, wenn der CI-Typ „cmdb_Group_Based“ ist.

    curl -X PUT \
  https://instance.servicenow.com/api/now/cmdb/csdm/app_service/f809cb60db94101037740f95ca96190f/populate_service \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -u 'username':'password' \
  -d '{
  "population_method": {
    "type":"cmdb_group_based",
    "group_id": "e809cf60db94101037640f95ca961932"
  }
}'
    {
    "result": {}
}

    Das folgende Codebeispiel zeigt, wie ein Discovery-Anwendungsservice ausgefüllt wird.

    curl -X PUT \
  https://instance.servicenow.com/api/now/cmdb/csdm/app_service/f809cb60db94101037740f95ca96190f/populate_service \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -u 'username':'password' \
  -d '{
  "population_method": {
    "type":"discovery",
    "entry_point_id":"cmdb_ci_endpoint_ad_forest",
    "attributes": [
      {
        "name":"host",
        "value":"test1.com"
      },
      {
        "name":"port",
        "value":"500"
      },
      {
        "name":"protocol",
        "value":"ssh"
      }
    ]
  }
}'
    {
    "result": {}
}

    Anwendungsservice – PUT /now/cmdb/csdm/App_Service/{Service_sys_ID}/Service_Details

    Aktualisiert den angegebenen Anwendungsservice mit den übergebenen Basisinformationen.

    Sie validiert auch die Eindeutigkeit des Anwendungsservice, indem die übergebenen Informationen mit den Regeln der Identifizierungs- und Abgleichsmodul (Ire) verglichen werden, die in der Anwendungsserviceklasse definiert sind.
    Hinweis:
    Dieser Endpunkt ist veraltet, verwenden Sie SG Services – NACH /sg_Services/App_Service/Update Stattdessen.

    URL-Format

    Standard-URL: /api/now/cmdb/csdm/App_Service/{Service_sys_ID}/Service_Details

    Unterstützte Anforderungsparameter

    Tabelle : 31. Pfad-Parameter
    Name Beschreibung
    Service_sys_ID SYS_ID des zu aktualisierenden Anwendungsservice.

    Datentyp: Zeichenfolge

    Tabelle: Serviceinstanz [cmdb_ci_service_auto]
    Tabelle : 32. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 33. Anforderungstextparameter (XML oder JSON)
    Name Beschreibung
    Basic_Details Details des Service, der dem angegebenen Anwendungsservice zugeordnet ist.

    Datentyp: Objekt

    "basic_details": {
  "environment": "String",
  "name": "String"
}
    Basic_Details.Environment Umgebung, in der der Anwendungsservice bereitgestellt wird, z. B. „Produktion“ oder „Testlabor 2“. Dies kann ein beliebiger Wert sein, der für den Implementierer sinnvoll ist.

    Datentyp: Zeichenfolge

    Maximale Länge: 40

    Standard: Null
    basic_details.name Erforderlich. Name des Anwendungsservice. Muss ein eindeutiger Name aus allen anderen Anwendungsservices sein.

    Datentyp: Zeichenfolge

    Maximale Länge: 255
    Beziehungen Servicetypen, die dem Anwendungsservice zugeordnet werden sollen. Befindet sich in der Tabelle „CI-Beziehungen“ [cmdb_rel_ci].

    Datentyp: Objekt

    "relationships": {
  "business_app": [Array],
  "business_service_offering": [Array],
  "technical_service_offering": [Array]
}
    Beziehungen.Business_App Liste der sys_IDs der Geschäftsanwendungen, die mit dem Anwendungsservice verknüpft werden sollen.

    Datentyp: Array
    Beziehungen.Business_Service_Offering Liste der sys_IDs der Business-Serviceangebote, die mit dem Anwendungsservice verknüpft werden sollen.

    Datentyp: Array
    Beziehungen.Technical_Service_Offering Liste der sys_IDs der technischen Serviceangebote, die mit dem Anwendungsservice verknüpft werden sollen.

    Datentyp: Array

    Header

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

    Tabelle : 34. Anforderungskopfzeilen.
    Header Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützt nur application/json.
    Inhaltstyp Datenformat des Anforderungstexts. Unterstützt nur application/json.
    Tabelle : 35. Antwortkopfzeilen
    Header 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 REST-API-HTTP-Antwortcodes .

    Tabelle : 36. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    401 Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder haben nicht die Rolle „App_Service_admin“.

    Antworttext-Parameter (JSON oder XML)

    Name Beschreibung
    Fehler Beschreibt einen aufgetretenen Fehler.

    Datentyp: Objekt

    "error": {
  "details": "String",
  "message": "String"
}
    error.details Zusätzliche Informationen zum Fehler.

    Datentyp: Zeichenfolge
    Fehler.Nachricht Nachricht, die den Fehler beschreibt.

    Datentyp: Zeichenfolge

    Beispiel für Curl-Anforderung

    curl -X PUT \
  https://instance.servicenow.com/api/now/cmdb/csdm/app_service/f809cb60db94101037740f95ca96190f/service_details \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -u 'username':'password' \
  -d '{
  "basic_details": {
    "environment": "Test Lab 2"
  },  "relationships": {
    "business_app" :["f07c7620db54101037740f95ca96199a"]
  }
}'
    {
    "result": {}
}