SG-Services-API

  • Freigeben Version: Zurich
  • Aktualisiert 31. Juli 2025
  • 25 Minuten Lesedauer
  • Die SG-Services Die API stellt Endpunkte zum Erstellen und Verwalten von Anwendungsservices und der vorgelagerten Beziehungen zwischen ihnen bereit.

    Apps im Store anfordern

    Besuchen Sie die ServiceNow Store-Website, um alle verfügbaren Apps anzuzeigen und Informationen zum Senden von Anforderungen an den Store zu erhalten. Kumulative Informationen zu Release-Hinweisen für alle veröffentlichten Apps finden Sie unter ServiceNow Store-Versionshinweise .

    Diese API kann nur verwendet werden, wenn das Plugin „CMDB-Anwendungs-API“ und „CLI“ (sn_Service_Graph) aktiviert ist. Diese API wird in verwendet sn_Service_Graph Namespace.

    Die Verwendung dieser API erfordert keine Details zu Quelltabellen oder Beziehungstypen.

    Um kritische Vorgänge zu skripten, die die Automatisierung im gesamten Unternehmen unterstützen, können Sie APIs nutzen oder Befehlszeilenvorgänge ausführen, die die CMDB-AnwendungsCLI und die API Store-App bereitstellen, anstatt die Anwenderoberfläche zu verwenden. Die CMDB-Anwendungs-CLI und die API Store-App bieten ein robustes Framework, das alle APIs konsolidiert, die sich auf Anwendungsservices beziehen, und die Befehlszeilen, mit denen Sie auf die Schnittstelle zu diesen APIs zugreifen können.

    CLI- und API-Befehle der CMDB-Anwendung ermöglichen die folgenden Aufgaben:
    • Registrieren und Erstellen eines Anwendungsservice und Herstellen vorgelagerter Beziehungen
    • Ruft Details eines bestimmten Anwendungsservice und seiner vorgelagerten Beziehungen ab
    • Verbinden von Konstrukten auf höherer Ebene wie Geschäftsanwendungen und Business-Service-Angebote
    • Ein Anwendungsservice wird mit einem bestimmten Auffüllungstyp ausgefüllt
    • Ändern des Status eines Anwendungsservice

    Informationen zur Befehlszeilenlösung finden Sie unter CMDB-Anwendungs-CLI und API verfügbare Befehle .

    SG-Services: NACH /sg_Services/App_Service/convert

    Konvertiert einen manuellen oder leeren Anwendungsservice in einen berechneten Anwendungsservice. Während der Konvertierung wird der Anwendungsservice-Datensatz mit der neu zugewiesenen Klasse in die Tabelle [cmdb_ci_Service_calculated] verschoben.

    Die folgenden Eigenschaften zum Identifizieren eines CI haben wie folgt Vorrang:
    1. sys_ID: Bei sys_ID verwendet das System nur die sys_ID und ignoriert alle zusätzlichen Werte.
    2. Zahl: Wenn ohne sys_ID angegeben, verwendet das System nur die Zahl und ignoriert alle zusätzlichen Werte.
    3. <Ire-Feldname>: Das System verwendet diese Werte nur, wenn die sys_ID oder die Zahl nicht angegeben ist.

    URL-Format

    Versionierte URL: /api/sn_Service_Graph/{api_Version}/sg_Services/App_Service/convert

    Standard-URL: /api/sn_Service_Graph/sg_Services/App_Service/convert

    Hinweis:
    Verfügbare Versionen werden in angegeben REST API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf der Formular „geskripteter REST-Service“ .

    Unterstützte Anforderungsparameter

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

    Datentyp: Zeichenfolge

    Tabelle : 2. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 3. Anforderungstext-Parameter (JSON)
    Name Beschreibung
    <Ire-Feldname> Mindestens ein Ire-Feld, das den Anwendungsservice identifiziert. Beispiel: Name oder Version.

    Datentyp: Zeichenfolge

    Ebenen Anzahl der Ebenen, die in die Konvertierung einbezogen werden sollen.

    Datentyp: Zeichenfolge

    Nummer Eindeutige Nummer, die den Anwendungsservice identifiziert.

    Datentyp: Zeichenfolge

    sys_id SYS_ID des Anwendungsservice, der in der Tabelle „Serviceinstanz“ [cmdb_ci_Service_Auto] aufgeführt ist.

    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 : 4. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützt nur 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 REST API-HTTP-Antwortcodes .

    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 Anwenderanmeldeinformationen sind falsch, oder der Anwender hat nicht die Rolle „App_Service_admin“.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Parameter des Antwort-Haupttexts (JSON)

    Name Beschreibung
    status Gibt Erfolg oder Fehler an.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Das folgende Beispiel zeigt, wie ein Anwendungsservicetyp konvertiert wird.

    curl "https://instance.service-now.com/api/sn_service_graph/sg_services/app_service/convert" \
    --request POST \
    --header "Accept:application/json" \
    --header "Content-Type:application/json" \
    --data "{
     \"name\": \"Test Register\",
     \"environment\": \"Test\",
     \"version\": \"1.0\",
     \"levels\" : 8
    }" \
    --user 'username':'password'

    Ergebnisse, die eine erfolgreiche Konvertierung in einen berechneten Anwendungsservice anzeigen.

    {
      "result": {
      "status": "success"
      }
    }

    SG-Services: NACH /sg_Services/App_Service/delete

    Löscht einen Anwendungsservice.

    Die folgenden Eigenschaften zum Identifizieren eines CI haben wie folgt Vorrang:
    1. sys_ID: Bei sys_ID verwendet das System nur die sys_ID und ignoriert alle zusätzlichen Werte.
    2. Zahl: Wenn ohne sys_ID angegeben, verwendet das System nur die Zahl und ignoriert alle zusätzlichen Werte.
    3. <Ire-Feldname>: Das System verwendet diese Werte nur, wenn die sys_ID oder die Zahl nicht angegeben ist.

    URL-Format

    Versionierte URL: /api/sn_Service_Graph/{api_Version}/sg_Services/App_Service/delete

    Standard-URL: /api/sn_Service_Graph/sg_Services/App_Service/delete

    Hinweis:
    Verfügbare Versionen werden in angegeben REST API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf der Formular „geskripteter REST-Service“ .

    Unterstützte Anforderungsparameter

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

    Datentyp: Zeichenfolge

    Tabelle : 8. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 9. Anforderungstext-Parameter (JSON)
    Name Beschreibung
    <Ire-Feldname> Mindestens ein Ire-Feld, das den Anwendungsservice identifiziert. Beispiel: Name oder Version.

    Datentyp: Zeichenfolge

    Nummer Eindeutige Nummer, die den Anwendungsservice identifiziert.

    Datentyp: Zeichenfolge

    sys_id SYS_ID des Anwendungsservice, der in der Tabelle „Serviceinstanz“ [cmdb_ci_Service_Auto] aufgeführt ist.

    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 : 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 REST API-HTTP-Antwortcodes .

    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 Anwenderanmeldeinformationen sind falsch, oder der Anwender hat nicht die Rolle „App_Service_admin“.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Parameter des Antwort-Haupttexts (JSON)

    Name Beschreibung
    status Gibt Erfolg oder Fehler an.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Das folgende Beispiel zeigt, wie ein Anwendungsservice gelöscht wird.

    curl "https://instance.service-now.com/api/sn_service_graph/sg_services/app_service/delete" \
    --request POST \
    --header "Accept:application/json" \
    --header "Content-Type:application/json" \
    --data "{
       \"name\": \"Test Register\",
       \"environment\": \"Test\",
       \"version\": \"1.0\"
    }" \
    --user 'username':'password'

    Ergebnisse, die auf eine erfolgreiche Entfernung eines Anwendungsservice hinweisen.

    {
      "result": {
      "status": "success"
      }
    }

    SG-Services: NACH /sg_Services/App_Service/find

    Sucht die Details eines bestimmten Anwendungsservice und seiner vorgelagerten Beziehungen.

    Anwender mit der Rolle „App_Service_user“ können diese API verwenden, die Ergebnisse sind jedoch auf Anwendungsservices im Status „Betrieb“ beschränkt. Die Rolle „App_Service_admin“ ermöglicht die unbegrenzte Anzeige von Anwendungsservices.

    Die folgenden Eigenschaften zum Identifizieren eines CI haben wie folgt Vorrang:
    1. sys_ID: Bei sys_ID verwendet das System nur die sys_ID und ignoriert alle zusätzlichen Werte.
    2. Zahl: Wenn ohne sys_ID angegeben, verwendet das System nur die Zahl und ignoriert alle zusätzlichen Werte.
    3. <Ire-Feldname>: Das System verwendet diese Werte nur, wenn die sys_ID oder die Zahl nicht angegeben ist.

    URL-Format

    Versionierte URL: /api/sn_Service_Graph/{api_Version}/sg_Services/App_Service/Find

    Standard-URL: /api/sn_Service_Graph/sg_Services/App_Service/Find

    Hinweis:
    Verfügbare Versionen werden in angegeben REST API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf der Formular „geskripteter REST-Service“ .

    Unterstützte Anforderungsparameter

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

    Datentyp: Zeichenfolge

    Tabelle : 14. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 15. Anforderungstext-Parameter (JSON)
    Name Beschreibung
    <IRE fields> Mindestens ein Ire-Feld, das den Anwendungsservice identifiziert. Beispiel: Name oder Version.

    Datentyp: Zeichenfolge

    Nummer Eindeutige Nummer, die den Anwendungsservice identifiziert.

    Datentyp: Zeichenfolge

    sys_id SYS_ID des Anwendungsservice, der in der Tabelle „Serviceinstanz“ [cmdb_ci_Service_Auto] aufgeführt ist.

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

    Tabelle : 18. 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 Anwenderanmeldeinformationen sind falsch, oder der Anwender hat nicht die Rolle „App_Service_admin“.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Parameter des Antwort-Haupttexts (JSON)

    Name Beschreibung
    <Ire-Feldname> Mindestens ein Ire-Feld, das den Anwendungsservice identifiziert. Beispiel: Name oder Version.

    Datentyp: Zeichenfolge

    Nummer Eindeutige Nummer, die den Anwendungsservice identifiziert.

    Datentyp: Zeichenfolge

    operational_status Betriebsstatus des Anwendungsservice. Beispiel: Aktiv.

    Datentyp: Zeichenfolge

    Beziehungen Liste der Objekte, die die vorgelagerten Beziehungen des Anwendungsservice definieren.

    Datentyp: Array

    "relationships": [
     {
        "name": "String",
        "number": "String",
        "sys_id": "String",
        "class_name": "String",
        "relationship": "String"
     }
    ]
    Beziehungen.class_Name Name der Klasse, die den Anwendungsservice enthält.

    Datentyp: Zeichenfolge

    relationships.name Name der Beziehung.

    Datentyp: Zeichenfolge

    Beziehungen.Nummer Eindeutige Nummer der Beziehung

    Datentyp: Zeichenfolge

    Beziehungen.Beziehung Die Beziehungsregel.

    Datentyp: Zeichenfolge

    Beziehungen.sys_ID SYS_ID der Beziehung.

    Datentyp: Zeichenfolge

    sys_id SYS_ID des Anwendungsservice, der in der Tabelle „Serviceinstanz“ [cmdb_ci_Service_Auto] aufgeführt ist.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Das folgende Beispiel zeigt, wie Sie Details zu einem Anwendungsservice finden.

    curl "https://instance.service-now.com/api/sn_service_graph/sg_services/app_service/find" \
    --request POST \
    --header "Accept:application/json" \
    --header "Content-Type:application/json" \
    --data "{
       \"name\": \"Test App Service1\"
     }" \
    --user 'username':'password'

    Der Antworttext enthält den Anwendungsservice und Beziehungsinformationen.

    {
      "result": {
        "aliases": null,
        "asset": null,
        "asset_tag": null,
        "assigned": "",
        "assigned_to": null,
        "assignment_group": null,
        "attestation_score": null,
        "attested": "0",
        "attested_by": null,
        "attested_date": "",
        "attributes": null,
        "bucket": null,
        "business_contact": null,
        "business_need": null,
        "business_relation_manager": null,
        "business_unit": null,
        "busines_criticality": "4 - not critical",
        "can_print": "0",
        "category": null,
        "change_control": null,
        "checked_in": "",
        "checked_out": "",
        "checkout": null,
        "comments": null,
        "company": null,
        "compatibility_dependencies": null,
        "consumer_type": "internal",
        "correlation_id": null,
        "cost": null,
        "cost_cc": "USD",
        "cost_center": null,
        "delivery_date": "",
        "delivery_manager": null,
        "department": null,
        "discovery_source": "Manual Entry",
        "dns_domain": null,
        "due": "",
        "due_in": null,
        "duplicate_of": null,
        "end_date": "",
        "environment": null,
        "fault_count": "0",
        "first_discovered": "2021-07-19 20:09:48",
        "fqdn": null,
        "gl_account": null,
        "hide_from_dashboard": "0",
        "install_date": "",
        "install_status": "1",
        "invoice_number": null,
        "ip_address": null,
        "justification": null,
        "last_discovered": "2021-07-19 20:09:48",
        "last_review_date": "",
        "layer": null,
        "lease_id": null,
        "life_cycle_stage": null,
        "life_cycle_stage_status": null,
        "location": null,
        "mac_address": null,
        "maintenance_schedule": null,
        "managed_by": null,
        "managed_by_group": null,
        "manufacturer": null,
        "model_id": null,
        "model_number": null,
        "monitor": "0",
        "monitoring_requirements": null,
        "name": "Test App Service1",
        "number": "SNSVC0001014",
        "operational_status": "2",
        "order_date": "",
        "owned_by": null,
        "parent": null,
        "portfolio_status": "pipeline",
        "po_number": null,
        "prerequisites": null,
        "price_model": "per_unit",
        "price_unit": null,
        "published_ref": null,
        "purchase_date": "",
        "schedule": null,
        "serial_number": null,
        "service_classification": "Application Service",
        "service_level_requirement": null,
        "service_owner_delegate": null,
        "service_status": "requirements",
        "severity": null,
        "short_description": null,
        "skip_sync": "0",
        "sla": null,
        "spm_service_portfolio": null,
        "spm_taxonomy_node": null,
        "stakeholders": null,
        "start_date": "",
        "state": null,
        "subcategory": null,
        "supported_by": null,
        "support_group": null,
        "sys_class_name": "cmdb_ci_service_auto",
        "sys_class_path": "/!!/!7/!(",
        "sys_created_by": "admin",
        "sys_created_on": "2021-07-19 20:09:48",
        "sys_domain": "global",
        "sys_domain_path": "/",
        "sys_id": "a2f0618040697410f87713b656474255",
        "sys_mod_count": "0",
        "sys_updated_by": "admin",
        "sys_updated_on": "2021-07-19 20:09:48",
        "unit_description": null,
        "unverified": "0",
        "used_for": "Production",
        "user_group": null,
        "vendor": null,
        "version": null,
        "view_service": "61e1cb757f23220002d31ccebefa9120",
        "warranty_expiration": "",
        "relationships": [
          {
            "name": "Test Biz App1",
            "sys_id": "0250a94040697410f87713b656474250",
            "number": "APM0001001",
            "class_name": "cmdb_ci_business_app",
            "relationship": "Consumes::Consumed by"
          },
          {
            "name": "Tech Service Offering1",
            "sys_id": "98d0ed4040697410f87713b6564742ef",
            "number": "BSN0001005",
            "class_name": "service_offering",
            "relationship": "Contains::Contained by"
          }
        ]
      }
    }

    SG-Services: NACH /sg_Services/App_Service/Füllen

    Füllt einen Anwendungsservice mit einer Service-Auffüllungsmethode aus.

    Die folgenden Eigenschaften zum Identifizieren eines CI haben wie folgt Vorrang:
    1. sys_ID: Bei sys_ID verwendet das System nur die sys_ID und ignoriert alle zusätzlichen Werte.
    2. Zahl: Wenn ohne sys_ID angegeben, verwendet das System nur die Zahl und ignoriert alle zusätzlichen Werte.
    3. <Ire-Feldname>: Das System verwendet diese Werte nur, wenn die sys_ID oder die Zahl nicht angegeben ist.

    URL-Format

    Versionierte URL: /api/sn_Service_Graph/{api_Version}/sg_Services/App_Service/populate

    Standard-URL: /api/sn_Service_Graph/sg_Services/App_Service/populate

    Hinweis:
    Verfügbare Versionen werden in angegeben REST API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf der Formular „geskripteter REST-Service“ .

    Unterstützte Anforderungsparameter

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

    Datentyp: Zeichenfolge

    Tabelle : 20. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 21. Anforderungstext-Parameter (JSON)
    Name Beschreibung
    <Ire-Feldname> Mindestens ein Ire-Feld, das den Anwendungsservice identifiziert. Beispiel: Name oder Version.

    Datentyp: Zeichenfolge

    Nummer Eindeutige Nummer, die den Anwendungsservice identifiziert.

    Datentyp: Zeichenfolge

    Population_method Erforderlich. Identifiziert die Auffüllungsmethode und die zugehörige Eigenschaft, um den Inhalt für die Auffüllung zu identifizieren.

    Pro Typ ist nur ein begleitendes Objekt gültig.

    Datentyp: Objekt

    population_method.group_id Gruppen-ID der CMDB-Gruppe, die mit dem Auffüllungstyp „cmdb_Group“ konfiguriert ist.

    Datentyp: „Zeichenfolge“

    "population_method": {
      "group_id": "String",
      "type": "cmdb_group"
    }

    Zugeordneter Auffüllungstyp: cmdb_Group

    Population_method.levels Anzahl der Ebenen, die beim Erstellen des Service verwendet werden sollen. Wenn der Ebenenwert nicht angegeben ist, überprüft das System die sys_property auf den Wert. Wenn svc.manual.convert.levels.default_value nicht ausgefüllt ist, wird der Standardwert 3 verwendet.

    Datentyp: Zahl

    "population_method": {
      "levels": Number,
      "type": "dynamic_service"
    }

    Zugeordneter Auffüllungstyp: Dynamic_Service

    Standard: 3, wenn für die sys_property kein Ebenenwert festgelegt ist

    population_method.service_candidate

    Eindeutiger Bezeichner des Servicekandidaten.

    Datentyp: Zeichenfolge

    "population_method": {
      "service_candidate": "String",
      "type": "tag_based_service_family"
    }

    Zugeordneter Auffüllungstyp: Tag_based_Service_family

    population_method.service_relations Liste von Objekten, die Hierarchiedaten für die CIs im Anwendungsservice enthalten. 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

    "population_method": {
    
      "service_relations":[
         {
          "child": "String",
          "parent": "String"
         }
      ],
    
      "type": "service_hierarchy"   
    }

    Zugeordneter Auffüllungstyp: Service_hierarchy

    population_method.service_relations.child Name eines untergeordneten CI, das sich auf das CI bezieht.

    Datentyp: Zeichenfolge

    population_method.service_relations.parent Name eines übergeordneten CI, das sich auf das CI bezieht.

    Datentyp: Zeichenfolge

    Population_method.Tags Liste von Objekten mit Tags, die dem CI zugeordnet werden sollen. Diese Informationen befinden sich in der Tabelle „Schlüsselwerte“ [cmdb_key_value].

    Datentyp: Array

    "population_method": {
    
      "tags": [
         {
          "tag": "String",
          "value": "String"
         }
      ],
    
      "type": "tag_list"  
    }

    Zugeordneter Auffüllungstyp: Tag_list

    Population_method.Tags.Tag Tag-Name.

    Datentyp: Zeichenfolge

    Population_method.Tags.value Tag-Wert.

    Datentyp: Zeichenfolge

    Population_method.type Erforderlich. Auffüllungstyp, der dem Anwendungsservice hinzugefügt werden soll.

    Datentyp: Objekt

    Gültige Werte:
    • cmdb_Gruppe
    • Service_Hierarchie
    • Dynamic_Service
    • Tag_Liste
    • Tag_based_Service_family
    sys_id SYS_ID des Anwendungsservice, der in der Tabelle „Serviceinstanz“ [cmdb_ci_Service_Auto] aufgeführt ist.

    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 : 22. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. 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 REST API-HTTP-Antwortcodes .

    Tabelle : 24. 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 Anwenderanmeldeinformationen sind falsch, oder der Anwender hat nicht die Rolle „App_Service_admin“.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Parameter des Antwort-Haupttexts (JSON)

    Name Beschreibung
    status Gibt Erfolg oder Fehler an.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Das folgende Beispiel zeigt, wie Sie einen Anwendungsservice mit dem Typ „Dynamic_Service“ ausfüllen.

    curl "https://instance.service-now.com/api/sn_service_graph/sg_services/app_service/populate" \
    --request POST \
    --header "Accept:application/json" \
    --header "Content-Type:application/json" \
    --data "{
      \"name\": \"Test Register\",
      \"environment\": \"Test\",
      \"version\": \"1.0\",
    
     \"population_method\": {
       \"type\": \"dynamic_service\",
       \"levels\" : 8
      }
    }" \
    --user 'username':'password'

    Ergebnisse, die auf eine erfolgreiche Auffüllung eines Anwendungsservice hinweisen.

    {
      "result": {
      "status": "success"
      }
    }

    SG-Services: NACH /sg_Services/App_Service/Register

    Erstellt einen Anwendungsservice, markiert und erstellt vorgelagerte Beziehungen wie Geschäftsanwendungen, Business-Serviceangebote und andere Anwendungsservices.

    Die folgenden Eigenschaften zum Identifizieren eines CI haben wie folgt Vorrang:
    1. sys_ID: Bei sys_ID verwendet das System nur die sys_ID und ignoriert alle zusätzlichen Werte.
    2. Zahl: Wenn ohne sys_ID angegeben, verwendet das System nur die Zahl und ignoriert alle zusätzlichen Werte.
    3. <Ire-Feldname>: Das System verwendet diese Werte nur, wenn die sys_ID oder die Zahl nicht angegeben ist.

    URL-Format

    Versionierte URL: /api/sn_Service_Graph/{api_Version}/sg_Services/App_Service/Register

    Standard-URL: /api/sn_Service_Graph/sg_Services/App_Service/Register

    Hinweis:
    Verfügbare Versionen werden in angegeben REST API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf der Formular „geskripteter REST-Service“ .

    Unterstützte Anforderungsparameter

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

    Datentyp: Zeichenfolge

    Tabelle : 26. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 27. Anforderungstext-Parameter (JSON)
    Name Beschreibung
    <Ire-Feldname> Mindestens ein Ire-Feld, das den Anwendungsservice identifiziert. Beispiel: Name oder Version.

    Datentyp: Zeichenfolge

    Nummer Eindeutige Nummer, die den Anwendungsservice identifiziert.

    Datentyp: Zeichenfolge

    Beziehungen Vorgelagerte Beziehungen kategorisiert nach Typ.

    Datentyp: Objekt

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

    Die maximale Anzahl von Beziehungen beträgt 25.

    Beziehungen.Business_App
    Liste von Objekten, die Beziehungstypen der Geschäftsanwendung darstellen. Diese Werte können mit einem der folgenden Elemente als Schlüssel-Wert-Paare definiert werden.
    • <Ire-Feldname>
    • Nummer
    • sys_id

    Datentyp: Array

    Beziehungen.Business_Service_Offering
    Liste von Objekten, die Beziehungstypen des Business-Serviceangebots darstellen. Diese Werte können mithilfe der folgenden Elemente als Schlüssel-Wert-Paare definiert werden.
    • <Ire-Feldname>
    • Nummer
    • sys_id

    Datentyp: Array

    Beziehungen.parent_App_Service
    Liste von Objekten, die Anwendungs-Service-Beziehungstypen darstellen. Diese Werte können mithilfe der folgenden Elemente als Schlüssel-Wert-Paare definiert werden.
    • <Ire-Feldname>
    • Nummer
    • sys_id

    Datentyp: Array

    Beziehungen.Technical_Service_Offering
    Liste von Objekten, die das Technologiemanagement-Angebot darstellen (ehemals technisches Serviceangebot) Beziehungstypen. Diese Werte können mithilfe der folgenden Elemente als Schlüssel-Wert-Paare definiert werden.
    • <Ire-Feldname>
    • Nummer
    • sys_id

    Datentyp: Array

    sys_id SYS_ID des Anwendungsservice, der in der Tabelle „Serviceinstanz“ [cmdb_ci_Service_Auto] aufgeführt ist.

    Datentyp: Zeichenfolge

    tags Liste von Objekten, die Tag-Definitionen als Schlüssel-Wert-Paare enthalten.
    "tags": [
     {
      "key": "String",
      "value": "String"
     }]

    Datentyp: Array

    tags.key Tag-Kategoriename.

    Datentyp: Zeichenfolge

    Tags.Wert Tag-Wert.

    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.
    Tabelle : 29. Antwortkopfzeilen
    CHeader 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.
    400 Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
    401 Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch, oder der Anwender hat nicht die Rolle „App_Service_admin“.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Parameter des Antwort-Haupttexts (JSON)

    CHeader Beschreibung
    App_Service Details zum Anwendungsservice.

    Datentyp: Objekt

    "app_service": {
      "name": "String",
      "number": "String",
      "sys_id": "String"
    }
    app_service.name Name des Anwendungsservice.

    Datentyp: Zeichenfolge

    App_Service.number Eindeutige Nummer, die den Anwendungsservice identifiziert.

    Datentyp: Zeichenfolge

    App_Service.sys_ID SYS_ID des Anwendungsservice, der in der Tabelle „Serviceinstanz“ [cmdb_ci_Service_Auto] aufgeführt ist.

    Datentyp: Zeichenfolge

    Nachricht Nachricht, die den Status beschreibt.
    Mögliche Werte:
    • Service bereits vorhanden
    • Service erfolgreich registriert

    Datentyp: Zeichenfolge

    status Status, der angibt, ob der Service registriert wurde.
    Mögliche Werte:
    • Einfügen: Der Anwendungsservice wurde erfolgreich erstellt.
    • Keine Aktion: Der Anwendungsservice ist bereits vorhanden. Keine Aktion ausgeführt.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Das folgende Beispiel zeigt, wie ein Anwendungsservice registriert wird.

    curl "instance.service-now.com/api/sn_service_graph/sg_services/app_service/register" \--request POST \
    --header "Accept:application/json" \
    --header "Content-Type:application/json" \
    --data "{
      \"name\": \"Test Register\",
      \"environment\": \"Test\",
      \"version\": \"1.0\",
      \"number\": \" SNSVC0001014\",
      \"relationships\": {
        \"business_application\": [
          {
            \"sys_id\": \"0250a94040697410f87713b656474250\"
          },
          {
            \"number\": \"APM0001002\"
          },
          {
            \"name\": \"Test Biz App1\"
          }
        ],
        \"business_service_offering\": [
          {
            \"sys_id\": \"ed32e98040697410f87713b656474259\"
          }
        ],
        \"technical_service_offering\": [
          {
            \"sys_id\": \"80e12d8040697410f87713b65647421c\"
          },
          {
            \"number\": \"BSN0001005\"
          },
          {
            \"name\": \"Tech Service Offering2\"
          }
        ],
        \"parent_app_service\": [
          {
            \"sys_id\": \"a2f0618040697410f87713b656474255\"
          }
        ]
      },
      \"tags\": [
        {
          \"key\": \"key1\",
          \"value\": \"value1\"
        },
        {
          \"key\": \"key2\",
          \"value\": \"value2\"
        }
      ]
    }" \
    --user 'username':'password'

    Der Antworttext enthält ID- und Statusinformationen.

    {
      "result": {
        "app_service": {
          "sys_id": "5780cb604061f410f87713b656474271",
          "name": "Test Register",
          "number": " SNSVC0001014"
        },
        "message": "Service registered successfully",
        "status": "INSERT"
      }
    }

    SG-Services: NACH /sg_Services/App_Service/Relationship/create

    Erstellt vorgelagerte Beziehungen wie Geschäftsanwendungen, Business-Serviceangebote und andere Anwendungsservices.

    Diese API erstellt eine Beziehung, die Eingaben mit einem einzelnen übergeordneten Objekt und einem entsprechenden untergeordneten Objekt übernimmt.

    Die folgenden Eigenschaften zum Identifizieren eines CI haben wie folgt Vorrang:
    1. sys_ID: Bei sys_ID verwendet das System nur die sys_ID und ignoriert alle zusätzlichen Werte.
    2. Zahl: Wenn ohne sys_ID angegeben, verwendet das System nur die Zahl und ignoriert alle zusätzlichen Werte.
    3. <Ire-Feldname>: Das System verwendet diese Werte nur, wenn die sys_ID oder die Zahl nicht angegeben ist.

    URL-Format

    Versionierte URL: /api/sn_Service_Graph/{api_Version}/sg_Services/App_Service/Relationship/create

    Standard-URL: /api/sn_Service_Graph/sg_Services/App_Service/Relationship/create

    Hinweis:
    Verfügbare Versionen werden in angegeben REST API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf der Formular „geskripteter REST-Service“ .

    Unterstützte Anforderungsparameter

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

    Datentyp: Zeichenfolge

    Tabelle : 32. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 33. Anforderungstext-Parameter (JSON)
    Name Beschreibung
    child Informationen, die den untergeordneten Anwendungsservice identifizieren, mit dem eine Beziehung erstellt werden soll.

    Eine dynamische CI-Gruppe kann als untergeordnetes Element hinzugefügt werden, kann jedoch nicht übergeordnet sein.

    Datentyp: Objekt

    "child": {
      "<service_app_identifier>": "String"
    }

    Tabelle: Serviceinstanz [cmdb_ci_Service_Auto]

    Untergeordnetes Element.<service_app_identifier> Details zur Identifizierung des untergeordneten Anwendungsservice, mit dem eine Beziehung erstellt werden soll.
    Es ist nur eine Option erforderlich. Jede Option wird nach Verarbeitungsvorrang aufgelistet:
    • sys_ID: SYS_ID des untergeordneten Anwendungsservice.
    • Nummer: Eindeutige Nummer, die den untergeordneten Anwendungsservice identifiziert.
    • <IRE-Feldname>: IRE-Felder, die den Anwendungsservice identifizieren. Beispiel: Name oder Version.

    Datentyp: Zeichenfolge

    übergeordnet Details zur Identifizierung des übergeordneten Anwendungsservice, mit dem eine Beziehung erstellt werden soll.

    Datentyp: Objekt

    "parent": {
      "<service_app_identifier>": "String",
      "class_name": "String"
    }
    Übergeordnet.<service_app_identifier> Informationen zur Identifizierung des Anwendungsservice.
    Es ist nur eine Option erforderlich. Jede Option wird nach Verarbeitungsvorrang aufgelistet:
    • sys_ID: SYS_ID der Anwendungsservice, der in der Serviceinstanz [cmdb_ci_Service_Auto] aufgeführt ist.
    • Nummer: Eindeutige Nummer, die den Anwendungsservice identifiziert.
    • <IRE-Feldname>: Mindestens ein IRE-Feld, das den Anwendungsservice identifiziert. Beispiel: Name oder Version.

    Datentyp: Zeichenfolge

    Parent.class_Name Name der Klasse, die den Anwendungsservice enthält.
    Der Name der übergeordneten Klasse muss aus einer der folgenden Tabellen stammen:
    • cmdb_ci_business_app
    • cmdb_ci_Service_Auto
    • cmdb_ci_Service_by_Tags
    • cmdb_ci_Service_Calculated
    • cmdb_ci_Service_detected
    • Service.Offering

    Standard: cmdb_ci_Service_Auto

    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 : 34. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. 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 REST API-HTTP-Antwortcodes .

    Tabelle : 36. 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 Anwenderanmeldeinformationen sind falsch, oder der Anwender hat nicht die Rolle „App_Service_admin“.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Parameter des Antwort-Haupttexts (JSON)

    Name Beschreibung
    status Gibt Erfolg oder Fehler an.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Das folgende Beispiel zeigt, wie eine Beziehung aus einem Anwendungsservice erstellt wird.

    curl "https://instance.service-now.com/api/sn_service_graph/sg_services/app_service/relationship/create" \
    --request POST \
    --header "Accept:application/json" \
    --header "Content-Type:application/json" \
    --data "{
      \"child\": {
       \"name\": \"wdfsdf\",
       \"environment\": \"Test\",
       \"version\": \"1.0\"
       },
      \"parent\": {
       \"sys_id\": \"abcdefg\",
       \"name\": \"business App1\",
       \"class_name\": \"service_offering\"
      }
    }" \
    --user 'username':'password'

    Ergebnisse, die auf eine erfolgreiche Erstellung einer Anwendungsservice-Beziehung hinweisen.

    {
      "result": {
      "status": "success"
      }
    }

    SG-Services: NACH /sg_Services/App_Service/Relationship/delete

    Löscht eine vorgelagerte Anwendungsservice-Beziehung.

    Die folgenden Eigenschaften zum Identifizieren eines CI haben wie folgt Vorrang:
    1. sys_ID: Bei sys_ID verwendet das System nur die sys_ID und ignoriert alle zusätzlichen Werte.
    2. Zahl: Wenn ohne sys_ID angegeben, verwendet das System nur die Zahl und ignoriert alle zusätzlichen Werte.
    3. <Ire-Feldname>: Das System verwendet diese Werte nur, wenn die sys_ID oder die Zahl nicht angegeben ist.

    URL-Format

    Versionierte URL: /api/sn_Service_Graph/{api_Version}/sg_Services/App_Service/Relationship/delete

    Standard-URL: /api/sn_Service_Graph/sg_Services/App_Service/Relationship/delete

    Hinweis:
    Verfügbare Versionen werden in angegeben REST API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf der Formular „geskripteter REST-Service“ .

    Unterstützte Anforderungsparameter

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

    Datentyp: Zeichenfolge

    Tabelle : 38. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 39. Anforderungstext-Parameter (JSON)
    Name Beschreibung
    child Informationen, die die untergeordnete Beziehung beschreiben, die aus der Serviceanwendung gelöscht werden soll.

    Datentyp: Objekt

    "child": {
      "<IRE field name>": "String",
      "number": "String",
      "sys_id": "String"
    }
    Untergeordnetes Element.<IRE-Feldname> Mindestens ein IRE-Feld, das den untergeordneten Anwendungsservice identifiziert. Beispiel: Name oder Version.

    Datentyp: Zeichenfolge

    Untergeordnetes Element Eindeutige Nummer, die den untergeordneten Anwendungsservice identifiziert.

    Datentyp: Zeichenfolge

    Child.sys_ID SYS_ID des untergeordneten Anwendungsservice, der in der Serviceinstanz [cmdb_ci_Service_Auto] aufgeführt ist.

    Datentyp: Zeichenfolge

    übergeordnet Details zur Identifizierung des übergeordneten Anwendungsservice, aus dem eine Beziehung entfernt werden soll.

    Datentyp: Objekt

    "parent": {
      "<IRE field name>": "String",
      "number": "String",
      "sys_id": "String",
      "class_name": "String"
    }
    Übergeordnetes Element.<IRE-Feldname> Mindestens ein Ire-Feld, das den Anwendungsservice identifiziert. Beispiel: Name oder Version.

    Datentyp: Zeichenfolge

    Übergeordnetes Element Eindeutige Nummer, die den Anwendungsservice identifiziert.

    Datentyp: Zeichenfolge

    Parent.sys_ID SYS_ID des Anwendungsservice, der in der Tabelle „Serviceinstanz“ [cmdb_ci_Service_Auto] aufgeführt ist.

    Datentyp: Zeichenfolge

    Parent.class_Name Name der Klasse, die den Anwendungsservice enthält.
    Der Name der übergeordneten Klasse muss aus einer der folgenden Tabellen stammen:
    • cmdb_ci_Service_Auto
    • cmdb_ci_Service_detected
    • cmdb_ci_Service_by_Tags
    • cmdb_ci_Service_Calculated
    • Service.Offering
    • cmdb_ci_business_app

    Standard: cmdb_ci_Service_Auto

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

    Tabelle : 42. 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 Anwenderanmeldeinformationen sind falsch, oder der Anwender hat nicht die Rolle „App_Service_admin“.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Parameter des Antwort-Haupttexts (JSON)

    Name Beschreibung
    status Gibt Erfolg oder Fehler an.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Das folgende Beispiel zeigt, wie Sie eine Beziehung aus einem Anwendungsservice entfernen.

    curl "https://instance.service-now.com/api/sn_service_graph/sg_services/app_service/relationship/delete" \
    --request POST \
    --header "Accept:application/json" \
    --header "Content-Type:application/json" \
    --data "{
      \"child\": {
      \"name\": \"Test Register\",
      \"environment\": \"Test\",
      \"version\": \"1.0\"
    
      },
      \"parent\": {
       \"sys_id\": \"abcdefg\",
       \"name\": \"business App1\",
       \"class_name\": \"service_offering\"
         }
     }" \
    --user 'username':'password'

    Ergebnisse, die auf eine erfolgreiche Entfernung einer Anwendungsservice-Beziehung hinweisen.

    {
      "result": {
      "status": "success"
      }
    }

    SG-Services: POST /sg_Services/App_Service/State

    Ändert den Lebenszyklusstatus des Anwendungsservice in „Aktivieren“, „Deaktivieren“ oder „Stilllegen“.

    Die folgenden Eigenschaften zum Identifizieren eines CI haben wie folgt Vorrang:
    1. sys_ID: Bei sys_ID verwendet das System nur die sys_ID und ignoriert alle zusätzlichen Werte.
    2. Zahl: Wenn ohne sys_ID angegeben, verwendet das System nur die Zahl und ignoriert alle zusätzlichen Werte.
    3. <Ire-Feldname>: Das System verwendet diese Werte nur, wenn die sys_ID oder die Zahl nicht angegeben ist.

    URL-Format

    Versionierte URL: /api/sn_Service_Graph/{api_Version}/sg_Services/App_Service/State

    Standard-URL: /api/sn_Service_Graph/sg_Services/App_Service/State

    Hinweis:
    Verfügbare Versionen werden in angegeben REST API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf der Formular „geskripteter REST-Service“ .

    Unterstützte Anforderungsparameter

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

    Datentyp: Zeichenfolge

    Tabelle : 44. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 45. Anforderungstext-Parameter (JSON)
    Name Beschreibung
    <Ire-Feldname> Mindestens ein Ire-Feld, das den Anwendungsservice identifiziert. Beispiel: Name oder Version.

    Datentyp: Zeichenfolge

    Nummer Eindeutige Nummer, die den Anwendungsservice identifiziert.

    Datentyp: Zeichenfolge

    Status Erforderlich. Lebenszyklusstatus des Anwendungsservice.
    Gültige Werte:
    • AKTIVIEREN: Lebenszyklus ist funktionsfähig und wird verwendet.
      • Life_Cycle_stage=betriebsbereit
      • Life_Cycle_stage_Status=in Gebrauch
      • Operational_Status=operativ
    • DEAKTIVIEREN: Der Lebenszyklus ist nicht funktionsfähig und befindet sich in der Designphase.
      • Life_Cycle_stage=Design
      • Life_Cycle_stage_Status=Build
      • Operational_Status=nicht funktionsfähig
    • STILLLEGEN: Ende der Lebensdauer.
      • Life_Cycle_stage=Ende der Lebensdauer
      • Life_Cycle_stage_Status=stillgelegt
      • Operational_Status=stillgelegt

    Datentyp: Zeichenfolge

    Gespeichert in: Serviceinstanz [cmdb_ci_Service_Auto]

    sys_id SYS_ID des Anwendungsservice, der in der Tabelle „Serviceinstanz“ [cmdb_ci_Service_Auto] aufgeführt ist.

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

    Tabelle : 48. 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 Anwenderanmeldeinformationen sind falsch, oder der Anwender hat nicht die Rolle „App_Service_admin“.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Parameter des Antwort-Haupttexts (JSON)

    Name Beschreibung
    status Gibt Erfolg oder Fehler an.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Das folgende Beispiel zeigt, wie Sie den Lebenszyklusstatus eines Anwendungsservice in „Aktivieren“ ändern.

    curl "https://instance.service-now.com/api/sn_service_graph/sg_services/app_service/state" \
    --request POST \
    --header "Accept:application/json" \
    --header "Content-Type:application/json" \
    --data "{
      {
      \"name\": \"Test Register\",
      \"environment\": \"Test\",
      \"version\": \"1.0\",
      \"state\": \"activate\"
      }
    }" \
    --user 'username':'password'

    Ergebnisse, die auf einen erfolgreichen Vorgang hinweisen.

    {
      "result": {
      "status": "success"
      }
    }

    SG-Services: NACH /sg_Services/App_Service/Update

    Aktualisiert einen vorhandenen bereitgestellten Anwendungsservice und erstellt Tags für den angegebenen Anwendungsservice.

    Die folgenden Eigenschaften zum Identifizieren eines CI haben wie folgt Vorrang:
    1. sys_ID: Bei sys_ID verwendet das System nur die sys_ID und ignoriert alle zusätzlichen Werte.
    2. Zahl: Wenn ohne sys_ID angegeben, verwendet das System nur die Zahl und ignoriert alle zusätzlichen Werte.
    3. <Ire-Feldname>: Das System verwendet diese Werte nur, wenn die sys_ID oder die Zahl nicht angegeben ist.

    URL-Format

    Versionierte URL: /api/sn_Service_Graph/{api_Version}/sg_Services/App_Service/Update

    Standard-URL: /api/sn_Service_Graph/sg_Services/App_Service/Update

    Hinweis:
    Verfügbare Versionen werden in angegeben REST API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf der Formular „geskripteter REST-Service“ .

    Unterstützte Anforderungsparameter

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

    Datentyp: Zeichenfolge

    Tabelle : 50. Anforderungstext-Parameter (JSON)
    Name Beschreibung
    <zu aktualisierende Felder oder Tags> Verwenden Sie Schlüssel-Wert-Paare, um jedes zu aktualisierende Feld oder Tag zu identifizieren.

    Nur grundlegende Informationen können aktualisiert werden, keine vorgelagerten Beziehungen können aktualisiert werden.

    Datentyp: Zeichenfolge

    <Ire-Feldname> Mindestens ein Ire-Feld, das den Anwendungsservice identifiziert. Beispiel: Name oder Version.

    Sie können die sys_ID, die Nummer oder die IRE senden, um einen Anwendungsservice zu identifizieren. Keines dieser Felder kann jedoch aktualisiert werden, wenn sie als Bezeichner verwendet werden. Um die IRE-Felder zu aktualisieren, muss die Eingabe die sys_ID oder sys_number als Bezeichner enthalten.

    Datentyp: Zeichenfolge

    Nummer Eindeutige Nummer, die den Anwendungsservice identifiziert.

    Datentyp: Zeichenfolge

    sys_id SYS_ID des Anwendungsservice, der in der Tabelle „Serviceinstanz“ [cmdb_ci_Service_Auto] aufgeführt ist.

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

    Tabelle : 53. 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 Anwenderanmeldeinformationen sind falsch, oder der Anwender hat nicht die Rolle „App_Service_admin“.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Parameter des Antwort-Haupttexts (JSON)

    Name Beschreibung
    <Ire-Feldname> Mindestens ein Ire-Feld, das den Anwendungsservice identifiziert. Beispiel: Name oder Version.

    Datentyp: Zeichenfolge

    Nummer Eindeutige Nummer, die den Anwendungsservice identifiziert.

    Datentyp: Zeichenfolge

    sys_id SYS_ID des Anwendungsservice, der in der Tabelle „Serviceinstanz“ [cmdb_ci_Service_Auto] aufgeführt ist.

    Datentyp: Zeichenfolge

    <updated fields> Wenn die Aktualisierung erfolgreich ist, wird jedes geänderte Feld, das in der Nutzlast gesendet wird, im Antworttext aufgeführt.

    cURL-Anforderung

    Das folgende Beispiel zeigt, wie Sie einen Anwendungsservice mithilfe des Namens als IRE-Feld aktualisieren.

    curl "https://instance.service-now.com/api/sn_service_graph/sg_services/app_service/update" \
    --request POST \
    --header "Accept:application/json" \
    --header "Content-Type:application/json" \
    --data "{
      {
       \"name\": \"Test Register\",
       \"environment\": \"Test\",
       \"version\": \"1.0\"
      }
    }" \
    --user 'username':'password'

    Die Antwort enthält Informationen zur Identifizierung des Anwendungsservice und aktualisierte Felder.

    {
      "result": {
      "sys_id": "123456",
      "number": "SVCKji0w9e",
      "name": "Test Register",
      "environment": "Test",
      "version": "1.0"
      }
    }