Playbook

Cortex XSOAR API

Playbook is a collection of tasks
allRead
optional
allReadWrite
optional
brands
optional
cacheVersn
optional
format: int64
commands
optional
comment
optional
commitMessage
optional
created
optional
format: date-time
dbotCreatedBy
optional
Who has created this event - relevant only for manual incidents
definitionId
optional
deprecated
optional
detached
optional
encTasks
optional
fromServerVersion
optional
Version
hasRole
optional
Internal field to make queries on role faster
hidden
optional
highlight
optional
id
optional
indexName
optional
inputs
optional
array[PlaybookInput] PlaybookInputs - array of PlaybookInput
itemVersion
optional
Version
locked
optional
missingScriptsIds
optional
modified
optional
format: date-time
name
optional
nameRaw
optional
numericId
optional
format: int64
outputs
optional
array[PlaybookOutput] PlaybookOutputs - array of PlaybookOutput
packID
optional
packName
optional
packPropagationLabels
optional
prevName
optional
previousAllRead
optional
previousAllReadWrite
optional
previousRoles
optional
Do not change this field manually
primaryTerm
optional
format: int64
private
optional
propagationLabels
optional
quiet
optional
remote
optional
roles
optional
The role assigned to this investigation
scriptIds
optional
sequenceNumber
optional
format: int64
shouldCommit
optional
sizeInBytes
optional
format: int64
sortValues
optional
sourcePlaybookID
optional
startTaskId
optional
syncHash
optional
system
optional
tags
optional
taskIds
optional
auto generated field that will contain all task ids in this playbook Needed for searching with bleve
tasks
optional
map[String, PlaybookTask]
toServerVersion
optional
Version
vcShouldIgnore
optional
vcShouldKeepItemLegacyProdMachine
optional
version
optional
format: int64
view
optional
PlaybookView represents the view in client of playbook graph
xsoarHasReadOnlyRole
optional
xsoarPreviousReadOnlyRoles
optional
xsoarReadOnlyRoles
optional