SG-Services-API

Die SG Services API bietet Endpunkte zum Erstellen und Verwalten von Anwendungsservices und den vorgelagerten Beziehungen zwischen ihnen.

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.

Für die Verwendung dieser API sind keine Details zu Quelltabellen oder Beziehungstypen erforderlich.

Um ein Skript 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 Benutzeroberfläche zu verwenden. Die Store-App CMDB Application CLI und API bietet ein robustes Framework, das alle APIs im Zusammenhang mit Anwendungsservices und die Befehlszeilen konsolidiert, mit denen Sie auf die Schnittstelle zu diesen APIs zugreifen können.

CMDB-Anwendungs-CLI- und -API-Befehle ermöglichen die folgenden Aufgaben:

• Anwendungsservice registrieren und erstellen und vorgelagerte Beziehungen herstellen
• Abrufen von Details eines bestimmten Anwendungsservice und seiner vorgelagerten Beziehungen
• Verbinden von übergeordneten Konstrukten wie Geschäftsanwendungen und Geschäftsserviceangeboten
• Anwendungsservice mit einem bestimmten Auffüllungstyp ausfüllen
• Status eines Anwendungsservice ändern

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

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

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. Anforderungstextparameter (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 einbezogen werden sollen. Datentyp: Zeichenfolge
Nummer	Eindeutige Nummer, die den Anwendungsservice identifiziert. Datentyp: Zeichenfolge
sys_id	Sys_id des Anwendungsservice, der in der Anwendungsservice-Tabelle [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 HTTP-Antwortcodesder REST-API.

Tabelle : 6. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
401	Nicht autorisiert Die Benutzeranmeldeinformationen sind falsch, oder der Benutzer 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 Misserfolg 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. Nummer: Wenn ohne sys_id angegeben, verwendet das System nur die Nummer und ignoriert zusätzliche Werte.
3. <IRE field name>– Das System verwendet diese Werte nur, wenn sys_id oder Nummer 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

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. Anforderungstextparameter (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 Anwendungsservice, der in der Anwendungsservice-Tabelle [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 HTTP-Antwortcodesder REST-API.

Tabelle : 12. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
401	Nicht autorisiert Die Benutzeranmeldeinformationen sind falsch, oder der Benutzer 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 Misserfolg 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 – POST – /sg_services/app_service/find

Sucht nach den 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 „Betriebsbereit“ 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. Nummer: Wenn ohne sys_id angegeben, verwendet das System nur die Nummer und ignoriert zusätzliche Werte.
3. <IRE field name>– Das System verwendet diese Werte nur, wenn sys_id oder Nummer 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

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. Anforderungstextparameter (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 Anwendungsservice, der in der Anwendungsservice-Tabelle [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 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 Benutzeranmeldeinformationen sind falsch, oder der Benutzer 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. Zum 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" } ]
„relationships.class_name“	Name der Klasse, die den Anwendungsservice enthält. Datentyp: Zeichenfolge
beziehungen.name	Name der Beziehung. Datentyp: Zeichenfolge
beziehungen.number	Eindeutige Nummer der Beziehung. Datentyp: Zeichenfolge
beziehungen.relationship	Die Beziehungsregel. Datentyp: Zeichenfolge
beziehungen.sys_id	Sys_id der Beziehung. Datentyp: Zeichenfolge
sys_id	Sys_id des Anwendungsservice, der in der Anwendungsservice-Tabelle [cmdb_ci_service_auto] aufgeführt ist. Datentyp: Zeichenfolge

cURL-Anforderung

Das folgende Beispiel zeigt, wie Sie Details eines 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 die 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 – POST – /sg_services/app_service/populate

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

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. Nummer: Wenn ohne sys_id angegeben, verwendet das System nur die Nummer und ignoriert zusätzliche Werte.
3. <IRE field name>– Das System verwendet diese Werte nur, wenn sys_id oder Nummer 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

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. Anforderungstextparameter (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 Auffüllungsmethode und die zugehörige Eigenschaft, um den Inhalt für die Auffüllung zu identifizieren. Pro Typ ist nur ein Begleitobjekt gültig. Datentyp: Objekt
„population_method.group_id“	Gruppen-ID der CMDB-Gruppe, die mit dem Auffüllungstyp cmdb_group konfiguriert wurde. Datentyp: „Zeichenfolge“ "population_method": { "group_id": "String", "type": "cmdb_group" } Zugeordneter Auffüllungstyp: cmdb_group
„population_method.level“	Anzahl der beim Erstellen des Service zu verwendenden Ebenen. Wenn der Ebenenwert nicht angegeben ist, überprüft das System 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 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 der Objekte, 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 der Objekte 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 Anwendungsservice, der in der Anwendungsservice-Tabelle [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 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 Benutzeranmeldeinformationen sind falsch, oder der Benutzer 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 Misserfolg an. Datentyp: Zeichenfolge

cURL-Anforderung

Das folgende Beispiel zeigt, wie ein Anwendungsservice mit dem Typ „dynamic_service“ ausgefü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 eine erfolgreiche Auffüllung eines Anwendungsservice hinweisen.

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

SG Services – POST – /sg_services/app_service/register

Erstellt einen Anwendungsservice, markiert und erstellt vorgelagerte Beziehungen wie Geschäftsanwendungen, Geschäftsserviceangebote 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. Nummer: Wenn ohne sys_id angegeben, verwendet das System nur die Nummer und ignoriert zusätzliche Werte.
3. <IRE field name>– Das System verwendet diese Werte nur, wenn sys_id oder Nummer 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

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. Anforderungstextparameter (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, 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 der Objekte, die Geschäftsanwendungs-Beziehungstypen 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 der Objekte, die die Beziehungstypen des Business Service-Angebots darstellen. Diese Werte können mithilfe der folgenden Elemente als Schlüssel-Wert-Paare definiert werden. <IRE field name> Nummer sys_id Datentyp: Array
beziehungen.übergeordnet_app_service	Liste der Objekte, die Anwendungsservice-Beziehungstypen darstellen. Diese Werte können mithilfe der folgenden Elemente als Schlüssel-Wert-Paare definiert werden. <IRE field name> Nummer sys_id Datentyp: Array
beziehungen.technical_service_offering	Liste der Objekte, die die Beziehungstypen des technischen Serviceangebots darstellen. Diese Werte können mithilfe der folgenden Elemente als Schlüssel-Wert-Paare definiert werden. <IRE field name> Nummer sys_id Datentyp: Array
sys_id	Sys_id des Anwendungsservice, der in der Anwendungsservice-Tabelle [cmdb_ci_service_auto] aufgeführt ist. Datentyp: Zeichenfolge
tags	Liste der Objekte, 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 Benutzeranmeldeinformationen sind falsch, oder der Benutzer 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	Anwendungsservice-Details. 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 Anwendungsservice-Tabelle [cmdb_ci_service_auto] aufgeführt ist. Datentyp: Zeichenfolge
Nachricht	Nachricht, die den Status beschreibt. Mögliche Werte: Service ist 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 – POST – /sg_services/app_service/relationship/create

Erstellt vorgelagerte Beziehungen wie Geschäftsanwendungen, Geschäftsserviceangebote und andere Anwendungsservices.

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

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. Nummer: Wenn ohne sys_id angegeben, verwendet das System nur die Nummer und ignoriert zusätzliche Werte.
3. <IRE field name>– Das System verwendet diese Werte nur, wenn sys_id oder Nummer 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

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. Anforderungstextparameter (JSON)

Name	Beschreibung
child	Informationen zur Identifizierung des untergeordneten Anwendungsservice, mit dem eine Beziehung erstellt werden soll. Das untergeordnete Element befindet sich in der Anwendungsservice-Tabelle [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" }
Kind.<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 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 zur Identifizierung des übergeordneten Anwendungsservice, mit dem eine Beziehung erstellt werden soll. Datentyp: Objekt "parent": { "<service_app_identifier>": "String", "class_name": "String" }
übergeordnetes Element.<service_app_identifier>	Informationen zur Identifizierung des Anwendungsservice. Es ist nur eine Option erforderlich. Jede Option wird nach Verarbeitungsrangfolge aufgelistet: sys_id – Sys_id des Anwendungsservice, der im Anwendungsservice [cmdb_ci_service_auto] aufgeführt ist. 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 Benutzeranmeldeinformationen sind falsch, oder der Benutzer 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 Misserfolg 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 Anwendungsservicebeziehung hinweisen.

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

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

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. Anforderungstextparameter (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" }
Kind.<IRE field name>	Ein oder mehrere IRE-Felder, die den untergeordneten Anwendungsservice identifizieren. Zum Beispiel Name oder Version. Datentyp: Zeichenfolge
child.number	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 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 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 Anwendungsservice, der in der Anwendungsservice-Tabelle [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_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 Benutzeranmeldeinformationen sind falsch, oder der Benutzer 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 Misserfolg an. Datentyp: Zeichenfolge

cURL-Anforderung

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

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 Anwendungsservicebeziehung 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 – Wenn sys_id, verwendet das System nur die sys_id und ignoriert alle zusätzlichen Werte.
2. Nummer: Wenn ohne sys_id angegeben, verwendet das System nur die Nummer und ignoriert zusätzliche Werte.
3. <IRE field name>– Das System verwendet diese Werte nur, wenn sys_id oder Nummer 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

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. Anforderungstextparameter (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
Status	Erforderlich. Lebenszyklusstatus des Anwendungsservice. Diese Werte werden in der Tabelle „Anwendungsservices“ [cmdb_ci_service_auto] aktualisiert. Gültige Werte: AKTIVIEREN – Lebenszyklus ist betriebsbereit und wird verwendet. operational_status = Funktionsfähig Life_cycle_stage = Funktionsfähig Life_cycle_stage_status = In Verwendung DEAKTIVIEREN – Lebenszyklus ist nicht betriebsbereit und befindet sich in der Entwurfsphase. operational_status = Nicht funktionsfähig Life_cycle_stage = Design Life_cycle_stage_status = Build RUHESTELLUNG: Ende der Lebensdauer. operational_status = Deaktiviert Life_cycle_stage = Ende der Lebensdauer Life_cycle_stage_status = Deaktiviert Datentyp: Zeichenfolge
sys_id	Sys_id des Anwendungsservice, der in der Anwendungsservice-Tabelle [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 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 Benutzeranmeldeinformationen sind falsch, oder der Benutzer 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 Misserfolg an. Datentyp: Zeichenfolge

cURL-Anforderung

Das folgende Beispiel zeigt, wie Sie den Lebenszyklusstatus eines Anwendungsservice in „Aktiviert“ ä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 – POST – /sg_services/app_service/update

Aktualisiert einen vorhandenen 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. Nummer: Wenn ohne sys_id angegeben, verwendet das System nur die Nummer und ignoriert zusätzliche Werte.
3. <IRE field name>– Das System verwendet diese Werte nur, wenn sys_id oder Nummer 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

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. Anforderungstextparameter (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. Vorgelagerte Beziehungen können nicht 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, Nummer oder 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 Anwendungsservice, der in der Anwendungsservice-Tabelle [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 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 Benutzeranmeldeinformationen sind falsch, oder der Benutzer 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 Anwendungsservice, der in der Anwendungsservice-Tabelle [cmdb_ci_service_auto] aufgeführt ist. Datentyp: Zeichenfolge
<updated fields>	Wenn die Aktualisierung erfolgreich ist, wird jedes in der Nutzlast gesendete geänderte Feld im Antworttext aufgelistet.

cURL-Anforderung

Das folgende Beispiel zeigt, wie ein Anwendungsservice aktualisiert wird, wobei Name als IRE-Feld verwendet wird.

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