Anwendungsservice-API

  • Freigeben Version: Washingtondc
  • Aktualisiert 1. Februar 2024
  • 15 Minuten Lesedauer

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

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

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

    Anwendungsservice – GET /now/cmdb/app_service/{sys_id}/getContent

    Ruft eine Liste von Konfigurationselementen (Configuration Items, CI) in einem zugeordneten Anwendungsservice und die Beziehungen zwischen diesen 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. Pfadparameter
    Name Beschreibung
    sys_id Sys_id des zugeordneten Anwendungsservice. Befindet sich in der Tabelle „Zugeordneter Anwendungsservice“ [cmdb_ci_service_discovered].

    Datentyp: Zeichenfolge
    Tabelle : 2. Abfrageparameter
    Name Beschreibung
    Modus Menge der zurückzugebenden Beziehungsdaten.
    Gültige Werte:
    • Shallow: Übergeordnete und untergeordnete Beziehungen zwischen CIs innerhalb eines Service zurückgeben.
    • Full: Gibt zusätzlich zu den im Modus „Shallow“ zurückgegebenen Daten CI-Attribute und Suchinformationen zurück.
    Bei den Werten wird nicht zwischen Groß- und Kleinschreibung unterschieden.

    Datentyp: Zeichenfolge
    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.
    400 Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
    401 Nicht autorisiert Die Benutzeranmeldeinformationen sind falsch, oder sie verfügen nicht über die Rolle „app_service_admin“.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Antworttextparameter (JSON oder XML)

    Name Beschreibung
    cmdb Liste der Objekte, die die dem angegebenen Anwendungsservice zugeordneten CIs beschreiben.

    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 Suchen 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.relations Beziehungsdaten für zugeordnete CIs, z. B. Hosts und deren untergeordnete Elemente.

    Datentyp: Array
    service Liste der Services, die sich auf den identifizierten Service beziehen.

    Datentyp: Array

    "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 oberste CI, als Einstiegspunkt eines Anwendungsservice bezeichnet, verfügt nicht über ein übergeordnetes CI.

    Datentyp: Array

    "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.übergeordnet Name eines übergeordneten CI, das sich auf das CI bezieht.

    Datentyp: Zeichenfolge
    service.url Relativer Pfad zum Anwendungsservice.

    Datentyp: Zeichenfolge

    Beispiel für eine 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 stattdessen SG Services – POST – /sg_services/app_service/find.

    URL-Format

    Standard-URL: /api/now/cmdb/csdm/app_service/find_service

    Unterstützte Anforderungsparameter

    Tabelle : 7. Pfadparameter
    Name Beschreibung
    Keine
    Tabelle : 8. Abfrageparameter
    Name Beschreibung
    Name Erforderlich, wenn number nicht übergeben wird. Name des Service, für den Informationen zurückgegeben werden sollen. Befindet sich in der Anwendungsservice-Tabelle [cmdb_ci_service_auto].

    Datentyp: Zeichenfolge
    Nummer Erforderlich, wenn name nicht übergeben wird. Eindeutige Nummer, die den Anwendungsservice identifiziert, für den Informationen zurückgegeben werden sollen. Befindet sich in der Anwendungsservice-Tabelle [cmdb_ci_service_auto].

    Datentyp: Zeichenfolge
    Tabelle : 9. 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 : 10. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützt nur application/json.
    Tabelle : 11. 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 : 12. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    400 Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
    401 Nicht autorisiert Die Benutzeranmeldeinformationen sind falsch, oder sie verfügen nicht über die Rolle „app_service_admin“.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Antworttextparameter (JSON oder XML)

    Name Beschreibung
    Fehler Beschreibt einen aufgetretenen Fehler.

    Datentyp: Objekt

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

    Datentyp: Zeichenfolge
    Fehler.Nachricht Meldung, 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 „Test Lab 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.relationships.business_app Liste der sys_ids der Geschäftsanwendungen, die sich auf den Anwendungsservice beziehen.

    Datentyp: Array
    services.relationships.technical_service_offering Liste der sys_ids der Business Service-Angebote, die sich auf den Anwendungsservice beziehen.

    Datentyp: Array
    services.relationships.business_service_offering Liste der sys_ids der technischen Serviceangebote im Zusammenhang mit dem Anwendungsservice.

    Datentyp: Array
    Services.sys_id Sys_id des Anwendungsservice.

    Datentyp: Zeichenfolge
    Services.Version Versionsnummer des Anwendungsservice.

    Datentyp: Zeichenfolge

    Maximale Länge: 40

    Format: Benutzerdefinierbar

    Standard: null

    Beispiel für eine 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 – POST /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

    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 : 14. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml.

    Standard: application/json
    Content-Type Datenformat des Anforderungstexts. Unterstützte Typen: application/json oder application/xml.

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

    Statuscodes

    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 : 16. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    400 Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
    401 Nicht autorisiert. Die Anmeldeinformationen 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 beispielsweise dem Feld „Kommentare“ Inhalt hinzuzufügen, fügen Sie "comments": "Passing data to the Comments field" zur JSON-Anforderung hinzu.

    Tabelle : 17. Im Anforderungstext akzeptierte Elemente
    Elemente Beschreibung
    Name Name des Anwendungsservice, den Sie erstellen oder aktualisieren möchten.
    service_relations Informationen über CIs und die von ihnen gebildete Hierarchie. Alle CIs bilden Paare aus einem übergeordneten CI und einem untergeordneten CI. Das oberste CI, als Einstiegspunkt eines Anwendungsservice bezeichnet, verfügt nicht über ein ü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 dieses CI mit dem CI der höheren Ebene in der Kartenhierarchie verbindet.

    Antwort-Haupttext

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

    Tabelle : 18. Im Antwort-Haupttext zurückgegebene Elemente
    Elemente Beschreibung
    URL URL der Standardtabellen-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 Inhalts des Anwendungsservice.

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

    Datentyp: Zeichenfolge
    Info Anzahl der dem Anwendungsservice hinzugefügten CIs.

    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 eine 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 – POST /now/cmdb/csdm/app_service/register_service

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

    Vor dem Speichern des Datensatzes werden die übergebenen Parameter und die Eindeutigkeit des Anwendungsservicenamens überprüft. Außerdem werden vorgelagerte Beziehungen erstellt, die dem Service Geschäftskontext bereitstellen, indem die angegebenen Geschäftsanwendungen, Business Service-Angebote und technischen Serviceangebote der Serviceanwendung zugeordnet werden. Es werden keine nachgelagerten Beziehungen zur Infrastruktur erstellt. Um nachgelagerte Beziehungen zu definieren, müssen Sie den Anwendungsservice – PUT /now/cmdb/csdm/app_service/{service_sys_id}/populate_service- Endpunkt aufrufen.
    Hinweis:
    Dieser Endpunkt ist veraltet. Verwenden Sie stattdessen SG Services – POST – /sg_services/app_service/register.

    URL-Format

    Standard-URL: /api/now/cmdb/csdm/app_service/register_service

    Unterstützte Anforderungsparameter

    Tabelle : 19. Pfadparameter
    Name Beschreibung
    Keine
    Tabelle : 20. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 21. Anforderungstextparameter
    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 „Test Lab 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: Benutzerdefinierbar

    Standard: null
    Beziehungen Vorgelagerte (übergeordnete) Servicetypen, die dem Anwendungsservice zugeordnet werden sollen. Diese Beziehungen werden in der Tabelle „CI-Beziehungen“ [cmdb_rel_ci] gespeichert.

    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 sich auf den Anwendungsservice beziehen sollen.

    Datentyp: Array
    beziehungen.business_service_offering Liste der sys_ids der Business Service-Angebote, die sich auf den Anwendungsservice beziehen.

    Datentyp: Array
    beziehungen.technical_service_offering Liste der sys_ids der technischen Serviceangebote, die sich auf den Anwendungsservice beziehen.

    Datentyp: Array

    Header

    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 : 22. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützt nur application/json.
    Content-Type Datenformat des Anforderungstexts. Unterstützt nur application/json.
    Tabelle : 23. 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 : 24. Statuscodes
    Statuscode Beschreibung
    201 Erfolgreich. Der Anwendungsservice wurde erfolgreich registriert.
    400 Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
    401 Nicht autorisiert Die Benutzeranmeldeinformationen sind falsch, oder sie verfügen nicht über die Rolle „app_service_admin“.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Antworttextparameter (JSON oder XML)

    Name Beschreibung
    Fehler Beschreibt einen aufgetretenen Fehler.

    Datentyp: Objekt

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

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

    Datentyp: Zeichenfolge
    Nummer Eindeutige Nummer, die den Anwendungsservice identifiziert. Diese Nummer wird vom Endpunkt generiert.
    service_sys_id Sys_id des registrierten Anwendungsservice.

    Beispiel für eine 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 (Configuration Items, CI) aus.

    Bevor Sie diesen Endpunkt aufrufen, müssen Sie den POST-Endpunkt /now/cmdb/csdm/app_service/register_service aufrufen, um den Anwendungsservice zu erstellen.
    Hinweis:
    Dieser Endpunkt ist veraltet. Verwenden Sie stattdessen SG Services – POST – /sg_services/app_service/populate.

    URL-Format

    Standard-URL: /api/now/cmdb/csdm/app_service/{service_sys_id}/populate_service

    Unterstützte Anforderungsparameter

    Tabelle : 25. Pfadparameter
    Name Beschreibung
    service_sys_id Sys_id des Anwendungsservice, der mit den angegebenen CIs ausgefüllt werden soll. Befindet sich in der Anwendungsservice-Tabelle [cmdb_ci_service_auto].

    Datentyp: Zeichenfolge
    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 im Objekt populate_method hängen von der Art der ausgefüllten Informationen ab. definiert durch den Parameter type.

    Datentyp: Objekt

    Für type = cmdb_group_based

    {
  "population_method": {
    "group_id": "String",
    "type": "String"
  }
}
    Für type = Erkennung
    Hinweis:
    Um diesen Typ zu verwenden, müssen Sie das Plugin „Service Mapping“ (com.snc.service-mapping) aktivieren.
    {
  "population_method": {
    "attributes": [Array],
    "entry_point_id": "String",
    "type":"String"
  }
}
    Für type = tag_list
    Hinweis:
    Um diesen Typ zu verwenden, müssen Sie das Plugin „Service Mapping“ (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.

    Weitere Informationen zu Einstiegspunkten finden Sie unter Einstiegspunktattribute.

    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 = Erkennung. Einstiegspunkt in den Anwendungsservice. Weitere Informationen zu Einstiegspunkten finden Sie unter Einstiegspunktattribute und Einstiegspunkttypen für Service Mapping erstellen.

    Datentyp: Zeichenfolge
    „population_method.group_id“ Erforderlich, wenn population_method.type = cmdb_group_based. Sys_id der Gruppe, die dem CI zugeordnet werden soll. Befindet sich in der Tabelle „CMDB-Gruppe“ [cmdb_group].

    Datentyp: Zeichenfolge
    „population_method.tags“ Liste der Tags, die dem CI zugeordnet werden sollen. Diese Informationen befinden sich in der Tabelle „Schlüsselwerte“ [cmdb_key_value].

    Datentyp: Array

    {
  "tags": {
    "tag": "String",
    "value": "String"
  }
}
    „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
    • Erkennung von
    • tag_list

    Datentyp: Zeichenfolge

    Header

    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 : 28. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützt nur application/json.
    Content-Type Datenformat des Anforderungstexts. Unterstützt nur application/json.
    Tabelle : 29. 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 : 30. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    401 Nicht autorisiert Die Benutzeranmeldeinformationen sind falsch, oder sie verfügen nicht über die Rolle „app_service_admin“.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten.

    Antworttextparameter (JSON oder XML)

    Name Beschreibung
    Fehler Beschreibt einen aufgetretenen Fehler.

    Datentyp: Objekt

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

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

    Datentyp: Zeichenfolge

    Beispiel für eine 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 anhand der IRE-Regeln (Identification and Reconciliation Engine) überprüft werden, die in der Anwendungsserviceklasse definiert sind.
    Hinweis:
    Dieser Endpunkt ist veraltet. Verwenden Sie stattdessen SG Services – POST – /sg_services/app_service/update.

    URL-Format

    Standard-URL: /api/now/cmdb/csdm/app_service/{service_sys_id}/service_details

    Unterstützte Anforderungsparameter

    Tabelle : 31. Pfadparameter
    Name Beschreibung
    service_sys_id Sys_id des zu aktualisierenden Anwendungsservice. Befindet sich in der Anwendungsservice-Tabelle [cmdb_ci_service_auto].

    Datentyp: Zeichenfolge
    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 „Test Lab 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 sich auf den Anwendungsservice beziehen sollen.

    Datentyp: Array
    beziehungen.business_service_offering Liste der sys_ids der Business Service-Angebote, die sich auf den Anwendungsservice beziehen.

    Datentyp: Array
    beziehungen.technical_service_offering Liste der sys_ids der technischen Serviceangebote, die sich auf den Anwendungsservice beziehen.

    Datentyp: Array

    Header

    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 : 34. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützt nur application/json.
    Content-Type Datenformat des Anforderungstexts. Unterstützt nur application/json.
    Tabelle : 35. 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 : 36. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    401 Nicht autorisiert Die Benutzeranmeldeinformationen sind falsch, oder sie verfügen nicht über die Rolle „app_service_admin“.

    Antworttextparameter (JSON oder XML)

    Name Beschreibung
    Fehler Beschreibt einen aufgetretenen Fehler.

    Datentyp: Objekt

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

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

    Datentyp: Zeichenfolge

    Beispiel für eine 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": {}
}