---
sourceDocument: Yokohama-API-Referenz
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/de-DE/yokohama/api-reference

 Release :

    - yokohama

ft:locale :

    - de-DE

ft:publication_title :

    - Yokohama-API-Referenz

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# StatusverwaltungsSkriptableApi -- Global

# StatusverwaltungsSkriptableApi -- Global {#ariaid-title1}

* Freigeben Version: Yokohama
* 
* Aktualisiert 30. Januar 2025
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 6 Minuten Lesedauer

Die StatusverwaltungsSkriptableApi Stellt eine Reihe von Methoden zum Bearbeiten von betriebsstatus von Konfigurationselementen (CI) und zum Anwenden von CI-Aktionen bereit.

Die StatusverwaltungsSkriptableApi Methoden entsprechen Einschränkungen und Berechtigungen, die durch nicht zulässige CI-Aktionen, kompatible CI-Aktionen und nicht zulässige Betriebsübergänge angegeben sind. Wenn eine Methode versucht, einen eingeschränkten Vorgang auszuführen, wird der Vorgang blockiert, ein Fehler protokolliert und gegebenenfalls eine Aufgabe erstellt.

Die StatusverwaltungsSkriptableApi Methoden sind statische Methoden. Sie greifen mit auf die Methoden zu `SNC.StatusverwaltungsSkriptableApi `Globales Objekt.

## StateManagementScriptableApi -- addBulkCIAction(Zeichenfolge requestorId, Zeichenfolge sysIdList, Zeichenfolge ciActionName, Zeichenfolge ciActionListOld, Zeichenfolge leaseTime) {#ariaid-title2}

Fügen Sie einer Liste von CIs eine CI-Aktion hinzu.
{#SMSA-addBulkCIAction_S_S_S_S_S__table_g5l_w4s_px__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Request-ID | Zeichenfolge | Eine sys_ID eines Workflow-Kontexts oder die von zurückgegebene GUID RegisterOperator() Methode. |
| SysIdList | Zeichenfolge | Eine kommagetrennte Liste von CI-sys_IDs. |
| CiActionName | Zeichenfolge | Der Name der CI-Aktion. |
| CiActionListAlt | Zeichenfolge | (Optional) Eine kommagetrennte Liste alter CI-Aktionen, in denen sich alle CIs befinden sollen. |
| LeaseTime | Zeichenfolge | (Optional) Zeitdauer, für die die Miete für die angegebene CI-Aktion gültig ist. Im Format HH:MM:SS. |
[Tabelle : 1. Parameter]

{#SMSA-addBulkCIAction_S_S_S_S_S__table_g5l_w4s_px} {#SMSA-addBulkCIAction_S_S_S_S_S__table_h5l_w4s_px__entry__2}

| Typ | Beschreibung |
|-|-|
| Zeichenfolge | Eine JSON-formatierte Zeichenfolge mit Name-Wert-Paaren für * Ergebnis: „Wahr", wenn die Aktion für alle CIs in der Liste festgelegt ist. Andernfalls „falsch". * Fehler: Liste der Fehler. {#SMSA-addBulkCIAction_S_S_S_S_S__ul_ewf_5vl_px} |
[Tabelle : 2. Rückgaben]

{#SMSA-addBulkCIAction_S_S_S_S_S__table_h5l_w4s_px}

## StateManagementScriptableApi -- extendCIActionLease( Zeichenfolge requestorId, Zeichenfolge ciSysId, Zeichenfolge ciActionName, Zeichenfolge leaseTime) {#ariaid-title3}

Verlängern Sie die CI-action-Lease-Zeit für den registrierten Anwender. Wenn die vorherige Miete abgelaufen ist, beginnt die neue Leasingzeit jetzt.
{#SMSA-extendCIActionLease_S_S_S_S__table_f24_j3s_px__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Request-ID | Zeichenfolge | Eine sys_ID eines Workflow-Kontexts oder die von zurückgegebene GUID RegisterOperator() Methode. |
| ciSysId | Zeichenfolge | Die sys_ID des CI |
| CiActionName | Zeichenfolge | Der Name der CI-Aktion. |
| LeaseTime | Zeichenfolge | Zeitdauer, für die die Miete für die angegebene CI-Aktion gültig ist. Im Format HH:MM:SS. |
[Tabelle : 3. Parameter]

{#SMSA-extendCIActionLease_S_S_S_S__table_f24_j3s_px} {#SMSA-extendCIActionLease_S_S_S_S__table_g24_j3s_px__entry__2}

| Typ | Beschreibung |
|-|-|
| Zeichenfolge | Eine JSON-formatierte Zeichenfolge mit Name-Wert-Paaren für * Ergebnis: „Wahr", wenn die Leasingzeit festgelegt wurde. * Fehler: Liste der Fehler. {#SMSA-extendCIActionLease_S_S_S_S__ul_ewf_5vl_px} |
[Tabelle : 4. Rückgaben]

{#SMSA-extendCIActionLease_S_S_S_S__table_g24_j3s_px}

## StateManagementScriptableApi -- getCIActions(Zeichenfolge ciSysId) {#ariaid-title4}

Gibt eine Liste aktiver CI-Aktionen für das angegebene CI zurück.
{#SMSA-getCIActions_S__table_ql1_fws_px__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| ciSysId | Zeichenfolge | SYS_ID des CI. |
[Tabelle : 5. Parameter]

{#SMSA-getCIActions_S__table_ql1_fws_px} {#SMSA-getCIActions_S__table_rl1_fws_px__entry__2}

| Typ | Beschreibung |
|-|-|
| Zeichenfolge | Eine JSON-formatierte Zeichenfolge mit Name-Wert-Paaren. Mögliche Werte: * CiActions: Kommagetrennte Liste aktiver CI-Aktionen für das CI, oder No_Active_action . * Fehler: Liste der Fehler. {#SMSA-getCIActions_S__ul_ewf_5vl_px} |
[Tabelle : 6. Rückgaben]

{#SMSA-getCIActions_S__table_rl1_fws_px}  
Das folgende Beispiel zeigt, wie aktive Aktionen für eine Liste von Konfigurationselementen abgerufen werden.

    // Store sys_ids of configuration items for which to get data
    var CIArray = ["a9c0c8d2c6112276018f7705562f9cb0","0c43bc4fc61122750182c132411702f2","46bbf419a9fe1981009802288c1eb79d","46a4381ca9fe1981005c3e99af3cd164","0c43bcbdc61122750182c132e9b6565d"];

    var output = '';

    // looping above array to fetch each sys_id and passing to method
    for(var i=0; i < CIArray.length; i++) {

      // passing sys_id of CI stored in array to method
      output = SNC.StateManagementScriptableApi.getCIActions(CIArray[i]);

      // print a JSON formatted string with name-value pairs
      gs.print(output);
    }

Ausgabe:

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

## StateManagementScriptableApi -- getOperationalState(Zeichenfolge ciSysId) {#ariaid-title5}

Gibt den Betriebsstatus des CI zurück.
{#SMSA-getCIOperationalState_S__table_n5f_1ns_px__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| ciSysId | Zeichenfolge | SYS_ID des CI. |
[Tabelle : 7. Parameter]

{#SMSA-getCIOperationalState_S__table_n5f_1ns_px} {#SMSA-getCIOperationalState_S__table_o5f_1ns_px__entry__2}

| Typ | Beschreibung |
|-|-|
| Zeichenfolge | Eine JSON-formatierte Zeichenfolge mit Name-Wert-Paaren. Mögliche Werte: * CiActions: Zeichenfolgenauswahlwerte des Felds Operational_Status, oder UNBEKANNT . * Fehler: Liste der Fehler. {#SMSA-getCIOperationalState_S__ul_ewf_5vl_px} |
[Tabelle : 8. Rückgaben]

{#SMSA-getCIOperationalState_S__table_o5f_1ns_px}  
Das folgende Beispiel zeigt, wie die betriebsstatus einer Liste angegebener Konfigurationselemente abgerufen werden.

    // Store sys_ids of configuration items for which to get the operational state.
    var CIArray = ["0c43bc4fc61122750182c132411702f2","46bbf419a9fe1981009802288c1eb79d","46a4381ca9fe1981005c3e99af3cd164","0c43bcbdc61122750182c132e9b6565d","a9c0c8d2c6112276018f7705562f9cb0"];

    var output = '';

    // Loop the array to fetch each sys_id and pass to the method.
    for(var i=0;i<CIArray.length;i++) {
      // Pass sys_id of CI stored in array to the method  
      output = SNC.StateManagementScriptableApi.getOperationalState(CIArray[i]); 

      // prints a JSON formatted string with name-value pairs
      gs.print(output);
    }

Ausgabe:

    *** Script: {"operationalState":"Operational","result":true}
    *** Script: {"operationalState":"Operational","result":true}
    *** Script: {"operationalState":"Operational","result":true}
    *** Script: {"operationalState":"Operational","result":true}
    ci_state_management                        : INVALID_SYS_ID: Invalid sys_id [a9c0c8d2c6112276018f7705562f9cb0]: no thrown error
    *** Script: {"errors":[{"error":"INVALID_SYS_ID","message":"Invalid sys_id [a9c0c8d2c6112276018f7705562f9cb0]"}],"operationalState":"unknown","result":false}

## StateManagementScriptableApi -- isCompatibleCIAction(Zeichenfolge actionName, Zeichenfolge otherActionName) {#ariaid-title6}

Bestimmt, ob die beiden angegebenen Aktionen kompatibel sind.
{#SMSA-isCompatibleCIAction_S_S__table_fkl_v1t_px__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| actionName | Zeichenfolge | Ein CI-Aktionsname |
| OtherActionName | Zeichenfolge | Ein CI-Aktionsname |
[Tabelle : 9. Parameter]

{#SMSA-isCompatibleCIAction_S_S__table_fkl_v1t_px} {#SMSA-isCompatibleCIAction_S_S__table_gkl_v1t_px__entry__2}

| Typ | Beschreibung |
|-|-|
| Boolean | Gibt „wahr" zurück, wenn die beiden angegebenen CI-Aktionen kompatibel sind. |
[Tabelle : 10. Rückgaben]

{#SMSA-isCompatibleCIAction_S_S__table_gkl_v1t_px}

## StateManagementScriptableApi -- isLeaseExpired(Zeichenfolge requestorId, Zeichenfolge ciSysId, Zeichenfolge ciActionName) {#ariaid-title7}

Bestimmt, ob der Mietvertrag für die anfordernde Person einer angegebenen CI-Aktion abgelaufen ist.
{#SMSA-isLeaseExpired_S_S_S__table_ot5_v5r_px__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Request-ID | Zeichenfolge | Eine sys_ID eines Workflow-Kontexts oder die von zurückgegebene GUID RegisterOperator() Methode. |
| ciSysId | Zeichenfolge | Die sys_ID des CI |
| CiActionName | Zeichenfolge | Name der CI-Aktion. |
[Tabelle : 11. Parameter]

{#SMSA-isLeaseExpired_S_S_S__table_ot5_v5r_px} {#SMSA-isLeaseExpired_S_S_S__table_pt5_v5r_px__entry__2}

| Typ | Beschreibung |
|-|-|
| Zeichenfolge | Eine JSON-formatierte Zeichenfolge mit Name-Wert-Paaren für * Ergebnis: „Wahr", wenn der Mietvertrag des Anwenders abgelaufen ist. * Fehler: Liste der Fehler. {#SMSA-isLeaseExpired_S_S_S__ul_ewf_5vl_px} |
[Tabelle : 12. Rückgaben]

{#SMSA-isLeaseExpired_S_S_S__table_pt5_v5r_px}

## StateManagementScriptableApi -- isNotAllowedAction(Zeichenfolge ciType, Zeichenfolge opsLabel, Zeichenfolge actionName) {#ariaid-title8}

Bestimmen Sie für einen CI-Typ, ob eine CI-Aktion für einen Betriebsstatus nicht zulässig ist.
{#SMSA-isNotAllowedAction_S_S_S__table_lzz_cxs_px__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| ciType | Zeichenfolge | Der CI-Typ |
| OpsBezeichnung | Zeichenfolge | Der Betriebsstatus |
| actionName | Zeichenfolge | Der Name der CI-Aktion |
[Tabelle : 13. Parameter]

{#SMSA-isNotAllowedAction_S_S_S__table_lzz_cxs_px} {#SMSA-isNotAllowedAction_S_S_S__table_mzz_cxs_px__entry__2}

| Typ | Beschreibung |
|-|-|
| Boolean | Gibt „wahr" zurück, wenn die Aktion für den angegebenen CI-Typ im angegebenen Betriebsstatus nicht zulässig ist. |
[Tabelle : 14. Rückgaben]

{#SMSA-isNotAllowedAction_S_S_S__table_mzz_cxs_px}

## StateManagementScriptableApi -- isNotAllowedOpsTransition(Zeichenfolge ciType, Zeichenfolge opsLabel, Zeichenfolge transitionOpsLabel) {#ariaid-title9}

Bestimmen Sie für einen CI-Typ, ob ein Betriebsstatus-Übergang nicht zulässig ist.
{#SMSA-isNotAllowedOpsTransition_S_S_S__table_erm_mys_px__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| ciType | Zeichenfolge | Der CI-Typ |
| OpsBezeichnung | Zeichenfolge | Die Bezeichnung des ersten Betriebsstatus. |
| TransitionOpsBezeichnung | Zeichenfolge | Die Bezeichnung des endenden Betriebsstatus. |
[Tabelle : 15. Parameter]

{#SMSA-isNotAllowedOpsTransition_S_S_S__table_erm_mys_px} {#SMSA-isNotAllowedOpsTransition_S_S_S__table_frm_mys_px__entry__2}

| Typ | Beschreibung |
|-|-|
| Boolean | Gibt „wahr" zurück, wenn der angegebene Übergang des Betriebsstatus für den angegebenen CI-Typ nicht zulässig ist. |
[Tabelle : 16. Rückgaben]

{#SMSA-isNotAllowedOpsTransition_S_S_S__table_frm_mys_px}

## StateManagementScriptableApi -- isValidRequestor(Zeichenfolge requestorId) {#ariaid-title10}

Bestimmt, ob die angegebene anfordernde Person ein gültiger aktiver Workflow-Anwender oder ein registrierter Anwender ist.
{#SMSA-isValidRequestor_S__table_dr5_5sr_px__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Request-ID | Zeichenfolge | SYS_ID eines Workflow-Kontexts oder der GUID, die von zurückgegeben wird RegisterOperator() Methode. |
[Tabelle : 17. Parameter]

{#SMSA-isValidRequestor_S__table_dr5_5sr_px} {#SMSA-isValidRequestor_S__table_er5_5sr_px__entry__2}

| Typ | Beschreibung |
|-|-|
| Zeichenfolge | JSON-formatierte Name-Wert-Paare. Mögliche Werte: * Ergebnis -- Wahr Ob die Anforderungs-ID gültig ist. * Fehler: Liste der Fehler. |
[Tabelle : 18. Rückgaben]

{#SMSA-isValidRequestor_S__table_er5_5sr_px}  
Dieses Beispiel zeigt, wie verwendet wird IsValidRequestor() Methode zum Überprüfen, ob ein Operator ein registrierter Anwender ist.

    var output = SNC.StateManagementScriptableApi.registerOperator();
    var jsonUtil = new JSON();
    var result = jsonUtil.decode(output);
    var requestorId = result.requestorId; // Fetching requestorId

    output = SNC.StateManagementScriptableApi.isValidRequestor(requestorId);
    gs.info(output);

Ausgabe:

    {"result":true}

## StateManagementScriptableApi -- registerOperator() {#ariaid-title11}

Registriert einen Operator für einen nicht-Workflow-Anwender.
{#SMSA-registerOperator__table_l5c_hvl_px__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Keine |   |   |
[Tabelle : 19. Parameter]

{#SMSA-registerOperator__table_l5c_hvl_px} {#SMSA-registerOperator__table_m5c_hvl_px__entry__2}

| Typ | Beschreibung |
|-|-|
| Zeichenfolge | Eine JSON-formatierte Zeichenfolge mit Name-Wert-Paaren für * Anforderungs-ID: GUID des registrierten Anwenders, die zum Festlegen von CI-Aktions-/betriebsstatus verwendet wird. * Ergebnis: „Wahr", wenn erfolgreich registriert. * Fehler: Liste der Fehler. {#SMSA-registerOperator__ul_ewf_5vl_px} |
[Tabelle : 20. Rückgaben]

{#SMSA-registerOperator__table_m5c_hvl_px}  


    var output = SNC.StateManagementScriptableApi.registerOperator();
    var jsonUntil = new JSON();
    var result = jsonUntil.decode(output);
    var requestorId = result.requestorId;

## StateManagementScriptableApi -- removeBulkCIAction(Zeichenfolge requestorId, Zeichenfolge sysIdList, Zeichenfolge ciActionName) {#ariaid-title12}

Entfernt eine CI-Aktion für eine Liste von CIs.
{#SMSA-removeBulkCIAction_S_S_S__table_iz1_2vs_px__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Request-ID | Zeichenfolge | Eine sys_ID eines Workflow-Kontexts oder die von zurückgegebene GUID RegisterOperator() Methode. |
| SysIdList | Zeichenfolge | Eine kommagetrennte Liste von CI-sys_IDs |
| CiActionName | Zeichenfolge | Der Name der CI-Aktion |
[Tabelle : 21. Parameter]

{#SMSA-removeBulkCIAction_S_S_S__table_iz1_2vs_px} {#SMSA-removeBulkCIAction_S_S_S__table_jz1_2vs_px__entry__2}

| Typ | Beschreibung |
|-|-|
| Zeichenfolge | Eine JSON-formatierte Zeichenfolge mit Name-Wert-Paaren für * Ergebnis: „Wahr", wenn die Aktion für alle CIs in der Liste entfernt wird; andernfalls „falsch". * Fehler: Liste der Fehler. {#SMSA-removeBulkCIAction_S_S_S__ul_ewf_5vl_px} |
[Tabelle : 22. Rückgaben]

{#SMSA-removeBulkCIAction_S_S_S__table_jz1_2vs_px}

## StateManagementScriptableApi -- setBulkCIOperationalState(Zeichenfolge requestorId, Zeichenfolge sysIdList, Zeichenfolge opsLabel, Zeichenfolge opsStateListOld) {#ariaid-title13}

Legen Sie den Betriebsstatus für die Liste der CIs fest.
{#SMSA-setBulkCIOpState_S_S_S_S__table_hgf_5ks_px__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Request-ID | Zeichenfolge | Eine sys_ID eines Workflow-Kontexts oder die von zurückgegebene GUID RegisterOperator() Methode. |
| SysIdList | Zeichenfolge | Eine kommagetrennte Liste von CI-sys_IDs. |
| OpsBezeichnung | Zeichenfolge | Dies ist die Zeichenfolgenbezeichnung einer Operational_Status-Auswahl. |
| OpsStateListAlt | Zeichenfolge | (Optional) Eine kommagetrennte Liste alter CI-status, in der sich alle CIs befinden sollen. |
[Tabelle : 23. Parameter]

{#SMSA-setBulkCIOpState_S_S_S_S__table_hgf_5ks_px} {#SMSA-setBulkCIOpState_S_S_S_S__table_igf_5ks_px__entry__2}

| Typ | Beschreibung |
|-|-|
| Zeichenfolge | Eine JSON-formatierte Zeichenfolge mit Name-Wert-Paaren für * Ergebnis: „Wahr", wenn der Status für alle CIs in der Liste festgelegt ist. Andernfalls „falsch". * Fehler: Liste der Fehler. {#SMSA-setBulkCIOpState_S_S_S_S__ul_ewf_5vl_px} |
[Tabelle : 24. Rückgaben]

{#SMSA-setBulkCIOpState_S_S_S_S__table_igf_5ks_px}  

    var output = SNC.StateManagementScriptableApi.registerOperator();
    var jsonUntil = new JSON();
    var result = jsonUtil.decode(output);
    var requestorId = result.requestorId;

    // list of sys_ids to update
    var sys_ids;

    // Set list of sys_ids's Operational State to 'Repair in Progress'
    output = SNC.StateManagementScriptableApi.setBulkCIOperationalState(requestorId, sys_ids,'Repair in Progress');
    gs.print(output);

## StateManagementScriptableApi -- unregisterOperator( Zeichenfolge requestorId) {#ariaid-title14}

Hebt die Registrierung eines Operators für nicht-Workflow-Anwender auf.
{#SMSA-unregisterOperator_S__table_pwv_2xl_px__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Request-ID | Zeichenfolge | SYS_ID eines Workflow-Kontexts oder der GUID, die von zurückgegeben wird RegisterOperator() Methode. |
[Tabelle : 25. Parameter]

{#SMSA-unregisterOperator_S__table_pwv_2xl_px} {#SMSA-unregisterOperator_S__table_qwv_2xl_px__entry__2}

| Typ | Beschreibung |
|-|-|
| Zeichenfolge | JSON-formatierte Name-Wert-Paare. Mögliche Werte: * Ergebnis -- Wahr Wenn die Registrierung erfolgreich aufgehoben wurde * Fehler: Liste der Fehler. |
[Tabelle : 26. Rückgaben]

{#SMSA-unregisterOperator_S__table_qwv_2xl_px}  
Dieses Beispiel zeigt, wie verwendet wird Nicht registrierungOperator() Methode zum Aufheben der Registrierung eines registrierten Anwenders.

    var output = SNC.StateManagementScriptableApi.registerOperator();
    var jsonUtil = new JSON();
    var result = jsonUtil.decode(output);
    var requestorId = result.requestorId; // Fetching requestorId

    output = SNC.StateManagementScriptableApi.unregisterOperator(requestorId);
    gs.info(output); 

Ausgabe:

    {"result":true}


