CI Lifecycle Management-API

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

    • Die CI Lifecycle Management- API bietet Endpunkte, um Betriebsstatus von Configuration Items (CI) zu bearbeiten und CI-Aktionen anzuwenden.

    Die API-Schnittstellen entsprechen den Einschränkungen und Erlaubnissen, die durch nicht zulässige CI-Aktionen, kompatible CI-Aktionen und nicht zulässige Betriebsübergänge angegeben sind. Wenn eine Schnittstelle einen eingeschränkten Vorgang versucht, wird der Vorgang blockiert, ein Fehler protokolliert und gegebenenfalls eine Aufgabe erstellt.

    CI Lifecycle Management – DELETE /now/cilifecyclemgmt/actions

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

    URL-Format

    Versionierte URL: /api/now/{api_version}/cilifecyclemgmt/actions

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

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

    Datentyp: Zeichenfolge
    requestorId Erforderlich. Sys_id eines Workflow-Kontexts oder eine Operator-Anwender-ID, die vom Endpunkt CI Lifecycle Management – POST /now/cilifecyclemgmt/operators zurückgegeben wird.

    Operator-Benutzer-IDs befinden sich in der Tabelle „CI-Status registrierte Benutzer“ [statemgmt_register_users].

    Datentyp: Zeichenfolge
    sysIds Erforderlich. Kommagetrennte Liste von 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-Antwortcodesder REST-API.

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

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

    Wenn der Endpunkt während der Verarbeitung der Anforderung auf Fehler stößt, werden Fehlercodes und Meldungen im Parameter des Antworttexts result.errors 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.

    Antworttextparameter (JSON oder XML)

    Name Beschreibung
    Ergebnis Objekt, das das Ergebnis der Anforderung enthält.

    Datentyp: Objekt

    "result": {
  "errors": [Array],
  "result": "String"
}
    result.errors Liste der Objekte, in denen jedes Objekt einen Fehler darstellt, der beim Verarbeiten der Anforderung aufgetreten ist.

    Datentyp: Array

    "errors": [
  {
    "error": "String",
    "message": "String"
  }
]
    result.errors.error Bezeichner für einen Statusverwaltungsfehler, der beim Verarbeiten der Anforderung aufgetreten ist.
    Mögliche Werte:
    • CI_ACTION_ALREADY_SET
    • CI_ACTION_NOT_SET
    • DUPLICATE_CI_ACTION_RECORD
    • DUPLICATE_OPS_STATE_RECORD
    • DUPLICATE_SYS_ID
    • INKOMPATIBEL_CI_ACTION
    • UNGÜLTIG_CI_AKTION
    • UNGÜLTIG_LÖSCHEN
    • INVALID_INPUT_PARAMETER
    • INVALID_LEASETIME
    • INVALID_OPS_STATE
    • INVALID_OPS_STATE_TRANSITION
    • INVALID_REQUESTOR
    • INVALID_REQUESTOR_FOR_CI
    • INVALID_SYS_ID
    • MUTEX_UNAVAILABLE
    • NOT_ALLOWED_CI_ACTION
    • OPS_STATUS_NOT_SET
    • UNPRIORITISIERT_OPS_STATUS
    • NICHT UNTERSTÜTZT_SYS_ID

    Datentyp: Zeichenfolge
    result.errors.message Nachricht mit Details zum zugeordneten error.

    Datentyp: Zeichenfolge
    result.result Kennzeichnung, die angibt, ob die CI-Aktion erfolgreich entfernt wurde.
    Mögliche Werte:
    • true: CI-Aktion wurde entfernt.
    • false: CI-Aktion wurde nicht entfernt.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Entfernen Sie 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 Lifecycle Management – DELETE /now/cilifecyclemgmt/operators/{req_id}

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

    URL-Format

    Versionierte URL: /api/now/{api_version}/cilifecyclemgmt/operators/{req_id}

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

    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 Operator-Anwender-ID, die vom Endpunkt CI Lifecycle Management – POST /now/cilifecyclemgmt/operators zurückgegeben wird.

    Operator-Benutzer-IDs befinden sich in der Tabelle „CI-Status registrierte Benutzer“ [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-Antwortcodesder REST-API.

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

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

    Wenn der Endpunkt während der Verarbeitung der Anforderung auf Fehler stößt, werden Fehlercodes und Meldungen im Parameter des Antworttexts result.errors 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.

    Antworttextparameter (JSON oder XML)

    Name Beschreibung
    Ergebnis Objekt, das das Ergebnis der Anforderung enthält.

    Datentyp: Objekt

    "result": {
  "errors": [Array],
  "result": "String"
}
    result.errors Liste der Objekte, in denen jedes Objekt einen Fehler darstellt, der beim Verarbeiten der Anforderung aufgetreten ist.

    Datentyp: Array

    "errors": [
  {
    "error": "String",
    "message": "String"
  }
]
    result.errors.error Bezeichner für einen Statusverwaltungsfehler, der beim Verarbeiten der Anforderung aufgetreten ist.
    Mögliche Werte:
    • CI_ACTION_ALREADY_SET
    • CI_ACTION_NOT_SET
    • DUPLICATE_CI_ACTION_RECORD
    • DUPLICATE_OPS_STATE_RECORD
    • DUPLICATE_SYS_ID
    • INKOMPATIBEL_CI_ACTION
    • UNGÜLTIG_CI_AKTION
    • UNGÜLTIG_LÖSCHEN
    • INVALID_INPUT_PARAMETER
    • INVALID_LEASETIME
    • INVALID_OPS_STATE
    • INVALID_OPS_STATE_TRANSITION
    • INVALID_REQUESTOR
    • INVALID_REQUESTOR_FOR_CI
    • INVALID_SYS_ID
    • MUTEX_UNAVAILABLE
    • NOT_ALLOWED_CI_ACTION
    • OPS_STATUS_NOT_SET
    • UNPRIORITISIERT_OPS_STATUS
    • NICHT UNTERSTÜTZT_SYS_ID

    Datentyp: Zeichenfolge
    result.errors.message Nachricht mit Details zum zugeordneten error.

    Datentyp: Zeichenfolge
    result.result Kennzeichnung, die angibt, ob die Registrierung des Operators erfolgreich aufgehoben wurde.
    Mögliche Werte:
    • true: Die Registrierung des Operators wurde erfolgreich aufgehoben.
    • false: Die Registrierung des Operators wurde nicht erfolgreich aufgehoben.

    Datentyp: Zeichenfolge

    cURL-Anforderung

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

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

    Der Antworttext überprüft, ob die Registrierung des Operators aufgehoben wurde.

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

    CI Lifecycle Management – GET /now/cilifecyclemgmt/actions/{sys_id}

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

    URL-Format

    Versionierte URL: /api/now/{api_version}/cilifecyclemgmt/actions/{sys_id}

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

    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 zugeordnete 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-Antwortcodesder REST-API.

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

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

    Wenn der Endpunkt während der Verarbeitung der Anforderung auf Fehler stößt, werden Fehlercodes und Meldungen im Parameter des Antworttexts result.errors 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.

    Antworttextparameter (JSON oder XML)

    Name Beschreibung
    Ergebnis Objekt, das das Ergebnis der Anforderung enthält.

    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 der Objekte, in denen jedes Objekt einen Fehler darstellt, der beim Verarbeiten der Anforderung aufgetreten ist.

    Datentyp: Array

    "errors": [
  {
    "error": "String",
    "message": "String"
  }
]
    result.errors.error Bezeichner für einen Statusverwaltungsfehler, der beim Verarbeiten der Anforderung aufgetreten ist.
    Mögliche Werte:
    • CI_ACTION_ALREADY_SET
    • CI_ACTION_NOT_SET
    • DUPLICATE_CI_ACTION_RECORD
    • DUPLICATE_OPS_STATE_RECORD
    • DUPLICATE_SYS_ID
    • INKOMPATIBEL_CI_ACTION
    • UNGÜLTIG_CI_AKTION
    • UNGÜLTIG_LÖSCHEN
    • INVALID_INPUT_PARAMETER
    • INVALID_LEASETIME
    • INVALID_OPS_STATE
    • INVALID_OPS_STATE_TRANSITION
    • INVALID_REQUESTOR
    • INVALID_REQUESTOR_FOR_CI
    • INVALID_SYS_ID
    • MUTEX_UNAVAILABLE
    • NOT_ALLOWED_CI_ACTION
    • OPS_STATUS_NOT_SET
    • UNPRIORITISIERT_OPS_STATUS
    • NICHT UNTERSTÜTZT_SYS_ID

    Datentyp: Zeichenfolge
    result.errors.message 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:
    • true: Liste der aktiven CI-Aktionen wurde zurückgegeben.
    • false: 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 Lifecycle Management – GET /now/cilifecyclemgmt/compatActions

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

    URL-Format

    Versionierte URL: /api/now/{api_version}/cilifecyclemgmt/compatActions

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

    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-Antwortcodesder REST-API.

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

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

    Wenn der Endpunkt während der Verarbeitung der Anforderung auf Fehler stößt, werden Fehlercodes und Meldungen im Parameter des Antworttexts result.errors 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.

    Antworttextparameter (JSON oder XML)

    Name Beschreibung
    Ergebnis Kennzeichnung, die angibt, ob die beiden angegebenen CI-Aktionen kompatibel sind.
    Mögliche Werte:
    • true: CI-Aktionen sind kompatibel.
    • false: CI-Aktionen sind nicht kompatibel.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Überprüfen Sie die Kompatibilität von Patch- und Bereitstellungs-CI-Aktionen.

    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 Lifecycle Management – GET /now/cilifecyclemgmt/leases/{sys_id}/expired

    Bestimmt, ob die Miete für die anfordernde Person einer Configuration Item (CI)-Aktion abgelaufen ist, die auf das angegebene CI angewendet wird.

    URL-Format

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

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

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

    Datentyp: Zeichenfolge
    requestorId Erforderlich. Sys_id eines Workflow-Kontexts oder eine Operator-Anwender-ID, die vom Endpunkt CI Lifecycle Management – POST /now/cilifecyclemgmt/operators zurückgegeben wird.

    Operator-Benutzer-IDs befinden sich in der Tabelle „CI-Status registrierte Benutzer“ [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-Antwortcodesder REST-API.

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

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

    Wenn der Endpunkt während der Verarbeitung der Anforderung auf Fehler stößt, werden Fehlercodes und Meldungen im Parameter des Antworttexts result.errors 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.

    Antworttextparameter (JSON oder XML)

    Name Beschreibung
    Ergebnis Objekt, das das Ergebnis der Anforderung enthält.

    Datentyp: Objekt

    "result": {
  "errors": [Array],
  "result": "String"
}
    result.errors Liste der Objekte, in denen jedes Objekt einen Fehler darstellt, der beim Verarbeiten der Anforderung aufgetreten ist.

    Datentyp: Array

    "errors": [
  {
    "error": "String",
    "message": "String"
  }
]
    result.errors.error Bezeichner für einen Statusverwaltungsfehler, der beim Verarbeiten der Anforderung aufgetreten ist.
    Mögliche Werte:
    • CI_ACTION_ALREADY_SET
    • CI_ACTION_NOT_SET
    • DUPLICATE_CI_ACTION_RECORD
    • DUPLICATE_OPS_STATE_RECORD
    • DUPLICATE_SYS_ID
    • INKOMPATIBEL_CI_ACTION
    • UNGÜLTIG_CI_AKTION
    • UNGÜLTIG_LÖSCHEN
    • INVALID_INPUT_PARAMETER
    • INVALID_LEASETIME
    • INVALID_OPS_STATE
    • INVALID_OPS_STATE_TRANSITION
    • INVALID_REQUESTOR
    • INVALID_REQUESTOR_FOR_CI
    • INVALID_SYS_ID
    • MUTEX_UNAVAILABLE
    • NOT_ALLOWED_CI_ACTION
    • OPS_STATUS_NOT_SET
    • UNPRIORITISIERT_OPS_STATUS
    • NICHT UNTERSTÜTZT_SYS_ID

    Datentyp: Zeichenfolge
    result.errors.message Nachricht mit Details zum zugeordneten error.

    Datentyp: Zeichenfolge
    result.result Kennzeichnung, die angibt, ob die Miete für die anfordernde Person der angewendeten CI-Aktion abgelaufen ist.
    Mögliche Werte:
    • true: Mietvertrag der anfordernden Person ist abgelaufen.
    • false: Mietvertrag 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 an, dass die Miete für die anfordernde Person der angewendeten CI-Aktion nicht abgelaufen ist.

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

    CI Lifecycle Management – GET /now/cilifecyclemgmt/notAllowedAction

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

    URL-Format

    Versionierte URL: /api/now/{api_version}/cilifecyclemgmt/notAllowedAction

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

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

    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-Antwortcodesder REST-API.

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

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

    Wenn der Endpunkt während der Verarbeitung der Anforderung auf Fehler stößt, werden Fehlercodes und Meldungen im Parameter des Antworttexts result.errors 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.

    Antworttextparameter (JSON oder XML)

    Name Beschreibung
    Ergebnis Kennzeichnung, die angibt, ob die CI-Aktion für CIs des angegebenen Typs im angegebenen Betriebsstatus eingeschränkt (nicht zulässig) ist.
    Mögliche Werte:
    • true: CI-Aktion ist eingeschränkt (nicht zulässig).
    • false: CI-Aktion ist nicht beschrä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 Lifecycle Management – GET /now/cilifecyclemgmt/notAllowedOpsTransition

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

    URL-Format

    Versionierte URL: /api/now/{api_version}/cilifecyclemgmt/notAllowedOpsTransition

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

    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 Betriebszustands, 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-Antwortcodesder REST-API.

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

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

    Wenn der Endpunkt während der Verarbeitung der Anforderung auf Fehler stößt, werden Fehlercodes und Meldungen im Parameter des Antworttexts result.errors 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.

    Antworttextparameter (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:
    • true: Betriebsstatusübergang ist eingeschränkt (nicht zulässig).
    • false: Der Übergang des Betriebszustands ist nicht beschränkt (zulässig).

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Überprüfen Sie, ob der Übergang vom Betriebsstatus „Stillgelegt“ in den Betriebszustand „DR“ 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 beschränkt (zulässig) ist.

    {
  "result": false
}

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

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

    URL-Format

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

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

    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 Operator-Anwender-ID, die vom Endpunkt CI Lifecycle Management – POST /now/cilifecyclemgmt/operators zurückgegeben wird.

    Operator-Benutzer-IDs befinden sich in der Tabelle „CI-Status registrierte Benutzer“ [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-Antwortcodesder REST-API.

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

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

    Wenn der Endpunkt während der Verarbeitung der Anforderung auf Fehler stößt, werden Fehlercodes und Meldungen im Parameter des Antworttexts result.errors 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.

    Antworttextparameter (JSON oder XML)

    Name Beschreibung
    Ergebnis Objekt, das das Ergebnis der Anforderung enthält.

    Datentyp: Objekt

    "result": {
  "errors": [Array],
  "result": "String"
}
    result.errors Liste der Objekte, in denen jedes Objekt einen Fehler darstellt, der beim Verarbeiten der Anforderung aufgetreten ist.

    Datentyp: Array

    "errors": [
  {
    "error": "String",
    "message": "String"
  }
]
    result.errors.error Bezeichner für einen Statusverwaltungsfehler, der beim Verarbeiten der Anforderung aufgetreten ist.
    Mögliche Werte:
    • CI_ACTION_ALREADY_SET
    • CI_ACTION_NOT_SET
    • DUPLICATE_CI_ACTION_RECORD
    • DUPLICATE_OPS_STATE_RECORD
    • DUPLICATE_SYS_ID
    • INKOMPATIBEL_CI_ACTION
    • UNGÜLTIG_CI_AKTION
    • UNGÜLTIG_LÖSCHEN
    • INVALID_INPUT_PARAMETER
    • INVALID_LEASETIME
    • INVALID_OPS_STATE
    • INVALID_OPS_STATE_TRANSITION
    • INVALID_REQUESTOR
    • INVALID_REQUESTOR_FOR_CI
    • INVALID_SYS_ID
    • MUTEX_UNAVAILABLE
    • NOT_ALLOWED_CI_ACTION
    • OPS_STATUS_NOT_SET
    • UNPRIORITISIERT_OPS_STATUS
    • NICHT UNTERSTÜTZT_SYS_ID

    Datentyp: Zeichenfolge
    result.errors.message Nachricht mit Details zum zugeordneten error.

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

    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 Lifecycle Management – GET /now/cilifecyclemgmt/statuses/{sys_id}

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

    URL-Format

    Versionierte URL: /api/now/{api_version}/cilifecyclemgmt/statuses/{sys_id}

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

    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-Antwortcodesder REST-API.

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

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

    Wenn der Endpunkt während der Verarbeitung der Anforderung auf Fehler stößt, werden Fehlercodes und Meldungen im Parameter des Antworttexts result.errors 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.

    Antworttextparameter (JSON oder XML)

    Name Beschreibung
    Ergebnis Objekt, das das Ergebnis der Anforderung enthält.

    Datentyp: Objekt

    "result": {
  "errors": [Array],
  "result": "String"
}
    result.errors Liste der Objekte, in denen jedes Objekt einen Fehler darstellt, der beim Verarbeiten der Anforderung aufgetreten ist.

    Datentyp: Array

    "errors": [
  {
    "error": "String",
    "message": "String"
  }
]
    result.errors.error Bezeichner für einen Statusverwaltungsfehler, der beim Verarbeiten der Anforderung aufgetreten ist.
    Mögliche Werte:
    • CI_ACTION_ALREADY_SET
    • CI_ACTION_NOT_SET
    • DUPLICATE_CI_ACTION_RECORD
    • DUPLICATE_OPS_STATE_RECORD
    • DUPLICATE_SYS_ID
    • INKOMPATIBEL_CI_ACTION
    • UNGÜLTIG_CI_AKTION
    • UNGÜLTIG_LÖSCHEN
    • INVALID_INPUT_PARAMETER
    • INVALID_LEASETIME
    • INVALID_OPS_STATE
    • INVALID_OPS_STATE_TRANSITION
    • INVALID_REQUESTOR
    • INVALID_REQUESTOR_FOR_CI
    • INVALID_SYS_ID
    • MUTEX_UNAVAILABLE
    • NOT_ALLOWED_CI_ACTION
    • OPS_STATUS_NOT_SET
    • UNPRIORITISIERT_OPS_STATUS
    • NICHT UNTERSTÜTZT_SYS_ID

    Datentyp: Zeichenfolge
    result.errors.message 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 Lifecycle Management – PATCH /now/cilifecyclemgmt/leases/{sys_id}

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

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

    URL-Format

    Versionierte URL: /api/now/{api_version}/cilifecyclemgmt/leases/{sys_id}

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

    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 erweitert 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 Operator-Anwender-ID, die vom Endpunkt CI Lifecycle Management – POST /now/cilifecyclemgmt/operators zurückgegeben wird.

    Operator-Benutzer-IDs befinden sich in der Tabelle „CI-Status registrierte Benutzer“ [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-Antwortcodesder REST-API.

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

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

    Wenn der Endpunkt während der Verarbeitung der Anforderung auf Fehler stößt, werden Fehlercodes und Meldungen im Parameter des Antworttexts result.errors 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.

    Antworttextparameter (JSON oder XML)

    Name Beschreibung
    Ergebnis Objekt, das das Ergebnis der Anforderung enthält.

    Datentyp: Objekt

    "result": {
  "errors": [Array],
  "result": "String"
}
    result.errors Liste der Objekte, in denen jedes Objekt einen Fehler darstellt, der beim Verarbeiten der Anforderung aufgetreten ist.

    Datentyp: Array

    "errors": [
  {
    "error": "String",
    "message": "String"
  }
]
    result.errors.error Bezeichner für einen Statusverwaltungsfehler, der beim Verarbeiten der Anforderung aufgetreten ist.
    Mögliche Werte:
    • CI_ACTION_ALREADY_SET
    • CI_ACTION_NOT_SET
    • DUPLICATE_CI_ACTION_RECORD
    • DUPLICATE_OPS_STATE_RECORD
    • DUPLICATE_SYS_ID
    • INKOMPATIBEL_CI_ACTION
    • UNGÜLTIG_CI_AKTION
    • UNGÜLTIG_LÖSCHEN
    • INVALID_INPUT_PARAMETER
    • INVALID_LEASETIME
    • INVALID_OPS_STATE
    • INVALID_OPS_STATE_TRANSITION
    • INVALID_REQUESTOR
    • INVALID_REQUESTOR_FOR_CI
    • INVALID_SYS_ID
    • MUTEX_UNAVAILABLE
    • NOT_ALLOWED_CI_ACTION
    • OPS_STATUS_NOT_SET
    • UNPRIORITISIERT_OPS_STATUS
    • NICHT UNTERSTÜTZT_SYS_ID

    Datentyp: Zeichenfolge
    result.errors.message Nachricht mit Details zum zugeordneten error.

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

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Verlängern Sie die Dauer einer Anforderer-Lease 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 Lifecycle Management – POST /now/cilifecyclemgmt/actions

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

    URL-Format

    Versionierte URL: /api/now/{api_version}/cilifecyclemgmt/actions

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

    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 der alten CI-Aktionen, in der alle CIs enthalten sein sollten.

    Datentyp: Zeichenfolge
    requestorId Erforderlich. Sys_id eines Workflow-Kontexts oder eine Operator-Anwender-ID, die vom Endpunkt CI Lifecycle Management – POST /now/cilifecyclemgmt/operators zurückgegeben wird.

    Operator-Benutzer-IDs befinden sich in der Tabelle „CI-Status registrierte Benutzer“ [statemgmt_register_users].

    Datentyp: Zeichenfolge
    sysIds Erforderlich. Kommagetrennte Liste von 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-Antwortcodesder REST-API.

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

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

    Wenn der Endpunkt während der Verarbeitung der Anforderung auf Fehler stößt, werden Fehlercodes und Meldungen im Parameter des Antworttexts result.errors 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.

    Antworttextparameter (JSON oder XML)

    Name Beschreibung
    Ergebnis Objekt, das das Ergebnis der Anforderung enthält.

    Datentyp: Objekt

    "result": {
  "errors": [Array],
  "result": "String"
}
    result.errors Liste der Objekte, in denen jedes Objekt einen Fehler darstellt, der beim Verarbeiten der Anforderung aufgetreten ist.

    Datentyp: Array

    "errors": [
  {
    "error": "String",
    "message": "String"
  }
]
    result.errors.error Bezeichner für einen Statusverwaltungsfehler, der beim Verarbeiten der Anforderung aufgetreten ist.
    Mögliche Werte:
    • CI_ACTION_ALREADY_SET
    • CI_ACTION_NOT_SET
    • DUPLICATE_CI_ACTION_RECORD
    • DUPLICATE_OPS_STATE_RECORD
    • DUPLICATE_SYS_ID
    • INKOMPATIBEL_CI_ACTION
    • UNGÜLTIG_CI_AKTION
    • UNGÜLTIG_LÖSCHEN
    • INVALID_INPUT_PARAMETER
    • INVALID_LEASETIME
    • INVALID_OPS_STATE
    • INVALID_OPS_STATE_TRANSITION
    • INVALID_REQUESTOR
    • INVALID_REQUESTOR_FOR_CI
    • INVALID_SYS_ID
    • MUTEX_UNAVAILABLE
    • NOT_ALLOWED_CI_ACTION
    • OPS_STATUS_NOT_SET
    • UNPRIORITISIERT_OPS_STATUS
    • NICHT UNTERSTÜTZT_SYS_ID

    Datentyp: Zeichenfolge
    result.errors.message 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:
    • true: CI-Aktionen wurden festgelegt.
    • false: CI-Aktionen wurden nicht festgelegt.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Fügen Sie zwei CIs eine Patching-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 Lifecycle Management – POST /now/cilifecyclemgmt/operators

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

    URL-Format

    Versionierte URL: /api/now/{api_version}/cilifecyclemgmt/operators

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

    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-Antwortcodesder REST-API.

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

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

    Wenn der Endpunkt während der Verarbeitung der Anforderung auf Fehler stößt, werden Fehlercodes und Meldungen im Parameter des Antworttexts result.errors 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.

    Antworttextparameter (JSON oder XML)

    Name Beschreibung
    Ergebnis Objekt, das das Ergebnis der Anforderung enthält.

    Datentyp: Objekt

    "result": {
  "errors": [Array],
  "result": "String"
}
    result.errors Liste der Objekte, in denen jedes Objekt einen Fehler darstellt, der beim Verarbeiten der Anforderung aufgetreten ist.

    Datentyp: Array

    "errors": [
  {
    "error": "String",
    "message": "String"
  }
]
    result.errors.error Bezeichner für einen Statusverwaltungsfehler, der beim Verarbeiten der Anforderung aufgetreten ist.
    Mögliche Werte:
    • CI_ACTION_ALREADY_SET
    • CI_ACTION_NOT_SET
    • DUPLICATE_CI_ACTION_RECORD
    • DUPLICATE_OPS_STATE_RECORD
    • DUPLICATE_SYS_ID
    • INKOMPATIBEL_CI_ACTION
    • UNGÜLTIG_CI_AKTION
    • UNGÜLTIG_LÖSCHEN
    • INVALID_INPUT_PARAMETER
    • INVALID_LEASETIME
    • INVALID_OPS_STATE
    • INVALID_OPS_STATE_TRANSITION
    • INVALID_REQUESTOR
    • INVALID_REQUESTOR_FOR_CI
    • INVALID_SYS_ID
    • MUTEX_UNAVAILABLE
    • NOT_ALLOWED_CI_ACTION
    • OPS_STATUS_NOT_SET
    • UNPRIORITISIERT_OPS_STATUS
    • NICHT UNTERSTÜTZT_SYS_ID

    Datentyp: Zeichenfolge
    result.errors.message 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:
    • true: Operator wurde erfolgreich registriert.
    • false: 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 Lifecycle Management – POST /now/cilifecyclemgmt/statuses

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

    URL-Format

    Versionierte URL: /api/now/{api_version}/cilifecyclemgmt/statuses

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

    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 Operator-Anwender-ID, die vom Endpunkt CI Lifecycle Management – POST /now/cilifecyclemgmt/operators zurückgegeben wird.

    Operator-Benutzer-IDs befinden sich in der Tabelle „CI-Status registrierte Benutzer“ [statemgmt_register_users].

    Datentyp: Zeichenfolge
    sysIds Erforderlich. Kommagetrennte Liste von 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-Antwortcodesder REST-API.

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

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

    Wenn der Endpunkt während der Verarbeitung der Anforderung auf Fehler stößt, werden Fehlercodes und Meldungen im Parameter des Antworttexts result.errors 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.

    Antworttextparameter (JSON oder XML)

    Name Beschreibung
    Ergebnis Objekt, das das Ergebnis der Anforderung enthält.

    Datentyp: Objekt

    "result": {
  "errors": [Array],
  "result": "String"
}
    result.errors Liste der Objekte, in denen jedes Objekt einen Fehler darstellt, der beim Verarbeiten der Anforderung aufgetreten ist.

    Datentyp: Array

    "errors": [
  {
    "error": "String",
    "message": "String"
  }
]
    result.errors.error Bezeichner für einen Statusverwaltungsfehler, der beim Verarbeiten der Anforderung aufgetreten ist.
    Mögliche Werte:
    • CI_ACTION_ALREADY_SET
    • CI_ACTION_NOT_SET
    • DUPLICATE_CI_ACTION_RECORD
    • DUPLICATE_OPS_STATE_RECORD
    • DUPLICATE_SYS_ID
    • INKOMPATIBEL_CI_ACTION
    • UNGÜLTIG_CI_AKTION
    • UNGÜLTIG_LÖSCHEN
    • INVALID_INPUT_PARAMETER
    • INVALID_LEASETIME
    • INVALID_OPS_STATE
    • INVALID_OPS_STATE_TRANSITION
    • INVALID_REQUESTOR
    • INVALID_REQUESTOR_FOR_CI
    • INVALID_SYS_ID
    • MUTEX_UNAVAILABLE
    • NOT_ALLOWED_CI_ACTION
    • OPS_STATUS_NOT_SET
    • UNPRIORITISIERT_OPS_STATUS
    • NICHT UNTERSTÜTZT_SYS_ID

    Datentyp: Zeichenfolge
    result.errors.message Nachricht mit Details zum zugeordneten error.

    Datentyp: Zeichenfolge
    result.result Kennzeichnung, die angibt, ob der gewünschte Status für alle in der Anforderung enthaltenen CIs festgelegt wurde.
    Mögliche Werte:
    • true: Betriebsstatus festgelegt.
    • false: 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
  }
}