CI-Lebenszyklusmanagement-API

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

    • Die CI-Lebenszyklusmanagement Die API stellt Endpunkte bereit, um betriebsstatus von Konfigurationselementen (CI) zu bearbeiten und CI-Aktionen anzuwenden.

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

    CI-Lebenszyklusmanagement – LÖSCHT /now/cilifecyclemgmt/actions

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

    URL-Format

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

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

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

    Unterstützte Anforderungsparameter

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

    Datentyp: Zeichenfolge
    Tabelle : 2. Abfrageparameter
    Name Beschreibung
    actionName Erforderlich. Name der Konfigurationselementaktion.

    Datentyp: Zeichenfolge
    Request-ID Erforderlich. SYS_ID eines Workflow-Kontexts oder eine Operator-Anwender-ID, die von zurückgegeben wird CI-Lebenszyklusmanagement – POST /now/cilifecyclemgmt/OperatorsEndpunkt.

    Anwender-IDs des Anwenders befinden sich in der Tabelle „registrierte Anwender des CI-Status“ [statemgmt_Register_users].

    Datentyp: Zeichenfolge
    Sys-IDs Erforderlich. Kommagetrennte Liste von CI-sys_IDs.

    Datentyp: Zeichenfolge
    Tabelle : 3. Anforderungstext-Parameter (XML oder JSON)
    Name Beschreibung
    Keine

    Header

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

    Tabelle : 4. Anforderungskopfzeilen.
    Header Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/jsonOder application/xml.

    Standard: application/json
    Tabelle : 5. Antwort-Header
    Header Beschreibung
    Keine

    Statuscodes

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

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

    Überprüfen Sie den Antworttext result.resultParameter zum Überprüfen des Ergebnisses des Vorgangs.

    Wenn der Endpunkt während der Verarbeitung der Anforderung auf Fehler stößt, werden Fehlercodes und Meldungen im Antworttext angezeigt result.errorsParameter.
    401 Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler.

    Antworttext-Parameter (JSON oder XML)

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

    Datentyp: Objekt

    "result": {
  "errors": [Array],
  "result": "String"
}
    Ergebnis.Fehler Liste der Objekte, in denen 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 Statusverwaltungsfehler, der bei der Verarbeitung der Anforderung aufgetreten ist.
    Mögliche Werte:
    • CI_ACTION_ALREADY_SET
    • CI_ACTION_NOT_SET
    • DUPLICATE_CI_ACTION_RECORD
    • DUPLICATE_OPS_STATE_RECORD
    • DUPLIKAT_SYS_ID
    • INCIDENT_CI_ACTION
    • UNGÜLTIGE_CI_AKTION
    • UNGÜLTIG_LÖSCHEN
    • UNGÜLTIGE_INPUT_PARAMETERS
    • INVALID_LEASETIME
    • UNGÜLTIGER_OPS_STATUS
    • INVALID_OPS_STATE_TRANSITION
    • UNGÜLTIGER_ANFORDERER
    • INVALID_REQUESTOR_FOR_CI
    • UNGÜLTIGE_SYS_ID
    • MUTEX_NICHT VERFÜGBAR
    • NOT_ALLOWED_CI_ACTION
    • OPS_STATE_NOT_SET
    • UNPRIORITIZED_OPS_STATE
    • NICHT SUPPORTED_SYS_ID

    Datentyp: Zeichenfolge
    Ergebnis.Fehler.Nachricht Nachricht, die Details zum zugeordneten enthält error.

    Datentyp: Zeichenfolge
    Ergebnis.Ergebnis 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

    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-Lebenszyklusmanagement – LÖSCHT /now/cilifecyclemgmt/Operators/{req_ID}

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

    URL-Format

    Versionierte URL: /api/now/{api_Version}/cilifecyclemgmt/Operators/{req_ID}

    Standard-URL: /api/now/cilifecyclemgmt/Operators/{req_ID}

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

    Unterstützte Anforderungsparameter

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

    Datentyp: Zeichenfolge
    req_ID SYS_ID eines Workflow-Kontexts oder eine Operator-Anwender-ID, die von zurückgegeben wird CI-Lebenszyklusmanagement – POST /now/cilifecyclemgmt/OperatorsEndpunkt.

    Anwender-IDs des Anwenders befinden sich in der Tabelle „registrierte Anwender des CI-Status“ [statemgmt_Register_users].

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

    Header

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

    Tabelle : 10. Anforderungskopfzeilen.
    Header Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/jsonOder application/xml.

    Standard: application/json
    Tabelle : 11. Antwort-Header
    Header Beschreibung
    Keine

    Statuscodes

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

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

    Überprüfen Sie den Antworttext result.resultParameter zum Überprüfen des Ergebnisses des Vorgangs.

    Wenn der Endpunkt während der Verarbeitung der Anforderung auf Fehler stößt, werden Fehlercodes und Meldungen im Antworttext angezeigt result.errorsParameter.
    401 Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler.

    Antworttext-Parameter (JSON oder XML)

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

    Datentyp: Objekt

    "result": {
  "errors": [Array],
  "result": "String"
}
    Ergebnis.Fehler Liste der Objekte, in denen 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 Statusverwaltungsfehler, der bei der Verarbeitung der Anforderung aufgetreten ist.
    Mögliche Werte:
    • CI_ACTION_ALREADY_SET
    • CI_ACTION_NOT_SET
    • DUPLICATE_CI_ACTION_RECORD
    • DUPLICATE_OPS_STATE_RECORD
    • DUPLIKAT_SYS_ID
    • INCIDENT_CI_ACTION
    • UNGÜLTIGE_CI_AKTION
    • UNGÜLTIG_LÖSCHEN
    • UNGÜLTIGE_INPUT_PARAMETERS
    • INVALID_LEASETIME
    • UNGÜLTIGER_OPS_STATUS
    • INVALID_OPS_STATE_TRANSITION
    • UNGÜLTIGER_ANFORDERER
    • INVALID_REQUESTOR_FOR_CI
    • UNGÜLTIGE_SYS_ID
    • MUTEX_NICHT VERFÜGBAR
    • NOT_ALLOWED_CI_ACTION
    • OPS_STATE_NOT_SET
    • UNPRIORITIZED_OPS_STATE
    • NICHT SUPPORTED_SYS_ID

    Datentyp: Zeichenfolge
    Ergebnis.Fehler.Nachricht Nachricht, die Details zum zugeordneten enthält error.

    Datentyp: Zeichenfolge
    Ergebnis.Ergebnis Kennzeichnung, die angibt, ob die Registrierung des Operators erfolgreich aufgehoben wurde.
    Mögliche Werte:
    • Wahr: Registrierung des Operators wurde erfolgreich aufgehoben.
    • Falsch: Registrierung des Operators 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-Lebenszyklusmanagement – GET /now/cilifecyclemgmt/actions/{sys_ID}

    Gibt eine Liste aktiver Konfigurationselementaktionen (CI) 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}

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

    Unterstützte Anforderungsparameter

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

    Datentyp: Zeichenfolge
    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. Anforderungstext-Parameter (XML oder JSON)
    Name Beschreibung
    Keine

    Header

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

    Tabelle : 16. Anforderungskopfzeilen.
    Header Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/jsonOder application/xml.

    Standard: application/json
    Tabelle : 17. Antwort-Header
    Header Beschreibung
    Keine

    Statuscodes

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

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

    Überprüfen Sie den Antworttext result.ciActionsParameter zum Überprüfen des Ergebnisses des Vorgangs.

    Wenn der Endpunkt während der Verarbeitung der Anforderung auf Fehler stößt, werden Fehlercodes und Meldungen im Antworttext angezeigt result.errorsParameter.
    401 Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler.

    Antworttext-Parameter (JSON oder XML)

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

    Datentyp: Objekt

    "result": {
  "errors": [Array],
  "result": "String"
}
    Ergebnis.ciAktionen Kommagetrennte Liste aktiver CI-Aktionen für das CI, oder No_Active_action Wenn keine gefunden wurden.

    Datentyp: Zeichenfolge
    Ergebnis.Fehler Liste der Objekte, in denen 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 Statusverwaltungsfehler, der bei der Verarbeitung der Anforderung aufgetreten ist.
    Mögliche Werte:
    • CI_ACTION_ALREADY_SET
    • CI_ACTION_NOT_SET
    • DUPLICATE_CI_ACTION_RECORD
    • DUPLICATE_OPS_STATE_RECORD
    • DUPLIKAT_SYS_ID
    • INCIDENT_CI_ACTION
    • UNGÜLTIGE_CI_AKTION
    • UNGÜLTIG_LÖSCHEN
    • UNGÜLTIGE_INPUT_PARAMETERS
    • INVALID_LEASETIME
    • UNGÜLTIGER_OPS_STATUS
    • INVALID_OPS_STATE_TRANSITION
    • UNGÜLTIGER_ANFORDERER
    • INVALID_REQUESTOR_FOR_CI
    • UNGÜLTIGE_SYS_ID
    • MUTEX_NICHT VERFÜGBAR
    • NOT_ALLOWED_CI_ACTION
    • OPS_STATE_NOT_SET
    • UNPRIORITIZED_OPS_STATE
    • NICHT SUPPORTED_SYS_ID

    Datentyp: Zeichenfolge
    Ergebnis.Fehler.Nachricht Nachricht, die Details zum zugeordneten enthält error.

    Datentyp: Zeichenfolge
    Ergebnis.Ergebnis 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 an, dass für das angegebene CI keine CI-Aktionen aktiv sind.

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

    CI-Lebenszyklusmanagement – GET /now/cilifecyclemgmt/compatActions

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

    URL-Format

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

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

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

    Unterstützte Anforderungsparameter

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

    Datentyp: Zeichenfolge
    Tabelle : 20. Abfrageparameter
    Name Beschreibung
    actionName Erforderlich. Name der zu vergleichenden CI-Aktion.

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

    Datentyp: Zeichenfolge
    Tabelle : 21. Anforderungstext-Parameter (XML oder JSON)
    Name Beschreibung
    Keine

    Header

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

    Tabelle : 22. Anforderungskopfzeilen.
    Header Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/jsonOder application/xml.

    Standard: application/json
    Tabelle : 23. Antwort-Header
    Header Beschreibung
    Keine

    Statuscodes

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

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

    Überprüfen Sie den Antworttext result.resultParameter zum Überprüfen des Ergebnisses des Vorgangs.

    Wenn der Endpunkt während der Verarbeitung der Anforderung auf Fehler stößt, werden Fehlercodes und Meldungen im Antworttext angezeigt result.errorsParameter.
    401 Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler.

    Antworttext-Parameter (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üfen Sie die Kompatibilität von CI-Aktionen für das Patchen und die Bereitstellung.

    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-Lebenszyklusmanagement – GET /now/cilifecyclemgmt/leases/{sys_ID}/expired

    Bestimmt, ob der Mietvertrag für die anfordernde Person einer auf das angegebene CI angewendeten Konfigurationselementaktion (Configuration Item, CI) abgelaufen ist.

    URL-Format

    Versionierte URL: /api/now/{api_Version}/cilifecyclemgmt/leases/{sys_ID}/abgelaufen

    Standard-URL: /api/now/cilifecyclemgmt/leases/{sys_ID}/abgelaufen

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

    Unterstützte Anforderungsparameter

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

    Datentyp: Zeichenfolge
    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
    Request-ID Erforderlich. SYS_ID eines Workflow-Kontexts oder eine Operator-Anwender-ID, die von zurückgegeben wird CI-Lebenszyklusmanagement – POST /now/cilifecyclemgmt/OperatorsEndpunkt.

    Anwender-IDs des Anwenders befinden sich in der Tabelle „registrierte Anwender des CI-Status“ [statemgmt_Register_users].

    Datentyp: Zeichenfolge
    Tabelle : 27. Anforderungstext-Parameter (XML oder JSON)
    Name Beschreibung
    Keine

    Header

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

    Tabelle : 28. Anforderungskopfzeilen.
    Header Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/jsonOder application/xml.

    Standard: application/json
    Tabelle : 29. Antwort-Header
    Header Beschreibung
    Keine

    Statuscodes

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

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

    Überprüfen Sie den Antworttext result.resultParameter zum Überprüfen des Ergebnisses des Vorgangs.

    Wenn der Endpunkt während der Verarbeitung der Anforderung auf Fehler stößt, werden Fehlercodes und Meldungen im Antworttext angezeigt result.errorsParameter.
    401 Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler.

    Antworttext-Parameter (JSON oder XML)

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

    Datentyp: Objekt

    "result": {
  "errors": [Array],
  "result": "String"
}
    Ergebnis.Fehler Liste der Objekte, in denen 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 Statusverwaltungsfehler, der bei der Verarbeitung der Anforderung aufgetreten ist.
    Mögliche Werte:
    • CI_ACTION_ALREADY_SET
    • CI_ACTION_NOT_SET
    • DUPLICATE_CI_ACTION_RECORD
    • DUPLICATE_OPS_STATE_RECORD
    • DUPLIKAT_SYS_ID
    • INCIDENT_CI_ACTION
    • UNGÜLTIGE_CI_AKTION
    • UNGÜLTIG_LÖSCHEN
    • UNGÜLTIGE_INPUT_PARAMETERS
    • INVALID_LEASETIME
    • UNGÜLTIGER_OPS_STATUS
    • INVALID_OPS_STATE_TRANSITION
    • UNGÜLTIGER_ANFORDERER
    • INVALID_REQUESTOR_FOR_CI
    • UNGÜLTIGE_SYS_ID
    • MUTEX_NICHT VERFÜGBAR
    • NOT_ALLOWED_CI_ACTION
    • OPS_STATE_NOT_SET
    • UNPRIORITIZED_OPS_STATE
    • NICHT SUPPORTED_SYS_ID

    Datentyp: Zeichenfolge
    Ergebnis.Fehler.Nachricht Nachricht, die Details zum zugeordneten enthält error.

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

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

    CI-Lebenszyklusmanagement – GET /now/cilifecyclemgmt/notAllowedAction

    Bestimmt, ob eine angegebene Konfigurationselement-Aktion (CI) 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

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

    Unterstützte Anforderungsparameter

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

    Datentyp: Zeichenfolge
    Tabelle : 32. Abfrageparameter
    Name Beschreibung
    actionName Erforderlich. Name der zu überprüfenden CI-Aktion.

    Datentyp: Zeichenfolge
    ciClass Erforderlich. CI-Klasse.

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

    Datentyp: Zeichenfolge
    Tabelle : 33. Anforderungstext-Parameter (XML oder JSON)
    Name Beschreibung
    Keine

    Header

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

    Tabelle : 34. Anforderungskopfzeilen.
    Header Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/jsonOder application/xml.

    Standard: application/json
    Tabelle : 35. Antwort-Header
    Header Beschreibung
    Keine

    Statuscodes

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

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

    Überprüfen Sie den Antworttext result.resultParameter zum Überprüfen des Ergebnisses des Vorgangs.

    Wenn der Endpunkt während der Verarbeitung der Anforderung auf Fehler stößt, werden Fehlercodes und Meldungen im Antworttext angezeigt result.errorsParameter.
    401 Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler.

    Antworttext-Parameter (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 uneingeschränkt (zulässig).

    Datentyp: Zeichenfolge

    Curl-Anforderung

    Überprüfen Sie, ob die CI-Aktion „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-Lebenszyklusmanagement – GET /now/cilifecyclemgmt/notAllowedOpsTransition

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

    URL-Format

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

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

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

    Unterstützte Anforderungsparameter

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

    Datentyp: Zeichenfolge
    Tabelle : 38. Abfrageparameter
    Name Beschreibung
    ciClass Erforderlich. CI-Klasse, für die Übergangsbeschränkungen überprüft werden sollen.

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

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

    Datentyp: Zeichenfolge
    Tabelle : 39. Anforderungstext-Parameter (XML oder JSON)
    Name Beschreibung
    Keine

    Header

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

    Tabelle : 40. Anforderungskopfzeilen.
    Header Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/jsonOder application/xml.

    Standard: application/json
    Tabelle : 41. Antwort-Header
    Header Beschreibung
    Keine

    Statuscodes

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

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

    Überprüfen Sie den Antworttext result.resultParameter zum Überprüfen des Ergebnisses des Vorgangs.

    Wenn der Endpunkt während der Verarbeitung der Anforderung auf Fehler stößt, werden Fehlercodes und Meldungen im Antworttext angezeigt result.errorsParameter.
    401 Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler.

    Antworttext-Parameter (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: Übergang des Betriebsstatus ist eingeschränkt (nicht zulässig).
    • Falsch: Der Übergang des Betriebsstatus ist uneingeschränkt (zulässig).

    Datentyp: Zeichenfolge

    Curl-Anforderung

    Überprüfen Sie, ob der Übergang vom Status „stillgelegt“ in den Betriebsstatus „DR-Standby“ 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 an, dass der angegebene Betriebsstatusübergang für diese CI-Klasse uneingeschränkt (zulässig) ist.

    {
  "result": false
}

    CI-Lebenszyklusmanagement – RUFT /now/cilifecyclemgmt/requestors/{req_ID}/valid ab

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

    URL-Format

    Versionierte URL: /api/now/{api_Version}/cilifecyclemgmt/Anforderer/{req_ID}/valid

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

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

    Unterstützte Anforderungsparameter

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

    Datentyp: Zeichenfolge
    req_ID SYS_ID eines Workflow-Kontexts oder eine Operator-Anwender-ID, die von zurückgegeben wird CI-Lebenszyklusmanagement – POST /now/cilifecyclemgmt/OperatorsEndpunkt.

    Anwender-IDs des Anwenders befinden sich in der Tabelle „registrierte Anwender des CI-Status“ [statemgmt_Register_users].

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

    Header

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

    Tabelle : 46. Anforderungskopfzeilen.
    Header Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/jsonOder application/xml.

    Standard: application/json
    Tabelle : 47. Antwort-Header
    Header Beschreibung
    Keine

    Statuscodes

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

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

    Überprüfen Sie den Antworttext result.resultParameter zum Überprüfen des Ergebnisses des Vorgangs.

    Wenn der Endpunkt während der Verarbeitung der Anforderung auf Fehler stößt, werden Fehlercodes und Meldungen im Antworttext angezeigt result.errorsParameter.
    401 Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler.

    Antworttext-Parameter (JSON oder XML)

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

    Datentyp: Objekt

    "result": {
  "errors": [Array],
  "result": "String"
}
    Ergebnis.Fehler Liste der Objekte, in denen 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 Statusverwaltungsfehler, der bei der Verarbeitung der Anforderung aufgetreten ist.
    Mögliche Werte:
    • CI_ACTION_ALREADY_SET
    • CI_ACTION_NOT_SET
    • DUPLICATE_CI_ACTION_RECORD
    • DUPLICATE_OPS_STATE_RECORD
    • DUPLIKAT_SYS_ID
    • INCIDENT_CI_ACTION
    • UNGÜLTIGE_CI_AKTION
    • UNGÜLTIG_LÖSCHEN
    • UNGÜLTIGE_INPUT_PARAMETERS
    • INVALID_LEASETIME
    • UNGÜLTIGER_OPS_STATUS
    • INVALID_OPS_STATE_TRANSITION
    • UNGÜLTIGER_ANFORDERER
    • INVALID_REQUESTOR_FOR_CI
    • UNGÜLTIGE_SYS_ID
    • MUTEX_NICHT VERFÜGBAR
    • NOT_ALLOWED_CI_ACTION
    • OPS_STATE_NOT_SET
    • UNPRIORITIZED_OPS_STATE
    • NICHT SUPPORTED_SYS_ID

    Datentyp: Zeichenfolge
    Ergebnis.Fehler.Nachricht Nachricht, die Details zum zugeordneten enthält error.

    Datentyp: Zeichenfolge
    Ergebnis.Ergebnis Kennzeichnung, die angibt, ob der angegebene aktive Workflow-Anwender oder registrierte Anwender eine gültige anfordernde Person ist.
    Mögliche Werte:
    • Wahr: Gültige anfordernde Person.
    • Falsch: 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-Lebenszyklusmanagement – GET /now/cilifecyclemgmt/statuses/{sys_ID}

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

    URL-Format

    Versionierte URL: /api/now/{api_Version}/cilifecyclemgmt/statuses/{sys_ID}

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

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

    Unterstützte Anforderungsparameter

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

    Datentyp: Zeichenfolge
    sys_id SYS_ID des CI.

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

    Header

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

    Tabelle : 52. Anforderungskopfzeilen.
    Header Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/jsonOder application/xml.

    Standard: application/json
    Tabelle : 53. Antwort-Header
    Header Beschreibung
    Keine

    Statuscodes

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

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

    Überprüfen Sie den Antworttext result.resultParameter zum Überprüfen des Ergebnisses des Vorgangs.

    Wenn der Endpunkt während der Verarbeitung der Anforderung auf Fehler stößt, werden Fehlercodes und Meldungen im Antworttext angezeigt result.errorsParameter.
    401 Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler.

    Antworttext-Parameter (JSON oder XML)

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

    Datentyp: Objekt

    "result": {
  "errors": [Array],
  "result": "String"
}
    Ergebnis.Fehler Liste der Objekte, in denen 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 Statusverwaltungsfehler, der bei der Verarbeitung der Anforderung aufgetreten ist.
    Mögliche Werte:
    • CI_ACTION_ALREADY_SET
    • CI_ACTION_NOT_SET
    • DUPLICATE_CI_ACTION_RECORD
    • DUPLICATE_OPS_STATE_RECORD
    • DUPLIKAT_SYS_ID
    • INCIDENT_CI_ACTION
    • UNGÜLTIGE_CI_AKTION
    • UNGÜLTIG_LÖSCHEN
    • UNGÜLTIGE_INPUT_PARAMETERS
    • INVALID_LEASETIME
    • UNGÜLTIGER_OPS_STATUS
    • INVALID_OPS_STATE_TRANSITION
    • UNGÜLTIGER_ANFORDERER
    • INVALID_REQUESTOR_FOR_CI
    • UNGÜLTIGE_SYS_ID
    • MUTEX_NICHT VERFÜGBAR
    • NOT_ALLOWED_CI_ACTION
    • OPS_STATE_NOT_SET
    • UNPRIORITIZED_OPS_STATE
    • NICHT SUPPORTED_SYS_ID

    Datentyp: Zeichenfolge
    Ergebnis.Fehler.Nachricht Nachricht, die Details zum zugeordneten enthält error.

    Datentyp: Zeichenfolge
    Ergebnis.Betriebsstatus 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-Lebenszyklusmanagement – PATCH /now/cilifecyclemgmt/leases/{sys_ID}

    Erweitert die Leasingablaufzeit der angegebenen Konfigurationselement-Aktion (CI) für den angegebenen Anwender.

    Wenn der vorherige Mietvertrag 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}

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

    Unterstützte Anforderungsparameter

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

    Datentyp: Zeichenfolge
    sys_id SYS_ID des CI, für das der Mietvertrag 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 angegebene CI-Aktion gültig ist actionName.

    Datentyp: Zeichenfolge

    FORMAT: HH:MM:SS
    Request-ID Erforderlich. SYS_ID eines Workflow-Kontexts oder eine Operator-Anwender-ID, die von zurückgegeben wird CI-Lebenszyklusmanagement – POST /now/cilifecyclemgmt/OperatorsEndpunkt.

    Anwender-IDs des Anwenders befinden sich in der Tabelle „registrierte Anwender des CI-Status“ [statemgmt_Register_users].

    Datentyp: Zeichenfolge
    Tabelle : 57. Anforderungstext-Parameter (XML oder JSON)
    Name Beschreibung
    Keine

    Header

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

    Tabelle : 58. Anforderungskopfzeilen.
    Header Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/jsonOder application/xml.

    Standard: application/json
    Inhaltstyp Datenformat des Anforderungstexts. Unterstützte Typen: application/jsonOder application/xml.

    Standard: application/json
    Tabelle : 59. Antwort-Header
    Header Beschreibung
    Keine

    Statuscodes

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

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

    Überprüfen Sie den Antworttext result.resultParameter zum Überprüfen des Ergebnisses des Vorgangs.

    Wenn der Endpunkt während der Verarbeitung der Anforderung auf Fehler stößt, werden Fehlercodes und Meldungen im Antworttext angezeigt result.errorsParameter.
    401 Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler.

    Antworttext-Parameter (JSON oder XML)

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

    Datentyp: Objekt

    "result": {
  "errors": [Array],
  "result": "String"
}
    Ergebnis.Fehler Liste der Objekte, in denen 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 Statusverwaltungsfehler, der bei der Verarbeitung der Anforderung aufgetreten ist.
    Mögliche Werte:
    • CI_ACTION_ALREADY_SET
    • CI_ACTION_NOT_SET
    • DUPLICATE_CI_ACTION_RECORD
    • DUPLICATE_OPS_STATE_RECORD
    • DUPLIKAT_SYS_ID
    • INCIDENT_CI_ACTION
    • UNGÜLTIGE_CI_AKTION
    • UNGÜLTIG_LÖSCHEN
    • UNGÜLTIGE_INPUT_PARAMETERS
    • INVALID_LEASETIME
    • UNGÜLTIGER_OPS_STATUS
    • INVALID_OPS_STATE_TRANSITION
    • UNGÜLTIGER_ANFORDERER
    • INVALID_REQUESTOR_FOR_CI
    • UNGÜLTIGE_SYS_ID
    • MUTEX_NICHT VERFÜGBAR
    • NOT_ALLOWED_CI_ACTION
    • OPS_STATE_NOT_SET
    • UNPRIORITIZED_OPS_STATE
    • NICHT SUPPORTED_SYS_ID

    Datentyp: Zeichenfolge
    Ergebnis.Fehler.Nachricht Nachricht, die Details zum zugeordneten enthält error.

    Datentyp: Zeichenfolge
    Ergebnis.Ergebnis Kennzeichnung, die angibt, ob die Mietzeit verlängert wurde.
    Mögliche Werte:
    • Wahr: Mietzeit wurde verlängert.
    • Falsch: Mietzeit wurde nicht verlängert.

    Datentyp: Zeichenfolge

    Curl-Anforderung

    Verlängern Sie die Dauer einer Patch-CI-Aktion „anfordernde Person mieten“ 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-Lebenszyklusmanagement – POST /now/cilifecyclemgmt/actions

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

    URL-Format

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

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

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

    Unterstützte Anforderungsparameter

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

    Datentyp: Zeichenfolge
    Tabelle : 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 denen sich alle CIs befinden sollen.

    Datentyp: Zeichenfolge
    Request-ID Erforderlich. SYS_ID eines Workflow-Kontexts oder eine Operator-Anwender-ID, die von zurückgegeben wird CI-Lebenszyklusmanagement – POST /now/cilifecyclemgmt/OperatorsEndpunkt.

    Anwender-IDs des Anwenders befinden sich in der Tabelle „registrierte Anwender des CI-Status“ [statemgmt_Register_users].

    Datentyp: Zeichenfolge
    Sys-IDs Erforderlich. Kommagetrennte Liste von CI-sys_IDs, denen die CI-Aktion hinzugefügt werden soll.

    Datentyp: Zeichenfolge
    Tabelle : 63. Anforderungstext-Parameter (XML oder JSON)
    Name Beschreibung
    Keine

    Header

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

    Tabelle : 64. Anforderungskopfzeilen.
    Header Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/jsonOder application/xml.

    Standard: application/json
    Inhaltstyp Datenformat des Anforderungstexts. Unterstützte Typen: application/jsonOder application/xml.

    Standard: application/json
    Tabelle : 65. Antwort-Header
    Header Beschreibung
    Keine

    Statuscodes

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

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

    Überprüfen Sie den Antworttext result.resultParameter zum Überprüfen des Ergebnisses des Vorgangs.

    Wenn der Endpunkt während der Verarbeitung der Anforderung auf Fehler stößt, werden Fehlercodes und Meldungen im Antworttext angezeigt result.errorsParameter.
    401 Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler.

    Antworttext-Parameter (JSON oder XML)

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

    Datentyp: Objekt

    "result": {
  "errors": [Array],
  "result": "String"
}
    Ergebnis.Fehler Liste der Objekte, in denen 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 Statusverwaltungsfehler, der bei der Verarbeitung der Anforderung aufgetreten ist.
    Mögliche Werte:
    • CI_ACTION_ALREADY_SET
    • CI_ACTION_NOT_SET
    • DUPLICATE_CI_ACTION_RECORD
    • DUPLICATE_OPS_STATE_RECORD
    • DUPLIKAT_SYS_ID
    • INCIDENT_CI_ACTION
    • UNGÜLTIGE_CI_AKTION
    • UNGÜLTIG_LÖSCHEN
    • UNGÜLTIGE_INPUT_PARAMETERS
    • INVALID_LEASETIME
    • UNGÜLTIGER_OPS_STATUS
    • INVALID_OPS_STATE_TRANSITION
    • UNGÜLTIGER_ANFORDERER
    • INVALID_REQUESTOR_FOR_CI
    • UNGÜLTIGE_SYS_ID
    • MUTEX_NICHT VERFÜGBAR
    • NOT_ALLOWED_CI_ACTION
    • OPS_STATE_NOT_SET
    • UNPRIORITIZED_OPS_STATE
    • NICHT SUPPORTED_SYS_ID

    Datentyp: Zeichenfolge
    Ergebnis.Fehler.Nachricht Nachricht, die Details zum zugeordneten enthält error.

    Datentyp: Zeichenfolge
    Ergebnis.Ergebnis 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: CI-Aktionen wurden nicht festgelegt.

    Datentyp: Zeichenfolge

    Curl-Anforderung

    Fügen Sie zwei CIs eine CI-Patching-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

    Versionierte URL: /api/now/{api_Version}/cilifecyclemgmt/Operators

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

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

    Unterstützte Anforderungsparameter

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

    Datentyp: Zeichenfolge
    Tabelle : 68. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 69. Anforderungstext-Parameter (XML oder JSON)
    Name Beschreibung
    Keine

    Header

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

    Tabelle : 70. Anforderungskopfzeilen.
    Header Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/jsonOder application/xml.

    Standard: application/json
    Inhaltstyp Datenformat des Anforderungstexts. Unterstützte Typen: application/jsonOder application/xml.

    Standard: application/json
    Tabelle : 71. Antwort-Header
    Header Beschreibung
    Keine

    Statuscodes

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

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

    Überprüfen Sie den Antworttext result.resultParameter zum Überprüfen des Ergebnisses des Vorgangs.

    Wenn der Endpunkt während der Verarbeitung der Anforderung auf Fehler stößt, werden Fehlercodes und Meldungen im Antworttext angezeigt result.errorsParameter.
    401 Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler.

    Antworttext-Parameter (JSON oder XML)

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

    Datentyp: Objekt

    "result": {
  "errors": [Array],
  "result": "String"
}
    Ergebnis.Fehler Liste der Objekte, in denen 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 Statusverwaltungsfehler, der bei der Verarbeitung der Anforderung aufgetreten ist.
    Mögliche Werte:
    • CI_ACTION_ALREADY_SET
    • CI_ACTION_NOT_SET
    • DUPLICATE_CI_ACTION_RECORD
    • DUPLICATE_OPS_STATE_RECORD
    • DUPLIKAT_SYS_ID
    • INCIDENT_CI_ACTION
    • UNGÜLTIGE_CI_AKTION
    • UNGÜLTIG_LÖSCHEN
    • UNGÜLTIGE_INPUT_PARAMETERS
    • INVALID_LEASETIME
    • UNGÜLTIGER_OPS_STATUS
    • INVALID_OPS_STATE_TRANSITION
    • UNGÜLTIGER_ANFORDERER
    • INVALID_REQUESTOR_FOR_CI
    • UNGÜLTIGE_SYS_ID
    • MUTEX_NICHT VERFÜGBAR
    • NOT_ALLOWED_CI_ACTION
    • OPS_STATE_NOT_SET
    • UNPRIORITIZED_OPS_STATE
    • NICHT SUPPORTED_SYS_ID

    Datentyp: Zeichenfolge
    Ergebnis.Fehler.Nachricht Nachricht, die Details zum zugeordneten enthält error.

    Datentyp: Zeichenfolge
    Ergebnis.AnforderungsId GUID für den registrierten Operator. Verwenden Sie diesen Wert, um CI-Aktionen und betriebsstatus festzulegen.

    Datentyp: Zeichenfolge
    Ergebnis.Ergebnis Kennzeichnung, die angibt, ob der Operator erfolgreich registriert wurde.
    Mögliche Werte:
    • Wahr: Der 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-Lebenszyklusmanagement – POST /now/cilifecyclemgmt/statuses

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

    URL-Format

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

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

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

    Unterstützte Anforderungsparameter

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

    Datentyp: Zeichenfolge
    Tabelle : 74. Abfrageparameter
    Name Beschreibung
    OldOpsBezeichnungen Kommagetrennte Liste der alten CI-betriebsstatus, in die alle CIs einbezogen werden sollen.

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

    Datentyp: Zeichenfolge
    Request-ID Erforderlich. SYS_ID eines Workflow-Kontexts oder eine Operator-Anwender-ID, die von zurückgegeben wird CI-Lebenszyklusmanagement – POST /now/cilifecyclemgmt/OperatorsEndpunkt.

    Anwender-IDs des Anwenders befinden sich in der Tabelle „registrierte Anwender des CI-Status“ [statemgmt_Register_users].

    Datentyp: Zeichenfolge
    Sys-IDs Erforderlich. Kommagetrennte Liste von sys_IDs von CIs, für die der Betriebsstatus festgelegt werden soll.

    Datentyp: Zeichenfolge
    Tabelle : 75. Anforderungstext-Parameter (XML oder JSON)
    Name Beschreibung
    Keine

    Header

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

    Tabelle : 76. Anforderungskopfzeilen.
    Header Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/jsonOder application/xml.

    Standard: application/json
    Inhaltstyp Datenformat des Anforderungstexts. Unterstützte Typen: application/jsonOder application/xml.

    Standard: application/json
    Tabelle : 77. Antwort-Header
    Header Beschreibung
    Keine

    Statuscodes

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

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

    Überprüfen Sie den Antworttext result.resultParameter zum Überprüfen des Ergebnisses des Vorgangs.

    Wenn der Endpunkt während der Verarbeitung der Anforderung auf Fehler stößt, werden Fehlercodes und Meldungen im Antworttext angezeigt result.errorsParameter.
    401 Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler.

    Antworttext-Parameter (JSON oder XML)

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

    Datentyp: Objekt

    "result": {
  "errors": [Array],
  "result": "String"
}
    Ergebnis.Fehler Liste der Objekte, in denen 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 Statusverwaltungsfehler, der bei der Verarbeitung der Anforderung aufgetreten ist.
    Mögliche Werte:
    • CI_ACTION_ALREADY_SET
    • CI_ACTION_NOT_SET
    • DUPLICATE_CI_ACTION_RECORD
    • DUPLICATE_OPS_STATE_RECORD
    • DUPLIKAT_SYS_ID
    • INCIDENT_CI_ACTION
    • UNGÜLTIGE_CI_AKTION
    • UNGÜLTIG_LÖSCHEN
    • UNGÜLTIGE_INPUT_PARAMETERS
    • INVALID_LEASETIME
    • UNGÜLTIGER_OPS_STATUS
    • INVALID_OPS_STATE_TRANSITION
    • UNGÜLTIGER_ANFORDERER
    • INVALID_REQUESTOR_FOR_CI
    • UNGÜLTIGE_SYS_ID
    • MUTEX_NICHT VERFÜGBAR
    • NOT_ALLOWED_CI_ACTION
    • OPS_STATE_NOT_SET
    • UNPRIORITIZED_OPS_STATE
    • NICHT SUPPORTED_SYS_ID

    Datentyp: Zeichenfolge
    Ergebnis.Fehler.Nachricht Nachricht, die Details zum zugeordneten enthält error.

    Datentyp: Zeichenfolge
    Ergebnis.Ergebnis Kennzeichnung, die angibt, ob der gewünschte Status für alle in der Anforderung enthaltenen CIs festgelegt wurde.
    Mögliche Werte:
    • Wahr: Betriebsstatus festgelegt.
    • Falsch: Betriebsstatus nicht festgelegt.

    Datentyp: Zeichenfolge

    Curl-Anforderung

    Legen Sie fest Reparatur wird ausgeführt Betriebsstatus für zwei CIs.

    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 an, dass der gewünschte Betriebsstatus für beide in der Anforderung angegebenen CIs festgelegt wurde.

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