PlaybookExperience- Scoped

</td></tr><tr><td>

&lt;Object&gt;.canceledPlaybookContext.can\_add\_activity

</td><td>

Flag that indicates whether a user can add an optional activity to the playbook.Valid values:

-   true: Current user can add an optional activity to the playbook.
-   false: Current user can’t add an optional activity to the playbook.

Data type: Boolean

</td></tr><tr><td>

&lt;Object&gt;.canceledPlaybookContext.can\_cancel

</td><td>

Flag that indicates whether a user can cancel a playbook.-   true: The process definition for the deactivated playbook is active.
-   false: The process definition for the deactivated playbook is inactive.

Data type: Boolean

</td></tr><tr><td>

&lt;Object&gt;.canceledPlaybookContext.can\_read

</td><td>

Flag that indicates whether the current user can read the playbook execution record. The current user must have read access to the parent record to be able to read the playbook execution record.

 Valid values:

-   true: Current user has read access to the playbook execution record.
-   false: Current user doesn't have read access to the playbook execution record.

 Data type: Boolean

</td></tr><tr><td>

&lt;Object&gt;.canceledPlaybookContext.can\_restart

</td><td>

Flag that indicates whether a user can restart a playbook, stage, or activity.-   true: Current user can restart the playbook, stage, or activity.
-   false: Current user can’t restart the playbook, stage, or activity.

Data type: Boolean

</td></tr><tr><td>

&lt;Object&gt;.canceledPlaybookContext.canceled\_by

</td><td>The <strong>User ID</strong> of the user who cancelled the playbook execution.Data type: String</td></tr><tr><td>

&lt;Object&gt;.canceledPlaybookContext.cancellation\_reason

</td><td>

The cancellation reason input by the user who cancelled the playbook execution.Data type: String

</td></tr><tr><td>

&lt;Object&gt;.canceledPlaybookContext.errors

</td><td>

List of cancellation errors. Each error is an object in the array.Data type: Array

 ```
"errors": [
    {      
      "message": "String",
      "type": "String"  
    }
]

</td></tr><tr><td>

&lt;Object&gt;.canceledPlaybookContext.state.displayValue

</td><td>

The display value of the playbook execution state.Data type: String

</td></tr><tr><td>

&lt;Object&gt;.canceledPlaybookContext.state.value

</td><td>

The value of the playbook execution state.Data type: String

</td></tr><tr><td>

&lt;Object&gt;.canceledPlaybookContext.sys\_id

</td><td>

Sys\_id of the playbook execution from the Process Executions \[sys\_pd\_context\] table.Data type: String

</td></tr><tr><td>

&lt;Object&gt;.canceledPlaybookContext.title

</td><td>

The label of the playbook execution from the Process Executions \[sys\_pd\_context\] table.Data type: String

</td></tr><tr><td>

&lt;Object&gt;.canceledPlaybookContext.variant\_id

</td><td>

Sys\_id of the playbook variant execution from the Process Executions \[sys\_pd\_context\] table.

</td></tr></tbody>
</table>

This example shows how to cancel a single execution of a specific playbook that is running too long.

Output:

Force cancel a single execution of a specific playbook.

Output:

## PlaybookExperience - cancelPlaybooksByParentRecord\(GlideRecord parentRecord, String cancellationReason, String scopedName, String playbookExperienceId\)

Cancels playbook executions for a given parent record.

<table id="table_udh_zjr_ypb" class="parameters"><thead><tr><th>

Name

</th><th>

Type

</th><th>

Description

</th></tr></thead><tbody><tr><td>

parentRecord

</td><td>

GlideRecord

</td><td>

The parent record to cancel playbook executions for. The parent record can be any record that has playbook executions, such as an interaction record or an onboarding case record.

</td></tr><tr><td>

cancellationReason

</td><td>

String

</td><td>

The reason for cancelling the playbook executions.

</td></tr><tr><td>

scopedName

</td><td>

String

</td><td>

Optional. The scoped name of the playbook to cancel. The scoped name is from the Process Definition \[sys\_pd\_process\_definition\] table in the format `scope.name`. If provided, only executions of this playbook are cancelled for the given parent record. If not provided, all executions of all playbooks are cancelled for the given parent record.

</td></tr><tr><td>

playbookExperienceId

</td><td>

String

</td><td>

Optional. Sys\_id of the playbook experience record in the Playbook Experience \[sys\_playbook\_experience\] table to use for the cancellation. Use this parameter if you've defined custom activity state mappings. See<a href="../../../build-workflows/workflow-studio/playbook-activity-state-mapping/">Playbook activity state mapping</a>.Default: Sys\_id of the Global Playbook Experience record.

</td></tr></tbody>
</table>

<table id="table_vdh_zjr_ypb" class="returns"><thead><tr><th>

Type

</th><th>

Description

</th></tr></thead><tbody><tr><td>

Object

</td><td>

Object containing the cancelled playbook executions and any skipped playbook executions that were unable to be cancelled.

</td></tr><tr><td>

&lt;Object&gt;.canceledPlaybookContext

</td><td>

List of the cancelled playbook executions. Each playbook execution is an object in the array.Data type: 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"   
    }
]

</td></tr><tr><td>

&lt;Object&gt;.canceledPlaybookContext.errors.message

</td><td>

The error message.Data type: String

</td></tr><tr><td>

&lt;Object&gt;.canceledPlaybookContext.errors.type

</td><td>

The type of error.Data type: String

</td></tr><tr><td>

&lt;Object&gt;.canceledPlaybookContext.is\_archived

</td><td>

Flag that indicates whether playbook context records are archived. Set to true. This value can’t be modified.Possible values:

-   true: Playbook context records are archived.
-   false: Playbook context records aren’t archived.

Data type: Boolean

</td></tr><tr><td>

&lt;Object&gt;.canceledPlaybookContext.parent\_record

</td><td>

Sys\_id of the parent record that playbook executions were cancelled for.Data type: String

</td></tr><tr><td>

&lt;Object&gt;.canceledPlaybookContext.parent\_table

</td><td>

The name of the table that the parent record is from.Data type: String

</td></tr><tr><td>

&lt;Object&gt;.canceledPlaybookContext.playbook\_id

</td><td>

Sys\_id of the playbook from the Process Definitions \[sys\_pd\_process\_definition\] table.Data type: String

</td></tr><tr><td>

&lt;Object&gt;.canceledPlaybookContext.playbook\_table

</td><td>

The name of the table that the playbook is from, generally the Process Definitions \[sys\_pd\_process\_definition\] table.Data type: String

</td></tr><tr><td>

&lt;Object&gt;.canceledPlaybookContext.scoped\_name

</td><td>

The scoped name of the playbook from the Process Definitions \[sys\_pd\_process\_definition\] table in the format `scope.name`.Data type: String

</td></tr><tr><td>

&lt;Object&gt;.canceledPlaybookContext.snapshot\_id

</td><td>

Sys\_id of the snapshot of the playbook execution from the \[sys\_pd\_snapshot\] table.Data type: String

</td></tr><tr><td>

&lt;Object&gt;.canceledPlaybookContext.state

</td><td>

The state of the playbook execution from the Process Executions \[sys\_pd\_context\] table.Data type: Object

 ```
"state": {    
   "displayValue": "String",    
   "value": "String"
}

[
    {
      "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"   
    }
]

</td></tr><tr><td>

&lt;Array&gt;.errors.message

</td><td>

The error message.Data type: String

</td></tr><tr><td>

&lt;Array&gt;.errors.type

</td><td>

The type of error.Data type: String

</td></tr><tr><td>

&lt;Array&gt;.parent\_record

</td><td>

Sys\_id of the parent record.Data type: String

</td></tr><tr><td>

&lt;Array&gt;.parent\_table

</td><td>

The name of the table that the parent record is from.Data type: String

</td></tr><tr><td>

&lt;Array&gt;.playbook\_id

</td><td>

Sys\_id of the playbook from the Process Definitions \[sys\_pd\_process\_definition\] table.Data type: String

</td></tr><tr><td>

&lt;Array&gt;.playbook\_table

</td><td>

The name of the table that the playbook is from, generally the Process Definitions \[sys\_pd\_process\_definition\] table.Data type: String

</td></tr><tr><td>

&lt;Array&gt;.scoped\_name

</td><td>

The scoped name of the playbook from the Process Definitions \[sys\_pd\_process\_definition\] table in the format `scope.name`.Data type: String

</td></tr><tr><td>

&lt;Array&gt;.state

</td><td>

The state of the playbook execution from the Process Executions \[sys\_pd\_context\] table.Data type: Object

 ```
"state": {    
   "displayValue": "String",    
   "value": "String"
}

{
 "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",
}

"errors": [
 {      
  "message": "String",
  "type": "String"  
 }
]

"state": [
    {      
      "displayValue": "String",
      "value": "String"  
    }
]