SG-Services-API

Die SG Services API stellt Endpunkte zum Erstellen und Verwalten von Anwendungsservices und den 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 zum Release für alle veröffentlichten Apps finden Sie in den Versionshinweisen zum ServiceNow Store.

Diese API kann nur verwendet werden, wenn das Plugin „CMDB Application API and CLI“ (sn_service_graph) aktiviert ist. Diese API wird innerhalb des Namespace sn_service_graph verwendet.

Zur Verwendung dieser API sind keine Details zu Quelltabellen oder Beziehungstypen erforderlich.

Um Skripts für kritische Vorgänge zu erstellen, die die Automatisierung im gesamten Unternehmen unterstützen, können Sie APIs nutzen oder Befehlszeilenvorgänge ausführen, die von der CMDB-Anwendungs-CLI und der API-Store-App bereitgestellt werden, anstatt die Anwenderoberfläche zu verwenden. Die CMDB-Anwendungs-CLI und API-Store-App bieten ein robustes Framework, das alle APIs für Anwendungsservices und die Befehlszeilen konsolidiert, mit denen Sie auf die Schnittstelle für diese APIs zugreifen können.

Die CLI- und API-Befehle der CMDB-Anwendung ermöglichen die folgenden Aufgaben:

• Registrieren und Erstellen eines Anwendungsservice sowie Aufbau vorgelagerter Beziehungen
• Details zu einem bestimmten Anwendungsservice und seinen vorgelagerten Beziehungen abrufen
• Konstrukte auf höherer Ebene wie Geschäftsanwendungen und Business-Service-Angebote werden miteinander verbunden
• Beim Ausfüllen eines Anwendungsservice mit einem bestimmten Auffüllungstyp
• Der Status eines Anwendungsservice wird geändert

Informationen zur Befehlszeilenlösung finden Sie unter Für CMDB-Anwendungs-CLIs und APIs verfügbare Befehle.

SG Services – POST – /sg_services/app_service/convert

Konvertiert einen Anwendungsservice vom Typ „Manuell“ oder „Leer“ 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: Wenn sys_id, verwendet das System nur die sys_id und ignoriert alle zusätzlichen Werte.
2. Zahl: Bei Angabe ohne sys_id verwendet das System nur die Zahl und ignoriert alle zusätzlichen Werte.
3. <IRE field name>– Das System verwendet diese Werte nur, wenn die sys_id oder Nummer nicht angegeben ist.

URL-Format

URL mit Versionsnummer: /api/sn_service_graph/{api_version}/sg_services/app_service/convert

Standard-URL: /api/sn_service_graph/sg_services/app_service/convert

Unterstützte Anforderungsparameter

Tabelle : 1. Pfadparameter

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

Tabelle : 2. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 3. Parameter des Anforderungstexts (JSON)

Name	Beschreibung
<IRE field name>	Ein oder mehrere IRE-Felder, die den Anwendungsservice identifizieren. Zum Beispiel Name oder Version. Datentyp: Zeichenfolge
Ebenen	Anzahl der Ebenen, die in die Konvertierung aufgenommen werden sollen. Datentyp: Zeichenfolge
Nummer	Eindeutige Nummer, die den Anwendungsservice identifiziert. Datentyp: Zeichenfolge
sys_id	Sys_id des in der Tabelle „Anwendungsservice“ [cmdb_ci_service_auto] aufgeführten Anwendungsservices. 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 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 Anmeldeinformationen des Anwenders sind falsch, oder der Anwender verfügt 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.

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 auf eine erfolgreiche Konvertierung in einen berechneten Anwendungsservice hinweisen.

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

SG-Services – POST – /sg_services/app_service/delete

Löscht einen Anwendungsservice.

Die folgenden Eigenschaften zum Identifizieren eines CI haben wie folgt Vorrang:

1. sys_id: Wenn sys_id, verwendet das System nur die sys_id und ignoriert alle zusätzlichen Werte.
2. Zahl: Bei Angabe ohne sys_id verwendet das System nur die Zahl und ignoriert alle zusätzlichen Werte.
3. <IRE field name>– Das System verwendet diese Werte nur, wenn die sys_id oder Nummer nicht angegeben ist.

URL-Format

URL mit Versionsnummer: /api/sn_service_graph/{api_version}/sg_services/app_service/delete

Standard-URL: /api/sn_service_graph/sg_services/app_service/delete

Unterstützte Anforderungsparameter

Tabelle : 7. Pfadparameter

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

Tabelle : 8. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 9. Parameter des Anforderungstexts (JSON)

Name	Beschreibung
<IRE field name>	Ein oder mehrere IRE-Felder, die den Anwendungsservice identifizieren. Zum Beispiel Name oder Version. Datentyp: Zeichenfolge
Nummer	Eindeutige Nummer, die den Anwendungsservice identifiziert. Datentyp: Zeichenfolge
sys_id	Sys_id des in der Tabelle „Anwendungsservice“ [cmdb_ci_service_auto] aufgeführten Anwendungsservices. 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 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 Anmeldeinformationen des Anwenders sind falsch, oder der Anwender verfügt 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.

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 hindeuten.

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

SG Services – POST – /sg_services/app_service/find

Sucht die Details eines bestimmten Anwendungsservice und seiner vorgelagerten Beziehungen.

Benutzer mit der Rolle „app_service_user“ können diese API verwenden, die Ergebnisse sind jedoch auf Anwendungsservices im Status „Operativ“ 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: Wenn sys_id, verwendet das System nur die sys_id und ignoriert alle zusätzlichen Werte.
2. Zahl: Bei Angabe ohne sys_id verwendet das System nur die Zahl und ignoriert alle zusätzlichen Werte.
3. <IRE field name>– Das System verwendet diese Werte nur, wenn die sys_id oder Nummer nicht angegeben ist.

URL-Format

URL mit Versionsnummer: /api/sn_service_graph/{api_version}/sg_services/app_service/find

Standard-URL: /api/sn_service_graph/sg_services/app_service/find

Unterstützte Anforderungsparameter

Tabelle : 13. Pfadparameter

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

Tabelle : 14. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 15. Parameter des Anforderungstexts (JSON)

Name	Beschreibung
<IRE fields>	Ein oder mehrere IRE-Felder, die den Anwendungsservice identifizieren. Zum Beispiel Name oder Version. Datentyp: Zeichenfolge
Nummer	Eindeutige Nummer, die den Anwendungsservice identifiziert. Datentyp: Zeichenfolge
sys_id	Sys_id des in der Tabelle „Anwendungsservice“ [cmdb_ci_service_auto] aufgeführten Anwendungsservices. 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 HTTP-Antwortcodesder REST-API.

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 Anmeldeinformationen des Anwenders sind falsch, oder der Anwender verfügt 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.

Parameter des Antwort-Haupttexts (JSON)

Name	Beschreibung
<IRE field name>	Ein oder mehrere IRE-Felder, die den Anwendungsservice identifizieren. Zum Beispiel Name oder Version. Datentyp: Zeichenfolge
Nummer	Eindeutige Nummer, die den Anwendungsservice identifiziert. Datentyp: Zeichenfolge
operational_status	Betriebsstatus des Anwendungsservice. Beispiel: active. Datentyp: Zeichenfolge
Beziehungen	Liste von Objekten, 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.anzahl	Eindeutige Nummer der Beziehung Datentyp: Zeichenfolge
Beziehungen.Beziehung	Beziehungsregel Datentyp: Zeichenfolge
beziehungen.sys_id	Sys_id der Beziehung. Datentyp: Zeichenfolge
sys_id	Sys_id des in der Tabelle „Anwendungsservice“ [cmdb_ci_service_auto] aufgeführten Anwendungsservices. 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 Informationen zum Anwendungsservice und zur Beziehung.

{
  "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 – POST – /sg_services/app_service/populate

Füllt einen Anwendungsservice mit einer Serviceauffüllungsmethode auf.

Die folgenden Eigenschaften zum Identifizieren eines CI haben wie folgt Vorrang:

1. sys_id: Wenn sys_id, verwendet das System nur die sys_id und ignoriert alle zusätzlichen Werte.
2. Zahl: Bei Angabe ohne sys_id verwendet das System nur die Zahl und ignoriert alle zusätzlichen Werte.
3. <IRE field name>– Das System verwendet diese Werte nur, wenn die sys_id oder Nummer nicht angegeben ist.

URL-Format

URL mit Versionsnummer: /api/sn_service_graph/{api_version}/sg_services/app_service/populate

Standard-URL: /api/sn_service_graph/sg_services/app_service/populate

Unterstützte Anforderungsparameter

Tabelle : 19. Pfadparameter

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

Tabelle : 20. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 21. Parameter des Anforderungstexts (JSON)

Name	Beschreibung
<IRE field name>	Ein oder mehrere IRE-Felder, die den Anwendungsservice identifizieren. Zum Beispiel Name oder Version. Datentyp: Zeichenfolge
Nummer	Eindeutige Nummer, die den Anwendungsservice identifiziert. Datentyp: Zeichenfolge
„population_method“	Erforderlich. Identifiziert die Ausfüllmethode und die zugehörige Eigenschaft, um den Inhalt für die Ausfüllung zu identifizieren. Pro Typ ist nur ein zugehöriges Objekt gültig. Datentyp: Objekt
„population_method.group_id“	Gruppen-ID der CMDB-Gruppe, die mit dem Ausfüllungstyp „cmdb_group“ konfiguriert ist. Datentyp: „Zeichenfolge“ "population_method": { "group_id": "String", "type": "cmdb_group" } Zugehöriger Auffüllungstyp: cmdb_group
„population_method.levels“	Anzahl der Ebenen, die beim Erstellen des Service verwendet werden sollen. Wenn der Ebenenwert nicht angegeben wird, sucht das System nach dem Wert in sys_property. 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" } Zugehöriger Auffüllungstyp: dynamic_service Standard: 3, wenn für sys_property kein Ebenenwert festgelegt ist
„population_method.service_candidate“	Eindeutiger Bezeichner des Service-Candidate. 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 innerhalb des 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" } Zugehöriger Auffüllungstyp: service_hierarchy
„population_method.service_relations.child“	Name eines dem CI zugehörigen untergeordneten CI. Datentyp: Zeichenfolge
„population_method.service_relations.parent“	Name des ü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_group service_hierarchy dynamic_service tag_list tag_based_service_family
sys_id	Sys_id des in der Tabelle „Anwendungsservice“ [cmdb_ci_service_auto] aufgeführten Anwendungsservices. 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 HTTP-Antwortcodesder REST-API.

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 Anmeldeinformationen des Anwenders sind falsch, oder der Anwender verfügt 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.

Parameter des Antwort-Haupttexts (JSON)

Name	Beschreibung
status	Gibt Erfolg oder Fehler an. Datentyp: Zeichenfolge

cURL-Anforderung

Das folgende Beispiel zeigt, wie ein Anwendungsservice mit dem Typ „dynamic_service“ gefüllt wird.

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 ein erfolgreiches Ausfüllen eines Anwendungsservice hinweisen.

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

SG Services – POST – /sg_services/app_service/register

Erstellt einen Anwendungsservice, Tags und erstellt vorgelagerte Beziehungen wie Geschäftsanwendungen, Business-Service-Angebote und andere Anwendungsservices.

Die folgenden Eigenschaften zum Identifizieren eines CI haben wie folgt Vorrang:

1. sys_id: Wenn sys_id, verwendet das System nur die sys_id und ignoriert alle zusätzlichen Werte.
2. Zahl: Bei Angabe ohne sys_id verwendet das System nur die Zahl und ignoriert alle zusätzlichen Werte.
3. <IRE field name>– Das System verwendet diese Werte nur, wenn die sys_id oder Nummer nicht angegeben ist.

URL-Format

URL mit Versionsnummer: /api/sn_service_graph/{api_version}/sg_services/app_service/register

Standard-URL: /api/sn_service_graph/sg_services/app_service/register

Unterstützte Anforderungsparameter

Tabelle : 25. Pfadparameter

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

Tabelle : 26. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 27. Parameter des Anforderungstexts (JSON)

Name	Beschreibung
<IRE field name>	Ein oder mehrere IRE-Felder, die den Anwendungsservice identifizieren. Zum Beispiel Name oder Version. Datentyp: Zeichenfolge
Nummer	Eindeutige Nummer, die den Anwendungsservice identifiziert. Datentyp: Zeichenfolge
Beziehungen	Vorgelagerte Beziehungen nach Typ kategorisiert. Datentyp: Objekt "relationships": { "business_app": [Array], "business_service_offering": [Array], "parent_app_service": [Array], "technical_service_offering": [Array] } Die maximale Anzahl der Beziehungen beträgt 25.
beziehungen.business_app	Liste von Objekten, die Beziehungstypen für Geschäftsanwendungen darstellen. Diese Werte können mit einem der folgenden Elemente als Schlüssel-Wert-Paare definiert werden. <IRE field name> Nummer sys_id Datentyp: Array
beziehungen.business_service_offering	Liste von Objekten, die Beziehungstypen für Business-Service-Angebote darstellen. Diese Werte können mit den folgenden Elementen als Schlüssel-Wert-Paare definiert werden. <IRE field name> Nummer sys_id Datentyp: Array
beziehungen.parent_app_service	Liste von Objekten, die Anwendungsservice-Beziehungstypen darstellen. Diese Werte können mit den folgenden Elementen als Schlüssel-Wert-Paare definiert werden. <IRE field name> Nummer sys_id Datentyp: Array
beziehungen.technical_service_offering	Liste von Objekten, die Beziehungstypen für technische Serviceangebote darstellen. Diese Werte können mit den folgenden Elementen als Schlüssel-Wert-Paare definiert werden. <IRE field name> Nummer sys_id Datentyp: Array
sys_id	Sys_id des in der Tabelle „Anwendungsservice“ [cmdb_ci_service_auto] aufgeführten Anwendungsservices. Datentyp: Zeichenfolge
tags	Liste von Objekten, die Tag-Definitionen als Schlüssel-Wert-Paare enthalten. "tags": [ { "key": "String", "value": "String" }] Datentyp: Array
Tags.Schlüssel	Name der Tag-Kategorie. 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 HTTP-Antwortcodesder REST-API.

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 Anmeldeinformationen des Anwenders sind falsch, oder der Anwender verfügt 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.

Parameter des Antwort-Haupttexts (JSON)

cHeader	Beschreibung
app_service	Anwendungsservicedetails. 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 in der Tabelle „Anwendungsservice“ [cmdb_ci_service_auto] aufgeführten Anwendungsservices. 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 Sie einen Anwendungsservice registrieren.

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 Informationen zur ID und zum Status.

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

SG Services – POST – /sg_services/app_service/relationship/create

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

Diese API erstellt eine Beziehung, indem sie Eingaben mit einem einzelnen übergeordneten und einem entsprechenden untergeordneten Objekt akzeptiert.

Die folgenden Eigenschaften zum Identifizieren eines CI haben wie folgt Vorrang:

1. sys_id: Wenn sys_id, verwendet das System nur die sys_id und ignoriert alle zusätzlichen Werte.
2. Zahl: Bei Angabe ohne sys_id verwendet das System nur die Zahl und ignoriert alle zusätzlichen Werte.
3. <IRE field name>– Das System verwendet diese Werte nur, wenn die sys_id oder Nummer nicht angegeben ist.

URL-Format

URL mit Versionsnummer: /api/sn_service_graph/{api_version}/sg_services/app_service/relationship/create

Standard-URL: /api/sn_service_graph/sg_services/app_service/relationship/create

Unterstützte Anforderungsparameter

Tabelle : 31. Pfadparameter

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

Tabelle : 32. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 33. Parameter des Anforderungstexts (JSON)

Name	Beschreibung
child	Informationen, die den untergeordneten Anwendungsservice identifizieren, mit dem eine Beziehung erstellt werden soll. Das untergeordnete Element befindet sich in der Tabelle „Anwendungsservice“ [cmdb_ci_service_auto]. Eine dynamische CI-Gruppe kann als untergeordnetes Element hinzugefügt werden, kann jedoch nicht übergeordnet sein. Datentyp: Objekt "child": { "<service_app_identifier>": "String" }
untergeordnetes Element.<service_app_identifier>	Details zum Identifizieren des untergeordneten Anwendungsservice, mit dem eine Beziehung erstellt werden soll. Nur eine Option ist erforderlich. Jede Option ist nach Verarbeitungsrangfolge aufgelistet: sys_id: Sys_id des untergeordneten Anwendungsservice. Nummer: Eindeutige Nummer, die den untergeordneten Anwendungsservice identifiziert. <IRE field name>– IRE-Felder, die den Anwendungsservice identifizieren. Zum Beispiel Name oder Version. Datentyp: Zeichenfolge
übergeordnet	Details, die den übergeordneten Anwendungsservice identifizieren, mit dem eine Beziehung erstellt werden soll. Datentyp: Objekt "parent": { "<service_app_identifier>": "String", "class_name": "String" }
Übergeordnet.<service_app_identifier>	Informationen zum Identifizieren des Anwendungsservice. Nur eine Option ist erforderlich. Jede Option ist nach Verarbeitungsrangfolge aufgelistet: sys_id: Sys_id des im Anwendungsservice [cmdb_ci_service_auto] aufgeführten Anwendungsservices. Nummer – Eindeutige Nummer, die den Anwendungsservice identifiziert. <IRE field name>– Ein oder mehrere IRE-Felder, die den Anwendungsservice identifizieren. Zum 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_service_auto cmdb_ci_service_discovered 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 : 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 HTTP-Antwortcodesder REST-API.

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 Anmeldeinformationen des Anwenders sind falsch, oder der Anwender verfügt 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.

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 erstellen.

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 – POST – /sg_services/app_service/relationship/delete

Löscht eine vorgelagerte Beziehung eines Anwendungsservice.

Die folgenden Eigenschaften zum Identifizieren eines CI haben wie folgt Vorrang:

1. sys_id: Wenn sys_id, verwendet das System nur die sys_id und ignoriert alle zusätzlichen Werte.
2. Zahl: Bei Angabe ohne sys_id verwendet das System nur die Zahl und ignoriert alle zusätzlichen Werte.
3. <IRE field name>– Das System verwendet diese Werte nur, wenn die sys_id oder Nummer nicht angegeben ist.

URL-Format

URL mit Versionsnummer: /api/sn_service_graph/{api_version}/sg_services/app_service/relationship/delete

Standard-URL: /api/sn_service_graph/sg_services/app_service/relationship/delete

Unterstützte Anforderungsparameter

Tabelle : 37. Pfadparameter

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

Tabelle : 38. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 39. Parameter des Anforderungstexts (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 field name>	Mindestens ein IRE-Feld, das den untergeordneten Anwendungsservice identifiziert Zum Beispiel Name oder Version. Datentyp: Zeichenfolge
untergeordnet.nummer	Eindeutige Nummer, die den untergeordneten Anwendungsservice identifiziert. Datentyp: Zeichenfolge
child.sys_id	Sys_id des untergeordneten Anwendungsservice, der im Anwendungsservice [cmdb_ci_service_auto] aufgeführt ist. Datentyp: Zeichenfolge
übergeordnet	Details, die den übergeordneten Anwendungsservice identifizieren, aus dem eine Beziehung entfernt werden soll. Datentyp: Objekt "parent": { "<IRE field name>": "String", "number": "String", "sys_id": "String", "class_name": "String" }
Übergeordnet.<IRE field name>	Ein oder mehrere IRE-Felder, die den Anwendungsservice identifizieren. Zum Beispiel Name oder Version. Datentyp: Zeichenfolge
parent.number	Eindeutige Nummer, die den Anwendungsservice identifiziert. Datentyp: Zeichenfolge
parent.sys_id	Sys_id des in der Tabelle „Anwendungsservice“ [cmdb_ci_service_auto] aufgeführten Anwendungsservices. 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_discovered 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 HTTP-Antwortcodesder REST-API.

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 Anmeldeinformationen des Anwenders sind falsch, oder der Anwender verfügt 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.

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 „Stillgelegt“.

Die folgenden Eigenschaften zum Identifizieren eines CI haben wie folgt Vorrang:

1. sys_id: Wenn sys_id, verwendet das System nur die sys_id und ignoriert alle zusätzlichen Werte.
2. Zahl: Bei Angabe ohne sys_id verwendet das System nur die Zahl und ignoriert alle zusätzlichen Werte.
3. <IRE field name>– Das System verwendet diese Werte nur, wenn die sys_id oder Nummer nicht angegeben ist.

URL-Format

URL mit Versionsnummer: /api/sn_service_graph/{api_version}/sg_services/app_service/state

Standard-URL: /api/sn_service_graph/sg_services/app_service/state

Unterstützte Anforderungsparameter

Tabelle : 43. Pfadparameter

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

Tabelle : 44. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 45. Parameter des Anforderungstexts (JSON)

Name	Beschreibung
<IRE field name>	Ein oder mehrere IRE-Felder, die den Anwendungsservice identifizieren. Zum Beispiel Name oder Version. Datentyp: Zeichenfolge
Nummer	Eindeutige Nummer, die den Anwendungsservice identifiziert. Datentyp: Zeichenfolge
Staat	Erforderlich. Lebenszyklusstatus des Anwendungsservice. Diese Werte werden in der Tabelle „Anwendungsservices“ [cmdb_ci_service_auto] aktualisiert. Gültige Werte: AKTIVIEREN – Der Lebenszyklus ist betriebsbereit und wird verwendet. operational_status=Funktionsfähig life_cycle_stage=Funktionsfähig life_cycle_stage_status=In Gebrauch DEAKTIVIEREN: Der Lebenszyklus ist nicht funktionsfähig und befindet sich in der Designphase. operational_status=Nicht funktionsfähig Life_cycle_stage = Design Life_cycle_stage_status=Build RETIRE: Ende der Lebensdauer. operational_status=Stillgelegt Life_cycle_stage = Ende der Lebensdauer Life_cycle_stage_status=Stillgelegt Datentyp: Zeichenfolge
sys_id	Sys_id des in der Tabelle „Anwendungsservice“ [cmdb_ci_service_auto] aufgeführten Anwendungsservices. 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 HTTP-Antwortcodesder REST-API.

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 Anmeldeinformationen des Anwenders sind falsch, oder der Anwender verfügt 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.

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 hindeuten.

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

SG Services – POST – /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: Wenn sys_id, verwendet das System nur die sys_id und ignoriert alle zusätzlichen Werte.
2. Zahl: Bei Angabe ohne sys_id verwendet das System nur die Zahl und ignoriert alle zusätzlichen Werte.
3. <IRE field name>– Das System verwendet diese Werte nur, wenn die sys_id oder Nummer nicht angegeben ist.

URL-Format

URL mit Versionsnummer: /api/sn_service_graph/{api_version}/sg_services/app_service/update

Standard-URL: /api/sn_service_graph/sg_services/app_service/update

Unterstützte Anforderungsparameter

Tabelle : 49. Pfadparameter

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

Tabelle : 50. Parameter des Anforderungstexts (JSON)

Name	Beschreibung
<fields or tags to update>	Verwenden Sie Schlüssel-Wert-Paare, um jedes Feld oder Tag zu identifizieren, das aktualisiert werden soll. Nur grundlegende Informationen können aktualisiert werden. Es können keine vorgelagerten Beziehungen aktualisiert werden. Datentyp: Zeichenfolge
<IRE field name>	Ein oder mehrere IRE-Felder, die den Anwendungsservice identifizieren. Zum 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 es als Bezeichner verwendet wird. Um die IRE-Felder zu aktualisieren, muss die Eingabe die sys_id oder Nummer als Bezeichner enthalten. Datentyp: Zeichenfolge
Nummer	Eindeutige Nummer, die den Anwendungsservice identifiziert. Datentyp: Zeichenfolge
sys_id	Sys_id des in der Tabelle „Anwendungsservice“ [cmdb_ci_service_auto] aufgeführten Anwendungsservices. 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 HTTP-Antwortcodesder REST-API.

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 Anmeldeinformationen des Anwenders sind falsch, oder der Anwender verfügt 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.

Parameter des Antwort-Haupttexts (JSON)

Name	Beschreibung
<IRE field name>	Ein oder mehrere IRE-Felder, die den Anwendungsservice identifizieren. Zum Beispiel Name oder Version. Datentyp: Zeichenfolge
Nummer	Eindeutige Nummer, die den Anwendungsservice identifiziert. Datentyp: Zeichenfolge
sys_id	Sys_id des in der Tabelle „Anwendungsservice“ [cmdb_ci_service_auto] aufgeführten Anwendungsservices. Datentyp: Zeichenfolge
<updated fields>	Wenn das Update erfolgreich ist, wird jedes in der Nutzlast gesendete geänderte Feld im Antworttext aufgelistet.

cURL-Anforderung

Das folgende Beispiel zeigt, wie Sie einen Anwendungsservice aktualisieren, indem Sie den Namen als IRE-Feld verwenden.

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"
  }
}