CI Lifecycle Management-API

  • Freigeben Version: Yokohama
  • Aktualisiert 30. Januar 2025
  • 28 Minuten Lesedauer

    • Die CI Lifecycle Management- API stellt Endpunkte bereit, um den Betriebsstatus von Configuration Item (CI) zu bearbeiten und CI-Aktionen anzuwenden.

    Die API-Schnittstellen müssen Einschränkungen und Toleranzen einhalten, die durch unzulässige CI-Aktionen, kompatible CI-Aktionen und unzulässige Betriebsübergänge festgelegt sind. Wenn eine Schnittstelle einen eingeschränkten Vorgang versucht, wird der Vorgang blockiert, ein Fehler protokolliert und gegebenenfalls eine Aufgabe erstellt.

    CI-Lebenszyklus-Management – /now/cilifecyclemgmt/actions löschen

    Entfernt eine CI-Aktion (Configuration Item, Konfigurationselement) für eine Liste von CIs.

    URL-Format

    URL mit Versionsnummer: /api/now/{api_version}/cilifecyclemgmt/actions

    Standard-URL: /api/now/cilifecyclemgmt/actions

    Hinweis:
    Verfügbare Versionen werden im REST-API-Explorerangegeben. Für geskriptete REST APIs finden Sie zusätzliche Versionsinformationen im Formular „Geskripteter REST-Service“.

    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
    actionName Erforderlich. Name der Configuration Item-Aktion.

    Datentyp: Zeichenfolge
    requestorId Erforderlich. Sys_id eines Workflow-Kontexts oder eine vom Endpunkt CI-Lebenszyklusmanagement – POST /now/cilifecyclemgmt/operators zurückgegebene Operator-Anwender-ID.

    Die IDs der Operator-Anwender befinden sich in der Tabelle „CI Status registrierter Anwender“ [statemgmt_register_users].

    Datentyp: Zeichenfolge
    sysIds Erforderlich. Kommagetrennte Liste der CI sys_ids.

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

    Kopfzeilen

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

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

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

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter HTTP-Antwortcodes der REST-API.

    Tabelle : 6. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde vom Endpunkt erfolgreich verarbeitet.

    Überprüfen Sie den Parameter des Antworttexts result.result, um das Ergebnis des Vorgangs zu überprüfen.

    Wenn für den Endpunkt bei der Verarbeitung der Anforderung Fehler auftreten, werden im Parameter des Antworttexts result.errors Fehlercodes und Meldungen angezeigt.
    401 Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Parameter des Antworttexts (JSON oder XML)

    Name Beschreibung
    Ergebnis Objekt, das das Ergebnis der Anforderung kapselt.

    Datentyp: Objekt

    "result": {
  "errors": [Array],
  "result": "String"
}
    result.errors Liste von Objekten, in der jedes Objekt einen Fehler darstellt, der bei der Verarbeitung der Anforderung aufgetreten ist.

    Datentyp: Array

    "errors": [
  {
    "error": "String",
    "message": "String"
  }
]
    Ergebnis.Fehler.Fehler Bezeichner für einen Statusmanagementfehler, der bei der Verarbeitung der Anforderung aufgetreten ist.
    Mögliche Werte:
    • CI_ACTION_ALREADY_SET
    • CI_AKTION_NOT_SET
    • DUPLICATE_CI_ACTION_RECORD
    • DUPLICATE_OPS_STATE_RECORD
    • DUPLICATE_SYS_ID
    • INCOMPATIBEL_CI_ACTION
    • INVALID_CI_ACTION
    • INVALID_DELETE
    • UNGÜLTIGE_EINGABETASTE_PARAMETER
    • UNGÜLTIGE_MIETZEIT
    • INVALID_OPS_STATUS
    • INVALID_OPS_STATE_TRANSITION
    • INVALID_REQUESTOR
    • INVALID_REQUESTOR_FOR_CI
    • INVALID_SYS_ID
    • MUTEX_NICHT VERFÜGBAR
    • NOT_ALLOWED_CI_ACTION
    • OPS_STATUS_NOT_SET
    • UNPRIORITÄT_OPS_STATUS
    • NICHT UNTERSTÜTZT_SYS_ID

    Datentyp: Zeichenfolge
    Ergebnis.Fehler.Nachricht Nachricht mit Details zum zugeordneten error.

    Datentyp: Zeichenfolge
    result.result Kennzeichnung, die angibt, ob die CI-Aktion erfolgreich entfernt wurde.
    Mögliche Werte:
    • „wahr“: CI-Aktion wurde entfernt.
    • „falsch“: CI-Aktion wurde nicht entfernt.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Entfernt eine CI-Aktion aus zwei CIs.

    curl --request DELETE \
'https://instance.service-now.com/api/now/cilifecyclemgmt/actions?actionName=Patching&requestorId=621b5a09309e5010f877773aa7167c0a&sysIds=00a9a80d3790200044e0bfc8bcbe5d1c,d0fdbc8437201000deeabfc8bcbe5d33' \
--header 'Accept: application/json' \
--user "username":"password"

    Der Antworttext bestätigt, dass die CI-Aktion aus den CIs entfernt wurde.

    {
  "result": {
    "result": true
  }
}

    CI-Lebenszyklus-Management – DELETE /now/cilifecyclemgmt/operators/{req_id}

    Hebt die Registrierung eines Operators für Nicht-Workflow-Anwender auf.

    URL-Format

    URL mit Versionsnummer: /api/now/{api_version}/cilifecyclemgmt/operators/{req_id}

    Standard-URL: /api/now/cilifecyclemgmt/operators/{req_id}

    Hinweis:
    Verfügbare Versionen werden im REST-API-Explorerangegeben. Für geskriptete REST APIs finden Sie zusätzliche Versionsinformationen im Formular „Geskripteter REST-Service“.

    Unterstützte Anforderungsparameter

    Tabelle : 7. Pfad-Parameter
    Parameter 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
    req_id Sys_id eines Workflow-Kontexts oder eine vom Endpunkt CI-Lebenszyklusmanagement – POST /now/cilifecyclemgmt/operators zurückgegebene Operator-Anwender-ID.

    Die IDs der Operator-Anwender befinden sich in der Tabelle „CI Status registrierter Anwender“ [statemgmt_register_users].

    Datentyp: Zeichenfolge
    Tabelle : 8. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 9. Anforderungstextparameter (XML oder JSON)
    Name Beschreibung
    Keine

    Kopfzeilen

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

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

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

    Tabelle : 12. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde vom Endpunkt erfolgreich verarbeitet.

    Überprüfen Sie den Parameter des Antworttexts result.result, um das Ergebnis des Vorgangs zu überprüfen.

    Wenn für den Endpunkt bei der Verarbeitung der Anforderung Fehler auftreten, werden im Parameter des Antworttexts result.errors Fehlercodes und Meldungen angezeigt.
    401 Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Parameter des Antworttexts (JSON oder XML)

    Name Beschreibung
    Ergebnis Objekt, das das Ergebnis der Anforderung kapselt.

    Datentyp: Objekt

    "result": {
  "errors": [Array],
  "result": "String"
}
    result.errors Liste von Objekten, in der jedes Objekt einen Fehler darstellt, der bei der Verarbeitung der Anforderung aufgetreten ist.

    Datentyp: Array

    "errors": [
  {
    "error": "String",
    "message": "String"
  }
]
    Ergebnis.Fehler.Fehler Bezeichner für einen Statusmanagementfehler, der bei der Verarbeitung der Anforderung aufgetreten ist.
    Mögliche Werte:
    • CI_ACTION_ALREADY_SET
    • CI_AKTION_NOT_SET
    • DUPLICATE_CI_ACTION_RECORD
    • DUPLICATE_OPS_STATE_RECORD
    • DUPLICATE_SYS_ID
    • INCOMPATIBEL_CI_ACTION
    • INVALID_CI_ACTION
    • INVALID_DELETE
    • UNGÜLTIGE_EINGABETASTE_PARAMETER
    • UNGÜLTIGE_MIETZEIT
    • INVALID_OPS_STATUS
    • INVALID_OPS_STATE_TRANSITION
    • INVALID_REQUESTOR
    • INVALID_REQUESTOR_FOR_CI
    • INVALID_SYS_ID
    • MUTEX_NICHT VERFÜGBAR
    • NOT_ALLOWED_CI_ACTION
    • OPS_STATUS_NOT_SET
    • UNPRIORITÄT_OPS_STATUS
    • NICHT UNTERSTÜTZT_SYS_ID

    Datentyp: Zeichenfolge
    Ergebnis.Fehler.Nachricht Nachricht mit Details zum zugeordneten error.

    Datentyp: Zeichenfolge
    result.result Kennzeichnung, die angibt, ob die Registrierung des Operators erfolgreich aufgehoben wurde.
    Mögliche Werte:
    • wahr: Die Registrierung des Operators wurde erfolgreich aufgehoben.
    • „falsch“: Die Registrierung des Anwenders wurde nicht erfolgreich aufgehoben.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Heben Sie die Registrierung eines Operators anhand der Anwender-ID auf.

    curl --request DELETE \
"https://instance.service-now.com/api/now/cilifecyclemgmt/operators/3cf1b3cc30121010f877773aa7167c6e" \
--header "Accept: application/json" \
--user "username":"password"

    Der Antworttext verifiziert, dass die Registrierung des Operators aufgehoben wurde.

    {
  "result": {
    "result": true
  }
}

    CI-Lebenszyklus-Management – GET /now/cilifecyclemgmt/actions/{sys_id}

    Gibt eine Liste aktiver Configuration Item-Aktionen (CI) für das angegebene CI zurück.

    URL-Format

    URL mit Versionsnummer: /api/now/{api_version}/cilifecyclemgmt/actions/{sys_id}

    Standard-URL: /api/now/cilifecyclemgmt/actions/{sys_id}

    Hinweis:
    Verfügbare Versionen werden im REST-API-Explorerangegeben. Für geskriptete REST APIs finden Sie zusätzliche Versionsinformationen im Formular „Geskripteter REST-Service“.

    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
    sys_id Sys_id des CI, für das zugehörige CI-Aktionen zurückgegeben werden sollen.

    Datentyp: Zeichenfolge
    Tabelle : 14. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 15. Anforderungstextparameter (XML oder JSON)
    Name Beschreibung
    Keine

    Kopfzeilen

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

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

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

    Tabelle : 18. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde vom Endpunkt erfolgreich verarbeitet.

    Überprüfen Sie den Parameter des Antworttexts result.ciActions, um das Ergebnis des Vorgangs zu überprüfen.

    Wenn für den Endpunkt bei der Verarbeitung der Anforderung Fehler auftreten, werden im Parameter des Antworttexts result.errors Fehlercodes und Meldungen angezeigt.
    401 Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Parameter des Antworttexts (JSON oder XML)

    Name Beschreibung
    Ergebnis Objekt, das das Ergebnis der Anforderung kapselt.

    Datentyp: Objekt

    "result": {
  "errors": [Array],
  "result": "String"
}
    result.ciActions Kommagetrennte Liste der aktiven CI-Aktionen für das CI oder „no_active_action“, wenn keine gefunden wurden.

    Datentyp: Zeichenfolge
    result.errors Liste von Objekten, in der jedes Objekt einen Fehler darstellt, der bei der Verarbeitung der Anforderung aufgetreten ist.

    Datentyp: Array

    "errors": [
  {
    "error": "String",
    "message": "String"
  }
]
    Ergebnis.Fehler.Fehler Bezeichner für einen Statusmanagementfehler, der bei der Verarbeitung der Anforderung aufgetreten ist.
    Mögliche Werte:
    • CI_ACTION_ALREADY_SET
    • CI_AKTION_NOT_SET
    • DUPLICATE_CI_ACTION_RECORD
    • DUPLICATE_OPS_STATE_RECORD
    • DUPLICATE_SYS_ID
    • INCOMPATIBEL_CI_ACTION
    • INVALID_CI_ACTION
    • INVALID_DELETE
    • UNGÜLTIGE_EINGABETASTE_PARAMETER
    • UNGÜLTIGE_MIETZEIT
    • INVALID_OPS_STATUS
    • INVALID_OPS_STATE_TRANSITION
    • INVALID_REQUESTOR
    • INVALID_REQUESTOR_FOR_CI
    • INVALID_SYS_ID
    • MUTEX_NICHT VERFÜGBAR
    • NOT_ALLOWED_CI_ACTION
    • OPS_STATUS_NOT_SET
    • UNPRIORITÄT_OPS_STATUS
    • NICHT UNTERSTÜTZT_SYS_ID

    Datentyp: Zeichenfolge
    Ergebnis.Fehler.Nachricht Nachricht mit Details zum zugeordneten error.

    Datentyp: Zeichenfolge
    result.result Kennzeichnung, die angibt, ob die Liste der aktiven CI-Aktionen für alle angegebenen CIs zurückgegeben wurde.
    Mögliche Werte:
    • „wahr“: Liste der aktiven CI-Aktionen wurde zurückgegeben.
    • „falsch“: Liste der aktiven CI-Aktionen wurde nicht zurückgegeben.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    curl --request GET \
'https://instance.service-now.com/api/now/cilifecyclemgmt/actions/00a9a80d3790200044e0bfc8bcbe5d1c' \
--header 'Accept: application/json' \
--user "username":"password"

    Der Antworttext zeigt, dass für das angegebene CI keine CI-Aktionen aktiv sind.

    {
  "result": {
    "ciActions": [
      "no_active_action"
    ],
    "result": true
  }
}

    CI-Lebenszyklus-Management – GET /now/cilifecyclemgmt/compatActions

    Bestimmt, ob zwei angegebene Configuration Item (CI)-Aktionen kompatibel sind.

    URL-Format

    URL mit Versionsnummer: /api/now/{api_version}/cilifecyclemgmt/compatActions

    Standard-URL: /api/now/cilifecyclemgmt/compatActions

    Hinweis:
    Verfügbare Versionen werden im REST-API-Explorerangegeben. Für geskriptete REST APIs finden Sie zusätzliche Versionsinformationen im Formular „Geskripteter REST-Service“.

    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
    actionName Erforderlich. Name der zu vergleichenden CI-Aktion.

    Datentyp: Zeichenfolge
    otherActionName Erforderlich. Name der zu vergleichenden CI-Aktion.

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

    Kopfzeilen

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

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

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

    Tabelle : 24. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde vom Endpunkt erfolgreich verarbeitet.

    Überprüfen Sie den Parameter des Antworttexts result.result, um das Ergebnis des Vorgangs zu überprüfen.

    Wenn für den Endpunkt bei der Verarbeitung der Anforderung Fehler auftreten, werden im Parameter des Antworttexts result.errors Fehlercodes und Meldungen angezeigt.
    401 Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Parameter des Antworttexts (JSON oder XML)

    Name Beschreibung
    Ergebnis Kennzeichnung, die angibt, ob die beiden angegebenen CI-Aktionen kompatibel sind.
    Mögliche Werte:
    • „wahr“: CI-Aktionen sind kompatibel.
    • „falsch“: CI-Aktionen sind nicht kompatibel.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Überprüft die Kompatibilität von CI-Aktionen für das Patchen und Bereitstellen.

    curl --request GET \
'https://instance.service-now.com/api/now/cilifecyclemgmt/compatActions?actionName=Patching&otherActionName=Provisioning' \
--header 'Accept: application/json' \
--user "username":"password"

    Der Antworttext bestätigt, dass die beiden CI-Aktionen kompatibel sind.

    {
  "result": true
}

    CI-Lebenszyklus-Management – GET /now/cilifecyclemgmt/leases/{sys_id}/expired

    Bestimmt, ob die Mietdauer für den Anforderer einer Configuration Item-Aktion (CI) abgelaufen ist, die auf das angegebene CI angewendet wurde.

    URL-Format

    URL mit Versionsnummer: /api/now/{api_version}/cilifecyclemgmt/leases/{sys_id}/expired

    Standard-URL: /api/now/cilifecyclemgmt/leases/{sys_id}/expired

    Hinweis:
    Verfügbare Versionen werden im REST-API-Explorerangegeben. Für geskriptete REST APIs finden Sie zusätzliche Versionsinformationen im Formular „Geskripteter REST-Service“.

    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
    sys_id Sys_id des CI, das das Ziel der angewendeten CI-Aktion ist.

    Datentyp: Zeichenfolge
    Tabelle : 26. Abfrageparameter
    Name Beschreibung
    actionName Erforderlich. Name der CI-Aktion, die auf das angegebene CI angewendet wurde.

    Datentyp: Zeichenfolge
    requestorId Erforderlich. Sys_id eines Workflow-Kontexts oder eine vom Endpunkt CI-Lebenszyklusmanagement – POST /now/cilifecyclemgmt/operators zurückgegebene Operator-Anwender-ID.

    Die IDs der Operator-Anwender befinden sich in der Tabelle „CI Status registrierter Anwender“ [statemgmt_register_users].

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

    Kopfzeilen

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

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

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

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter HTTP-Antwortcodes der REST-API.

    Tabelle : 30. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde vom Endpunkt erfolgreich verarbeitet.

    Überprüfen Sie den Parameter des Antworttexts result.result, um das Ergebnis des Vorgangs zu überprüfen.

    Wenn für den Endpunkt bei der Verarbeitung der Anforderung Fehler auftreten, werden im Parameter des Antworttexts result.errors Fehlercodes und Meldungen angezeigt.
    401 Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Parameter des Antworttexts (JSON oder XML)

    Name Beschreibung
    Ergebnis Objekt, das das Ergebnis der Anforderung kapselt.

    Datentyp: Objekt

    "result": {
  "errors": [Array],
  "result": "String"
}
    result.errors Liste von Objekten, in der jedes Objekt einen Fehler darstellt, der bei der Verarbeitung der Anforderung aufgetreten ist.

    Datentyp: Array

    "errors": [
  {
    "error": "String",
    "message": "String"
  }
]
    Ergebnis.Fehler.Fehler Bezeichner für einen Statusmanagementfehler, der bei der Verarbeitung der Anforderung aufgetreten ist.
    Mögliche Werte:
    • CI_ACTION_ALREADY_SET
    • CI_AKTION_NOT_SET
    • DUPLICATE_CI_ACTION_RECORD
    • DUPLICATE_OPS_STATE_RECORD
    • DUPLICATE_SYS_ID
    • INCOMPATIBEL_CI_ACTION
    • INVALID_CI_ACTION
    • INVALID_DELETE
    • UNGÜLTIGE_EINGABETASTE_PARAMETER
    • UNGÜLTIGE_MIETZEIT
    • INVALID_OPS_STATUS
    • INVALID_OPS_STATE_TRANSITION
    • INVALID_REQUESTOR
    • INVALID_REQUESTOR_FOR_CI
    • INVALID_SYS_ID
    • MUTEX_NICHT VERFÜGBAR
    • NOT_ALLOWED_CI_ACTION
    • OPS_STATUS_NOT_SET
    • UNPRIORITÄT_OPS_STATUS
    • NICHT UNTERSTÜTZT_SYS_ID

    Datentyp: Zeichenfolge
    Ergebnis.Fehler.Nachricht Nachricht mit Details zum zugeordneten error.

    Datentyp: Zeichenfolge
    result.result Kennzeichnung, die angibt, ob die Miete für den Anforderer der angewendeten CI-Aktion abgelaufen ist.
    Mögliche Werte:
    • „wahr“: Miete der anfordernden Person ist abgelaufen.
    • „falsch“: Mietdauer der anfordernden Person ist nicht abgelaufen.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    curl --request GET \
'https://instance.service-now.com/api/now/cilifecyclemgmt/leases/00a9a80d3790200044e0bfc8bcbe5d1c/expired?actionName=Patching&requestorId=621b5a09309e5010f877773aa7167c0a' \
--header 'Accept: application/json' \
--user "username":"password"

    Der Antworttext zeigt, dass die Miete für den Anforderer der angewendeten CI-Aktion nicht abgelaufen ist.

    {
  "result": {
    "result": false
  }
}

    CI-Lebenszyklus-Management – GET /now/cilifecyclemgmt/notAllowedAction

    Bestimmt, ob eine angegebene Configuration Item(CI)-Aktion für ein CI einer angegebenen Klasse in einem bestimmten Betriebsstatus nicht zulässig ist.

    URL-Format

    URL mit Versionsnummer: /api/now/{api_version}/cilifecyclemgmt/notAllowedAction

    Standard-URL: /api/now/cilifecyclemgmt/notAllowedAction

    Hinweis:
    Verfügbare Versionen werden im REST-API-Explorerangegeben. Für geskriptete REST APIs finden Sie zusätzliche Versionsinformationen im Formular „Geskripteter REST-Service“.

    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
    actionName Erforderlich. Name der zu überprüfenden CI-Aktion.

    Datentyp: Zeichenfolge
    ciClass Erforderlich. CI-Klasse.

    Datentyp: Zeichenfolge
    opsLabel Erforderlich. Zu überprüfender Betriebsstatus.

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

    Kopfzeilen

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

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

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

    Tabelle : 36. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde vom Endpunkt erfolgreich verarbeitet.

    Überprüfen Sie den Parameter des Antworttexts result.result, um das Ergebnis des Vorgangs zu überprüfen.

    Wenn für den Endpunkt bei der Verarbeitung der Anforderung Fehler auftreten, werden im Parameter des Antworttexts result.errors Fehlercodes und Meldungen angezeigt.
    401 Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Parameter des Antworttexts (JSON oder XML)

    Name Beschreibung
    Ergebnis Kennzeichnung, die angibt, ob die CI-Aktion für CIs des angegebenen Typs eingeschränkt (nicht zulässig) ist, wenn sie sich im angegebenen Betriebsstatus befinden.
    Mögliche Werte:
    • wahr: CI-Aktion ist eingeschränkt (nicht zulässig).
    • „falsch“: CI-Aktion ist nicht eingeschränkt (zulässig).

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Überprüfen Sie, ob die Aktion „CI patchen“ für Computer im DR-Standby-Betriebsstatus eingeschränkt (nicht zulässig) ist.

    curl --request GET \
"https://instance.service-now.com/api/now/cilifecyclemgmt/notAllowedAction?actionName=Patching&ciClass=cmdb_ci_computer&opsLabel=DR+Standby" \
--header "Accept: application/json" \
--user "username":"password"

    Der Antworttext bestätigt, dass diese Aktion für die angegebene CI-Klasse eingeschränkt (nicht zulässig) ist, wenn sie sich im angegebenen Betriebsstatus befindet.

    {
  "result": true
}

    CI-Lebenszyklus-Management – GET /now/cilifecyclemgmt/notAllowedOpsTransition

    Bestimmt, ob ein Configuration Item (CI) aus einer angegebenen Klasse von einem angegebenen Betriebsstatus in einen zweiten angegebenen Betriebsstatus übergehen kann.

    URL-Format

    URL mit Versionsnummer: /api/now/{api_version}/cilifecyclemgmt/notAllowedOpsTransition

    Standard-URL: /api/now/cilifecyclemgmt/notAllowedOpsTransition

    Hinweis:
    Verfügbare Versionen werden im REST-API-Explorerangegeben. Für geskriptete REST APIs finden Sie zusätzliche Versionsinformationen im Formular „Geskripteter REST-Service“.

    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
    ciClass Erforderlich. CI-Klasse, für die Übergangsbeschränkungen überprüft werden sollen.

    Datentyp: Zeichenfolge
    opsLabel Erforderlich. Bezeichnung des aktuellen CI-Betriebsstatus.

    Datentyp: Zeichenfolge
    transitionOpsLabel Erforderlich. Bezeichnung des Betriebsstatus, der das Ziel des Übergangs ist.

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

    Kopfzeilen

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

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

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

    Tabelle : 42. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde vom Endpunkt erfolgreich verarbeitet.

    Überprüfen Sie den Parameter des Antworttexts result.result, um das Ergebnis des Vorgangs zu überprüfen.

    Wenn für den Endpunkt bei der Verarbeitung der Anforderung Fehler auftreten, werden im Parameter des Antworttexts result.errors Fehlercodes und Meldungen angezeigt.
    401 Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Parameter des Antworttexts (JSON oder XML)

    Name Beschreibung
    Ergebnis Kennzeichnung, die angibt, ob der angegebene Betriebsstatusübergang für die angegebene CI-Klasse eingeschränkt (nicht zulässig) ist.
    Mögliche Werte:
    • wahr: Betriebsstatusübergang ist eingeschränkt (nicht zulässig).
    • „falsch“: Der Betriebsstatusübergang ist nicht eingeschränkt (zulässig).

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Überprüfen Sie, ob der Übergang vom Betriebsstatus „Deaktiviert“ in den DR-Standby-Status für Linux-Server-CIs eingeschränkt (nicht zulässig) ist.

    curl --request GET \
"https://instance.service-now.com/api/now/cilifecyclemgmt/notAllowedOpsTransition?ciClass=cmdb_ci_computer&opsLabel=Retired&transitionOpsLabel=DR+Standby" \
--header "Accept: application/json" \
--user "username":"password"

    Der Antworttext zeigt, dass der angegebene Betriebsstatusübergang für diese CI-Klasse nicht eingeschränkt (zulässig) ist.

    {
  "result": false
}

    CI-Lebenszyklus-Management – GET /now/cilifecyclemgmt/requestors/{req_id}/valid

    Bestimmt, ob der angegebene aktive Workflow-Anwender oder der registrierte Anwender eine gültige anfordernde Person ist.

    URL-Format

    URL mit Versionsnummer: /api/now/{api_version}/cilifecyclemgmt/requestors/{req_id}/valid

    Standard-URL: /api/now/cilifecyclemgmt/requestors/{req_id}/valid

    Hinweis:
    Verfügbare Versionen werden im REST-API-Explorerangegeben. Für geskriptete REST APIs finden Sie zusätzliche Versionsinformationen im Formular „Geskripteter REST-Service“.

    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
    req_id Sys_id eines Workflow-Kontexts oder eine vom Endpunkt CI-Lebenszyklusmanagement – POST /now/cilifecyclemgmt/operators zurückgegebene Operator-Anwender-ID.

    Die IDs der Operator-Anwender befinden sich in der Tabelle „CI Status registrierter Anwender“ [statemgmt_register_users].

    Datentyp: Zeichenfolge
    Tabelle : 44. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 45. Anforderungstextparameter (XML oder JSON)
    Name Beschreibung
    Keine

    Kopfzeilen

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

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

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

    Tabelle : 48. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde vom Endpunkt erfolgreich verarbeitet.

    Überprüfen Sie den Parameter des Antworttexts result.result, um das Ergebnis des Vorgangs zu überprüfen.

    Wenn für den Endpunkt bei der Verarbeitung der Anforderung Fehler auftreten, werden im Parameter des Antworttexts result.errors Fehlercodes und Meldungen angezeigt.
    401 Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Parameter des Antworttexts (JSON oder XML)

    Name Beschreibung
    Ergebnis Objekt, das das Ergebnis der Anforderung kapselt.

    Datentyp: Objekt

    "result": {
  "errors": [Array],
  "result": "String"
}
    result.errors Liste von Objekten, in der jedes Objekt einen Fehler darstellt, der bei der Verarbeitung der Anforderung aufgetreten ist.

    Datentyp: Array

    "errors": [
  {
    "error": "String",
    "message": "String"
  }
]
    Ergebnis.Fehler.Fehler Bezeichner für einen Statusmanagementfehler, der bei der Verarbeitung der Anforderung aufgetreten ist.
    Mögliche Werte:
    • CI_ACTION_ALREADY_SET
    • CI_AKTION_NOT_SET
    • DUPLICATE_CI_ACTION_RECORD
    • DUPLICATE_OPS_STATE_RECORD
    • DUPLICATE_SYS_ID
    • INCOMPATIBEL_CI_ACTION
    • INVALID_CI_ACTION
    • INVALID_DELETE
    • UNGÜLTIGE_EINGABETASTE_PARAMETER
    • UNGÜLTIGE_MIETZEIT
    • INVALID_OPS_STATUS
    • INVALID_OPS_STATE_TRANSITION
    • INVALID_REQUESTOR
    • INVALID_REQUESTOR_FOR_CI
    • INVALID_SYS_ID
    • MUTEX_NICHT VERFÜGBAR
    • NOT_ALLOWED_CI_ACTION
    • OPS_STATUS_NOT_SET
    • UNPRIORITÄT_OPS_STATUS
    • NICHT UNTERSTÜTZT_SYS_ID

    Datentyp: Zeichenfolge
    Ergebnis.Fehler.Nachricht Nachricht mit Details zum zugeordneten error.

    Datentyp: Zeichenfolge
    result.result Kennzeichnung, die angibt, ob der angegebene aktive Workflow-Anwender oder der registrierte Anwender eine gültige anfordernde Person ist.
    Mögliche Werte:
    • true: Gültiger Anforderer.
    • „falsch“: Ungültiger Anforderer.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    curl --request GET \
'https://instance.service-now.com/api/now/cilifecyclemgmt/requestors/4cab9b95301a9010f877773aa7167ca9/valid' \
--header 'Accept: application/json' \
--user "username":"password"
    {
  "result": {
    "result": true
  }
}

    CI-Lebenszyklus-Management – GET /now/cilifecyclemgmt/statuses/{sys_id}

    Gibt den aktuellen Betriebsstatus für das angegebene Configuration Item (CI) zurück.

    URL-Format

    URL mit Versionsangabe: /api/now/{api_version}/cilifecyclemgmt/statuses/{sys_id}

    Standard-URL: /api/now/cilifecyclemgmt/statuses/{sys_id}

    Hinweis:
    Verfügbare Versionen werden im REST-API-Explorerangegeben. Für geskriptete REST APIs finden Sie zusätzliche Versionsinformationen im Formular „Geskripteter REST-Service“.

    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
    sys_id Sys_id des CI.

    Datentyp: Zeichenfolge
    Tabelle : 50. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 51. Anforderungstextparameter (XML oder JSON)
    Name Beschreibung
    Keine

    Kopfzeilen

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

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

    Standard: application/json
    Tabelle : 53. 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-Antwortcodes der REST-API.

    Tabelle : 54. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde vom Endpunkt erfolgreich verarbeitet.

    Überprüfen Sie den Parameter des Antworttexts result.result, um das Ergebnis des Vorgangs zu überprüfen.

    Wenn für den Endpunkt bei der Verarbeitung der Anforderung Fehler auftreten, werden im Parameter des Antworttexts result.errors Fehlercodes und Meldungen angezeigt.
    401 Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Parameter des Antworttexts (JSON oder XML)

    Name Beschreibung
    Ergebnis Objekt, das das Ergebnis der Anforderung kapselt.

    Datentyp: Objekt

    "result": {
  "errors": [Array],
  "result": "String"
}
    result.errors Liste von Objekten, in der jedes Objekt einen Fehler darstellt, der bei der Verarbeitung der Anforderung aufgetreten ist.

    Datentyp: Array

    "errors": [
  {
    "error": "String",
    "message": "String"
  }
]
    Ergebnis.Fehler.Fehler Bezeichner für einen Statusmanagementfehler, der bei der Verarbeitung der Anforderung aufgetreten ist.
    Mögliche Werte:
    • CI_ACTION_ALREADY_SET
    • CI_AKTION_NOT_SET
    • DUPLICATE_CI_ACTION_RECORD
    • DUPLICATE_OPS_STATE_RECORD
    • DUPLICATE_SYS_ID
    • INCOMPATIBEL_CI_ACTION
    • INVALID_CI_ACTION
    • INVALID_DELETE
    • UNGÜLTIGE_EINGABETASTE_PARAMETER
    • UNGÜLTIGE_MIETZEIT
    • INVALID_OPS_STATUS
    • INVALID_OPS_STATE_TRANSITION
    • INVALID_REQUESTOR
    • INVALID_REQUESTOR_FOR_CI
    • INVALID_SYS_ID
    • MUTEX_NICHT VERFÜGBAR
    • NOT_ALLOWED_CI_ACTION
    • OPS_STATUS_NOT_SET
    • UNPRIORITÄT_OPS_STATUS
    • NICHT UNTERSTÜTZT_SYS_ID

    Datentyp: Zeichenfolge
    Ergebnis.Fehler.Nachricht Nachricht mit Details zum zugeordneten error.

    Datentyp: Zeichenfolge
    result.operationalStates Betriebsstatus für das angegebene CI oder unbekannt, wenn kein Status angegeben ist.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    curl --request GET 'https://instance.service-now.com/api/now/cilifecyclemgmt/statuses/aac0b1213784200044e0bfc8bcbe5de3' \
--header 'Accept: application/json' \
--user "username":"password"
    {
  "result": {
    "operationalState": "Repair in Progress",
    "result": true
  }
}

    CI-Lebenszyklus-Management – PATCH /now/cilifecyclemgmt/leases/{sys_id}

    Verlängert die Ablaufzeit der Miete der angegebenen Configuration Item(CI)-Aktion für den angegebenen Anwender.

    Wenn die vorherige Miete abgelaufen ist, beginnt die neue Mietdauer sofort.

    URL-Format

    URL mit Versionsnummer: /api/now/{api_version}/cilifecyclemgmt/leases/{sys_id}

    Standard-URL: /api/now/cilifecyclemgmt/leases/{sys_id}

    Hinweis:
    Verfügbare Versionen werden im REST-API-Explorerangegeben. Für geskriptete REST APIs finden Sie zusätzliche Versionsinformationen im Formular „Geskripteter REST-Service“.

    Unterstützte Anforderungsparameter

    Tabelle : 55. 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
    sys_id Sys_id des CI, für das die Miete verlängert werden soll.

    Datentyp: Zeichenfolge
    Tabelle : 56. Abfrageparameter
    Name Beschreibung
    actionName Erforderlich. Name der zugeordneten CI-Aktion.

    Datentyp: Zeichenfolge
    leaseTime Erforderlich. Zeitdauer, für die die Miete für die in actionNameangegebene CI-Aktion gültig ist.

    Datentyp: Zeichenfolge

    Format: HH:MM:SS
    requestorId Erforderlich. Sys_id eines Workflow-Kontexts oder eine vom Endpunkt CI-Lebenszyklusmanagement – POST /now/cilifecyclemgmt/operators zurückgegebene Operator-Anwender-ID.

    Die IDs der Operator-Anwender befinden sich in der Tabelle „CI Status registrierter Anwender“ [statemgmt_register_users].

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

    Kopfzeilen

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

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

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

    Standard: application/json
    Tabelle : 59. 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-Antwortcodes der REST-API.

    Tabelle : 60. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde vom Endpunkt erfolgreich verarbeitet.

    Überprüfen Sie den Parameter des Antworttexts result.result, um das Ergebnis des Vorgangs zu überprüfen.

    Wenn für den Endpunkt bei der Verarbeitung der Anforderung Fehler auftreten, werden im Parameter des Antworttexts result.errors Fehlercodes und Meldungen angezeigt.
    401 Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Parameter des Antworttexts (JSON oder XML)

    Name Beschreibung
    Ergebnis Objekt, das das Ergebnis der Anforderung kapselt.

    Datentyp: Objekt

    "result": {
  "errors": [Array],
  "result": "String"
}
    result.errors Liste von Objekten, in der jedes Objekt einen Fehler darstellt, der bei der Verarbeitung der Anforderung aufgetreten ist.

    Datentyp: Array

    "errors": [
  {
    "error": "String",
    "message": "String"
  }
]
    Ergebnis.Fehler.Fehler Bezeichner für einen Statusmanagementfehler, der bei der Verarbeitung der Anforderung aufgetreten ist.
    Mögliche Werte:
    • CI_ACTION_ALREADY_SET
    • CI_AKTION_NOT_SET
    • DUPLICATE_CI_ACTION_RECORD
    • DUPLICATE_OPS_STATE_RECORD
    • DUPLICATE_SYS_ID
    • INCOMPATIBEL_CI_ACTION
    • INVALID_CI_ACTION
    • INVALID_DELETE
    • UNGÜLTIGE_EINGABETASTE_PARAMETER
    • UNGÜLTIGE_MIETZEIT
    • INVALID_OPS_STATUS
    • INVALID_OPS_STATE_TRANSITION
    • INVALID_REQUESTOR
    • INVALID_REQUESTOR_FOR_CI
    • INVALID_SYS_ID
    • MUTEX_NICHT VERFÜGBAR
    • NOT_ALLOWED_CI_ACTION
    • OPS_STATUS_NOT_SET
    • UNPRIORITÄT_OPS_STATUS
    • NICHT UNTERSTÜTZT_SYS_ID

    Datentyp: Zeichenfolge
    Ergebnis.Fehler.Nachricht Nachricht mit Details zum zugeordneten error.

    Datentyp: Zeichenfolge
    result.result Kennzeichnung, die angibt, ob die Mietdauer verlängert wurde.
    Mögliche Werte:
    • „wahr“: Lease-Zeit wurde verlängert.
    • „falsch“: Lease-Zeit wurde nicht verlängert.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Verlängern Sie die Dauer der Mietdauer einer anfordernden Person einer Patch-CI-Aktion um 24 Stunden.

    curl --request PATCH 'https://instance.service-now.com/api/now/cilifecyclemgmt/leases/affd3c8437201000deeabfc8bcbe5dc3?actionName=Patching&leaseTime=24:00:00&requestorId=e7c3402d305a9010f877773aa7167c2a' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--user "username":"password"
    {
  "result": {
    "result": true
  }
}

    CI-Lebenszyklus-Management – POST /now/cilifecyclemgmt/actions

    Fügt einer angegebenen Liste von CIs eine angegebene Configuration Item-Aktion (CI) hinzu.

    URL-Format

    URL mit Versionsnummer: /api/now/{api_version}/cilifecyclemgmt/actions

    Standard-URL: /api/now/cilifecyclemgmt/actions

    Hinweis:
    Verfügbare Versionen werden im REST-API-Explorerangegeben. Für geskriptete REST APIs finden Sie zusätzliche Versionsinformationen im Formular „Geskripteter REST-Service“.

    Unterstützte Anforderungsparameter

    Tabelle : 61. 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 : 62. Abfrageparameter
    Name Beschreibung
    actionName Erforderlich. Name der CI-Aktion, die der Liste hinzugefügt werden soll.

    Datentyp: Zeichenfolge
    leaseTime Zeitdauer, für die die Miete für die angegebene CI-Aktion gültig ist.

    Datentyp: Zeichenfolge

    Format: HH:MM:SS
    oldActionNames Kommagetrennte Liste alter CI-Aktionen, in der sich alle CIs befinden müssen.

    Datentyp: Zeichenfolge
    requestorId Erforderlich. Sys_id eines Workflow-Kontexts oder eine vom Endpunkt CI-Lebenszyklusmanagement – POST /now/cilifecyclemgmt/operators zurückgegebene Operator-Anwender-ID.

    Die IDs der Operator-Anwender befinden sich in der Tabelle „CI Status registrierter Anwender“ [statemgmt_register_users].

    Datentyp: Zeichenfolge
    sysIds Erforderlich. Kommagetrennte Liste der CI sys_ids, denen die CI-Aktion hinzugefügt werden soll.

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

    Kopfzeilen

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

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

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

    Standard: application/json
    Tabelle : 65. 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-Antwortcodes der REST-API.

    Tabelle : 66. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde vom Endpunkt erfolgreich verarbeitet.

    Überprüfen Sie den Parameter des Antworttexts result.result, um das Ergebnis des Vorgangs zu überprüfen.

    Wenn für den Endpunkt bei der Verarbeitung der Anforderung Fehler auftreten, werden im Parameter des Antworttexts result.errors Fehlercodes und Meldungen angezeigt.
    401 Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Parameter des Antworttexts (JSON oder XML)

    Name Beschreibung
    Ergebnis Objekt, das das Ergebnis der Anforderung kapselt.

    Datentyp: Objekt

    "result": {
  "errors": [Array],
  "result": "String"
}
    result.errors Liste von Objekten, in der jedes Objekt einen Fehler darstellt, der bei der Verarbeitung der Anforderung aufgetreten ist.

    Datentyp: Array

    "errors": [
  {
    "error": "String",
    "message": "String"
  }
]
    Ergebnis.Fehler.Fehler Bezeichner für einen Statusmanagementfehler, der bei der Verarbeitung der Anforderung aufgetreten ist.
    Mögliche Werte:
    • CI_ACTION_ALREADY_SET
    • CI_AKTION_NOT_SET
    • DUPLICATE_CI_ACTION_RECORD
    • DUPLICATE_OPS_STATE_RECORD
    • DUPLICATE_SYS_ID
    • INCOMPATIBEL_CI_ACTION
    • INVALID_CI_ACTION
    • INVALID_DELETE
    • UNGÜLTIGE_EINGABETASTE_PARAMETER
    • UNGÜLTIGE_MIETZEIT
    • INVALID_OPS_STATUS
    • INVALID_OPS_STATE_TRANSITION
    • INVALID_REQUESTOR
    • INVALID_REQUESTOR_FOR_CI
    • INVALID_SYS_ID
    • MUTEX_NICHT VERFÜGBAR
    • NOT_ALLOWED_CI_ACTION
    • OPS_STATUS_NOT_SET
    • UNPRIORITÄT_OPS_STATUS
    • NICHT UNTERSTÜTZT_SYS_ID

    Datentyp: Zeichenfolge
    Ergebnis.Fehler.Nachricht Nachricht mit Details zum zugeordneten error.

    Datentyp: Zeichenfolge
    result.result Kennzeichnung, die angibt, ob die CI-Aktion für alle CIs in der Liste festgelegt wurde.
    Mögliche Werte:
    • wahr: CI-Aktionen wurden festgelegt.
    • „falsch“: Es wurden keine CI-Aktionen festgelegt.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Fügen Sie zwei CIs eine Patch-CI-Aktion hinzu.

    curl --request POST \
"https://instance.service-now.com/api/now/cilifecyclemgmt/actions?actionName=Patching&requestorId=621b5a09309e5010f877773aa7167c0a&sysIds=00a9a80d3790200044e0bfc8bcbe5d1c,d0fdbc8437201000deeabfc8bcbe5d33" \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--user "username":"password"
    {
  "result": {
    "result": true
  }
}

    CI-Lebenszyklusmanagement – POST /now/cilifecyclemgmt/operators

    Registriert einen Operator für einen Nicht-Workflow-Anwender.

    URL-Format

    URL mit Versionsnummer: /api/now/{api_version}/cilifecyclemgmt/operators

    Standard-URL: /api/now/cilifecyclemgmt/operators

    Hinweis:
    Verfügbare Versionen werden im REST-API-Explorerangegeben. Für geskriptete REST APIs finden Sie zusätzliche Versionsinformationen im Formular „Geskripteter REST-Service“.

    Unterstützte Anforderungsparameter

    Tabelle : 67. 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 : 68. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 69. Anforderungstextparameter (XML oder JSON)
    Name Beschreibung
    Keine

    Kopfzeilen

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

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

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

    Standard: application/json
    Tabelle : 71. 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-Antwortcodes der REST-API.

    Tabelle : 72. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde vom Endpunkt erfolgreich verarbeitet.

    Überprüfen Sie den Parameter des Antworttexts result.result, um das Ergebnis des Vorgangs zu überprüfen.

    Wenn für den Endpunkt bei der Verarbeitung der Anforderung Fehler auftreten, werden im Parameter des Antworttexts result.errors Fehlercodes und Meldungen angezeigt.
    401 Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Parameter des Antworttexts (JSON oder XML)

    Name Beschreibung
    Ergebnis Objekt, das das Ergebnis der Anforderung kapselt.

    Datentyp: Objekt

    "result": {
  "errors": [Array],
  "result": "String"
}
    result.errors Liste von Objekten, in der jedes Objekt einen Fehler darstellt, der bei der Verarbeitung der Anforderung aufgetreten ist.

    Datentyp: Array

    "errors": [
  {
    "error": "String",
    "message": "String"
  }
]
    Ergebnis.Fehler.Fehler Bezeichner für einen Statusmanagementfehler, der bei der Verarbeitung der Anforderung aufgetreten ist.
    Mögliche Werte:
    • CI_ACTION_ALREADY_SET
    • CI_AKTION_NOT_SET
    • DUPLICATE_CI_ACTION_RECORD
    • DUPLICATE_OPS_STATE_RECORD
    • DUPLICATE_SYS_ID
    • INCOMPATIBEL_CI_ACTION
    • INVALID_CI_ACTION
    • INVALID_DELETE
    • UNGÜLTIGE_EINGABETASTE_PARAMETER
    • UNGÜLTIGE_MIETZEIT
    • INVALID_OPS_STATUS
    • INVALID_OPS_STATE_TRANSITION
    • INVALID_REQUESTOR
    • INVALID_REQUESTOR_FOR_CI
    • INVALID_SYS_ID
    • MUTEX_NICHT VERFÜGBAR
    • NOT_ALLOWED_CI_ACTION
    • OPS_STATUS_NOT_SET
    • UNPRIORITÄT_OPS_STATUS
    • NICHT UNTERSTÜTZT_SYS_ID

    Datentyp: Zeichenfolge
    Ergebnis.Fehler.Nachricht Nachricht mit Details zum zugeordneten error.

    Datentyp: Zeichenfolge
    result.requestorId GUID für den registrierten Operator. Verwenden Sie diesen Wert, um CI-Aktionen und Betriebsstatus festzulegen.

    Datentyp: Zeichenfolge
    result.result Kennzeichnung, die angibt, ob der Operator erfolgreich registriert wurde.
    Mögliche Werte:
    • wahr: Operator wurde erfolgreich registriert.
    • „falsch“: Der Operator wurde nicht erfolgreich registriert.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    curl --request POST \
"https://instance.service-now.com/api/now/cilifecyclemgmt/operators" \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--user "username":"password"
    {
  "result": {
    "result": true,
    "requestorId": "6f992b8430121010f877773aa7167c42"
  }
}

    CI-Lebenszyklus-Management – POST /now/cilifecyclemgmt/statuses

    Legt den Betriebsstatus für eine angegebene Liste von Configuration Items (CIs) fest.

    URL-Format

    URL mit Versionsnummer: /api/now/{api_version}/cilifecyclemgmt/statuses

    Standard-URL: /api/now/cilifecyclemgmt/statuses

    Hinweis:
    Verfügbare Versionen werden im REST-API-Explorerangegeben. Für geskriptete REST APIs finden Sie zusätzliche Versionsinformationen im Formular „Geskripteter REST-Service“.

    Unterstützte Anforderungsparameter

    Tabelle : 73. 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 : 74. Abfrageparameter
    Name Beschreibung
    alteOpsLabels Kommagetrennte Liste der alten CI-Betriebsstatus, in der alle CIs enthalten sein sollen.

    Datentyp: Zeichenfolge
    opsLabel Erforderlich. Bezeichnung des Betriebsstatus, der für die angegebenen CIs festgelegt werden soll.

    Datentyp: Zeichenfolge
    requestorId Erforderlich. Sys_id eines Workflow-Kontexts oder eine vom Endpunkt CI-Lebenszyklusmanagement – POST /now/cilifecyclemgmt/operators zurückgegebene Operator-Anwender-ID.

    Die IDs der Operator-Anwender befinden sich in der Tabelle „CI Status registrierter Anwender“ [statemgmt_register_users].

    Datentyp: Zeichenfolge
    sysIds Erforderlich. Kommagetrennte Liste der sys_ids von CIs, für die der Betriebsstatus festgelegt werden soll.

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

    Kopfzeilen

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

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

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

    Standard: application/json
    Tabelle : 77. 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-Antwortcodes der REST-API.

    Tabelle : 78. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde vom Endpunkt erfolgreich verarbeitet.

    Überprüfen Sie den Parameter des Antworttexts result.result, um das Ergebnis des Vorgangs zu überprüfen.

    Wenn für den Endpunkt bei der Verarbeitung der Anforderung Fehler auftreten, werden im Parameter des Antworttexts result.errors Fehlercodes und Meldungen angezeigt.
    401 Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Parameter des Antworttexts (JSON oder XML)

    Name Beschreibung
    Ergebnis Objekt, das das Ergebnis der Anforderung kapselt.

    Datentyp: Objekt

    "result": {
  "errors": [Array],
  "result": "String"
}
    result.errors Liste von Objekten, in der jedes Objekt einen Fehler darstellt, der bei der Verarbeitung der Anforderung aufgetreten ist.

    Datentyp: Array

    "errors": [
  {
    "error": "String",
    "message": "String"
  }
]
    Ergebnis.Fehler.Fehler Bezeichner für einen Statusmanagementfehler, der bei der Verarbeitung der Anforderung aufgetreten ist.
    Mögliche Werte:
    • CI_ACTION_ALREADY_SET
    • CI_AKTION_NOT_SET
    • DUPLICATE_CI_ACTION_RECORD
    • DUPLICATE_OPS_STATE_RECORD
    • DUPLICATE_SYS_ID
    • INCOMPATIBEL_CI_ACTION
    • INVALID_CI_ACTION
    • INVALID_DELETE
    • UNGÜLTIGE_EINGABETASTE_PARAMETER
    • UNGÜLTIGE_MIETZEIT
    • INVALID_OPS_STATUS
    • INVALID_OPS_STATE_TRANSITION
    • INVALID_REQUESTOR
    • INVALID_REQUESTOR_FOR_CI
    • INVALID_SYS_ID
    • MUTEX_NICHT VERFÜGBAR
    • NOT_ALLOWED_CI_ACTION
    • OPS_STATUS_NOT_SET
    • UNPRIORITÄT_OPS_STATUS
    • NICHT UNTERSTÜTZT_SYS_ID

    Datentyp: Zeichenfolge
    Ergebnis.Fehler.Nachricht Nachricht mit Details zum zugeordneten error.

    Datentyp: Zeichenfolge
    result.result Kennzeichnung, die angibt, ob der gewünschte Zustand für alle in der Anforderung enthaltenen CIs festgelegt wurde.
    Mögliche Werte:
    • true: Betriebsstatus festgelegt.
    • „falsch“: Betriebsstatus nicht festgelegt.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Legen Sie den Betriebsstatus „ Reparatur in Bearbeitung“ für zwei CIs fest.

    curl --request POST \
"https://instance.service-now.com/api/now/cilifecyclemgmt/statuses?opsLabel=Repair%20in%20Progress&requestorId=23d58bc030121010f877773aa7167c83&sysIds=affd3c8437201000deeabfc8bcbe5dc3,aac0b1213784200044e0bfc8bcbe5de3" \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--user "username":"password"

    Der Antworttext zeigt, dass der gewünschte Betriebsstatus für beide in der Anforderung angegebenen CIs festgelegt wurde.

    {
  "result": {
    "result": true
  }
}