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


---

# PlaybookExperience -- Umfang

# PlaybookExperience -- Umfang {#ariaid-title1}

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

Die PlaybookExperience Die API stellt Methoden für die Verarbeitung von Playbook-Ausführungen bereit.

Diese API erfordert das Playbook Experience Core-Plugin (com.glide.playbook_experience.config) und wird in bereitgestellt `sn_Playbook `Namespace.

Diese API erfordert mindestens ein Playbook in der Tabelle „Prozessdefinition" \[sys_pd_process_definition\]. Zur Verwendung dieser API müssen Sie über die Rollen verfügen, die zum Anzeigen und Abbrechen eines laufenden Prozesses im Prozessautomatisierungs-Designer erforderlich sind. Weitere Informationen finden Sie unter [Prozessautomatisierungs-Designer](https://www.servicenow.com/docs/access?context=process-automation-designer&version=yokohama&pubname=yokohama-build-workflows&ft:locale=en-US).

## PlaybookExperience -- cancelPlaybooksByParentRecord(GlideRecord parentRecord, String cancellationReason, String scopedName, String playbookExperienceId) {#ariaid-title2}

Bricht Playbook-Ausführungen für einen bestimmten übergeordneten Datensatz ab.
{#Playbook-cancelPlaybooks_O_S_S_S__table_udh_zjr_ypb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| parentRecord | GlideRecord | Der übergeordnete Datensatz, für den Playbook-Ausführungen abgebrochen werden sollen. Der übergeordnete Datensatz kann ein beliebiger Datensatz sein, der Playbook-Ausführungen enthält, z. B. ein Interaktionsdatensatz oder ein Onboarding-Falldatensatz. |
| AbbruchReason | Zeichenfolge | Der Grund für den Abbruch der Playbook-Ausführungen. |
| scopedName | Zeichenfolge | Optional. Der bereichsbezogene Name des abzubrechenden Playbooks. Der bereichsbezogene Name stammt aus der Tabelle „Prozessdefinition" \[sys_pd_process_definition\] im Format `scope.name `. Wenn angegeben, werden nur Ausführungen dieses Playbooks für den angegebenen übergeordneten Datensatz abgebrochen. Wenn nicht angegeben, werden alle Ausführungen aller Playbooks für den angegebenen übergeordneten Datensatz abgebrochen. |
| playbookExperienceId | Zeichenfolge | Optional. SYS_ID des Playbook-Experience-Datensatzes in der Tabelle „Playbook-Experience" \[sys_Playbook_Experience\], der für den Abbruch verwendet werden soll. Verwenden Sie diesen Parameter, wenn Sie anwenderdefinierte Aktivitätsstatus-Zuordnungen definiert haben. Siehe Playbook-Aktivitätsstatuszuordnung . Standard: SYS_ID des Datensatzes der globalen Playbook-Experience. |
[Tabelle : 1. Parameter]

{#Playbook-cancelPlaybooks_O_S_S_S__table_udh_zjr_ypb} {#Playbook-cancelPlaybooks_O_S_S_S__table_vdh_zjr_ypb__entry__2}

| Typ | Beschreibung |
|-|-|
| Objekt | Objekt, das die abgebrochenen Playbook-Ausführungen und alle übersprungenen Playbook-Ausführungen enthält, die nicht abgebrochen werden konnten. { "canceledPlaybookContext": [Array], "skippedPlaybookContext": [Array] } |
| \<Object\>.CanceledPlaybookContext | Liste der abgebrochenen Playbook-Ausführungen. Jede Playbook-Ausführung ist ein Objekt im Array. Datentyp: Array "canceledPlaybookContext": [ { "can_read": Boolean, "canceled_by": "String", "cancellation_reason": "String", "errors": [Array], "parent_record": "String", "parent_table": "String", "playbook_id": "String", "playbook_table": "String", "scoped_name": "String", "state": {Object}, "sys_id": "String", "title": "String" } ] |
| \<Object\>.canceledPlaybookContext.can_read | Kennzeichnung, die angibt, ob der aktuelle Anwender den Playbook-Ausführungsdatensatz lesen kann. Der aktuelle Anwender muss Lesezugriff auf den übergeordneten Datensatz haben, um den Playbook-Ausführungsdatensatz lesen zu können. Gültige Werte: * Wahr: Der aktuelle Anwender hat Lesezugriff auf den Playbook-Ausführungsdatensatz. * Falsch: Der aktuelle Anwender hat keinen Lesezugriff auf den Playbook-Ausführungsdatensatz. {#Playbook-cancelPlaybooks_O_S_S_S__ul_ufz_s14_1qb} Datentyp: Boolescher Wert |
| \<Object\>.canceledPlaybookContext.canceled_by | Die Anwender-ID Des Anwenders, der die Playbook-Ausführung abgebrochen hat. Datentyp: Zeichenfolge |
| \<Object\>.canceledPlaybookContext.cancellation_reason | Der Abbruchgrund, der vom Anwender eingegeben wurde, der die Playbook-Ausführung abgebrochen hat. Datentyp: Zeichenfolge |
| \<Object\>.AbgebrochenPlaybookContext.error | Liste der Stornierungsfehler. Jeder Fehler ist ein Objekt im Array. Datentyp: Array "errors": [ { "message": "String", "type": "String" } ] |
| \<Object\>.CanceledPlaybookContext.error.message | Die Fehlermeldung. Datentyp: Zeichenfolge |
| \<Object\>.CanceledPlaybookContext.error.type | Der Typ des Fehlers. Datentyp: Zeichenfolge |
| \<Object\>.CanceledPlaybookContext.parent_Record | SYS_ID des übergeordneten Datensatzes, für den Playbook-Ausführungen abgebrochen wurden. Datentyp: Zeichenfolge |
| \<Object\>.CanceledPlaybookContext.parent_table | Der Name der Tabelle, aus der der übergeordnete Datensatz stammt. Datentyp: Zeichenfolge |
| \<Object\>.canceledPlaybookContext.playbook_id | SYS_ID des Playbooks aus der Tabelle „Prozessdefinitionen \[sys_pd_process_definition\]". Datentyp: Zeichenfolge |
| \<Object\>.canceledPlaybookContext.playbook_table | Der Name der Tabelle, aus der das Playbook stammt, im Allgemeinen die Tabelle „Prozessdefinitionen \[sys_pd_process_definition\]". Datentyp: Zeichenfolge |
| \<Object\>.CanceledPlaybookContext.scope_Name | Der bereichsbezogene Name des Playbooks aus der Tabelle „Prozessdefinitionen" \[sys_pd_process_definition\] im Format `scope.name `. Datentyp: Zeichenfolge |
| \<Object\>.CanceledPlaybookContext.State | Der Status der Playbook-Ausführung aus der Tabelle „Prozessausführungen" \[sys_pd_context\]. Datentyp: Objekt "state": { "displayValue": "String", "value": "String" } |
| \<Object\>.CanceledPlaybookContext.State.DisplayValue | Der Anzeigewert des Playbook-Ausführungsstatus. Datentyp: Zeichenfolge |
| \<Object\>.CanceledPlaybookContext.State.value | Der Wert des Playbook-Ausführungsstatus. Datentyp: Zeichenfolge |
| \<Object\>.CanceledPlaybookContext.sys_ID | SYS_ID der Playbook-Ausführung aus der Tabelle „Prozessausführungen" \[sys_pd_context\]. Datentyp: Zeichenfolge |
| \<Object\>.CanceledPlaybookContext.title | Die Bezeichnung der Playbook-Ausführung aus der Tabelle „Prozessausführungen" \[sys_pd_context\]. Datentyp: Zeichenfolge |
| \<Object\>.SkippedPlaybookContext | Liste der übersprungenen Playbook-Ausführungen. Jede Playbook-Ausführung ist ein Objekt im Array. Beschreibungen der Objekteigenschaften finden Sie unter canceledPlaybookContextArray. Datentyp: Array "skippedPlaybookContext": [ { "can_read": Boolean, "canceled_by": "String", "cancellation_reason": "String", "errors": [Array], "parent_record": "String", "parent_table": "String", "playbook_id": "String", "playbook_table": "String", "scoped_name": "String", "state": {Object}, "sys_id": "String", "title": "String" } ] |
[Tabelle : 2. Rückgaben]

{#Playbook-cancelPlaybooks_O_S_S_S__table_vdh_zjr_ypb}  
Dieses Beispiel zeigt, wie alle Ausführungen eines bestimmten Playbooks (in diesem Fall die Playbook-Experience-Demo) für einen bestimmten Interaktionsdatensatz abgebrochen werden. Um diese Methode in einer UI-Aktion oder Business-Regel zu verwenden, übergeben Sie `Aktuell `Stattdessen Objekt als parentRecord.

    var parentRecord = new GlideRecordUtil().getGR("interaction", "d91742531b343010a26c98a1b24bcbe0");

    var cancellationReason = "Cancelling this playbook";

    // demo playbook from Process Automation Experience Demo store app
    var scopedName = "sn_pad_demo.playbook_experience_demo"; 

    // demo playbook experience from Process Automation Experience Demo store app
    var playbookExperienceId = "a56d8d93ff311010cc0853ea793bf1a6"; 
    	
    var cancelPlaybookReturn = sn_playbook.PlaybookExperience.cancelPlaybooksByParentRecord(parentRecord, cancellationReason, scopedName, playbookExperienceId);
    	

    gs.info(JSON.stringify(cancelPlaybookReturn, null, 2));

Ausgabe:

    {
      "canceledPlaybookContext": [
        {
          "can_read": true,
          "sys_id": "d02782533d343010ac50ee17e75d3466",
          "scoped_name": "sn_pad_demo.playbook_experience_demo",
          "canceled_by": "admin",
          "playbook_table": "sys_pd_process_definition",
          "state": {
            "displayValue": "Pending Cancel",
            "value": "PENDING_CANCEL"
          },
          "title": "Playbook Experience Demo",
          "parent_record": "d91742531b343010a26c98a1b24bcbe0",
          "playbook_id": "0d35ee1807301010cc08d9630ad3002a",
          "cancellation_reason": "Cancelling this playbook",
          "parent_table": "interaction",
          "errors": []
        }
      ],
      "skippedPlaybookContext": []
    }

## PlaybookExperience -- getPlaybooksForParentRecord(GlideRecord parentRecord) {#ariaid-title3}

Ruft eine Liste der Playbook-Ausführungen für einen bestimmten übergeordneten Datensatz ab.
{#Playbook-getPlaybooksForParRec_O__table_ipb_gyn_cqb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| parentRecord | GlideRecord | Der übergeordnete Datensatz, für den Playbook-Ausführungen abgerufen werden sollen. Der übergeordnete Datensatz kann ein beliebiger Datensatz sein, der Playbook-Ausführungen enthalten kann, z. B. ein Interaktionsdatensatz oder ein Onboarding-Falldatensatz. |
[Tabelle : 3. Parameter]

{#Playbook-getPlaybooksForParRec_O__table_ipb_gyn_cqb} {#Playbook-getPlaybooksForParRec_O__table_jpb_gyn_cqb__entry__2}

| Typ | Beschreibung |
|-|-|
| Array | Liste der Playbook-Ausführungen für den übergeordneten Datensatz. Jede Playbook-Ausführung ist ein Objekt im Array. [ { "can_read": Boolean, "canceled_by": "String", "cancellation_reason": "String", "errors": [Array], "parent_record": "String", "parent_table": "String", "playbook_id": "String", "playbook_table": "String", "scoped_name": "String", "state": {Object}, "sys_id": "String", "title": "String" } ] |
| \<Array\>.CAN_read | Kennzeichnung, die angibt, ob der aktuelle Anwender den Playbook-Ausführungsdatensatz lesen kann. Der aktuelle Anwender muss Lesezugriff auf den übergeordneten Datensatz haben, um den Playbook-Ausführungsdatensatz lesen zu können. Gültige Werte: * Wahr: Der aktuelle Anwender hat Lesezugriff auf den Playbook-Ausführungsdatensatz. * Falsch: Der aktuelle Anwender hat keinen Lesezugriff auf den Playbook-Ausführungsdatensatz. {#Playbook-getPlaybooksForParRec_O__ul_ufz_s14_1qb} Datentyp: Boolescher Wert |
| \<Array\>.canceled_by | Die Anwender-ID Des Anwenders, der die Playbook-Ausführung abgebrochen hat. Leer, wenn das Playbook nicht abgebrochen wird. Datentyp: Zeichenfolge |
| \<Array\>.Cancel_reason | Der Abbruchgrund, der vom Anwender eingegeben wurde, der die Playbook-Ausführung abgebrochen hat. Leer, wenn das Playbook nicht abgebrochen wird. Datentyp: Zeichenfolge |
| \<Array\>.Fehler | Liste der Fehler. Jeder Fehler ist ein Objekt im Array. Datentyp: Array "errors": [ { "message": "String", "type": "String" } ] |
| \<Array\>.Fehler.Nachricht | Die Fehlermeldung. Datentyp: Zeichenfolge |
| \<Array\>.Fehler.Typ | Der Typ des Fehlers. Datentyp: Zeichenfolge |
| \<Array\>.parent_Record | SYS_ID des übergeordneten Datensatzes. Datentyp: Zeichenfolge |
| \<Array\>.parent_table | Der Name der Tabelle, aus der der übergeordnete Datensatz stammt. Datentyp: Zeichenfolge |
| \<Array\>.Playbook_ID | SYS_ID des Playbooks aus der Tabelle „Prozessdefinitionen \[sys_pd_process_definition\]". Datentyp: Zeichenfolge |
| \<Array\>.Playbook_table | Der Name der Tabelle, aus der das Playbook stammt, im Allgemeinen die Tabelle „Prozessdefinitionen \[sys_pd_process_definition\]". Datentyp: Zeichenfolge |
| \<Array\>.scope_Name | Der bereichsbezogene Name des Playbooks aus der Tabelle „Prozessdefinitionen" \[sys_pd_process_definition\] im Format `scope.name `. Datentyp: Zeichenfolge |
| \<Array\>.Status | Der Status der Playbook-Ausführung aus der Tabelle „Prozessausführungen" \[sys_pd_context\]. Datentyp: Objekt "state": { "displayValue": "String", "value": "String" } |
| \<Array\>.Status.Anzeigewert | Der Anzeigewert des Playbook-Ausführungsstatus. Datentyp: Zeichenfolge |
| \<Array\>.Status.Wert | Der Wert des Playbook-Ausführungsstatus. Datentyp: Zeichenfolge |
| \<Array\>.sys_ID | SYS_ID der Playbook-Ausführung aus der Tabelle „Prozessausführungen" \[sys_pd_context\]. Datentyp: Zeichenfolge |
| \<Array\>.Titel | Die Bezeichnung der Playbook-Ausführung aus der Tabelle „Prozessausführungen" \[sys_pd_context\]. Datentyp: Zeichenfolge |
[Tabelle : 4. Rückgaben]

{#Playbook-getPlaybooksForParRec_O__table_jpb_gyn_cqb}  
Dieses Beispiel zeigt, wie Playbook-Ausführungen für einen bestimmten Interaktionsdatensatz abgerufen werden. Um diese Methode in einer UI-Aktion oder Business-Regel zu verwenden, übergeben Sie `Aktuell `Stattdessen Objekt als parentRecord.

    var parentRecord = new GlideRecordUtil().getGR("interaction", "148776e5818d7410f87701eb89fdc824");
    var playbook = sn_playbook.PlaybookExperience.getPlaybooksForParentRecord(parentRecord);
    gs.info(JSON.stringify(playbook, null, 2));

Ausgabe:

    [
      {
        "can_read": true,
        "sys_id": "bd87bae50b8d7410807a8ffed6d0909e",
        "scoped_name": "sn_pad_demo.playbook_experience_demo",
        "canceled_by": "",
        "playbook_table": "sys_pd_process_definition",
        "state": {
          "displayValue": "In Progress",
          "value": "IN_PROGRESS"
        },
        "title": "Playbook Experience Demo",
        "parent_record": "148776e5818d7410f87701eb89fdc824",
        "playbook_id": "0d35ee1807301010cc08d9630ad3002a",
        "cancellation_reason": "",
        "parent_table": "interaction",
        "errors": []
      }
    ]

## PlaybookExperience -- parentRecordContainsPlaybook(GlideRecord parentRecord, Zeichenfolge scope edName) {#ariaid-title4}

Überprüft, ob ein übergeordneter Datensatz Playbook-Ausführungen enthält.
{#Playbook-parentRecCP_O_S__table_a4v_txn_cqb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| parentRecord | GlideRecord | Der übergeordnete Datensatz, der auf Playbook-Ausführungen überprüft werden soll. Der übergeordnete Datensatz kann ein beliebiger Datensatz sein, der Playbook-Ausführungen enthalten kann, z. B. ein Interaktionsdatensatz oder ein Onboarding-Falldatensatz. |
| scopedName | Zeichenfolge | Optional. Der bereichsbezogene Name des Playbooks, nach dem gesucht werden soll. Der bereichsbezogene Name stammt aus der Tabelle „Prozessdefinition" \[sys_pd_process_definition\] im Format `scope.name `. Wenn angegeben, werden nur Ausführungen dieses Playbooks überprüft. Wenn nicht angegeben, werden Ausführungen aller Playbooks überprüft. |
[Tabelle : 5. Parameter]

{#Playbook-parentRecCP_O_S__table_a4v_txn_cqb} {#Playbook-parentRecCP_O_S__table_b4v_txn_cqb__entry__2}

| Typ | Beschreibung |
|-|-|
| Boolean | Kennzeichnung, die angibt, ob der übergeordnete Datensatz Playbook-Ausführungen enthält. Gültige Werte: * Wahr: Übergeordneter Datensatz hat Playbook-Ausführungen. * Falsch: Übergeordneter Datensatz enthält keine Playbook-Ausführungen. {#Playbook-parentRecCP_O_S__ul_hlb_yhw_cqb} |
[Tabelle : 6. Rückgaben]

{#Playbook-parentRecCP_O_S__table_b4v_txn_cqb}  
Dieses Beispiel zeigt, wie überprüft wird, ob ein bestimmter Interaktionsdatensatz Ausführungen eines bestimmten Playbooks enthält (in diesem Fall die Playbook-Experience-Demo). Um diese Methode in einer UI-Aktion oder Business-Regel zu verwenden, übergeben Sie `Aktuell `Stattdessen Objekt als parentRecord.

    var parentRecord = new GlideRecordUtil().getGR("interaction", "148776e5818d7410f87701eb89fdc824");

    // demo playbook from Process Automation Experience Demo store app
    var scopedName = "sn_pad_demo.playbook_experience_demo"; 

    var hasPlaybooks = sn_playbook.PlaybookExperience.parentRecordContainsPlaybook(parentRecord, scopedName);
    gs.info(hasPlaybooks);

Ausgabe:

    true

## PlaybookExperience -- restartPlaybook(Zeichenfolge playbookContextId, ZeichenzeichenlaneContextId, Zeichenfolge activityContextId, Zeichenfolge playbookExperienceId) {#ariaid-title5}

Startet eine Ausführung von Anfang an (das gesamte Playbook) oder aus einer bestimmten Phase oder Aktivität eines Playbooks neu.
Hinweis:  
Nur Playbooks mit dem Status „in Bearbeitung", „in Warteschlange" oder „Abbruch ausstehend" können neu gestartet werden.
{#Playbook-restartPlaybook_S_S_S_S__table_udh_zjr_ypb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| playbookContextId | Zeichenfolge | SYS_ID des Playbook-Kontextdatensatzes für die Playbook-Ausführung oder -Ausführung, die Sie neu starten möchten. Tabelle: Prozessausführung \[sys_pd_context\] |
| laneContextId | Zeichenfolge | Optional. Die sys_ID des Phasenkontextdatensatzes für die Phasenausführung oder -Ausführung, von der aus Sie neu starten möchten. Hinweis: Nur abgeschlossene Phasen können neu gestartet werden. Tabelle: Spaltenausführungen \[sys_pd_lane_context\] |
| activityContextId | Zeichenfolge | Optional. Die sys_ID des Aktivitätskontextdatensatzes für die Aktivitätsausführung oder -Ausführung, von der aus Sie neu starten möchten. Hinweis: Nur abgeschlossene Aktivitäten können neu gestartet werden. Tabelle: Aktivitätsausführungen \[sys_pd_activity_context\] |
| playbookExperienceId | Zeichenfolge | Optional. Die sys_ID der Playbook-Experience, die Sie für die neu gestartete Ausführung verwenden möchten. Verwenden Sie diesen Parameter, wenn Sie anwenderdefinierte Zuordnungen des Aktivitätsstatus definiert haben. Siehe Playbook-Aktivitätsstatuszuordnung . Standard: Globale Playbook-Experience Tabelle: Playbook-Experience \[sys_Playbook_Experience\] |
[Tabelle : 7. Parameter]

{#Playbook-restartPlaybook_S_S_S_S__table_udh_zjr_ypb} {#Playbook-restartPlaybook_S_S_S_S__table_vdh_zjr_ypb__entry__2}

| Eigenschaft | Beschreibung |
|-|-|
| Objekt | Objekt, das die Details der neu gestarteten Playbook-Ausführung enthält. { "can_add_activity": Boolean, "can_cancel": Boolean, "can_read": Boolean "can_restart": Boolean, "canceled_by": "String", "cancellation_reason": "String", "errors": [Array] "is_archived": Boolean "parent_record": "String", "parent_table": "String", "playbook_id": "String", "playbook_table": "String", "scoped_name": "String", "state": {Object}, "sys_id": "String", "title": "String", } |
| CAN_add_activity | Kennzeichnung, die angibt, ob ein Anwender dem Playbook eine optionale Aktivität hinzufügen kann. Gültige Werte: * Wahr: Der aktuelle Anwender kann dem Playbook eine optionale Aktivität hinzufügen. * Falsch: Der aktuelle Anwender kann dem Playbook keine optionale Aktivität hinzufügen. {#Playbook-restartPlaybook_S_S_S_S__ul_mvg_gk3_2cc} Datentyp: Boolescher Wert |
| CAN_Cancel | Kennzeichnung, die angibt, ob ein Anwender ein Playbook stornieren kann. * Wahr: Die Prozessdefinition für das deaktivierte Playbook ist aktiv. * Falsch: Die Prozessdefinition für das deaktivierte Playbook ist inaktiv. {#Playbook-restartPlaybook_S_S_S_S__ul_oz5_cq3_2cc} Datentyp: Boolescher Wert |
| CAN_read | Kennzeichnung, die angibt, ob der aktuelle Anwender den Playbook-Ausführungsdatensatz lesen kann. Der aktuelle Anwender muss Lesezugriff auf den übergeordneten Datensatz haben, um den Playbook-Ausführungsdatensatz lesen zu können. * Wahr: Der aktuelle Anwender hat Lesezugriff auf den Playbook-Ausführungsdatensatz. * Falsch: Der aktuelle Anwender hat keinen Lesezugriff auf den Playbook-Ausführungsdatensatz. {#Playbook-restartPlaybook_S_S_S_S__ul_tkn_hq3_2cc} Datentyp: Boolescher Wert |
| CAN_restart | Kennzeichnung, die angibt, ob ein Anwender ein Playbook, eine Phase oder eine Aktivität neu starten kann. * Wahr: Der aktuelle Anwender kann das Playbook, die Phase oder die Aktivität neu starten. * Falsch: Der aktuelle Anwender kann das Playbook, die Phase oder die Aktivität nicht neu starten. {#Playbook-restartPlaybook_S_S_S_S__ul_rdq_1q3_2cc} Datentyp: Boolescher Wert |
| Abgebrochen_von | Anwender-ID Des Anwenders, der die Playbook-Ausführung abgebrochen hat. Datentyp: Zeichenfolge |
| Cancel_reason | Abbruchgrund, der vom Anwender eingegeben wurde, der die Playbook-Ausführung abgebrochen hat. Datentyp: Zeichenfolge |
| Fehler | Liste der Neustartfehler. Jeder Fehler ist ein Objekt im Array. Datentyp: Array "errors": [ { "message": "String", "type": "String" } ] |
| Ist_archiviert | Kennzeichnung, die angibt, ob Playbook-Kontextdatensätze archiviert werden. Mögliche Werte: * Wahr: Playbook-Kontextdatensätze werden archiviert. * Falsch: Playbook-Kontextdatensätze werden nicht archiviert. {#Playbook-restartPlaybook_S_S_S_S__ul_eff_t24_2cc} Datentyp: Boolescher Wert |
| parent_record | SYS_ID des übergeordneten Datensatzes, für den Playbook-Ausführungen neu gestartet wurden. Datentyp: Zeichenfolge |
| parent_table | Name der Tabelle, aus der der übergeordnete Datensatz stammt. Datentyp: Zeichenfolge |
| playbook_ID | SYS_ID des Playbooks. Datentyp: Zeichenfolge Tabelle: Prozessdefinitionen \[sys_pd_process_definition\] |
| playbook_table | Name der Tabelle, aus der das Playbook stammt, im Allgemeinen die Tabelle „Prozessdefinitionen \[sys_pd_process_definition\]". Datentyp: Zeichenfolge |
| Scoped_Name | Optional. Der bereichsbezogene Name des Playbooks, das neu gestartet werden soll. Der bereichsbezogene Name stammt aus der Tabelle „Prozessdefinition" \[sys_pd_process_definition\] im Format `scope.name `. Wenn angegeben, werden nur Ausführungen dieses Playbooks für den angegebenen übergeordneten Datensatz neu gestartet. Wenn nicht angegeben, werden alle Ausführungen aller Playbooks für den angegebenen übergeordneten Datensatz neu gestartet. Datentyp: Zeichenfolge |
| Staat | Gibt an, ob Ihre Anforderung zur Aktivierung erfolgreich war. Datentyp: Objekt Mögliche Werte: * ERFOLG: Das Playbook wurde erfolgreich aktiviert. * FEHLER: Die ID für das Playbook wurde nicht gefunden. {#Playbook-restartPlaybook_S_S_S_S__ul_vkk_g24_2cc} "state": [ { "displayValue": "String", "value": "String" } ] |
| status.Anzeigewert | Anzeigewert des Playbook-Ausführungsstatus. Datentyp: Zeichenfolge |
| status.Wert | Wert des Playbook-Ausführungsstatus. Datentyp: Zeichenfolge |
| sys_id | SYS_ID der Playbook-Ausführung. Datentyp: Zeichenfolge Tabelle: Prozessausführungen \[sys_pd_context\] |
| Titel | Bezeichnung der Playbook-Ausführung. Datentyp: Zeichenfolge Tabelle: Prozessausführungen \[sys_pd_context\] |
[Tabelle : 8. Rückgaben]

{#Playbook-restartPlaybook_S_S_S_S__table_vdh_zjr_ypb}  
Dieses Beispiel zeigt, wie eine gesamte Playbook-Ausführung mit der Datensatz-ID „Prozessausführungen \[sys_pd_context\] 98e4fe04591b4caca59583f7b8e30b0a" neu gestartet wird.

    var gr = new GlideRecord('sys_pd_context');
    var found = gr.get('98e4fe04591b4caca59583f7b8e30b0a'); 
    if (found) {
        var result = sn_playbook.PlaybookExperience.restartPlaybook(gr);
        gs.info(JSON.stringify(result));
    }
    else
        gs.info('invalid pd context');

Ausgabe:

    {
     "scoped_name": "global.restart_scriptable_demo",
     "canceled_by": "",
     "can_add_activity": true,
     "playbook_table": "sys_pd_process_definition",
     "can_restart": true,
     "can_cancel": true,
     "title": "Restart scriptable demo",
     "cancellation_reason": "",
     "parent_table": "interaction",
     "can_read": true,
     "sys_id": "98e4fe04591b4caca59583f7b8e30b0a",
     "is_archived": false,
     "state": {
       "displayValue": "In Progress",
       "value": "IN_PROGRESS"
     },
     "parent_record": "b88623beb5e10210f877d783f6f83a46",
     "playbook_id": "12d5a7fab5e10210f877d783f6f83aff",
     "errors": []
    }

## PlaybookExperience -- triggerPlaybook(Zeichenfolge scope-Name, GlideRecord parentRecord) {#ariaid-title6}

Initiiert ein Playbook für einen übergeordneten Datensatz.
{#Playbook-triggerPlaybook_S_O__table_e5p_xxn_cqb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| scopedName | Zeichenfolge | Der bereichsbezogene Name des zu initiierenden Playbooks. Der bereichsbezogene Name stammt aus der Tabelle „Prozessdefinition" \[sys_pd_process_definition\] im Format `scope.name `. |
| parentRecord | GlideRecord | Der übergeordnete Datensatz, für den ein Playbook initiiert werden soll. Der übergeordnete Datensatz kann ein beliebiger Datensatz sein, der Playbook-Ausführungen enthalten kann, z. B. ein Interaktionsdatensatz oder ein Onboarding-Falldatensatz. |
[Tabelle : 9. Parameter]

{#Playbook-triggerPlaybook_S_O__table_e5p_xxn_cqb} {#Playbook-triggerPlaybook_S_O__table_f5p_xxn_cqb__entry__2}

| Typ | Beschreibung |
|-|-|
| Zeichenfolge | SYS_ID der Playbook-Ausführung aus der Tabelle „Prozessausführungen" \[sys_pd_context\], die für den übergeordneten Datensatz erstellt wurde. Null, wenn eine Playbook-Ausführung nicht erfolgreich erstellt wurde. |
[Tabelle : 10. Rückgaben]

{#Playbook-triggerPlaybook_S_O__table_f5p_xxn_cqb}  
Dieses Beispiel zeigt, wie ein Playbook für einen bestimmten Interaktionsdatensatz initiiert wird. Um diese Methode in einer UI-Aktion oder Business-Regel zu verwenden, übergeben Sie `Aktuell `Stattdessen Objekt als parentRecord.

    var parentRecord = new GlideRecordUtil().getGR("interaction", "148776e5818d7410f87701eb89fdc824");

    // demo playbook from Process Automation Experience Demo store app
    var scopedName = "sn_pad_demo.playbook_experience_demo"; 

    var playbookExecution = sn_playbook.PlaybookExperience.triggerPlaybook(scopedName, parentRecord);
    gs.info(playbookExecution);

Ausgabe:

    f059958267cdb410952864f0fed358cc


